Packages:

ami.aws.infrastructure.cluster.x-k8s.io/v1beta1

Package v1beta1 contains API Schema definitions for the AMI v1beta1 API group

Resource Types:

    AWSAMI

    AWSAMI defines an AMI.

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    AWSAMISpec


    os
    string
    region
    string
    imageID
    string
    kubernetesVersion
    string

    AWSAMISpec

    (Appears on:AWSAMI)

    AWSAMISpec defines an AMI.

    Field Description
    os
    string
    region
    string
    imageID
    string
    kubernetesVersion
    string

    bootstrap.aws.infrastructure.cluster.x-k8s.io/v1alpha1

    Package v1alpha1 contains API Schema definitions for the bootstrap v1alpha1 API group

    Resource Types:

      AWSIAMConfiguration

      AWSIAMConfiguration controls the creation of AWS Identity and Access Management (IAM) resources for use by Kubernetes clusters and Kubernetes Cluster API Provider AWS.

      Field Description
      spec
      AWSIAMConfigurationSpec


      namePrefix
      string

      NamePrefix will be prepended to every AWS IAM role, user and policy created by clusterawsadm. Defaults to “”.

      nameSuffix
      string

      NameSuffix will be appended to every AWS IAM role, user and policy created by clusterawsadm. Defaults to “.cluster-api-provider-aws.sigs.k8s.io”.

      controlPlane
      ControlPlane

      ControlPlane controls the configuration of the AWS IAM role for a Kubernetes cluster’s control plane nodes.

      clusterAPIControllers
      ClusterAPIControllers

      ClusterAPIControllers controls the configuration of an IAM role and policy specifically for Kubernetes Cluster API Provider AWS.

      nodes
      Nodes

      Nodes controls the configuration of the AWS IAM role for all nodes in a Kubernetes cluster.

      bootstrapUser
      BootstrapUser

      BootstrapUser contains a list of elements that is specific to the configuration and enablement of an IAM user.

      stackName
      string

      StackName defines the name of the AWS CloudFormation stack.

      region
      string

      Region controls which region the control-plane is created in if not specified on the command line or via environment variables.

      eks
      EKSConfig

      EKS controls the configuration related to EKS. Settings in here affect the control plane and nodes roles

      eventBridge
      EventBridgeConfig

      EventBridge controls configuration for consuming EventBridge events

      partition
      string

      Partition is the AWS security partition being used. Defaults to “aws”

      secureSecretBackends
      []Cluster API AWS api/v1beta1.SecretBackend

      SecureSecretsBackend, when set to parameter-store will create AWS Systems Manager Parameter Storage policies. By default or with the value of secrets-manager, will generate AWS Secrets Manager policies instead.

      AWSIAMConfigurationSpec

      (Appears on:AWSIAMConfiguration)

      AWSIAMConfigurationSpec defines the specification of the AWSIAMConfiguration.

      Field Description
      namePrefix
      string

      NamePrefix will be prepended to every AWS IAM role, user and policy created by clusterawsadm. Defaults to “”.

      nameSuffix
      string

      NameSuffix will be appended to every AWS IAM role, user and policy created by clusterawsadm. Defaults to “.cluster-api-provider-aws.sigs.k8s.io”.

      controlPlane
      ControlPlane

      ControlPlane controls the configuration of the AWS IAM role for a Kubernetes cluster’s control plane nodes.

      clusterAPIControllers
      ClusterAPIControllers

      ClusterAPIControllers controls the configuration of an IAM role and policy specifically for Kubernetes Cluster API Provider AWS.

      nodes
      Nodes

      Nodes controls the configuration of the AWS IAM role for all nodes in a Kubernetes cluster.

      bootstrapUser
      BootstrapUser

      BootstrapUser contains a list of elements that is specific to the configuration and enablement of an IAM user.

      stackName
      string

      StackName defines the name of the AWS CloudFormation stack.

      region
      string

      Region controls which region the control-plane is created in if not specified on the command line or via environment variables.

      eks
      EKSConfig

      EKS controls the configuration related to EKS. Settings in here affect the control plane and nodes roles

      eventBridge
      EventBridgeConfig

      EventBridge controls configuration for consuming EventBridge events

      partition
      string

      Partition is the AWS security partition being used. Defaults to “aws”

      secureSecretBackends
      []Cluster API AWS api/v1beta1.SecretBackend

      SecureSecretsBackend, when set to parameter-store will create AWS Systems Manager Parameter Storage policies. By default or with the value of secrets-manager, will generate AWS Secrets Manager policies instead.

      AWSIAMRoleSpec

      (Appears on:ClusterAPIControllers, ControlPlane, EKSConfig, Nodes)

      AWSIAMRoleSpec defines common configuration for AWS IAM roles created by Kubernetes Cluster API Provider AWS.

      Field Description
      disable
      bool

      Disable if set to true will not create the AWS IAM role. Defaults to false.

      extraPolicyAttachments
      []string

      ExtraPolicyAttachments is a list of additional policies to be attached to the IAM role.

      extraStatements
      []Cluster API AWS iam/api/v1beta1.StatementEntry

      ExtraStatements are additional IAM statements to be included inline for the role.

      trustStatements
      []Cluster API AWS iam/api/v1beta1.StatementEntry

      TrustStatements is an IAM PolicyDocument defining what identities are allowed to assume this role. See “sigs.k8s.io/cluster-api-provider-aws/cmd/clusterawsadm/api/iam/v1beta1” for more documentation.

      tags
      Cluster API AWS api/v1beta1.Tags

      Tags is a map of tags to be applied to the AWS IAM role.

      BootstrapUser

      (Appears on:AWSIAMConfigurationSpec)

      BootstrapUser contains a list of elements that is specific to the configuration and enablement of an IAM user.

      Field Description
      enable
      bool

      Enable controls whether or not a bootstrap AWS IAM user will be created. This can be used to scope down the initial credentials used to bootstrap the cluster. Defaults to false.

      userName
      string

      UserName controls the username of the bootstrap user. Defaults to “bootstrapper.cluster-api-provider-aws.sigs.k8s.io”

      groupName
      string

      GroupName controls the group the user will belong to. Defaults to “bootstrapper.cluster-api-provider-aws.sigs.k8s.io”

      extraPolicyAttachments
      []string

      ExtraPolicyAttachments is a list of additional policies to be attached to the IAM user.

      extraGroups
      []string

      ExtraGroups is a list of groups to add this user to.

      extraStatements
      []Cluster API AWS iam/api/v1beta1.StatementEntry

      ExtraStatements are additional AWS IAM policy document statements to be included inline for the user.

      tags
      Cluster API AWS api/v1beta1.Tags

      Tags is a map of tags to be applied to the AWS IAM user.

      ClusterAPIControllers

      (Appears on:AWSIAMConfigurationSpec)

      ClusterAPIControllers controls the configuration of the AWS IAM role for the Kubernetes Cluster API Provider AWS controller.

      Field Description
      AWSIAMRoleSpec
      AWSIAMRoleSpec

      (Members of AWSIAMRoleSpec are embedded into this type.)

      allowedEC2InstanceProfiles
      []string

      AllowedEC2InstanceProfiles controls which EC2 roles are allowed to be consumed by Cluster API when creating an ec2 instance. Defaults to *., where suffix is defaulted to .cluster-api-provider-aws.sigs.k8s.io

      ControlPlane

      (Appears on:AWSIAMConfigurationSpec)

      ControlPlane controls the configuration of the AWS IAM role for the control plane of provisioned Kubernetes clusters.

      Field Description
      AWSIAMRoleSpec
      AWSIAMRoleSpec

      (Members of AWSIAMRoleSpec are embedded into this type.)

      disableClusterAPIControllerPolicyAttachment
      bool

      DisableClusterAPIControllerPolicyAttachment, if set to true, will not attach the AWS IAM policy for Cluster API Provider AWS to the control plane role. Defaults to false.

      disableCloudProviderPolicy
      bool

      DisableCloudProviderPolicy if set to true, will not generate and attach the AWS IAM policy for the AWS Cloud Provider.

      enableCSIPolicy
      bool

      EnableCSIPolicy if set to true, will generate and attach the AWS IAM policy for the EBS CSI Driver.

      EKSConfig

      (Appears on:AWSIAMConfigurationSpec)

      EKSConfig represents the EKS related configuration config.

      Field Description
      disable
      bool

      Disable controls whether EKS-related permissions are granted

      iamRoleCreation
      bool

      AllowIAMRoleCreation controls whether the EKS controllers have permissions for creating IAM roles per cluster

      enableUserEKSConsolePolicy
      bool

      EnableUserEKSConsolePolicy controls the creation of the policy to view EKS nodes and workloads.

      defaultControlPlaneRole
      AWSIAMRoleSpec

      DefaultControlPlaneRole controls the configuration of the AWS IAM role for the EKS control plane. This is the default role that will be used if no role is included in the spec and automatic creation of the role isn’t enabled

      managedMachinePool
      AWSIAMRoleSpec

      ManagedMachinePool controls the configuration of the AWS IAM role for used by EKS managed machine pools.

      fargate
      AWSIAMRoleSpec

      Fargate controls the configuration of the AWS IAM role for used by EKS managed machine pools.

      kmsAliasPrefix
      string

      KMSAliasPrefix is prefix to use to restrict permission to KMS keys to only those that have an alias name that is prefixed by this. Defaults to cluster-api-provider-aws-*

      EventBridgeConfig

      (Appears on:AWSIAMConfigurationSpec)

      EventBridgeConfig represents configuration for enabling experimental feature to consume EventBridge EC2 events.

      Field Description
      enable
      bool

      Enable controls whether permissions are granted to consume EC2 events

      Nodes

      (Appears on:AWSIAMConfigurationSpec)

      Nodes controls the configuration of the AWS IAM role for worker nodes in a cluster created by Kubernetes Cluster API Provider AWS.

      Field Description
      AWSIAMRoleSpec
      AWSIAMRoleSpec

      (Members of AWSIAMRoleSpec are embedded into this type.)

      disableCloudProviderPolicy
      bool

      DisableCloudProviderPolicy if set to true, will not generate and attach the policy for the AWS Cloud Provider. Defaults to false.

      ec2ContainerRegistryReadOnly
      bool

      EC2ContainerRegistryReadOnly controls whether the node has read-only access to the EC2 container registry


      bootstrap.aws.infrastructure.cluster.x-k8s.io/v1beta1

      Package v1beta1 contains API Schema definitions for the bootstrap v1beta1 API group

      Resource Types:

        AWSIAMConfiguration

        AWSIAMConfiguration controls the creation of AWS Identity and Access Management (IAM) resources for use by Kubernetes clusters and Kubernetes Cluster API Provider AWS.

        Field Description
        spec
        AWSIAMConfigurationSpec


        namePrefix
        string

        NamePrefix will be prepended to every AWS IAM role, user and policy created by clusterawsadm. Defaults to “”.

        nameSuffix
        string

        NameSuffix will be appended to every AWS IAM role, user and policy created by clusterawsadm. Defaults to “.cluster-api-provider-aws.sigs.k8s.io”.

        controlPlane
        ControlPlane

        ControlPlane controls the configuration of the AWS IAM role for a Kubernetes cluster’s control plane nodes.

        clusterAPIControllers
        ClusterAPIControllers

        ClusterAPIControllers controls the configuration of an IAM role and policy specifically for Kubernetes Cluster API Provider AWS.

        nodes
        Nodes

        Nodes controls the configuration of the AWS IAM role for all nodes in a Kubernetes cluster.

        bootstrapUser
        BootstrapUser

        BootstrapUser contains a list of elements that is specific to the configuration and enablement of an IAM user.

        stackName
        string

        StackName defines the name of the AWS CloudFormation stack.

        region
        string

        Region controls which region the control-plane is created in if not specified on the command line or via environment variables.

        eks
        EKSConfig

        EKS controls the configuration related to EKS. Settings in here affect the control plane and nodes roles

        eventBridge
        EventBridgeConfig

        EventBridge controls configuration for consuming EventBridge events

        partition
        string

        Partition is the AWS security partition being used. Defaults to “aws”

        secureSecretBackends
        []Cluster API AWS api/v1beta1.SecretBackend

        SecureSecretsBackend, when set to parameter-store will create AWS Systems Manager Parameter Storage policies. By default or with the value of secrets-manager, will generate AWS Secrets Manager policies instead.

        AWSIAMConfigurationSpec

        (Appears on:AWSIAMConfiguration)

        AWSIAMConfigurationSpec defines the specification of the AWSIAMConfiguration.

        Field Description
        namePrefix
        string

        NamePrefix will be prepended to every AWS IAM role, user and policy created by clusterawsadm. Defaults to “”.

        nameSuffix
        string

        NameSuffix will be appended to every AWS IAM role, user and policy created by clusterawsadm. Defaults to “.cluster-api-provider-aws.sigs.k8s.io”.

        controlPlane
        ControlPlane

        ControlPlane controls the configuration of the AWS IAM role for a Kubernetes cluster’s control plane nodes.

        clusterAPIControllers
        ClusterAPIControllers

        ClusterAPIControllers controls the configuration of an IAM role and policy specifically for Kubernetes Cluster API Provider AWS.

        nodes
        Nodes

        Nodes controls the configuration of the AWS IAM role for all nodes in a Kubernetes cluster.

        bootstrapUser
        BootstrapUser

        BootstrapUser contains a list of elements that is specific to the configuration and enablement of an IAM user.

        stackName
        string

        StackName defines the name of the AWS CloudFormation stack.

        region
        string

        Region controls which region the control-plane is created in if not specified on the command line or via environment variables.

        eks
        EKSConfig

        EKS controls the configuration related to EKS. Settings in here affect the control plane and nodes roles

        eventBridge
        EventBridgeConfig

        EventBridge controls configuration for consuming EventBridge events

        partition
        string

        Partition is the AWS security partition being used. Defaults to “aws”

        secureSecretBackends
        []Cluster API AWS api/v1beta1.SecretBackend

        SecureSecretsBackend, when set to parameter-store will create AWS Systems Manager Parameter Storage policies. By default or with the value of secrets-manager, will generate AWS Secrets Manager policies instead.

        AWSIAMRoleSpec

        (Appears on:ClusterAPIControllers, ControlPlane, EKSConfig, Nodes)

        AWSIAMRoleSpec defines common configuration for AWS IAM roles created by Kubernetes Cluster API Provider AWS.

        Field Description
        disable
        bool

        Disable if set to true will not create the AWS IAM role. Defaults to false.

        extraPolicyAttachments
        []string

        ExtraPolicyAttachments is a list of additional policies to be attached to the IAM role.

        extraStatements
        []Cluster API AWS iam/api/v1beta1.StatementEntry

        ExtraStatements are additional IAM statements to be included inline for the role.

        trustStatements
        []Cluster API AWS iam/api/v1beta1.StatementEntry

        TrustStatements is an IAM PolicyDocument defining what identities are allowed to assume this role. See “sigs.k8s.io/cluster-api-provider-aws/cmd/clusterawsadm/api/iam/v1beta1” for more documentation.

        tags
        Cluster API AWS api/v1beta1.Tags

        Tags is a map of tags to be applied to the AWS IAM role.

        BootstrapUser

        (Appears on:AWSIAMConfigurationSpec)

        BootstrapUser contains a list of elements that is specific to the configuration and enablement of an IAM user.

        Field Description
        enable
        bool

        Enable controls whether or not a bootstrap AWS IAM user will be created. This can be used to scope down the initial credentials used to bootstrap the cluster. Defaults to false.

        userName
        string

        UserName controls the username of the bootstrap user. Defaults to “bootstrapper.cluster-api-provider-aws.sigs.k8s.io”

        groupName
        string

        GroupName controls the group the user will belong to. Defaults to “bootstrapper.cluster-api-provider-aws.sigs.k8s.io”

        extraPolicyAttachments
        []string

        ExtraPolicyAttachments is a list of additional policies to be attached to the IAM user.

        extraGroups
        []string

        ExtraGroups is a list of groups to add this user to.

        extraStatements
        []Cluster API AWS iam/api/v1beta1.StatementEntry

        ExtraStatements are additional AWS IAM policy document statements to be included inline for the user.

        tags
        Cluster API AWS api/v1beta1.Tags

        Tags is a map of tags to be applied to the AWS IAM user.

        ClusterAPIControllers

        (Appears on:AWSIAMConfigurationSpec)

        ClusterAPIControllers controls the configuration of the AWS IAM role for the Kubernetes Cluster API Provider AWS controller.

        Field Description
        AWSIAMRoleSpec
        AWSIAMRoleSpec

        (Members of AWSIAMRoleSpec are embedded into this type.)

        allowedEC2InstanceProfiles
        []string

        AllowedEC2InstanceProfiles controls which EC2 roles are allowed to be consumed by Cluster API when creating an ec2 instance. Defaults to *., where suffix is defaulted to .cluster-api-provider-aws.sigs.k8s.io

        ControlPlane

        (Appears on:AWSIAMConfigurationSpec)

        ControlPlane controls the configuration of the AWS IAM role for the control plane of provisioned Kubernetes clusters.

        Field Description
        AWSIAMRoleSpec
        AWSIAMRoleSpec

        (Members of AWSIAMRoleSpec are embedded into this type.)

        disableClusterAPIControllerPolicyAttachment
        bool

        DisableClusterAPIControllerPolicyAttachment, if set to true, will not attach the AWS IAM policy for Cluster API Provider AWS to the control plane role. Defaults to false.

        disableCloudProviderPolicy
        bool

        DisableCloudProviderPolicy if set to true, will not generate and attach the AWS IAM policy for the AWS Cloud Provider.

        enableCSIPolicy
        bool

        EnableCSIPolicy if set to true, will generate and attach the AWS IAM policy for the EBS CSI Driver.

        EKSConfig

        (Appears on:AWSIAMConfigurationSpec)

        EKSConfig represents the EKS related configuration config.

        Field Description
        disable
        bool

        Disable controls whether EKS-related permissions are granted

        iamRoleCreation
        bool

        AllowIAMRoleCreation controls whether the EKS controllers have permissions for creating IAM roles per cluster

        enableUserEKSConsolePolicy
        bool

        EnableUserEKSConsolePolicy controls the creation of the policy to view EKS nodes and workloads.

        defaultControlPlaneRole
        AWSIAMRoleSpec

        DefaultControlPlaneRole controls the configuration of the AWS IAM role for the EKS control plane. This is the default role that will be used if no role is included in the spec and automatic creation of the role isn’t enabled

        managedMachinePool
        AWSIAMRoleSpec

        ManagedMachinePool controls the configuration of the AWS IAM role for used by EKS managed machine pools.

        fargate
        AWSIAMRoleSpec

        Fargate controls the configuration of the AWS IAM role for used by EKS managed machine pools.

        kmsAliasPrefix
        string

        KMSAliasPrefix is prefix to use to restrict permission to KMS keys to only those that have an alias name that is prefixed by this. Defaults to cluster-api-provider-aws-*

        EventBridgeConfig

        (Appears on:AWSIAMConfigurationSpec)

        EventBridgeConfig represents configuration for enabling experimental feature to consume EventBridge EC2 events.

        Field Description
        enable
        bool

        Enable controls whether permissions are granted to consume EC2 events

        Nodes

        (Appears on:AWSIAMConfigurationSpec)

        Nodes controls the configuration of the AWS IAM role for worker nodes in a cluster created by Kubernetes Cluster API Provider AWS.

        Field Description
        AWSIAMRoleSpec
        AWSIAMRoleSpec

        (Members of AWSIAMRoleSpec are embedded into this type.)

        disableCloudProviderPolicy
        bool

        DisableCloudProviderPolicy if set to true, will not generate and attach the policy for the AWS Cloud Provider. Defaults to false.

        ec2ContainerRegistryReadOnly
        bool

        EC2ContainerRegistryReadOnly controls whether the node has read-only access to the EC2 container registry


        bootstrap.cluster.x-k8s.io/v1alpha4

        Resource Types:

          EKSConfig

          EKSConfig is the Schema for the eksconfigs API

          Field Description
          metadata
          Kubernetes meta/v1.ObjectMeta
          Refer to the Kubernetes API documentation for the fields of the metadata field.
          spec
          EKSConfigSpec


          kubeletExtraArgs
          map[string]string
          (Optional)

          Passes the kubelet args into the EKS bootstrap script

          status
          EKSConfigStatus

          EKSConfigSpec

          (Appears on:EKSConfig, EKSConfigTemplateResource)

          EKSConfigSpec defines the desired state of EKSConfig

          Field Description
          kubeletExtraArgs
          map[string]string
          (Optional)

          Passes the kubelet args into the EKS bootstrap script

          EKSConfigStatus

          (Appears on:EKSConfig)

          EKSConfigStatus defines the observed state of EKSConfig

          Field Description
          ready
          bool

          Ready indicates the BootstrapData secret is ready to be consumed

          dataSecretName
          string
          (Optional)

          DataSecretName is the name of the secret that stores the bootstrap data script.

          failureReason
          string
          (Optional)

          FailureReason will be set on non-retryable errors

          failureMessage
          string
          (Optional)

          FailureMessage will be set on non-retryable errors

          observedGeneration
          int64
          (Optional)

          ObservedGeneration is the latest generation observed by the controller.

          conditions
          Cluster API api/v1alpha4.Conditions
          (Optional)

          Conditions defines current service state of the EKSConfig.

          EKSConfigTemplate

          EKSConfigTemplate is the Schema for the eksconfigtemplates API

          Field Description
          metadata
          Kubernetes meta/v1.ObjectMeta
          Refer to the Kubernetes API documentation for the fields of the metadata field.
          spec
          EKSConfigTemplateSpec


          template
          EKSConfigTemplateResource

          EKSConfigTemplateResource

          (Appears on:EKSConfigTemplateSpec)

          EKSConfigTemplateResource defines the Template structure

          Field Description
          spec
          EKSConfigSpec


          kubeletExtraArgs
          map[string]string
          (Optional)

          Passes the kubelet args into the EKS bootstrap script

          EKSConfigTemplateSpec

          (Appears on:EKSConfigTemplate)

          EKSConfigTemplateSpec defines the desired state of EKSConfigTemplate

          Field Description
          template
          EKSConfigTemplateResource

          bootstrap.cluster.x-k8s.io/v1beta1

          Resource Types:

            EKSConfig

            EKSConfig is the schema for the Amazon EKS Machine Bootstrap Configuration API.

            Field Description
            metadata
            Kubernetes meta/v1.ObjectMeta
            Refer to the Kubernetes API documentation for the fields of the metadata field.
            spec
            EKSConfigSpec


            kubeletExtraArgs
            map[string]string
            (Optional)

            KubeletExtraArgs passes the specified kubelet args into the Amazon EKS machine bootstrap script

            status
            EKSConfigStatus

            EKSConfigSpec

            (Appears on:EKSConfig, EKSConfigTemplateResource)

            EKSConfigSpec defines the desired state of Amazon EKS Bootstrap Configuration.

            Field Description
            kubeletExtraArgs
            map[string]string
            (Optional)

            KubeletExtraArgs passes the specified kubelet args into the Amazon EKS machine bootstrap script

            EKSConfigStatus

            (Appears on:EKSConfig)

            EKSConfigStatus defines the observed state of the Amazon EKS Bootstrap Configuration.

            Field Description
            ready
            bool

            Ready indicates the BootstrapData secret is ready to be consumed

            dataSecretName
            string
            (Optional)

            DataSecretName is the name of the secret that stores the bootstrap data script.

            failureReason
            string
            (Optional)

            FailureReason will be set on non-retryable errors

            failureMessage
            string
            (Optional)

            FailureMessage will be set on non-retryable errors

            observedGeneration
            int64
            (Optional)

            ObservedGeneration is the latest generation observed by the controller.

            conditions
            Cluster API api/v1beta1.Conditions
            (Optional)

            Conditions defines current service state of the EKSConfig.

            EKSConfigTemplate

            EKSConfigTemplate is the Amazon EKS Bootstrap Configuration Template API.

            Field Description
            metadata
            Kubernetes meta/v1.ObjectMeta
            Refer to the Kubernetes API documentation for the fields of the metadata field.
            spec
            EKSConfigTemplateSpec


            template
            EKSConfigTemplateResource

            EKSConfigTemplateResource

            (Appears on:EKSConfigTemplateSpec)

            EKSConfigTemplateResource defines the Template structure.

            Field Description
            spec
            EKSConfigSpec


            kubeletExtraArgs
            map[string]string
            (Optional)

            KubeletExtraArgs passes the specified kubelet args into the Amazon EKS machine bootstrap script

            EKSConfigTemplateSpec

            (Appears on:EKSConfigTemplate)

            EKSConfigTemplateSpec defines the desired state of templated EKSConfig Amazon EKS Bootstrap Configuration resources.

            Field Description
            template
            EKSConfigTemplateResource

            controlplane.cluster.x-k8s.io/v1alpha4

            Resource Types:

              AWSManagedControlPlane

              AWSManagedControlPlane is the Schema for the awsmanagedcontrolplanes API

              Field Description
              metadata
              Kubernetes meta/v1.ObjectMeta
              Refer to the Kubernetes API documentation for the fields of the metadata field.
              spec
              AWSManagedControlPlaneSpec


              eksClusterName
              string
              (Optional)

              EKSClusterName allows you to specify the name of the EKS cluster in AWS. If you don’t specify a name then a default name will be created based on the namespace and name of the managed control plane.

              identityRef
              Cluster API AWS api/v1alpha4.AWSIdentityReference
              (Optional)

              IdentityRef is a reference to a identity to be used when reconciling the managed control plane.

              network
              Cluster API AWS api/v1alpha4.NetworkSpec

              NetworkSpec encapsulates all things related to AWS network.

              secondaryCidrBlock
              string
              (Optional)

              SecondaryCidrBlock is the additional CIDR range to use for pod IPs. Must be within the 100.64.0.0/10 or 198.19.0.0/16 range.

              region
              string

              The AWS Region the cluster lives in.

              sshKeyName
              string
              (Optional)

              SSHKeyName is the name of the ssh key to attach to the bastion host. Valid values are empty string (do not use SSH keys), a valid SSH key name, or omitted (use the default SSH key name)

              version
              string
              (Optional)

              Version defines the desired Kubernetes version. If no version number is supplied then the latest version of Kubernetes that EKS supports will be used.

              roleName
              string
              (Optional)

              RoleName specifies the name of IAM role that gives EKS permission to make API calls. If the role is pre-existing we will treat it as unmanaged and not delete it on deletion. If the EKSEnableIAM feature flag is true and no name is supplied then a role is created.

              roleAdditionalPolicies
              []string
              (Optional)

              RoleAdditionalPolicies allows you to attach additional polices to the control plane role. You must enable the EKSAllowAddRoles feature flag to incorporate these into the created role.

              logging
              ControlPlaneLoggingSpec
              (Optional)

              Logging specifies which EKS Cluster logs should be enabled. Entries for each of the enabled logs will be sent to CloudWatch

              encryptionConfig
              EncryptionConfig
              (Optional)

              EncryptionConfig specifies the encryption configuration for the cluster

              additionalTags
              Cluster API AWS api/v1alpha4.Tags
              (Optional)

              AdditionalTags is an optional set of tags to add to AWS resources managed by the AWS provider, in addition to the ones added by default.

              iamAuthenticatorConfig
              IAMAuthenticatorConfig
              (Optional)

              IAMAuthenticatorConfig allows the specification of any additional user or role mappings for use when generating the aws-iam-authenticator configuration. If this is nil the default configuration is still generated for the cluster.

              endpointAccess
              EndpointAccess
              (Optional)

              Endpoints specifies access to this cluster’s control plane endpoints

              controlPlaneEndpoint
              Cluster API api/v1alpha4.APIEndpoint
              (Optional)

              ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.

              imageLookupFormat
              string
              (Optional)

              ImageLookupFormat is the AMI naming format to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupOrg. Supports substitutions for {{.BaseOS}} and {{.K8sVersion}} with the base OS and kubernetes version, respectively. The BaseOS will be the value in ImageLookupBaseOS or ubuntu (the default), and the kubernetes version as defined by the packages produced by kubernetes/release without v as a prefix: 1.13.0, 1.12.5-mybuild.1, or 1.17.3. For example, the default image format of capa-ami-{{.BaseOS}}-?{{.K8sVersion}}-* will end up searching for AMIs that match the pattern capa-ami-ubuntu-?1.18.0-* for a Machine that is targeting kubernetes v1.18.0 and the ubuntu base OS. See also: https://golang.org/pkg/text/template/

              imageLookupOrg
              string
              (Optional)

              ImageLookupOrg is the AWS Organization ID to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupOrg.

              imageLookupBaseOS
              string

              ImageLookupBaseOS is the name of the base operating system used to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupBaseOS.

              bastion
              Cluster API AWS api/v1alpha4.Bastion
              (Optional)

              Bastion contains options to configure the bastion host.

              tokenMethod
              EKSTokenMethod

              TokenMethod is used to specify the method for obtaining a client token for communicating with EKS iam-authenticator - obtains a client token using iam-authentictor aws-cli - obtains a client token using the AWS CLI Defaults to iam-authenticator

              associateOIDCProvider
              bool

              AssociateOIDCProvider can be enabled to automatically create an identity provider for the controller for use with IAM roles for service accounts

              addons
              []../../controlplane/eks/api/v1alpha4.Addon
              (Optional)

              Addons defines the EKS addons to enable with the EKS cluster.

              oidcIdentityProviderConfig
              OIDCIdentityProviderConfig
              (Optional)

              IdentityProviderconfig is used to specify the oidc provider config to be attached with this eks cluster

              disableVPCCNI
              bool

              DisableVPCCNI indcates the the Amazon VPC CNI should be disabled. With EKS clusters that the Amazon VPC CNI is automatically installed into the cluster. For clusters where you want to use an alternate CNI this option provides a way to specify that the Amazon VPC CNI should be deleted. You cannot set this to true if you are using the Amazon VPC CNI addon or if you have specified a secondary CIDR block.

              status
              AWSManagedControlPlaneStatus

              AWSManagedControlPlaneSpec

              (Appears on:AWSManagedControlPlane)

              AWSManagedControlPlaneSpec defines the desired state of AWSManagedControlPlane

              Field Description
              eksClusterName
              string
              (Optional)

              EKSClusterName allows you to specify the name of the EKS cluster in AWS. If you don’t specify a name then a default name will be created based on the namespace and name of the managed control plane.

              identityRef
              Cluster API AWS api/v1alpha4.AWSIdentityReference
              (Optional)

              IdentityRef is a reference to a identity to be used when reconciling the managed control plane.

              network
              Cluster API AWS api/v1alpha4.NetworkSpec

              NetworkSpec encapsulates all things related to AWS network.

              secondaryCidrBlock
              string
              (Optional)

              SecondaryCidrBlock is the additional CIDR range to use for pod IPs. Must be within the 100.64.0.0/10 or 198.19.0.0/16 range.

              region
              string

              The AWS Region the cluster lives in.

              sshKeyName
              string
              (Optional)

              SSHKeyName is the name of the ssh key to attach to the bastion host. Valid values are empty string (do not use SSH keys), a valid SSH key name, or omitted (use the default SSH key name)

              version
              string
              (Optional)

              Version defines the desired Kubernetes version. If no version number is supplied then the latest version of Kubernetes that EKS supports will be used.

              roleName
              string
              (Optional)

              RoleName specifies the name of IAM role that gives EKS permission to make API calls. If the role is pre-existing we will treat it as unmanaged and not delete it on deletion. If the EKSEnableIAM feature flag is true and no name is supplied then a role is created.

              roleAdditionalPolicies
              []string
              (Optional)

              RoleAdditionalPolicies allows you to attach additional polices to the control plane role. You must enable the EKSAllowAddRoles feature flag to incorporate these into the created role.

              logging
              ControlPlaneLoggingSpec
              (Optional)

              Logging specifies which EKS Cluster logs should be enabled. Entries for each of the enabled logs will be sent to CloudWatch

              encryptionConfig
              EncryptionConfig
              (Optional)

              EncryptionConfig specifies the encryption configuration for the cluster

              additionalTags
              Cluster API AWS api/v1alpha4.Tags
              (Optional)

              AdditionalTags is an optional set of tags to add to AWS resources managed by the AWS provider, in addition to the ones added by default.

              iamAuthenticatorConfig
              IAMAuthenticatorConfig
              (Optional)

              IAMAuthenticatorConfig allows the specification of any additional user or role mappings for use when generating the aws-iam-authenticator configuration. If this is nil the default configuration is still generated for the cluster.

              endpointAccess
              EndpointAccess
              (Optional)

              Endpoints specifies access to this cluster’s control plane endpoints

              controlPlaneEndpoint
              Cluster API api/v1alpha4.APIEndpoint
              (Optional)

              ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.

              imageLookupFormat
              string
              (Optional)

              ImageLookupFormat is the AMI naming format to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupOrg. Supports substitutions for {{.BaseOS}} and {{.K8sVersion}} with the base OS and kubernetes version, respectively. The BaseOS will be the value in ImageLookupBaseOS or ubuntu (the default), and the kubernetes version as defined by the packages produced by kubernetes/release without v as a prefix: 1.13.0, 1.12.5-mybuild.1, or 1.17.3. For example, the default image format of capa-ami-{{.BaseOS}}-?{{.K8sVersion}}-* will end up searching for AMIs that match the pattern capa-ami-ubuntu-?1.18.0-* for a Machine that is targeting kubernetes v1.18.0 and the ubuntu base OS. See also: https://golang.org/pkg/text/template/

              imageLookupOrg
              string
              (Optional)

              ImageLookupOrg is the AWS Organization ID to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupOrg.

              imageLookupBaseOS
              string

              ImageLookupBaseOS is the name of the base operating system used to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupBaseOS.

              bastion
              Cluster API AWS api/v1alpha4.Bastion
              (Optional)

              Bastion contains options to configure the bastion host.

              tokenMethod
              EKSTokenMethod

              TokenMethod is used to specify the method for obtaining a client token for communicating with EKS iam-authenticator - obtains a client token using iam-authentictor aws-cli - obtains a client token using the AWS CLI Defaults to iam-authenticator

              associateOIDCProvider
              bool

              AssociateOIDCProvider can be enabled to automatically create an identity provider for the controller for use with IAM roles for service accounts

              addons
              []../../controlplane/eks/api/v1alpha4.Addon
              (Optional)

              Addons defines the EKS addons to enable with the EKS cluster.

              oidcIdentityProviderConfig
              OIDCIdentityProviderConfig
              (Optional)

              IdentityProviderconfig is used to specify the oidc provider config to be attached with this eks cluster

              disableVPCCNI
              bool

              DisableVPCCNI indcates the the Amazon VPC CNI should be disabled. With EKS clusters that the Amazon VPC CNI is automatically installed into the cluster. For clusters where you want to use an alternate CNI this option provides a way to specify that the Amazon VPC CNI should be deleted. You cannot set this to true if you are using the Amazon VPC CNI addon or if you have specified a secondary CIDR block.

              AWSManagedControlPlaneStatus

              (Appears on:AWSManagedControlPlane)

              AWSManagedControlPlaneStatus defines the observed state of AWSManagedControlPlane

              Field Description
              networkStatus
              Cluster API AWS api/v1alpha4.NetworkStatus
              (Optional)

              Networks holds details about the AWS networking resources used by the control plane

              failureDomains
              Cluster API api/v1alpha4.FailureDomains
              (Optional)

              FailureDomains specifies a list fo available availability zones that can be used

              bastion
              Cluster API AWS api/v1alpha4.Instance
              (Optional)

              Bastion holds details of the instance that is used as a bastion jump box

              oidcProvider
              OIDCProviderStatus
              (Optional)

              OIDCProvider holds the status of the identity provider for this cluster

              externalManagedControlPlane
              bool

              ExternalManagedControlPlane indicates to cluster-api that the control plane is managed by an external service such as AKS, EKS, GKE, etc.

              initialized
              bool
              (Optional)

              Initialized denotes whether or not the control plane has the uploaded kubernetes config-map.

              ready
              bool

              Ready denotes that the AWSManagedControlPlane API Server is ready to receive requests and that the VPC infra is ready.

              failureMessage
              string
              (Optional)

              ErrorMessage indicates that there is a terminal problem reconciling the state, and will be set to a descriptive error message.

              conditions
              Cluster API api/v1alpha4.Conditions

              Conditions specifies the cpnditions for the managed control plane

              addons
              []AddonState
              (Optional)

              Addons holds the current status of the EKS addons

              identityProviderStatus
              IdentityProviderStatus
              (Optional)

              IdentityProviderStatus holds the status for associated identity provider

              Addon

              Addon represents a EKS addon

              Field Description
              name
              string

              Name is the name of the addon

              version
              string

              Version is the version of the addon to use

              conflictResolution
              AddonResolution

              ConflictResolution is used to declare what should happen if there are parameter conflicts. Defaults to none

              serviceAccountRoleARN
              string
              (Optional)

              ServiceAccountRoleArn is the ARN of an IAM role to bind to the addons service account

              AddonIssue

              (Appears on:AddonState)

              AddonIssue represents an issue with an addon

              Field Description
              code
              string

              Code is the issue code

              message
              string

              Message is the textual description of the issue

              resourceIds
              []string

              ResourceIDs is a list of resource ids for the issue

              AddonResolution (string alias)

              (Appears on:Addon)

              AddonResolution defines the method for resolving parameter conflicts.

              AddonState

              (Appears on:AWSManagedControlPlaneStatus)

              AddonState represents the state of an addon

              Field Description
              name
              string

              Name is the name of the addon

              version
              string

              Version is the version of the addon to use

              arn
              string

              ARN is the AWS ARN of the addon

              serviceAccountRoleARN
              string

              ServiceAccountRoleArn is the ARN of the IAM role used for the service account

              createdAt
              Kubernetes meta/v1.Time

              CreatedAt is the date and time the addon was created at

              modifiedAt
              Kubernetes meta/v1.Time

              ModifiedAt is the date and time the addon was last modified

              status
              string

              Status is the status of the addon

              issues
              []AddonIssue

              Issues is a list of issue associated with the addon

              AddonStatus (string alias)

              AddonStatus defines the status for an addon.

              ControlPlaneLoggingSpec

              (Appears on:AWSManagedControlPlaneSpec)

              ControlPlaneLoggingSpec defines what EKS control plane logs that should be enabled.

              Field Description
              apiServer
              bool

              APIServer indicates if the Kubernetes API Server log (kube-apiserver) shoulkd be enabled

              audit
              bool

              Audit indicates if the Kubernetes API audit log should be enabled

              authenticator
              bool

              Authenticator indicates if the iam authenticator log should be enabled

              controllerManager
              bool

              ControllerManager indicates if the controller manager (kube-controller-manager) log should be enabled

              scheduler
              bool

              Scheduler indicates if the Kubernetes scheduler (kube-scheduler) log should be enabled

              EKSTokenMethod (string alias)

              (Appears on:AWSManagedControlPlaneSpec)

              EKSTokenMethod defines the method for obtaining a client token to use when connecting to EKS.

              EncryptionConfig

              (Appears on:AWSManagedControlPlaneSpec)

              EncryptionConfig specifies the encryption configuration for the EKS clsuter.

              Field Description
              provider
              string

              Provider specifies the ARN or alias of the CMK (in AWS KMS)

              resources
              []*string

              Resources specifies the resources to be encrypted

              EndpointAccess

              (Appears on:AWSManagedControlPlaneSpec)

              EndpointAccess specifies how control plane endpoints are accessible.

              Field Description
              public
              bool
              (Optional)

              Public controls whether control plane endpoints are publicly accessible

              publicCIDRs
              []*string
              (Optional)

              PublicCIDRs specifies which blocks can access the public endpoint

              private
              bool
              (Optional)

              Private points VPC-internal control plane access to the private endpoint

              IAMAuthenticatorConfig

              (Appears on:AWSManagedControlPlaneSpec)

              IAMAuthenticatorConfig represents an aws-iam-authenticator configuration.

              Field Description
              mapRoles
              []RoleMapping
              (Optional)

              RoleMappings is a list of role mappings

              mapUsers
              []UserMapping
              (Optional)

              UserMappings is a list of user mappings

              IdentityProviderStatus

              (Appears on:AWSManagedControlPlaneStatus)

              Field Description
              arn
              string

              ARN holds the ARN of associated identity provider

              status
              string

              Status holds current status of associated identity provider

              KubernetesMapping

              (Appears on:RoleMapping, UserMapping)

              KubernetesMapping represents the kubernetes RBAC mapping.

              Field Description
              username
              string

              UserName is a kubernetes RBAC user subject

              groups
              []string

              Groups is a list of kubernetes RBAC groups

              OIDCIdentityProviderConfig

              (Appears on:AWSManagedControlPlaneSpec)

              Field Description
              clientId
              string

              This is also known as audience. The ID for the client application that makes authentication requests to the OpenID identity provider.

              groupsClaim
              string
              (Optional)

              The JWT claim that the provider uses to return your groups.

              groupsPrefix
              string
              (Optional)

              The prefix that is prepended to group claims to prevent clashes with existing names (such as system: groups). For example, the valueoidc: will create group names like oidc:engineering and oidc:infra.

              identityProviderConfigName
              string

              The name of the OIDC provider configuration.

              IdentityProviderConfigName is a required field

              issuerUrl
              string

              The URL of the OpenID identity provider that allows the API server to discover public signing keys for verifying tokens. The URL must begin with https:// and should correspond to the iss claim in the provider’s OIDC ID tokens. Per the OIDC standard, path components are allowed but query parameters are not. Typically the URL consists of only a hostname, like https://server.example.org or https://example.com. This URL should point to the level below .well-known/openid-configuration and must be publicly accessible over the internet.

              requiredClaims
              map[string]string
              (Optional)

              The key value pairs that describe required claims in the identity token. If set, each claim is verified to be present in the token with a matching value. For the maximum number of claims that you can require, see Amazon EKS service quotas (https://docs.aws.amazon.com/eks/latest/userguide/service-quotas.html) in the Amazon EKS User Guide.

              usernameClaim
              string
              (Optional)

              The JSON Web Token (JWT) claim to use as the username. The default is sub, which is expected to be a unique identifier of the end user. You can choose other claims, such as email or name, depending on the OpenID identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins.

              usernamePrefix
              string
              (Optional)

              The prefix that is prepended to username claims to prevent clashes with existing names. If you do not provide this field, and username is a value other than email, the prefix defaults to issuerurl#. You can use the value - to disable all prefixing.

              tags
              Cluster API AWS api/v1alpha4.Tags
              (Optional)

              tags to apply to oidc identity provider association

              OIDCProviderStatus

              (Appears on:AWSManagedControlPlaneStatus)

              OIDCProviderStatus holds the status of the AWS OIDC identity provider.

              Field Description
              arn
              string

              ARN holds the ARN of the provider

              trustPolicy
              string

              TrustPolicy contains the boilerplate IAM trust policy to use for IRSA

              RoleMapping

              (Appears on:IAMAuthenticatorConfig)

              RoleMapping represents a mapping from a IAM role to Kubernetes users and groups

              Field Description
              rolearn
              string

              RoleARN is the AWS ARN for the role to map

              KubernetesMapping
              KubernetesMapping

              (Members of KubernetesMapping are embedded into this type.)

              KubernetesMapping holds the RBAC details for the mapping

              UserMapping

              (Appears on:IAMAuthenticatorConfig)

              UserMapping represents a mapping from an IAM user to Kubernetes users and groups

              Field Description
              userarn
              string

              UserARN is the AWS ARN for the user to map

              KubernetesMapping
              KubernetesMapping

              (Members of KubernetesMapping are embedded into this type.)

              KubernetesMapping holds the RBAC details for the mapping


              controlplane.cluster.x-k8s.io/v1beta1

              Package v1beta1 contains API Schema definitions for the controlplane v1beta1 API group

              Resource Types:

                AWSManagedControlPlane

                AWSManagedControlPlane is the schema for the Amazon EKS Managed Control Plane API.

                Field Description
                metadata
                Kubernetes meta/v1.ObjectMeta
                Refer to the Kubernetes API documentation for the fields of the metadata field.
                spec
                AWSManagedControlPlaneSpec


                eksClusterName
                string
                (Optional)

                EKSClusterName allows you to specify the name of the EKS cluster in AWS. If you don’t specify a name then a default name will be created based on the namespace and name of the managed control plane.

                identityRef
                Cluster API AWS api/v1beta1.AWSIdentityReference
                (Optional)

                IdentityRef is a reference to a identity to be used when reconciling the managed control plane.

                network
                Cluster API AWS api/v1beta1.NetworkSpec

                NetworkSpec encapsulates all things related to AWS network.

                secondaryCidrBlock
                string
                (Optional)

                SecondaryCidrBlock is the additional CIDR range to use for pod IPs. Must be within the 100.64.0.0/10 or 198.19.0.0/16 range.

                region
                string

                The AWS Region the cluster lives in.

                sshKeyName
                string
                (Optional)

                SSHKeyName is the name of the ssh key to attach to the bastion host. Valid values are empty string (do not use SSH keys), a valid SSH key name, or omitted (use the default SSH key name)

                version
                string
                (Optional)

                Version defines the desired Kubernetes version. If no version number is supplied then the latest version of Kubernetes that EKS supports will be used.

                roleName
                string
                (Optional)

                RoleName specifies the name of IAM role that gives EKS permission to make API calls. If the role is pre-existing we will treat it as unmanaged and not delete it on deletion. If the EKSEnableIAM feature flag is true and no name is supplied then a role is created.

                roleAdditionalPolicies
                []string
                (Optional)

                RoleAdditionalPolicies allows you to attach additional polices to the control plane role. You must enable the EKSAllowAddRoles feature flag to incorporate these into the created role.

                logging
                ControlPlaneLoggingSpec
                (Optional)

                Logging specifies which EKS Cluster logs should be enabled. Entries for each of the enabled logs will be sent to CloudWatch

                encryptionConfig
                EncryptionConfig
                (Optional)

                EncryptionConfig specifies the encryption configuration for the cluster

                additionalTags
                Cluster API AWS api/v1beta1.Tags
                (Optional)

                AdditionalTags is an optional set of tags to add to AWS resources managed by the AWS provider, in addition to the ones added by default.

                iamAuthenticatorConfig
                IAMAuthenticatorConfig
                (Optional)

                IAMAuthenticatorConfig allows the specification of any additional user or role mappings for use when generating the aws-iam-authenticator configuration. If this is nil the default configuration is still generated for the cluster.

                endpointAccess
                EndpointAccess
                (Optional)

                Endpoints specifies access to this cluster’s control plane endpoints

                controlPlaneEndpoint
                Cluster API api/v1beta1.APIEndpoint
                (Optional)

                ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.

                imageLookupFormat
                string
                (Optional)

                ImageLookupFormat is the AMI naming format to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupOrg. Supports substitutions for {{.BaseOS}} and {{.K8sVersion}} with the base OS and kubernetes version, respectively. The BaseOS will be the value in ImageLookupBaseOS or ubuntu (the default), and the kubernetes version as defined by the packages produced by kubernetes/release without v as a prefix: 1.13.0, 1.12.5-mybuild.1, or 1.17.3. For example, the default image format of capa-ami-{{.BaseOS}}-?{{.K8sVersion}}-* will end up searching for AMIs that match the pattern capa-ami-ubuntu-?1.18.0-* for a Machine that is targeting kubernetes v1.18.0 and the ubuntu base OS. See also: https://golang.org/pkg/text/template/

                imageLookupOrg
                string
                (Optional)

                ImageLookupOrg is the AWS Organization ID to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupOrg.

                imageLookupBaseOS
                string

                ImageLookupBaseOS is the name of the base operating system used to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupBaseOS.

                bastion
                Cluster API AWS api/v1beta1.Bastion
                (Optional)

                Bastion contains options to configure the bastion host.

                tokenMethod
                EKSTokenMethod

                TokenMethod is used to specify the method for obtaining a client token for communicating with EKS iam-authenticator - obtains a client token using iam-authentictor aws-cli - obtains a client token using the AWS CLI Defaults to iam-authenticator

                associateOIDCProvider
                bool

                AssociateOIDCProvider can be enabled to automatically create an identity provider for the controller for use with IAM roles for service accounts

                addons
                []../../controlplane/eks/api/v1beta1.Addon
                (Optional)

                Addons defines the EKS addons to enable with the EKS cluster.

                oidcIdentityProviderConfig
                OIDCIdentityProviderConfig
                (Optional)

                IdentityProviderconfig is used to specify the oidc provider config to be attached with this eks cluster

                disableVPCCNI
                bool

                DisableVPCCNI indcates the the Amazon VPC CNI should be disabled. With EKS clusters that the Amazon VPC CNI is automatically installed into the cluster. For clusters where you want to use an alternate CNI this option provides a way to specify that the Amazon VPC CNI should be deleted. You cannot set this to true if you are using the Amazon VPC CNI addon or if you have specified a secondary CIDR block.

                status
                AWSManagedControlPlaneStatus

                AWSManagedControlPlaneSpec

                (Appears on:AWSManagedControlPlane)

                AWSManagedControlPlaneSpec defines the desired state of an Amazon EKS Cluster.

                Field Description
                eksClusterName
                string
                (Optional)

                EKSClusterName allows you to specify the name of the EKS cluster in AWS. If you don’t specify a name then a default name will be created based on the namespace and name of the managed control plane.

                identityRef
                Cluster API AWS api/v1beta1.AWSIdentityReference
                (Optional)

                IdentityRef is a reference to a identity to be used when reconciling the managed control plane.

                network
                Cluster API AWS api/v1beta1.NetworkSpec

                NetworkSpec encapsulates all things related to AWS network.

                secondaryCidrBlock
                string
                (Optional)

                SecondaryCidrBlock is the additional CIDR range to use for pod IPs. Must be within the 100.64.0.0/10 or 198.19.0.0/16 range.

                region
                string

                The AWS Region the cluster lives in.

                sshKeyName
                string
                (Optional)

                SSHKeyName is the name of the ssh key to attach to the bastion host. Valid values are empty string (do not use SSH keys), a valid SSH key name, or omitted (use the default SSH key name)

                version
                string
                (Optional)

                Version defines the desired Kubernetes version. If no version number is supplied then the latest version of Kubernetes that EKS supports will be used.

                roleName
                string
                (Optional)

                RoleName specifies the name of IAM role that gives EKS permission to make API calls. If the role is pre-existing we will treat it as unmanaged and not delete it on deletion. If the EKSEnableIAM feature flag is true and no name is supplied then a role is created.

                roleAdditionalPolicies
                []string
                (Optional)

                RoleAdditionalPolicies allows you to attach additional polices to the control plane role. You must enable the EKSAllowAddRoles feature flag to incorporate these into the created role.

                logging
                ControlPlaneLoggingSpec
                (Optional)

                Logging specifies which EKS Cluster logs should be enabled. Entries for each of the enabled logs will be sent to CloudWatch

                encryptionConfig
                EncryptionConfig
                (Optional)

                EncryptionConfig specifies the encryption configuration for the cluster

                additionalTags
                Cluster API AWS api/v1beta1.Tags
                (Optional)

                AdditionalTags is an optional set of tags to add to AWS resources managed by the AWS provider, in addition to the ones added by default.

                iamAuthenticatorConfig
                IAMAuthenticatorConfig
                (Optional)

                IAMAuthenticatorConfig allows the specification of any additional user or role mappings for use when generating the aws-iam-authenticator configuration. If this is nil the default configuration is still generated for the cluster.

                endpointAccess
                EndpointAccess
                (Optional)

                Endpoints specifies access to this cluster’s control plane endpoints

                controlPlaneEndpoint
                Cluster API api/v1beta1.APIEndpoint
                (Optional)

                ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.

                imageLookupFormat
                string
                (Optional)

                ImageLookupFormat is the AMI naming format to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupOrg. Supports substitutions for {{.BaseOS}} and {{.K8sVersion}} with the base OS and kubernetes version, respectively. The BaseOS will be the value in ImageLookupBaseOS or ubuntu (the default), and the kubernetes version as defined by the packages produced by kubernetes/release without v as a prefix: 1.13.0, 1.12.5-mybuild.1, or 1.17.3. For example, the default image format of capa-ami-{{.BaseOS}}-?{{.K8sVersion}}-* will end up searching for AMIs that match the pattern capa-ami-ubuntu-?1.18.0-* for a Machine that is targeting kubernetes v1.18.0 and the ubuntu base OS. See also: https://golang.org/pkg/text/template/

                imageLookupOrg
                string
                (Optional)

                ImageLookupOrg is the AWS Organization ID to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupOrg.

                imageLookupBaseOS
                string

                ImageLookupBaseOS is the name of the base operating system used to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupBaseOS.

                bastion
                Cluster API AWS api/v1beta1.Bastion
                (Optional)

                Bastion contains options to configure the bastion host.

                tokenMethod
                EKSTokenMethod

                TokenMethod is used to specify the method for obtaining a client token for communicating with EKS iam-authenticator - obtains a client token using iam-authentictor aws-cli - obtains a client token using the AWS CLI Defaults to iam-authenticator

                associateOIDCProvider
                bool

                AssociateOIDCProvider can be enabled to automatically create an identity provider for the controller for use with IAM roles for service accounts

                addons
                []../../controlplane/eks/api/v1beta1.Addon
                (Optional)

                Addons defines the EKS addons to enable with the EKS cluster.

                oidcIdentityProviderConfig
                OIDCIdentityProviderConfig
                (Optional)

                IdentityProviderconfig is used to specify the oidc provider config to be attached with this eks cluster

                disableVPCCNI
                bool

                DisableVPCCNI indcates the the Amazon VPC CNI should be disabled. With EKS clusters that the Amazon VPC CNI is automatically installed into the cluster. For clusters where you want to use an alternate CNI this option provides a way to specify that the Amazon VPC CNI should be deleted. You cannot set this to true if you are using the Amazon VPC CNI addon or if you have specified a secondary CIDR block.

                AWSManagedControlPlaneStatus

                (Appears on:AWSManagedControlPlane)

                AWSManagedControlPlaneStatus defines the observed state of an Amazon EKS Cluster.

                Field Description
                networkStatus
                Cluster API AWS api/v1beta1.NetworkStatus
                (Optional)

                Networks holds details about the AWS networking resources used by the control plane

                failureDomains
                Cluster API api/v1beta1.FailureDomains
                (Optional)

                FailureDomains specifies a list fo available availability zones that can be used

                bastion
                Cluster API AWS api/v1beta1.Instance
                (Optional)

                Bastion holds details of the instance that is used as a bastion jump box

                oidcProvider
                OIDCProviderStatus
                (Optional)

                OIDCProvider holds the status of the identity provider for this cluster

                externalManagedControlPlane
                bool

                ExternalManagedControlPlane indicates to cluster-api that the control plane is managed by an external service such as AKS, EKS, GKE, etc.

                initialized
                bool
                (Optional)

                Initialized denotes whether or not the control plane has the uploaded kubernetes config-map.

                ready
                bool

                Ready denotes that the AWSManagedControlPlane API Server is ready to receive requests and that the VPC infra is ready.

                failureMessage
                string
                (Optional)

                ErrorMessage indicates that there is a terminal problem reconciling the state, and will be set to a descriptive error message.

                conditions
                Cluster API api/v1beta1.Conditions

                Conditions specifies the cpnditions for the managed control plane

                addons
                []AddonState
                (Optional)

                Addons holds the current status of the EKS addons

                identityProviderStatus
                IdentityProviderStatus
                (Optional)

                IdentityProviderStatus holds the status for associated identity provider

                Addon

                Addon represents a EKS addon.

                Field Description
                name
                string

                Name is the name of the addon

                version
                string

                Version is the version of the addon to use

                conflictResolution
                AddonResolution

                ConflictResolution is used to declare what should happen if there are parameter conflicts. Defaults to none

                serviceAccountRoleARN
                string
                (Optional)

                ServiceAccountRoleArn is the ARN of an IAM role to bind to the addons service account

                AddonIssue

                (Appears on:AddonState)

                AddonIssue represents an issue with an addon.

                Field Description
                code
                string

                Code is the issue code

                message
                string

                Message is the textual description of the issue

                resourceIds
                []string

                ResourceIDs is a list of resource ids for the issue

                AddonResolution (string alias)

                (Appears on:Addon)

                AddonResolution defines the method for resolving parameter conflicts.

                AddonState

                (Appears on:AWSManagedControlPlaneStatus)

                AddonState represents the state of an addon.

                Field Description
                name
                string

                Name is the name of the addon

                version
                string

                Version is the version of the addon to use

                arn
                string

                ARN is the AWS ARN of the addon

                serviceAccountRoleARN
                string

                ServiceAccountRoleArn is the ARN of the IAM role used for the service account

                createdAt
                Kubernetes meta/v1.Time

                CreatedAt is the date and time the addon was created at

                modifiedAt
                Kubernetes meta/v1.Time

                ModifiedAt is the date and time the addon was last modified

                status
                string

                Status is the status of the addon

                issues
                []AddonIssue

                Issues is a list of issue associated with the addon

                AddonStatus (string alias)

                AddonStatus defines the status for an addon.

                ControlPlaneLoggingSpec

                (Appears on:AWSManagedControlPlaneSpec)

                ControlPlaneLoggingSpec defines what EKS control plane logs that should be enabled.

                Field Description
                apiServer
                bool

                APIServer indicates if the Kubernetes API Server log (kube-apiserver) shoulkd be enabled

                audit
                bool

                Audit indicates if the Kubernetes API audit log should be enabled

                authenticator
                bool

                Authenticator indicates if the iam authenticator log should be enabled

                controllerManager
                bool

                ControllerManager indicates if the controller manager (kube-controller-manager) log should be enabled

                scheduler
                bool

                Scheduler indicates if the Kubernetes scheduler (kube-scheduler) log should be enabled

                EKSTokenMethod (string alias)

                (Appears on:AWSManagedControlPlaneSpec)

                EKSTokenMethod defines the method for obtaining a client token to use when connecting to EKS.

                EncryptionConfig

                (Appears on:AWSManagedControlPlaneSpec)

                EncryptionConfig specifies the encryption configuration for the EKS clsuter.

                Field Description
                provider
                string

                Provider specifies the ARN or alias of the CMK (in AWS KMS)

                resources
                []*string

                Resources specifies the resources to be encrypted

                EndpointAccess

                (Appears on:AWSManagedControlPlaneSpec)

                EndpointAccess specifies how control plane endpoints are accessible.

                Field Description
                public
                bool
                (Optional)

                Public controls whether control plane endpoints are publicly accessible

                publicCIDRs
                []*string
                (Optional)

                PublicCIDRs specifies which blocks can access the public endpoint

                private
                bool
                (Optional)

                Private points VPC-internal control plane access to the private endpoint

                IAMAuthenticatorConfig

                (Appears on:AWSManagedControlPlaneSpec)

                IAMAuthenticatorConfig represents an aws-iam-authenticator configuration.

                Field Description
                mapRoles
                []RoleMapping
                (Optional)

                RoleMappings is a list of role mappings

                mapUsers
                []UserMapping
                (Optional)

                UserMappings is a list of user mappings

                IdentityProviderStatus

                (Appears on:AWSManagedControlPlaneStatus)

                Field Description
                arn
                string

                ARN holds the ARN of associated identity provider

                status
                string

                Status holds current status of associated identity provider

                KubernetesMapping

                (Appears on:RoleMapping, UserMapping)

                KubernetesMapping represents the kubernetes RBAC mapping.

                Field Description
                username
                string

                UserName is a kubernetes RBAC user subject

                groups
                []string

                Groups is a list of kubernetes RBAC groups

                OIDCIdentityProviderConfig

                (Appears on:AWSManagedControlPlaneSpec)

                Field Description
                clientId
                string

                This is also known as audience. The ID for the client application that makes authentication requests to the OpenID identity provider.

                groupsClaim
                string
                (Optional)

                The JWT claim that the provider uses to return your groups.

                groupsPrefix
                string
                (Optional)

                The prefix that is prepended to group claims to prevent clashes with existing names (such as system: groups). For example, the valueoidc: will create group names like oidc:engineering and oidc:infra.

                identityProviderConfigName
                string

                The name of the OIDC provider configuration.

                IdentityProviderConfigName is a required field

                issuerUrl
                string

                The URL of the OpenID identity provider that allows the API server to discover public signing keys for verifying tokens. The URL must begin with https:// and should correspond to the iss claim in the provider’s OIDC ID tokens. Per the OIDC standard, path components are allowed but query parameters are not. Typically the URL consists of only a hostname, like https://server.example.org or https://example.com. This URL should point to the level below .well-known/openid-configuration and must be publicly accessible over the internet.

                requiredClaims
                map[string]string
                (Optional)

                The key value pairs that describe required claims in the identity token. If set, each claim is verified to be present in the token with a matching value. For the maximum number of claims that you can require, see Amazon EKS service quotas (https://docs.aws.amazon.com/eks/latest/userguide/service-quotas.html) in the Amazon EKS User Guide.

                usernameClaim
                string
                (Optional)

                The JSON Web Token (JWT) claim to use as the username. The default is sub, which is expected to be a unique identifier of the end user. You can choose other claims, such as email or name, depending on the OpenID identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins.

                usernamePrefix
                string
                (Optional)

                The prefix that is prepended to username claims to prevent clashes with existing names. If you do not provide this field, and username is a value other than email, the prefix defaults to issuerurl#. You can use the value - to disable all prefixing.

                tags
                Cluster API AWS api/v1beta1.Tags
                (Optional)

                tags to apply to oidc identity provider association

                OIDCProviderStatus

                (Appears on:AWSManagedControlPlaneStatus)

                OIDCProviderStatus holds the status of the AWS OIDC identity provider.

                Field Description
                arn
                string

                ARN holds the ARN of the provider

                trustPolicy
                string

                TrustPolicy contains the boilerplate IAM trust policy to use for IRSA

                RoleMapping

                (Appears on:IAMAuthenticatorConfig)

                RoleMapping represents a mapping from a IAM role to Kubernetes users and groups.

                Field Description
                rolearn
                string

                RoleARN is the AWS ARN for the role to map

                KubernetesMapping
                KubernetesMapping

                (Members of KubernetesMapping are embedded into this type.)

                KubernetesMapping holds the RBAC details for the mapping

                UserMapping

                (Appears on:IAMAuthenticatorConfig)

                UserMapping represents a mapping from an IAM user to Kubernetes users and groups.

                Field Description
                userarn
                string

                UserARN is the AWS ARN for the user to map

                KubernetesMapping
                KubernetesMapping

                (Members of KubernetesMapping are embedded into this type.)

                KubernetesMapping holds the RBAC details for the mapping


                infrastructure.cluster.x-k8s.io/v1alpha4

                Package v1alpha4 contains the v1alpha4 API implementation.

                Resource Types:

                  AMIReference

                  (Appears on:AWSMachineSpec)

                  AMIReference is a reference to a specific AWS resource by ID, ARN, or filters. Only one of ID, ARN or Filters may be specified. Specifying more than one will result in a validation error.

                  Field Description
                  id
                  string
                  (Optional)

                  ID of resource

                  eksLookupType
                  EKSAMILookupType
                  (Optional)

                  EKSOptimizedLookupType If specified, will look up an EKS Optimized image in SSM Parameter store

                  AWSCluster

                  AWSCluster is the Schema for the awsclusters API.

                  Field Description
                  metadata
                  Kubernetes meta/v1.ObjectMeta
                  Refer to the Kubernetes API documentation for the fields of the metadata field.
                  spec
                  AWSClusterSpec


                  network
                  NetworkSpec

                  NetworkSpec encapsulates all things related to AWS network.

                  region
                  string

                  The AWS Region the cluster lives in.

                  sshKeyName
                  string
                  (Optional)

                  SSHKeyName is the name of the ssh key to attach to the bastion host. Valid values are empty string (do not use SSH keys), a valid SSH key name, or omitted (use the default SSH key name)

                  controlPlaneEndpoint
                  Cluster API api/v1alpha4.APIEndpoint
                  (Optional)

                  ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.

                  additionalTags
                  Tags
                  (Optional)

                  AdditionalTags is an optional set of tags to add to AWS resources managed by the AWS provider, in addition to the ones added by default.

                  controlPlaneLoadBalancer
                  AWSLoadBalancerSpec
                  (Optional)

                  ControlPlaneLoadBalancer is optional configuration for customizing control plane behavior.

                  imageLookupFormat
                  string
                  (Optional)

                  ImageLookupFormat is the AMI naming format to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupOrg. Supports substitutions for {{.BaseOS}} and {{.K8sVersion}} with the base OS and kubernetes version, respectively. The BaseOS will be the value in ImageLookupBaseOS or ubuntu (the default), and the kubernetes version as defined by the packages produced by kubernetes/release without v as a prefix: 1.13.0, 1.12.5-mybuild.1, or 1.17.3. For example, the default image format of capa-ami-{{.BaseOS}}-?{{.K8sVersion}}-* will end up searching for AMIs that match the pattern capa-ami-ubuntu-?1.18.0-* for a Machine that is targeting kubernetes v1.18.0 and the ubuntu base OS. See also: https://golang.org/pkg/text/template/

                  imageLookupOrg
                  string
                  (Optional)

                  ImageLookupOrg is the AWS Organization ID to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupOrg.

                  imageLookupBaseOS
                  string

                  ImageLookupBaseOS is the name of the base operating system used to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupBaseOS.

                  bastion
                  Bastion
                  (Optional)

                  Bastion contains options to configure the bastion host.

                  identityRef
                  AWSIdentityReference
                  (Optional)

                  IdentityRef is a reference to a identity to be used when reconciling this cluster

                  status
                  AWSClusterStatus

                  AWSClusterControllerIdentity

                  AWSClusterControllerIdentity is the Schema for the awsclustercontrolleridentities API It is used to grant access to use Cluster API Provider AWS Controller credentials.

                  Field Description
                  metadata
                  Kubernetes meta/v1.ObjectMeta
                  Refer to the Kubernetes API documentation for the fields of the metadata field.
                  spec
                  AWSClusterControllerIdentitySpec

                  Spec for this AWSClusterControllerIdentity.



                  AWSClusterIdentitySpec
                  AWSClusterIdentitySpec

                  (Members of AWSClusterIdentitySpec are embedded into this type.)

                  AWSClusterControllerIdentitySpec

                  (Appears on:AWSClusterControllerIdentity)

                  AWSClusterControllerIdentitySpec defines the specifications for AWSClusterControllerIdentity.

                  Field Description
                  AWSClusterIdentitySpec
                  AWSClusterIdentitySpec

                  (Members of AWSClusterIdentitySpec are embedded into this type.)

                  AWSClusterIdentitySpec

                  (Appears on:AWSClusterControllerIdentitySpec, AWSClusterRoleIdentitySpec, AWSClusterStaticIdentitySpec)

                  AWSClusterIdentitySpec defines the Spec struct for AWSClusterIdentity types.

                  Field Description
                  allowedNamespaces
                  AllowedNamespaces
                  (Optional)

                  AllowedNamespaces is used to identify which namespaces are allowed to use the identity from. Namespaces can be selected either using an array of namespaces or with label selector. An empty allowedNamespaces object indicates that AWSClusters can use this identity from any namespace. If this object is nil, no namespaces will be allowed (default behaviour, if this field is not provided) A namespace should be either in the NamespaceList or match with Selector to use the identity.

                  AWSClusterRoleIdentity

                  AWSClusterRoleIdentity is the Schema for the awsclusterroleidentities API It is used to assume a role using the provided sourceRef.

                  Field Description
                  metadata
                  Kubernetes meta/v1.ObjectMeta
                  Refer to the Kubernetes API documentation for the fields of the metadata field.
                  spec
                  AWSClusterRoleIdentitySpec

                  Spec for this AWSClusterRoleIdentity.



                  AWSClusterIdentitySpec
                  AWSClusterIdentitySpec

                  (Members of AWSClusterIdentitySpec are embedded into this type.)

                  AWSRoleSpec
                  AWSRoleSpec

                  (Members of AWSRoleSpec are embedded into this type.)

                  externalID
                  string
                  (Optional)

                  A unique identifier that might be required when you assume a role in another account. If the administrator of the account to which the role belongs provided you with an external ID, then provide that value in the ExternalId parameter. This value can be any string, such as a passphrase or account number. A cross-account role is usually set up to trust everyone in an account. Therefore, the administrator of the trusting account might send an external ID to the administrator of the trusted account. That way, only someone with the ID can assume the role, rather than everyone in the account. For more information about the external ID, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party in the IAM User Guide.

                  sourceIdentityRef
                  AWSIdentityReference

                  SourceIdentityRef is a reference to another identity which will be chained to do role assumption. All identity types are accepted.

                  AWSClusterRoleIdentitySpec

                  (Appears on:AWSClusterRoleIdentity)

                  AWSClusterRoleIdentitySpec defines the specifications for AWSClusterRoleIdentity.

                  Field Description
                  AWSClusterIdentitySpec
                  AWSClusterIdentitySpec

                  (Members of AWSClusterIdentitySpec are embedded into this type.)

                  AWSRoleSpec
                  AWSRoleSpec

                  (Members of AWSRoleSpec are embedded into this type.)

                  externalID
                  string
                  (Optional)

                  A unique identifier that might be required when you assume a role in another account. If the administrator of the account to which the role belongs provided you with an external ID, then provide that value in the ExternalId parameter. This value can be any string, such as a passphrase or account number. A cross-account role is usually set up to trust everyone in an account. Therefore, the administrator of the trusting account might send an external ID to the administrator of the trusted account. That way, only someone with the ID can assume the role, rather than everyone in the account. For more information about the external ID, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party in the IAM User Guide.

                  sourceIdentityRef
                  AWSIdentityReference

                  SourceIdentityRef is a reference to another identity which will be chained to do role assumption. All identity types are accepted.

                  AWSClusterSpec

                  (Appears on:AWSCluster, AWSClusterTemplateResource)

                  AWSClusterSpec defines the desired state of AWSCluster

                  Field Description
                  network
                  NetworkSpec

                  NetworkSpec encapsulates all things related to AWS network.

                  region
                  string

                  The AWS Region the cluster lives in.

                  sshKeyName
                  string
                  (Optional)

                  SSHKeyName is the name of the ssh key to attach to the bastion host. Valid values are empty string (do not use SSH keys), a valid SSH key name, or omitted (use the default SSH key name)

                  controlPlaneEndpoint
                  Cluster API api/v1alpha4.APIEndpoint
                  (Optional)

                  ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.

                  additionalTags
                  Tags
                  (Optional)

                  AdditionalTags is an optional set of tags to add to AWS resources managed by the AWS provider, in addition to the ones added by default.

                  controlPlaneLoadBalancer
                  AWSLoadBalancerSpec
                  (Optional)

                  ControlPlaneLoadBalancer is optional configuration for customizing control plane behavior.

                  imageLookupFormat
                  string
                  (Optional)

                  ImageLookupFormat is the AMI naming format to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupOrg. Supports substitutions for {{.BaseOS}} and {{.K8sVersion}} with the base OS and kubernetes version, respectively. The BaseOS will be the value in ImageLookupBaseOS or ubuntu (the default), and the kubernetes version as defined by the packages produced by kubernetes/release without v as a prefix: 1.13.0, 1.12.5-mybuild.1, or 1.17.3. For example, the default image format of capa-ami-{{.BaseOS}}-?{{.K8sVersion}}-* will end up searching for AMIs that match the pattern capa-ami-ubuntu-?1.18.0-* for a Machine that is targeting kubernetes v1.18.0 and the ubuntu base OS. See also: https://golang.org/pkg/text/template/

                  imageLookupOrg
                  string
                  (Optional)

                  ImageLookupOrg is the AWS Organization ID to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupOrg.

                  imageLookupBaseOS
                  string

                  ImageLookupBaseOS is the name of the base operating system used to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupBaseOS.

                  bastion
                  Bastion
                  (Optional)

                  Bastion contains options to configure the bastion host.

                  identityRef
                  AWSIdentityReference
                  (Optional)

                  IdentityRef is a reference to a identity to be used when reconciling this cluster

                  AWSClusterStaticIdentity

                  AWSClusterStaticIdentity is the Schema for the awsclusterstaticidentities API It represents a reference to an AWS access key ID and secret access key, stored in a secret.

                  Field Description
                  metadata
                  Kubernetes meta/v1.ObjectMeta
                  Refer to the Kubernetes API documentation for the fields of the metadata field.
                  spec
                  AWSClusterStaticIdentitySpec

                  Spec for this AWSClusterStaticIdentity



                  AWSClusterIdentitySpec
                  AWSClusterIdentitySpec

                  (Members of AWSClusterIdentitySpec are embedded into this type.)

                  secretRef
                  string

                  Reference to a secret containing the credentials. The secret should contain the following data keys: AccessKeyID: AKIAIOSFODNN7EXAMPLE SecretAccessKey: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY SessionToken: Optional

                  AWSClusterStaticIdentitySpec

                  (Appears on:AWSClusterStaticIdentity)

                  AWSClusterStaticIdentitySpec defines the specifications for AWSClusterStaticIdentity.

                  Field Description
                  AWSClusterIdentitySpec
                  AWSClusterIdentitySpec

                  (Members of AWSClusterIdentitySpec are embedded into this type.)

                  secretRef
                  string

                  Reference to a secret containing the credentials. The secret should contain the following data keys: AccessKeyID: AKIAIOSFODNN7EXAMPLE SecretAccessKey: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY SessionToken: Optional

                  AWSClusterStatus

                  (Appears on:AWSCluster)

                  AWSClusterStatus defines the observed state of AWSCluster

                  Field Description
                  ready
                  bool
                  networkStatus
                  NetworkStatus
                  failureDomains
                  Cluster API api/v1alpha4.FailureDomains
                  bastion
                  Instance
                  conditions
                  Cluster API api/v1alpha4.Conditions

                  AWSClusterTemplate

                  AWSClusterTemplate is the Schema for the awsclustertemplates API.

                  Field Description
                  metadata
                  Kubernetes meta/v1.ObjectMeta
                  Refer to the Kubernetes API documentation for the fields of the metadata field.
                  spec
                  AWSClusterTemplateSpec


                  template
                  AWSClusterTemplateResource

                  AWSClusterTemplateResource

                  (Appears on:AWSClusterTemplateSpec)

                  Field Description
                  spec
                  AWSClusterSpec


                  network
                  NetworkSpec

                  NetworkSpec encapsulates all things related to AWS network.

                  region
                  string

                  The AWS Region the cluster lives in.

                  sshKeyName
                  string
                  (Optional)

                  SSHKeyName is the name of the ssh key to attach to the bastion host. Valid values are empty string (do not use SSH keys), a valid SSH key name, or omitted (use the default SSH key name)

                  controlPlaneEndpoint
                  Cluster API api/v1alpha4.APIEndpoint
                  (Optional)

                  ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.

                  additionalTags
                  Tags
                  (Optional)

                  AdditionalTags is an optional set of tags to add to AWS resources managed by the AWS provider, in addition to the ones added by default.

                  controlPlaneLoadBalancer
                  AWSLoadBalancerSpec
                  (Optional)

                  ControlPlaneLoadBalancer is optional configuration for customizing control plane behavior.

                  imageLookupFormat
                  string
                  (Optional)

                  ImageLookupFormat is the AMI naming format to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupOrg. Supports substitutions for {{.BaseOS}} and {{.K8sVersion}} with the base OS and kubernetes version, respectively. The BaseOS will be the value in ImageLookupBaseOS or ubuntu (the default), and the kubernetes version as defined by the packages produced by kubernetes/release without v as a prefix: 1.13.0, 1.12.5-mybuild.1, or 1.17.3. For example, the default image format of capa-ami-{{.BaseOS}}-?{{.K8sVersion}}-* will end up searching for AMIs that match the pattern capa-ami-ubuntu-?1.18.0-* for a Machine that is targeting kubernetes v1.18.0 and the ubuntu base OS. See also: https://golang.org/pkg/text/template/

                  imageLookupOrg
                  string
                  (Optional)

                  ImageLookupOrg is the AWS Organization ID to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupOrg.

                  imageLookupBaseOS
                  string

                  ImageLookupBaseOS is the name of the base operating system used to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupBaseOS.

                  bastion
                  Bastion
                  (Optional)

                  Bastion contains options to configure the bastion host.

                  identityRef
                  AWSIdentityReference
                  (Optional)

                  IdentityRef is a reference to a identity to be used when reconciling this cluster

                  AWSClusterTemplateSpec

                  (Appears on:AWSClusterTemplate)

                  AWSClusterTemplateSpec defines the desired state of AWSClusterTemplate.

                  Field Description
                  template
                  AWSClusterTemplateResource

                  AWSIdentityKind (string alias)

                  (Appears on:AWSIdentityReference)

                  AWSIdentityKind defines allowed AWS identity types.

                  AWSIdentityReference

                  (Appears on:AWSClusterRoleIdentitySpec, AWSClusterSpec)

                  AWSIdentityReference specifies a identity.

                  Field Description
                  name
                  string

                  Name of the identity.

                  kind
                  AWSIdentityKind

                  Kind of the identity.

                  AWSLoadBalancerSpec

                  (Appears on:AWSClusterSpec)

                  AWSLoadBalancerSpec defines the desired state of an AWS load balancer.

                  Field Description
                  scheme
                  ClassicELBScheme
                  (Optional)

                  Scheme sets the scheme of the load balancer (defaults to internet-facing)

                  crossZoneLoadBalancing
                  bool
                  (Optional)

                  CrossZoneLoadBalancing enables the classic ELB cross availability zone balancing.

                  With cross-zone load balancing, each load balancer node for your Classic Load Balancer distributes requests evenly across the registered instances in all enabled Availability Zones. If cross-zone load balancing is disabled, each load balancer node distributes requests evenly across the registered instances in its Availability Zone only.

                  Defaults to false.

                  subnets
                  []string
                  (Optional)

                  Subnets sets the subnets that should be applied to the control plane load balancer (defaults to discovered subnets for managed VPCs or an empty set for unmanaged VPCs)

                  additionalSecurityGroups
                  []string
                  (Optional)

                  AdditionalSecurityGroups sets the security groups used by the load balancer. Expected to be security group IDs This is optional - if not provided new security groups will be created for the load balancer

                  AWSMachine

                  AWSMachine is the Schema for the awsmachines API

                  Field Description
                  metadata
                  Kubernetes meta/v1.ObjectMeta
                  Refer to the Kubernetes API documentation for the fields of the metadata field.
                  spec
                  AWSMachineSpec


                  providerID
                  string

                  ProviderID is the unique identifier as specified by the cloud provider.

                  instanceID
                  string

                  InstanceID is the EC2 instance ID for this machine.

                  ami
                  AMIReference

                  AMI is the reference to the AMI from which to create the machine instance.

                  imageLookupFormat
                  string
                  (Optional)

                  ImageLookupFormat is the AMI naming format to look up the image for this machine It will be ignored if an explicit AMI is set. Supports substitutions for {{.BaseOS}} and {{.K8sVersion}} with the base OS and kubernetes version, respectively. The BaseOS will be the value in ImageLookupBaseOS or ubuntu (the default), and the kubernetes version as defined by the packages produced by kubernetes/release without v as a prefix: 1.13.0, 1.12.5-mybuild.1, or 1.17.3. For example, the default image format of capa-ami-{{.BaseOS}}-?{{.K8sVersion}}-* will end up searching for AMIs that match the pattern capa-ami-ubuntu-?1.18.0-* for a Machine that is targeting kubernetes v1.18.0 and the ubuntu base OS. See also: https://golang.org/pkg/text/template/

                  imageLookupOrg
                  string

                  ImageLookupOrg is the AWS Organization ID to use for image lookup if AMI is not set.

                  imageLookupBaseOS
                  string

                  ImageLookupBaseOS is the name of the base operating system to use for image lookup the AMI is not set.

                  instanceType
                  string

                  InstanceType is the type of instance to create. Example: m4.xlarge

                  additionalTags
                  Tags
                  (Optional)

                  AdditionalTags is an optional set of tags to add to an instance, in addition to the ones added by default by the AWS provider. If both the AWSCluster and the AWSMachine specify the same tag name with different values, the AWSMachine’s value takes precedence.

                  iamInstanceProfile
                  string
                  (Optional)

                  IAMInstanceProfile is a name of an IAM instance profile to assign to the instance

                  publicIP
                  bool
                  (Optional)

                  PublicIP specifies whether the instance should get a public IP. Precedence for this setting is as follows: 1. This field if set 2. Cluster/flavor setting 3. Subnet default

                  additionalSecurityGroups
                  []AWSResourceReference
                  (Optional)

                  AdditionalSecurityGroups is an array of references to security groups that should be applied to the instance. These security groups would be set in addition to any security groups defined at the cluster level or in the actuator. It is possible to specify either IDs of Filters. Using Filters will cause additional requests to AWS API and if tags change the attached security groups might change too.

                  failureDomain
                  string

                  FailureDomain is the failure domain unique identifier this Machine should be attached to, as defined in Cluster API. For this infrastructure provider, the ID is equivalent to an AWS Availability Zone. If multiple subnets are matched for the availability zone, the first one returned is picked.

                  subnet
                  AWSResourceReference
                  (Optional)

                  Subnet is a reference to the subnet to use for this instance. If not specified, the cluster subnet will be used.

                  sshKeyName
                  string
                  (Optional)

                  SSHKeyName is the name of the ssh key to attach to the instance. Valid values are empty string (do not use SSH keys), a valid SSH key name, or omitted (use the default SSH key name)

                  rootVolume
                  Volume
                  (Optional)

                  RootVolume encapsulates the configuration options for the root volume

                  nonRootVolumes
                  []Volume
                  (Optional)

                  Configuration options for the non root storage volumes.

                  networkInterfaces
                  []string
                  (Optional)

                  NetworkInterfaces is a list of ENIs to associate with the instance. A maximum of 2 may be specified.

                  uncompressedUserData
                  bool
                  (Optional)

                  UncompressedUserData specify whether the user data is gzip-compressed before it is sent to ec2 instance. cloud-init has built-in support for gzip-compressed user data user data stored in aws secret manager is always gzip-compressed.

                  cloudInit
                  CloudInit
                  (Optional)

                  CloudInit defines options related to the bootstrapping systems where CloudInit is used.

                  spotMarketOptions
                  SpotMarketOptions
                  (Optional)

                  SpotMarketOptions allows users to configure instances to be run using AWS Spot instances.

                  tenancy
                  string
                  (Optional)

                  Tenancy indicates if instance should run on shared or single-tenant hardware.

                  status
                  AWSMachineStatus

                  AWSMachineProviderConditionType (string alias)

                  AWSMachineProviderConditionType is a valid value for AWSMachineProviderCondition.Type.

                  AWSMachineSpec

                  (Appears on:AWSMachine, AWSMachineTemplateResource)

                  AWSMachineSpec defines the desired state of AWSMachine

                  Field Description
                  providerID
                  string

                  ProviderID is the unique identifier as specified by the cloud provider.

                  instanceID
                  string

                  InstanceID is the EC2 instance ID for this machine.

                  ami
                  AMIReference

                  AMI is the reference to the AMI from which to create the machine instance.

                  imageLookupFormat
                  string
                  (Optional)

                  ImageLookupFormat is the AMI naming format to look up the image for this machine It will be ignored if an explicit AMI is set. Supports substitutions for {{.BaseOS}} and {{.K8sVersion}} with the base OS and kubernetes version, respectively. The BaseOS will be the value in ImageLookupBaseOS or ubuntu (the default), and the kubernetes version as defined by the packages produced by kubernetes/release without v as a prefix: 1.13.0, 1.12.5-mybuild.1, or 1.17.3. For example, the default image format of capa-ami-{{.BaseOS}}-?{{.K8sVersion}}-* will end up searching for AMIs that match the pattern capa-ami-ubuntu-?1.18.0-* for a Machine that is targeting kubernetes v1.18.0 and the ubuntu base OS. See also: https://golang.org/pkg/text/template/

                  imageLookupOrg
                  string

                  ImageLookupOrg is the AWS Organization ID to use for image lookup if AMI is not set.

                  imageLookupBaseOS
                  string

                  ImageLookupBaseOS is the name of the base operating system to use for image lookup the AMI is not set.

                  instanceType
                  string

                  InstanceType is the type of instance to create. Example: m4.xlarge

                  additionalTags
                  Tags
                  (Optional)

                  AdditionalTags is an optional set of tags to add to an instance, in addition to the ones added by default by the AWS provider. If both the AWSCluster and the AWSMachine specify the same tag name with different values, the AWSMachine’s value takes precedence.

                  iamInstanceProfile
                  string
                  (Optional)

                  IAMInstanceProfile is a name of an IAM instance profile to assign to the instance

                  publicIP
                  bool
                  (Optional)

                  PublicIP specifies whether the instance should get a public IP. Precedence for this setting is as follows: 1. This field if set 2. Cluster/flavor setting 3. Subnet default

                  additionalSecurityGroups
                  []AWSResourceReference
                  (Optional)

                  AdditionalSecurityGroups is an array of references to security groups that should be applied to the instance. These security groups would be set in addition to any security groups defined at the cluster level or in the actuator. It is possible to specify either IDs of Filters. Using Filters will cause additional requests to AWS API and if tags change the attached security groups might change too.

                  failureDomain
                  string

                  FailureDomain is the failure domain unique identifier this Machine should be attached to, as defined in Cluster API. For this infrastructure provider, the ID is equivalent to an AWS Availability Zone. If multiple subnets are matched for the availability zone, the first one returned is picked.

                  subnet
                  AWSResourceReference
                  (Optional)

                  Subnet is a reference to the subnet to use for this instance. If not specified, the cluster subnet will be used.

                  sshKeyName
                  string
                  (Optional)

                  SSHKeyName is the name of the ssh key to attach to the instance. Valid values are empty string (do not use SSH keys), a valid SSH key name, or omitted (use the default SSH key name)

                  rootVolume
                  Volume
                  (Optional)

                  RootVolume encapsulates the configuration options for the root volume

                  nonRootVolumes
                  []Volume
                  (Optional)

                  Configuration options for the non root storage volumes.

                  networkInterfaces
                  []string
                  (Optional)

                  NetworkInterfaces is a list of ENIs to associate with the instance. A maximum of 2 may be specified.

                  uncompressedUserData
                  bool
                  (Optional)

                  UncompressedUserData specify whether the user data is gzip-compressed before it is sent to ec2 instance. cloud-init has built-in support for gzip-compressed user data user data stored in aws secret manager is always gzip-compressed.

                  cloudInit
                  CloudInit
                  (Optional)

                  CloudInit defines options related to the bootstrapping systems where CloudInit is used.

                  spotMarketOptions
                  SpotMarketOptions
                  (Optional)

                  SpotMarketOptions allows users to configure instances to be run using AWS Spot instances.

                  tenancy
                  string
                  (Optional)

                  Tenancy indicates if instance should run on shared or single-tenant hardware.

                  AWSMachineStatus

                  (Appears on:AWSMachine)

                  AWSMachineStatus defines the observed state of AWSMachine

                  Field Description
                  ready
                  bool
                  (Optional)

                  Ready is true when the provider resource is ready.

                  interruptible
                  bool
                  (Optional)

                  Interruptible reports that this machine is using spot instances and can therefore be interrupted by CAPI when it receives a notice that the spot instance is to be terminated by AWS. This will be set to true when SpotMarketOptions is not nil (i.e. this machine is using a spot instance).

                  addresses
                  []Cluster API api/v1alpha4.MachineAddress

                  Addresses contains the AWS instance associated addresses.

                  instanceState
                  InstanceState
                  (Optional)

                  InstanceState is the state of the AWS instance for this machine.

                  failureReason
                  Cluster API errors.MachineStatusError
                  (Optional)

                  FailureReason will be set in the event that there is a terminal problem reconciling the Machine and will contain a succinct value suitable for machine interpretation.

                  This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Machine’s spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.

                  Any transient errors that occur during the reconciliation of Machines can be added as events to the Machine object and/or logged in the controller’s output.

                  failureMessage
                  string
                  (Optional)

                  FailureMessage will be set in the event that there is a terminal problem reconciling the Machine and will contain a more verbose string suitable for logging and human consumption.

                  This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Machine’s spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.

                  Any transient errors that occur during the reconciliation of Machines can be added as events to the Machine object and/or logged in the controller’s output.

                  conditions
                  Cluster API api/v1alpha4.Conditions
                  (Optional)

                  Conditions defines current service state of the AWSMachine.

                  AWSMachineTemplate

                  AWSMachineTemplate is the Schema for the awsmachinetemplates API

                  Field Description
                  metadata
                  Kubernetes meta/v1.ObjectMeta
                  Refer to the Kubernetes API documentation for the fields of the metadata field.
                  spec
                  AWSMachineTemplateSpec


                  template
                  AWSMachineTemplateResource

                  AWSMachineTemplateResource

                  (Appears on:AWSMachineTemplateSpec)

                  AWSMachineTemplateResource describes the data needed to create am AWSMachine from a template

                  Field Description
                  spec
                  AWSMachineSpec

                  Spec is the specification of the desired behavior of the machine.



                  providerID
                  string

                  ProviderID is the unique identifier as specified by the cloud provider.

                  instanceID
                  string

                  InstanceID is the EC2 instance ID for this machine.

                  ami
                  AMIReference

                  AMI is the reference to the AMI from which to create the machine instance.

                  imageLookupFormat
                  string
                  (Optional)

                  ImageLookupFormat is the AMI naming format to look up the image for this machine It will be ignored if an explicit AMI is set. Supports substitutions for {{.BaseOS}} and {{.K8sVersion}} with the base OS and kubernetes version, respectively. The BaseOS will be the value in ImageLookupBaseOS or ubuntu (the default), and the kubernetes version as defined by the packages produced by kubernetes/release without v as a prefix: 1.13.0, 1.12.5-mybuild.1, or 1.17.3. For example, the default image format of capa-ami-{{.BaseOS}}-?{{.K8sVersion}}-* will end up searching for AMIs that match the pattern capa-ami-ubuntu-?1.18.0-* for a Machine that is targeting kubernetes v1.18.0 and the ubuntu base OS. See also: https://golang.org/pkg/text/template/

                  imageLookupOrg
                  string

                  ImageLookupOrg is the AWS Organization ID to use for image lookup if AMI is not set.

                  imageLookupBaseOS
                  string

                  ImageLookupBaseOS is the name of the base operating system to use for image lookup the AMI is not set.

                  instanceType
                  string

                  InstanceType is the type of instance to create. Example: m4.xlarge

                  additionalTags
                  Tags
                  (Optional)

                  AdditionalTags is an optional set of tags to add to an instance, in addition to the ones added by default by the AWS provider. If both the AWSCluster and the AWSMachine specify the same tag name with different values, the AWSMachine’s value takes precedence.

                  iamInstanceProfile
                  string
                  (Optional)

                  IAMInstanceProfile is a name of an IAM instance profile to assign to the instance

                  publicIP
                  bool
                  (Optional)

                  PublicIP specifies whether the instance should get a public IP. Precedence for this setting is as follows: 1. This field if set 2. Cluster/flavor setting 3. Subnet default

                  additionalSecurityGroups
                  []AWSResourceReference
                  (Optional)

                  AdditionalSecurityGroups is an array of references to security groups that should be applied to the instance. These security groups would be set in addition to any security groups defined at the cluster level or in the actuator. It is possible to specify either IDs of Filters. Using Filters will cause additional requests to AWS API and if tags change the attached security groups might change too.

                  failureDomain
                  string

                  FailureDomain is the failure domain unique identifier this Machine should be attached to, as defined in Cluster API. For this infrastructure provider, the ID is equivalent to an AWS Availability Zone. If multiple subnets are matched for the availability zone, the first one returned is picked.

                  subnet
                  AWSResourceReference
                  (Optional)

                  Subnet is a reference to the subnet to use for this instance. If not specified, the cluster subnet will be used.

                  sshKeyName
                  string
                  (Optional)

                  SSHKeyName is the name of the ssh key to attach to the instance. Valid values are empty string (do not use SSH keys), a valid SSH key name, or omitted (use the default SSH key name)

                  rootVolume
                  Volume
                  (Optional)

                  RootVolume encapsulates the configuration options for the root volume

                  nonRootVolumes
                  []Volume
                  (Optional)

                  Configuration options for the non root storage volumes.

                  networkInterfaces
                  []string
                  (Optional)

                  NetworkInterfaces is a list of ENIs to associate with the instance. A maximum of 2 may be specified.

                  uncompressedUserData
                  bool
                  (Optional)

                  UncompressedUserData specify whether the user data is gzip-compressed before it is sent to ec2 instance. cloud-init has built-in support for gzip-compressed user data user data stored in aws secret manager is always gzip-compressed.

                  cloudInit
                  CloudInit
                  (Optional)

                  CloudInit defines options related to the bootstrapping systems where CloudInit is used.

                  spotMarketOptions
                  SpotMarketOptions
                  (Optional)

                  SpotMarketOptions allows users to configure instances to be run using AWS Spot instances.

                  tenancy
                  string
                  (Optional)

                  Tenancy indicates if instance should run on shared or single-tenant hardware.

                  AWSMachineTemplateSpec

                  (Appears on:AWSMachineTemplate)

                  AWSMachineTemplateSpec defines the desired state of AWSMachineTemplate

                  Field Description
                  template
                  AWSMachineTemplateResource

                  AWSResourceReference

                  (Appears on:AWSMachineSpec)

                  AWSResourceReference is a reference to a specific AWS resource by ID, ARN, or filters. Only one of ID, ARN or Filters may be specified. Specifying more than one will result in a validation error.

                  Field Description
                  id
                  string
                  (Optional)

                  ID of resource

                  arn
                  string
                  (Optional)

                  ARN of resource

                  filters
                  []Filter
                  (Optional)

                  Filters is a set of key/value pairs used to identify a resource They are applied according to the rules defined by the AWS API: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Filtering.html

                  AWSRoleSpec

                  (Appears on:AWSClusterRoleIdentitySpec)

                  AWSRoleSpec defines the specifications for all identities based around AWS roles.

                  Field Description
                  roleARN
                  string

                  The Amazon Resource Name (ARN) of the role to assume.

                  sessionName
                  string

                  An identifier for the assumed role session

                  durationSeconds
                  int32

                  The duration, in seconds, of the role session before it is renewed.

                  inlinePolicy
                  string

                  An IAM policy as a JSON-encoded string that you want to use as an inline session policy.

                  policyARNs
                  []string

                  The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.

                  AZSelectionScheme (string alias)

                  (Appears on:VPCSpec)

                  AZSelectionScheme defines the scheme of selecting AZs.

                  Actions ([]string alias)

                  (Appears on:StatementEntry)

                  Actions is the list of actions.

                  AllowedNamespaces

                  (Appears on:AWSClusterIdentitySpec)

                  AllowedNamespaces is a selector of namespaces that AWSClusters can use this ClusterPrincipal from. This is a standard Kubernetes LabelSelector, a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed.

                  Field Description
                  list
                  []string
                  (Optional)

                  An nil or empty list indicates that AWSClusters cannot use the identity from any namespace.

                  selector
                  Kubernetes meta/v1.LabelSelector
                  (Optional)

                  An empty selector indicates that AWSClusters cannot use this AWSClusterIdentity from any namespace.

                  Bastion

                  (Appears on:AWSClusterSpec)

                  Bastion defines a bastion host.

                  Field Description
                  enabled
                  bool
                  (Optional)

                  Enabled allows this provider to create a bastion host instance with a public ip to access the VPC private network.

                  disableIngressRules
                  bool
                  (Optional)

                  DisableIngressRules will ensure there are no Ingress rules in the bastion host’s security group. Requires AllowedCIDRBlocks to be empty.

                  allowedCIDRBlocks
                  []string
                  (Optional)

                  AllowedCIDRBlocks is a list of CIDR blocks allowed to access the bastion host. They are set as ingress rules for the Bastion host’s Security Group (defaults to 0.0.0.0/0).

                  instanceType
                  string

                  InstanceType will use the specified instance type for the bastion. If not specified, Cluster API Provider AWS will use t3.micro for all regions except us-east-1, where t2.micro will be the default.

                  ami
                  string
                  (Optional)

                  AMI will use the specified AMI to boot the bastion. If not specified, the AMI will default to one picked out in public space.

                  BuildParams

                  BuildParams is used to build tags around an aws resource.

                  Field Description
                  Lifecycle
                  ResourceLifecycle

                  Lifecycle determines the resource lifecycle.

                  ClusterName
                  string

                  ClusterName is the cluster associated with the resource.

                  ResourceID
                  string

                  ResourceID is the unique identifier of the resource to be tagged.

                  Name
                  string
                  (Optional)

                  Name is the name of the resource, it’s applied as the tag “Name” on AWS.

                  Role
                  string
                  (Optional)

                  Role is the role associated to the resource.

                  Additional
                  Tags
                  (Optional)

                  Any additional tags to be added to the resource.

                  CNIIngressRule

                  CNIIngressRule defines an AWS ingress rule for CNI requirements.

                  Field Description
                  description
                  string
                  protocol
                  SecurityGroupProtocol
                  fromPort
                  int64
                  toPort
                  int64

                  CNIIngressRules ([]../../api/v1alpha4.CNIIngressRule alias)

                  (Appears on:CNISpec)

                  CNIIngressRules is a slice of CNIIngressRule

                  CNISpec

                  (Appears on:NetworkSpec)

                  CNISpec defines configuration for CNI.

                  Field Description
                  cniIngressRules
                  CNIIngressRules

                  CNIIngressRules specify rules to apply to control plane and worker node security groups. The source for the rule will be set to control plane and worker security group IDs.

                  ClassicELB

                  (Appears on:NetworkStatus)

                  ClassicELB defines an AWS classic load balancer.

                  Field Description
                  name
                  string

                  The name of the load balancer. It must be unique within the set of load balancers defined in the region. It also serves as identifier.

                  dnsName
                  string

                  DNSName is the dns name of the load balancer.

                  scheme
                  ClassicELBScheme

                  Scheme is the load balancer scheme, either internet-facing or private.

                  availabilityZones
                  []string

                  AvailabilityZones is an array of availability zones in the VPC attached to the load balancer.

                  subnetIds
                  []string

                  SubnetIDs is an array of subnets in the VPC attached to the load balancer.

                  securityGroupIds
                  []string

                  SecurityGroupIDs is an array of security groups assigned to the load balancer.

                  listeners
                  []ClassicELBListener

                  Listeners is an array of classic elb listeners associated with the load balancer. There must be at least one.

                  healthChecks
                  ClassicELBHealthCheck

                  HealthCheck is the classic elb health check associated with the load balancer.

                  attributes
                  ClassicELBAttributes

                  Attributes defines extra attributes associated with the load balancer.

                  tags
                  map[string]string

                  Tags is a map of tags associated with the load balancer.

                  ClassicELBAttributes

                  (Appears on:ClassicELB)

                  ClassicELBAttributes defines extra attributes associated with a classic load balancer.

                  Field Description
                  idleTimeout
                  time.Duration

                  IdleTimeout is time that the connection is allowed to be idle (no data has been sent over the connection) before it is closed by the load balancer.

                  crossZoneLoadBalancing
                  bool
                  (Optional)

                  CrossZoneLoadBalancing enables the classic load balancer load balancing.

                  ClassicELBHealthCheck

                  (Appears on:ClassicELB)

                  ClassicELBHealthCheck defines an AWS classic load balancer health check.

                  Field Description
                  target
                  string
                  interval
                  time.Duration
                  timeout
                  time.Duration
                  healthyThreshold
                  int64
                  unhealthyThreshold
                  int64

                  ClassicELBListener

                  (Appears on:ClassicELB)

                  ClassicELBListener defines an AWS classic load balancer listener.

                  Field Description
                  protocol
                  ClassicELBProtocol
                  port
                  int64
                  instanceProtocol
                  ClassicELBProtocol
                  instancePort
                  int64

                  ClassicELBProtocol (string alias)

                  (Appears on:ClassicELBListener)

                  ClassicELBProtocol defines listener protocols for a classic load balancer.

                  ClassicELBScheme (string alias)

                  (Appears on:AWSLoadBalancerSpec, ClassicELB)

                  ClassicELBScheme defines the scheme of a classic load balancer.

                  CloudInit

                  (Appears on:AWSMachineSpec)

                  CloudInit defines options related to the bootstrapping systems where CloudInit is used.

                  Field Description
                  insecureSkipSecretsManager
                  bool

                  InsecureSkipSecretsManager, when set to true will not use AWS Secrets Manager or AWS Systems Manager Parameter Store to ensure privacy of userdata. By default, a cloud-init boothook shell script is prepended to download the userdata from Secrets Manager and additionally delete the secret.

                  secretCount
                  int32
                  (Optional)

                  SecretCount is the number of secrets used to form the complete secret

                  secretPrefix
                  string
                  (Optional)

                  SecretPrefix is the prefix for the secret name. This is stored temporarily, and deleted when the machine registers as a node against the workload cluster.

                  secureSecretsBackend
                  SecretBackend
                  (Optional)

                  SecureSecretsBackend, when set to parameter-store will utilize the AWS Systems Manager Parameter Storage to distribute secrets. By default or with the value of secrets-manager, will use AWS Secrets Manager instead.

                  ConditionOperator (string alias)

                  ConditionOperator defines an AWS condition operator.

                  Conditions (map[../../api/v1alpha4.ConditionOperator]interface{} alias)

                  (Appears on:StatementEntry)

                  Conditions is the map of all conditions in the statement entry.

                  EKSAMILookupType (string alias)

                  (Appears on:AMIReference)

                  EKSAMILookupType specifies which AWS AMI to use for a AWSMachine and AWSMachinePool.

                  Effect (string alias)

                  (Appears on:StatementEntry)

                  Effect defines an AWS IAM effect.

                  Filter

                  (Appears on:AWSResourceReference)

                  Filter is a filter used to identify an AWS resource

                  Field Description
                  name
                  string

                  Name of the filter. Filter names are case-sensitive.

                  values
                  []string

                  Values includes one or more filter values. Filter values are case-sensitive.

                  IngressRule

                  IngressRule defines an AWS ingress rule for security groups.

                  Field Description
                  description
                  string
                  protocol
                  SecurityGroupProtocol
                  fromPort
                  int64
                  toPort
                  int64
                  cidrBlocks
                  []string
                  (Optional)

                  List of CIDR blocks to allow access from. Cannot be specified with SourceSecurityGroupID.

                  sourceSecurityGroupIds
                  []string
                  (Optional)

                  The security group id to allow access from. Cannot be specified with CidrBlocks.

                  IngressRules ([]../../api/v1alpha4.IngressRule alias)

                  (Appears on:SecurityGroup)

                  IngressRules is a slice of AWS ingress rules for security groups.

                  Instance

                  (Appears on:AWSClusterStatus)

                  Instance describes an AWS instance.

                  Field Description
                  id
                  string
                  instanceState
                  InstanceState

                  The current state of the instance.

                  type
                  string

                  The instance type.

                  subnetId
                  string

                  The ID of the subnet of the instance.

                  imageId
                  string

                  The ID of the AMI used to launch the instance.

                  sshKeyName
                  string

                  The name of the SSH key pair.

                  securityGroupIds
                  []string

                  SecurityGroupIDs are one or more security group IDs this instance belongs to.

                  userData
                  string

                  UserData is the raw data script passed to the instance which is run upon bootstrap. This field must not be base64 encoded and should only be used when running a new instance.

                  iamProfile
                  string

                  The name of the IAM instance profile associated with the instance, if applicable.

                  addresses
                  []Cluster API api/v1alpha4.MachineAddress

                  Addresses contains the AWS instance associated addresses.

                  privateIp
                  string

                  The private IPv4 address assigned to the instance.

                  publicIp
                  string

                  The public IPv4 address assigned to the instance, if applicable.

                  enaSupport
                  bool

                  Specifies whether enhanced networking with ENA is enabled.

                  ebsOptimized
                  bool

                  Indicates whether the instance is optimized for Amazon EBS I/O.

                  rootVolume
                  Volume
                  (Optional)

                  Configuration options for the root storage volume.

                  nonRootVolumes
                  []Volume
                  (Optional)

                  Configuration options for the non root storage volumes.

                  networkInterfaces
                  []string

                  Specifies ENIs attached to instance

                  tags
                  map[string]string

                  The tags associated with the instance.

                  availabilityZone
                  string

                  Availability zone of instance

                  spotMarketOptions
                  SpotMarketOptions

                  SpotMarketOptions option for configuring instances to be run using AWS Spot instances.

                  tenancy
                  string
                  (Optional)

                  Tenancy indicates if instance should run on shared or single-tenant hardware.

                  volumeIDs
                  []string
                  (Optional)

                  IDs of the instance’s volumes

                  InstanceState (string alias)

                  (Appears on:AWSMachineStatus, Instance)

                  InstanceState describes the state of an AWS instance.

                  NetworkSpec

                  (Appears on:AWSClusterSpec)

                  NetworkSpec encapsulates all things related to AWS network.

                  Field Description
                  vpc
                  VPCSpec
                  (Optional)

                  VPC configuration.

                  subnets
                  Subnets
                  (Optional)

                  Subnets configuration.

                  cni
                  CNISpec
                  (Optional)

                  CNI configuration

                  securityGroupOverrides
                  map[../../api/v1alpha4.SecurityGroupRole]string
                  (Optional)

                  SecurityGroupOverrides is an optional set of security groups to use for cluster instances This is optional - if not provided new security groups will be created for the cluster

                  NetworkStatus

                  (Appears on:AWSClusterStatus)

                  NetworkStatus encapsulates AWS networking resources.

                  Field Description
                  securityGroups
                  map[../../api/v1alpha4.SecurityGroupRole]../../api/v1alpha4.SecurityGroup

                  SecurityGroups is a map from the role/kind of the security group to its unique name, if any.

                  apiServerElb
                  ClassicELB

                  APIServerELB is the Kubernetes api server classic load balancer.

                  PolicyDocument

                  PolicyDocument represents an AWS IAM policy document, and can be converted into JSON using “sigs.k8s.io/cluster-api-provider-aws/cmd/clusterawsadm/converters”.

                  Field Description
                  Version
                  string
                  Statement
                  Statements
                  Id
                  string

                  PrincipalID ([]string alias)

                  PrincipalID represents the list of all identities, such as ARNs.

                  PrincipalType (string alias)

                  PrincipalType defines an AWS principle type.

                  Principals (map[../../api/v1alpha4.PrincipalType]../../api/v1alpha4.PrincipalID alias)

                  (Appears on:StatementEntry)

                  Principals is the map of all identities a statement entry refers to.

                  ResourceLifecycle (string alias)

                  (Appears on:BuildParams)

                  ResourceLifecycle configures the lifecycle of a resource.

                  Resources ([]string alias)

                  (Appears on:StatementEntry)

                  Resources is the list of resources.

                  RouteTable

                  RouteTable defines an AWS routing table.

                  Field Description
                  id
                  string

                  SecretBackend (string alias)

                  (Appears on:CloudInit)

                  SecretBackend defines variants for backend secret storage.

                  SecurityGroup

                  (Appears on:NetworkStatus)

                  SecurityGroup defines an AWS security group.

                  Field Description
                  id
                  string

                  ID is a unique identifier.

                  name
                  string

                  Name is the security group name.

                  ingressRule
                  IngressRules
                  (Optional)

                  IngressRules is the inbound rules associated with the security group.

                  tags
                  Tags

                  Tags is a map of tags associated with the security group.

                  SecurityGroupProtocol (string alias)

                  (Appears on:CNIIngressRule, IngressRule)

                  SecurityGroupProtocol defines the protocol type for a security group rule.

                  SecurityGroupRole (string alias)

                  SecurityGroupRole defines the unique role of a security group.

                  SpotMarketOptions

                  (Appears on:AWSMachineSpec, Instance)

                  SpotMarketOptions defines the options available to a user when configuring Machines to run on Spot instances. Most users should provide an empty struct.

                  Field Description
                  maxPrice
                  string
                  (Optional)

                  MaxPrice defines the maximum price the user is willing to pay for Spot VM instances

                  StatementEntry

                  StatementEntry represents each “statement” block in an AWS IAM policy document.

                  Field Description
                  Sid
                  string
                  Principal
                  Principals
                  NotPrincipal
                  Principals
                  Effect
                  Effect
                  Action
                  Actions
                  Resource
                  Resources
                  Condition
                  Conditions

                  Statements ([]../../api/v1alpha4.StatementEntry alias)

                  (Appears on:PolicyDocument)

                  Statements is the list of StatementEntries.

                  SubnetSpec

                  SubnetSpec configures an AWS Subnet.

                  Field Description
                  id
                  string

                  ID defines a unique identifier to reference this resource.

                  cidrBlock
                  string

                  CidrBlock is the CIDR block to be used when the provider creates a managed VPC.

                  availabilityZone
                  string

                  AvailabilityZone defines the availability zone to use for this subnet in the cluster’s region.

                  isPublic
                  bool
                  (Optional)

                  IsPublic defines the subnet as a public subnet. A subnet is public when it is associated with a route table that has a route to an internet gateway.

                  routeTableId
                  string
                  (Optional)

                  RouteTableID is the routing table id associated with the subnet.

                  natGatewayId
                  string
                  (Optional)

                  NatGatewayID is the NAT gateway id associated with the subnet. Ignored unless the subnet is managed by the provider, in which case this is set on the public subnet where the NAT gateway resides. It is then used to determine routes for private subnets in the same AZ as the public subnet.

                  tags
                  Tags

                  Tags is a collection of tags describing the resource.

                  Subnets ([]../../api/v1alpha4.SubnetSpec alias)

                  (Appears on:NetworkSpec)

                  Subnets is a slice of Subnet.

                  Tags (map[string]string alias)

                  (Appears on:AWSClusterSpec, AWSMachineSpec, BuildParams, SecurityGroup, SubnetSpec, VPCSpec)

                  Tags defines a map of tags.

                  VPCSpec

                  (Appears on:NetworkSpec)

                  VPCSpec configures an AWS VPC.

                  Field Description
                  id
                  string

                  ID is the vpc-id of the VPC this provider should use to create resources.

                  cidrBlock
                  string

                  CidrBlock is the CIDR block to be used when the provider creates a managed VPC. Defaults to 10.0.0.0/16.

                  internetGatewayId
                  string
                  (Optional)

                  InternetGatewayID is the id of the internet gateway associated with the VPC.

                  tags
                  Tags

                  Tags is a collection of tags describing the resource.

                  availabilityZoneUsageLimit
                  int

                  AvailabilityZoneUsageLimit specifies the maximum number of availability zones (AZ) that should be used in a region when automatically creating subnets. If a region has more than this number of AZs then this number of AZs will be picked randomly when creating default subnets. Defaults to 3

                  availabilityZoneSelection
                  AZSelectionScheme

                  AvailabilityZoneSelection specifies how AZs should be selected if there are more AZs in a region than specified by AvailabilityZoneUsageLimit. There are 2 selection schemes: Ordered - selects based on alphabetical order Random - selects AZs randomly in a region Defaults to Ordered

                  Volume

                  (Appears on:AWSMachineSpec, Instance)

                  Volume encapsulates the configuration options for the storage device

                  Field Description
                  deviceName
                  string
                  (Optional)

                  Device name

                  size
                  int64

                  Size specifies size (in Gi) of the storage device. Must be greater than the image snapshot size or 8 (whichever is greater).

                  type
                  VolumeType
                  (Optional)

                  Type is the type of the volume (e.g. gp2, io1, etc…).

                  iops
                  int64
                  (Optional)

                  IOPS is the number of IOPS requested for the disk. Not applicable to all types.

                  throughput
                  int64
                  (Optional)

                  Throughput to provision in MiB/s supported for the volume type. Not applicable to all types.

                  encrypted
                  bool
                  (Optional)

                  Encrypted is whether the volume should be encrypted or not.

                  encryptionKey
                  string
                  (Optional)

                  EncryptionKey is the KMS key to use to encrypt the volume. Can be either a KMS key ID or ARN. If Encrypted is set and this is omitted, the default AWS key will be used. The key must already exist and be accessible by the controller.

                  VolumeType (string alias)

                  (Appears on:Volume)

                  VolumeType describes the EBS volume type. See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html

                  ASGStatus (string alias)

                  (Appears on:AWSMachinePoolStatus, AutoScalingGroup)

                  ASGStatus is a status string returned by the autoscaling API

                  AWSFargateProfile

                  AWSFargateProfile is the Schema for the awsfargateprofiles API

                  Field Description
                  metadata
                  Kubernetes meta/v1.ObjectMeta
                  Refer to the Kubernetes API documentation for the fields of the metadata field.
                  spec
                  FargateProfileSpec


                  clusterName
                  string

                  ClusterName is the name of the Cluster this object belongs to.

                  profileName
                  string

                  ProfileName specifies the profile name.

                  subnetIDs
                  []string
                  (Optional)

                  SubnetIDs specifies which subnets are used for the auto scaling group of this nodegroup.

                  additionalTags
                  Cluster API AWS api/v1alpha4.Tags
                  (Optional)

                  AdditionalTags is an optional set of tags to add to AWS resources managed by the AWS provider, in addition to the ones added by default.

                  roleName
                  string
                  (Optional)

                  RoleName specifies the name of IAM role for this fargate pool If the role is pre-existing we will treat it as unmanaged and not delete it on deletion. If the EKSEnableIAM feature flag is true and no name is supplied then a role is created.

                  selectors
                  []FargateSelector

                  Selectors specify fargate pod selectors.

                  status
                  FargateProfileStatus

                  AWSLaunchTemplate

                  (Appears on:AWSMachinePoolSpec)

                  AWSLaunchTemplate defines the desired state of AWSLaunchTemplate

                  Field Description
                  name
                  string

                  The name of the launch template.

                  iamInstanceProfile
                  string

                  The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role.

                  ami
                  Cluster API AWS api/v1alpha4.AMIReference
                  (Optional)

                  AMI is the reference to the AMI from which to create the machine instance.

                  imageLookupFormat
                  string
                  (Optional)

                  ImageLookupFormat is the AMI naming format to look up the image for this machine It will be ignored if an explicit AMI is set. Supports substitutions for {{.BaseOS}} and {{.K8sVersion}} with the base OS and kubernetes version, respectively. The BaseOS will be the value in ImageLookupBaseOS or ubuntu (the default), and the kubernetes version as defined by the packages produced by kubernetes/release without v as a prefix: 1.13.0, 1.12.5-mybuild.1, or 1.17.3. For example, the default image format of capa-ami-{{.BaseOS}}-?{{.K8sVersion}}-* will end up searching for AMIs that match the pattern capa-ami-ubuntu-?1.18.0-* for a Machine that is targeting kubernetes v1.18.0 and the ubuntu base OS. See also: https://golang.org/pkg/text/template/

                  imageLookupOrg
                  string

                  ImageLookupOrg is the AWS Organization ID to use for image lookup if AMI is not set.

                  imageLookupBaseOS
                  string

                  ImageLookupBaseOS is the name of the base operating system to use for image lookup the AMI is not set.

                  instanceType
                  string

                  InstanceType is the type of instance to create. Example: m4.xlarge

                  rootVolume
                  Cluster API AWS api/v1alpha4.Volume
                  (Optional)

                  RootVolume encapsulates the configuration options for the root volume

                  sshKeyName
                  string
                  (Optional)

                  SSHKeyName is the name of the ssh key to attach to the instance. Valid values are empty string (do not use SSH keys), a valid SSH key name, or omitted (use the default SSH key name)

                  versionNumber
                  int64

                  VersionNumber is the version of the launch template that is applied. Typically a new version is created when at least one of the following happens: 1) A new launch template spec is applied. 2) One or more parameters in an existing template is changed. 3) A new AMI is discovered.

                  additionalSecurityGroups
                  []Cluster API AWS api/v1alpha4.AWSResourceReference
                  (Optional)

                  AdditionalSecurityGroups is an array of references to security groups that should be applied to the instances. These security groups would be set in addition to any security groups defined at the cluster level or in the actuator.

                  AWSMachinePool

                  AWSMachinePool is the Schema for the awsmachinepools API

                  Field Description
                  metadata
                  Kubernetes meta/v1.ObjectMeta
                  Refer to the Kubernetes API documentation for the fields of the metadata field.
                  spec
                  AWSMachinePoolSpec


                  providerID
                  string
                  (Optional)

                  ProviderID is the ARN of the associated ASG

                  minSize
                  int32

                  MinSize defines the minimum size of the group.

                  maxSize
                  int32

                  MaxSize defines the maximum size of the group.

                  availabilityZones
                  []string

                  AvailabilityZones is an array of availability zones instances can run in

                  subnets
                  []Cluster API AWS api/v1alpha4.AWSResourceReference
                  (Optional)

                  Subnets is an array of subnet configurations

                  additionalTags
                  Cluster API AWS api/v1alpha4.Tags
                  (Optional)

                  AdditionalTags is an optional set of tags to add to an instance, in addition to the ones added by default by the AWS provider.

                  awsLaunchTemplate
                  AWSLaunchTemplate

                  AWSLaunchTemplate specifies the launch template and version to use when an instance is launched.

                  mixedInstancesPolicy
                  MixedInstancesPolicy

                  MixedInstancesPolicy describes how multiple instance types will be used by the ASG.

                  providerIDList
                  []string
                  (Optional)

                  ProviderIDList are the identification IDs of machine instances provided by the provider. This field must match the provider IDs as seen on the node objects corresponding to a machine pool’s machine instances.

                  defaultCoolDown
                  Kubernetes meta/v1.Duration
                  (Optional)

                  The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. If no value is supplied by user a default value of 300 seconds is set

                  refreshPreferences
                  RefreshPreferences
                  (Optional)

                  RefreshPreferences describes set of preferences associated with the instance refresh request.

                  capacityRebalance
                  bool
                  (Optional)

                  Enable or disable the capacity rebalance autoscaling group feature

                  status
                  AWSMachinePoolStatus

                  AWSMachinePoolInstanceStatus

                  (Appears on:AWSMachinePoolStatus)

                  AWSMachinePoolInstanceStatus defines the status of the AWSMachinePoolInstance.

                  Field Description
                  instanceID
                  string
                  (Optional)

                  InstanceID is the identification of the Machine Instance within ASG

                  version
                  string
                  (Optional)

                  Version defines the Kubernetes version for the Machine Instance

                  AWSMachinePoolSpec

                  (Appears on:AWSMachinePool)

                  AWSMachinePoolSpec defines the desired state of AWSMachinePool

                  Field Description
                  providerID
                  string
                  (Optional)

                  ProviderID is the ARN of the associated ASG

                  minSize
                  int32

                  MinSize defines the minimum size of the group.

                  maxSize
                  int32

                  MaxSize defines the maximum size of the group.

                  availabilityZones
                  []string

                  AvailabilityZones is an array of availability zones instances can run in

                  subnets
                  []Cluster API AWS api/v1alpha4.AWSResourceReference
                  (Optional)

                  Subnets is an array of subnet configurations

                  additionalTags
                  Cluster API AWS api/v1alpha4.Tags
                  (Optional)

                  AdditionalTags is an optional set of tags to add to an instance, in addition to the ones added by default by the AWS provider.

                  awsLaunchTemplate
                  AWSLaunchTemplate

                  AWSLaunchTemplate specifies the launch template and version to use when an instance is launched.

                  mixedInstancesPolicy
                  MixedInstancesPolicy

                  MixedInstancesPolicy describes how multiple instance types will be used by the ASG.

                  providerIDList
                  []string
                  (Optional)

                  ProviderIDList are the identification IDs of machine instances provided by the provider. This field must match the provider IDs as seen on the node objects corresponding to a machine pool’s machine instances.

                  defaultCoolDown
                  Kubernetes meta/v1.Duration
                  (Optional)

                  The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. If no value is supplied by user a default value of 300 seconds is set

                  refreshPreferences
                  RefreshPreferences
                  (Optional)

                  RefreshPreferences describes set of preferences associated with the instance refresh request.

                  capacityRebalance
                  bool
                  (Optional)

                  Enable or disable the capacity rebalance autoscaling group feature

                  AWSMachinePoolStatus

                  (Appears on:AWSMachinePool)

                  AWSMachinePoolStatus defines the observed state of AWSMachinePool

                  Field Description
                  ready
                  bool
                  (Optional)

                  Ready is true when the provider resource is ready.

                  replicas
                  int32
                  (Optional)

                  Replicas is the most recently observed number of replicas

                  conditions
                  Cluster API api/v1alpha4.Conditions
                  (Optional)

                  Conditions defines current service state of the AWSMachinePool.

                  instances
                  []AWSMachinePoolInstanceStatus
                  (Optional)

                  Instances contains the status for each instance in the pool

                  launchTemplateID
                  string

                  The ID of the launch template

                  failureReason
                  Cluster API errors.MachineStatusError
                  (Optional)

                  FailureReason will be set in the event that there is a terminal problem reconciling the Machine and will contain a succinct value suitable for machine interpretation.

                  This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Machine’s spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.

                  Any transient errors that occur during the reconciliation of Machines can be added as events to the Machine object and/or logged in the controller’s output.

                  failureMessage
                  string
                  (Optional)

                  FailureMessage will be set in the event that there is a terminal problem reconciling the Machine and will contain a more verbose string suitable for logging and human consumption.

                  This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Machine’s spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.

                  Any transient errors that occur during the reconciliation of Machines can be added as events to the Machine object and/or logged in the controller’s output.

                  asgStatus
                  ASGStatus

                  AWSManagedMachinePool

                  AWSManagedMachinePool is the Schema for the awsmanagedmachinepools API

                  Field Description
                  metadata
                  Kubernetes meta/v1.ObjectMeta
                  Refer to the Kubernetes API documentation for the fields of the metadata field.
                  spec
                  AWSManagedMachinePoolSpec


                  eksNodegroupName
                  string
                  (Optional)

                  EKSNodegroupName specifies the name of the nodegroup in AWS corresponding to this MachinePool. If you don’t specify a name then a default name will be created based on the namespace and name of the managed machine pool.

                  availabilityZones
                  []string

                  AvailabilityZones is an array of availability zones instances can run in

                  subnetIDs
                  []string
                  (Optional)

                  SubnetIDs specifies which subnets are used for the auto scaling group of this nodegroup

                  additionalTags
                  Cluster API AWS api/v1alpha4.Tags
                  (Optional)

                  AdditionalTags is an optional set of tags to add to AWS resources managed by the AWS provider, in addition to the ones added by default.

                  roleName
                  string
                  (Optional)

                  RoleName specifies the name of IAM role for the node group. If the role is pre-existing we will treat it as unmanaged and not delete it on deletion. If the EKSEnableIAM feature flag is true and no name is supplied then a role is created.

                  amiVersion
                  string
                  (Optional)

                  AMIVersion defines the desired AMI release version. If no version number is supplied then the latest version for the Kubernetes version will be used

                  amiType
                  ManagedMachineAMIType
                  (Optional)

                  AMIType defines the AMI type

                  labels
                  map[string]string
                  (Optional)

                  Labels specifies labels for the Kubernetes node objects

                  taints
                  Taints
                  (Optional)

                  Taints specifies the taints to apply to the nodes of the machine pool

                  diskSize
                  int32
                  (Optional)

                  DiskSize specifies the root disk size

                  instanceType
                  string
                  (Optional)

                  InstanceType specifies the AWS instance type

                  scaling
                  ManagedMachinePoolScaling
                  (Optional)

                  Scaling specifies scaling for the ASG behind this pool

                  remoteAccess
                  ManagedRemoteAccess
                  (Optional)

                  RemoteAccess specifies how machines can be accessed remotely

                  providerIDList
                  []string
                  (Optional)

                  ProviderIDList are the provider IDs of instances in the autoscaling group corresponding to the nodegroup represented by this machine pool

                  capacityType
                  ManagedMachinePoolCapacityType
                  (Optional)

                  CapacityType specifies the capacity type for the ASG behind this pool

                  status
                  AWSManagedMachinePoolStatus

                  AWSManagedMachinePoolSpec

                  (Appears on:AWSManagedMachinePool)

                  AWSManagedMachinePoolSpec defines the desired state of AWSManagedMachinePool

                  Field Description
                  eksNodegroupName
                  string
                  (Optional)

                  EKSNodegroupName specifies the name of the nodegroup in AWS corresponding to this MachinePool. If you don’t specify a name then a default name will be created based on the namespace and name of the managed machine pool.

                  availabilityZones
                  []string

                  AvailabilityZones is an array of availability zones instances can run in

                  subnetIDs
                  []string
                  (Optional)

                  SubnetIDs specifies which subnets are used for the auto scaling group of this nodegroup

                  additionalTags
                  Cluster API AWS api/v1alpha4.Tags
                  (Optional)

                  AdditionalTags is an optional set of tags to add to AWS resources managed by the AWS provider, in addition to the ones added by default.

                  roleName
                  string
                  (Optional)

                  RoleName specifies the name of IAM role for the node group. If the role is pre-existing we will treat it as unmanaged and not delete it on deletion. If the EKSEnableIAM feature flag is true and no name is supplied then a role is created.

                  amiVersion
                  string
                  (Optional)

                  AMIVersion defines the desired AMI release version. If no version number is supplied then the latest version for the Kubernetes version will be used

                  amiType
                  ManagedMachineAMIType
                  (Optional)

                  AMIType defines the AMI type

                  labels
                  map[string]string
                  (Optional)

                  Labels specifies labels for the Kubernetes node objects

                  taints
                  Taints
                  (Optional)

                  Taints specifies the taints to apply to the nodes of the machine pool

                  diskSize
                  int32
                  (Optional)

                  DiskSize specifies the root disk size

                  instanceType
                  string
                  (Optional)

                  InstanceType specifies the AWS instance type

                  scaling
                  ManagedMachinePoolScaling
                  (Optional)

                  Scaling specifies scaling for the ASG behind this pool

                  remoteAccess
                  ManagedRemoteAccess
                  (Optional)

                  RemoteAccess specifies how machines can be accessed remotely

                  providerIDList
                  []string
                  (Optional)

                  ProviderIDList are the provider IDs of instances in the autoscaling group corresponding to the nodegroup represented by this machine pool

                  capacityType
                  ManagedMachinePoolCapacityType
                  (Optional)

                  CapacityType specifies the capacity type for the ASG behind this pool

                  AWSManagedMachinePoolStatus

                  (Appears on:AWSManagedMachinePool)

                  AWSManagedMachinePoolStatus defines the observed state of AWSManagedMachinePool

                  Field Description
                  ready
                  bool

                  Ready denotes that the AWSManagedMachinePool nodegroup has joined the cluster

                  replicas
                  int32
                  (Optional)

                  Replicas is the most recently observed number of replicas.

                  failureReason
                  Cluster API errors.MachineStatusError
                  (Optional)

                  FailureReason will be set in the event that there is a terminal problem reconciling the MachinePool and will contain a succinct value suitable for machine interpretation.

                  This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Machine’s spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.

                  Any transient errors that occur during the reconciliation of MachinePools can be added as events to the MachinePool object and/or logged in the controller’s output.

                  failureMessage
                  string
                  (Optional)

                  FailureMessage will be set in the event that there is a terminal problem reconciling the MachinePool and will contain a more verbose string suitable for logging and human consumption.

                  This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the MachinePool’s spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.

                  Any transient errors that occur during the reconciliation of MachinePools can be added as events to the MachinePool object and/or logged in the controller’s output.

                  conditions
                  Cluster API api/v1alpha4.Conditions
                  (Optional)

                  Conditions defines current service state of the managed machine pool

                  AutoScalingGroup

                  AutoScalingGroup describes an AWS autoscaling group.

                  Field Description
                  id
                  string

                  The tags associated with the instance.

                  tags
                  Cluster API AWS api/v1alpha4.Tags
                  name
                  string
                  desiredCapacity
                  int32
                  maxSize
                  int32
                  minSize
                  int32
                  placementGroup
                  string
                  subnets
                  []string
                  defaultCoolDown
                  Kubernetes meta/v1.Duration
                  capacityRebalance
                  bool
                  mixedInstancesPolicy
                  MixedInstancesPolicy
                  Status
                  ASGStatus
                  instances
                  []Cluster API AWS api/v1alpha4.Instance

                  BlockDeviceMapping

                  BlockDeviceMapping specifies the block devices for the instance. You can specify virtual devices and EBS volumes.

                  Field Description
                  deviceName
                  string

                  The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh).

                  ebs
                  EBS
                  (Optional)

                  You can specify either VirtualName or Ebs, but not both.

                  EBS

                  (Appears on:BlockDeviceMapping)

                  EBS can be used to automatically set up EBS volumes when an instance is launched.

                  Field Description
                  encrypted
                  bool
                  (Optional)

                  Encrypted is whether the volume should be encrypted or not.

                  volumeSize
                  int64
                  (Optional)

                  The size of the volume, in GiB. This can be a number from 1-1,024 for standard, 4-16,384 for io1, 1-16,384 for gp2, and 500-16,384 for st1 and sc1. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

                  volumeType
                  string
                  (Optional)

                  The volume type For more information, see Amazon EBS Volume Types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html)

                  FargateProfileSpec

                  (Appears on:AWSFargateProfile)

                  FargateProfileSpec defines the desired state of FargateProfile

                  Field Description
                  clusterName
                  string

                  ClusterName is the name of the Cluster this object belongs to.

                  profileName
                  string

                  ProfileName specifies the profile name.

                  subnetIDs
                  []string
                  (Optional)

                  SubnetIDs specifies which subnets are used for the auto scaling group of this nodegroup.

                  additionalTags
                  Cluster API AWS api/v1alpha4.Tags
                  (Optional)

                  AdditionalTags is an optional set of tags to add to AWS resources managed by the AWS provider, in addition to the ones added by default.

                  roleName
                  string
                  (Optional)

                  RoleName specifies the name of IAM role for this fargate pool If the role is pre-existing we will treat it as unmanaged and not delete it on deletion. If the EKSEnableIAM feature flag is true and no name is supplied then a role is created.

                  selectors
                  []FargateSelector

                  Selectors specify fargate pod selectors.

                  FargateProfileStatus

                  (Appears on:AWSFargateProfile)

                  FargateProfileStatus defines the observed state of FargateProfile

                  Field Description
                  ready
                  bool

                  Ready denotes that the FargateProfile is available.

                  failureReason
                  Cluster API errors.MachineStatusError
                  (Optional)

                  FailureReason will be set in the event that there is a terminal problem reconciling the FargateProfile and will contain a succinct value suitable for machine interpretation.

                  This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the FargateProfile’s spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.

                  Any transient errors that occur during the reconciliation of FargateProfiles can be added as events to the FargateProfile object and/or logged in the controller’s output.

                  failureMessage
                  string
                  (Optional)

                  FailureMessage will be set in the event that there is a terminal problem reconciling the FargateProfile and will contain a more verbose string suitable for logging and human consumption.

                  This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the FargateProfile’s spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.

                  Any transient errors that occur during the reconciliation of FargateProfiles can be added as events to the FargateProfile object and/or logged in the controller’s output.

                  conditions
                  Cluster API api/v1alpha4.Conditions
                  (Optional)

                  Conditions defines current state of the Fargate profile.

                  FargateSelector

                  (Appears on:FargateProfileSpec)

                  FargateSelector specifies a selector for pods that should run on this fargate pool

                  Field Description
                  labels
                  map[string]string

                  Labels specifies which pod labels this selector should match.

                  namespace
                  string

                  Namespace specifies which namespace this selector should match.

                  InstancesDistribution

                  (Appears on:MixedInstancesPolicy)

                  InstancesDistribution to configure distribution of On-Demand Instances and Spot Instances.

                  Field Description
                  onDemandAllocationStrategy
                  OnDemandAllocationStrategy
                  spotAllocationStrategy
                  SpotAllocationStrategy
                  onDemandBaseCapacity
                  int64
                  onDemandPercentageAboveBaseCapacity
                  int64

                  ManagedMachineAMIType (string alias)

                  (Appears on:AWSManagedMachinePoolSpec)

                  ManagedMachineAMIType specifies which AWS AMI to use for a managed MachinePool.

                  Value Description

                  "AL2_ARM_64"

                  Al2Arm64 is the Arm AMI type.

                  "AL2_x86_64"

                  Al2x86_64 is the default AMI type.

                  "AL2_x86_64_GPU"

                  Al2x86_64GPU is the x86-64 GPU AMI type.

                  ManagedMachinePoolCapacityType (string alias)

                  (Appears on:AWSManagedMachinePoolSpec)

                  ManagedMachinePoolCapacityType specifies the capacity type to be used for the managed MachinePool.

                  Value Description

                  "onDemand"

                  ManagedMachinePoolCapacityTypeOnDemand is the default capacity type, to launch on-demand instances.

                  "spot"

                  ManagedMachinePoolCapacityTypeSpot is the spot instance capacity type to launch spot instances.

                  ManagedMachinePoolScaling

                  (Appears on:AWSManagedMachinePoolSpec)

                  ManagedMachinePoolScaling specifies scaling options.

                  Field Description
                  minSize
                  int32
                  maxSize
                  int32

                  ManagedRemoteAccess

                  (Appears on:AWSManagedMachinePoolSpec)

                  ManagedRemoteAccess specifies remote access settings for EC2 instances.

                  Field Description
                  sshKeyName
                  string

                  SSHKeyName specifies which EC2 SSH key can be used to access machines. If left empty, the key from the control plane is used.

                  sourceSecurityGroups
                  []string

                  SourceSecurityGroups specifies which security groups are allowed access

                  public
                  bool

                  Public specifies whether to open port 22 to the public internet

                  MixedInstancesPolicy

                  (Appears on:AWSMachinePoolSpec, AutoScalingGroup)

                  MixedInstancesPolicy for an Auto Scaling group.

                  Field Description
                  instancesDistribution
                  InstancesDistribution
                  overrides
                  []Overrides

                  OnDemandAllocationStrategy (string alias)

                  (Appears on:InstancesDistribution)

                  OnDemandAllocationStrategy indicates how to allocate instance types to fulfill On-Demand capacity.

                  Overrides

                  (Appears on:MixedInstancesPolicy)

                  Overrides are used to override the instance type specified by the launch template with multiple instance types that can be used to launch On-Demand Instances and Spot Instances.

                  Field Description
                  instanceType
                  string

                  RefreshPreferences

                  (Appears on:AWSMachinePoolSpec)

                  RefreshPreferences defines the specs for instance refreshing.

                  Field Description
                  strategy
                  string
                  (Optional)

                  The strategy to use for the instance refresh. The only valid value is Rolling. A rolling update is an update that is applied to all instances in an Auto Scaling group until all instances have been updated.

                  instanceWarmup
                  int64
                  (Optional)

                  The number of seconds until a newly launched instance is configured and ready to use. During this time, the next replacement will not be initiated. The default is to use the value for the health check grace period defined for the group.

                  minHealthyPercentage
                  int64
                  (Optional)

                  The amount of capacity as a percentage in ASG that must remain healthy during an instance refresh. The default is 90.

                  SpotAllocationStrategy (string alias)

                  (Appears on:InstancesDistribution)

                  SpotAllocationStrategy indicates how to allocate instances across Spot Instance pools.

                  Tags (map[string]string alias)

                  Tags is a mapping for tags.

                  Taint

                  Taint defines the specs for a Kubernetes taint.

                  Field Description
                  effect
                  TaintEffect

                  Effect specifies the effect for the taint

                  key
                  string

                  Key is the key of the taint

                  value
                  string

                  Value is the value of the taint

                  TaintEffect (string alias)

                  (Appears on:Taint)

                  TaintEffect is the effect for a Kubernetes taint.

                  Taints ([]../../exp/api/v1alpha4.Taint alias)

                  (Appears on:AWSManagedMachinePoolSpec)

                  Taints is an array of Taints.


                  infrastructure.cluster.x-k8s.io/v1beta1

                  Package v1beta1 contains the v1beta1 API implementation.

                  Resource Types:

                    AMIReference

                    (Appears on:AWSMachineSpec)

                    AMIReference is a reference to a specific AWS resource by ID, ARN, or filters. Only one of ID, ARN or Filters may be specified. Specifying more than one will result in a validation error.

                    Field Description
                    id
                    string
                    (Optional)

                    ID of resource

                    eksLookupType
                    EKSAMILookupType
                    (Optional)

                    EKSOptimizedLookupType If specified, will look up an EKS Optimized image in SSM Parameter store

                    AWSCluster

                    AWSCluster is the schema for Amazon EC2 based Kubernetes Cluster API.

                    Field Description
                    metadata
                    Kubernetes meta/v1.ObjectMeta
                    Refer to the Kubernetes API documentation for the fields of the metadata field.
                    spec
                    AWSClusterSpec


                    network
                    NetworkSpec

                    NetworkSpec encapsulates all things related to AWS network.

                    region
                    string

                    The AWS Region the cluster lives in.

                    sshKeyName
                    string
                    (Optional)

                    SSHKeyName is the name of the ssh key to attach to the bastion host. Valid values are empty string (do not use SSH keys), a valid SSH key name, or omitted (use the default SSH key name)

                    controlPlaneEndpoint
                    Cluster API api/v1beta1.APIEndpoint
                    (Optional)

                    ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.

                    additionalTags
                    Tags
                    (Optional)

                    AdditionalTags is an optional set of tags to add to AWS resources managed by the AWS provider, in addition to the ones added by default.

                    controlPlaneLoadBalancer
                    AWSLoadBalancerSpec
                    (Optional)

                    ControlPlaneLoadBalancer is optional configuration for customizing control plane behavior.

                    imageLookupFormat
                    string
                    (Optional)

                    ImageLookupFormat is the AMI naming format to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupOrg. Supports substitutions for {{.BaseOS}} and {{.K8sVersion}} with the base OS and kubernetes version, respectively. The BaseOS will be the value in ImageLookupBaseOS or ubuntu (the default), and the kubernetes version as defined by the packages produced by kubernetes/release without v as a prefix: 1.13.0, 1.12.5-mybuild.1, or 1.17.3. For example, the default image format of capa-ami-{{.BaseOS}}-?{{.K8sVersion}}-* will end up searching for AMIs that match the pattern capa-ami-ubuntu-?1.18.0-* for a Machine that is targeting kubernetes v1.18.0 and the ubuntu base OS. See also: https://golang.org/pkg/text/template/

                    imageLookupOrg
                    string
                    (Optional)

                    ImageLookupOrg is the AWS Organization ID to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupOrg.

                    imageLookupBaseOS
                    string

                    ImageLookupBaseOS is the name of the base operating system used to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupBaseOS.

                    bastion
                    Bastion
                    (Optional)

                    Bastion contains options to configure the bastion host.

                    identityRef
                    AWSIdentityReference
                    (Optional)

                    IdentityRef is a reference to a identity to be used when reconciling this cluster

                    status
                    AWSClusterStatus

                    AWSClusterControllerIdentity

                    AWSClusterControllerIdentity is the Schema for the awsclustercontrolleridentities API It is used to grant access to use Cluster API Provider AWS Controller credentials.

                    Field Description
                    metadata
                    Kubernetes meta/v1.ObjectMeta
                    Refer to the Kubernetes API documentation for the fields of the metadata field.
                    spec
                    AWSClusterControllerIdentitySpec

                    Spec for this AWSClusterControllerIdentity.



                    AWSClusterIdentitySpec
                    AWSClusterIdentitySpec

                    (Members of AWSClusterIdentitySpec are embedded into this type.)

                    AWSClusterControllerIdentitySpec

                    (Appears on:AWSClusterControllerIdentity)

                    AWSClusterControllerIdentitySpec defines the specifications for AWSClusterControllerIdentity.

                    Field Description
                    AWSClusterIdentitySpec
                    AWSClusterIdentitySpec

                    (Members of AWSClusterIdentitySpec are embedded into this type.)

                    AWSClusterIdentitySpec

                    (Appears on:AWSClusterControllerIdentitySpec, AWSClusterRoleIdentitySpec, AWSClusterStaticIdentitySpec)

                    AWSClusterIdentitySpec defines the Spec struct for AWSClusterIdentity types.

                    Field Description
                    allowedNamespaces
                    AllowedNamespaces
                    (Optional)

                    AllowedNamespaces is used to identify which namespaces are allowed to use the identity from. Namespaces can be selected either using an array of namespaces or with label selector. An empty allowedNamespaces object indicates that AWSClusters can use this identity from any namespace. If this object is nil, no namespaces will be allowed (default behaviour, if this field is not provided) A namespace should be either in the NamespaceList or match with Selector to use the identity.

                    AWSClusterRoleIdentity

                    AWSClusterRoleIdentity is the Schema for the awsclusterroleidentities API It is used to assume a role using the provided sourceRef.

                    Field Description
                    metadata
                    Kubernetes meta/v1.ObjectMeta
                    Refer to the Kubernetes API documentation for the fields of the metadata field.
                    spec
                    AWSClusterRoleIdentitySpec

                    Spec for this AWSClusterRoleIdentity.



                    AWSClusterIdentitySpec
                    AWSClusterIdentitySpec

                    (Members of AWSClusterIdentitySpec are embedded into this type.)

                    AWSRoleSpec
                    AWSRoleSpec

                    (Members of AWSRoleSpec are embedded into this type.)

                    externalID
                    string
                    (Optional)

                    A unique identifier that might be required when you assume a role in another account. If the administrator of the account to which the role belongs provided you with an external ID, then provide that value in the ExternalId parameter. This value can be any string, such as a passphrase or account number. A cross-account role is usually set up to trust everyone in an account. Therefore, the administrator of the trusting account might send an external ID to the administrator of the trusted account. That way, only someone with the ID can assume the role, rather than everyone in the account. For more information about the external ID, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party in the IAM User Guide.

                    sourceIdentityRef
                    AWSIdentityReference

                    SourceIdentityRef is a reference to another identity which will be chained to do role assumption. All identity types are accepted.

                    AWSClusterRoleIdentitySpec

                    (Appears on:AWSClusterRoleIdentity)

                    AWSClusterRoleIdentitySpec defines the specifications for AWSClusterRoleIdentity.

                    Field Description
                    AWSClusterIdentitySpec
                    AWSClusterIdentitySpec

                    (Members of AWSClusterIdentitySpec are embedded into this type.)

                    AWSRoleSpec
                    AWSRoleSpec

                    (Members of AWSRoleSpec are embedded into this type.)

                    externalID
                    string
                    (Optional)

                    A unique identifier that might be required when you assume a role in another account. If the administrator of the account to which the role belongs provided you with an external ID, then provide that value in the ExternalId parameter. This value can be any string, such as a passphrase or account number. A cross-account role is usually set up to trust everyone in an account. Therefore, the administrator of the trusting account might send an external ID to the administrator of the trusted account. That way, only someone with the ID can assume the role, rather than everyone in the account. For more information about the external ID, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party in the IAM User Guide.

                    sourceIdentityRef
                    AWSIdentityReference

                    SourceIdentityRef is a reference to another identity which will be chained to do role assumption. All identity types are accepted.

                    AWSClusterSpec

                    (Appears on:AWSCluster, AWSClusterTemplateResource)

                    AWSClusterSpec defines the desired state of an EC2-based Kubernetes cluster.

                    Field Description
                    network
                    NetworkSpec

                    NetworkSpec encapsulates all things related to AWS network.

                    region
                    string

                    The AWS Region the cluster lives in.

                    sshKeyName
                    string
                    (Optional)

                    SSHKeyName is the name of the ssh key to attach to the bastion host. Valid values are empty string (do not use SSH keys), a valid SSH key name, or omitted (use the default SSH key name)

                    controlPlaneEndpoint
                    Cluster API api/v1beta1.APIEndpoint
                    (Optional)

                    ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.

                    additionalTags
                    Tags
                    (Optional)

                    AdditionalTags is an optional set of tags to add to AWS resources managed by the AWS provider, in addition to the ones added by default.

                    controlPlaneLoadBalancer
                    AWSLoadBalancerSpec
                    (Optional)

                    ControlPlaneLoadBalancer is optional configuration for customizing control plane behavior.

                    imageLookupFormat
                    string
                    (Optional)

                    ImageLookupFormat is the AMI naming format to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupOrg. Supports substitutions for {{.BaseOS}} and {{.K8sVersion}} with the base OS and kubernetes version, respectively. The BaseOS will be the value in ImageLookupBaseOS or ubuntu (the default), and the kubernetes version as defined by the packages produced by kubernetes/release without v as a prefix: 1.13.0, 1.12.5-mybuild.1, or 1.17.3. For example, the default image format of capa-ami-{{.BaseOS}}-?{{.K8sVersion}}-* will end up searching for AMIs that match the pattern capa-ami-ubuntu-?1.18.0-* for a Machine that is targeting kubernetes v1.18.0 and the ubuntu base OS. See also: https://golang.org/pkg/text/template/

                    imageLookupOrg
                    string
                    (Optional)

                    ImageLookupOrg is the AWS Organization ID to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupOrg.

                    imageLookupBaseOS
                    string

                    ImageLookupBaseOS is the name of the base operating system used to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupBaseOS.

                    bastion
                    Bastion
                    (Optional)

                    Bastion contains options to configure the bastion host.

                    identityRef
                    AWSIdentityReference
                    (Optional)

                    IdentityRef is a reference to a identity to be used when reconciling this cluster

                    AWSClusterStaticIdentity

                    AWSClusterStaticIdentity is the Schema for the awsclusterstaticidentities API It represents a reference to an AWS access key ID and secret access key, stored in a secret.

                    Field Description
                    metadata
                    Kubernetes meta/v1.ObjectMeta
                    Refer to the Kubernetes API documentation for the fields of the metadata field.
                    spec
                    AWSClusterStaticIdentitySpec

                    Spec for this AWSClusterStaticIdentity



                    AWSClusterIdentitySpec
                    AWSClusterIdentitySpec

                    (Members of AWSClusterIdentitySpec are embedded into this type.)

                    secretRef
                    string

                    Reference to a secret containing the credentials. The secret should contain the following data keys: AccessKeyID: AKIAIOSFODNN7EXAMPLE SecretAccessKey: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY SessionToken: Optional

                    AWSClusterStaticIdentitySpec

                    (Appears on:AWSClusterStaticIdentity)

                    AWSClusterStaticIdentitySpec defines the specifications for AWSClusterStaticIdentity.

                    Field Description
                    AWSClusterIdentitySpec
                    AWSClusterIdentitySpec

                    (Members of AWSClusterIdentitySpec are embedded into this type.)

                    secretRef
                    string

                    Reference to a secret containing the credentials. The secret should contain the following data keys: AccessKeyID: AKIAIOSFODNN7EXAMPLE SecretAccessKey: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY SessionToken: Optional

                    AWSClusterStatus

                    (Appears on:AWSCluster)

                    AWSClusterStatus defines the observed state of AWSCluster.

                    Field Description
                    ready
                    bool
                    networkStatus
                    NetworkStatus
                    failureDomains
                    Cluster API api/v1beta1.FailureDomains
                    bastion
                    Instance
                    conditions
                    Cluster API api/v1beta1.Conditions

                    AWSClusterTemplate

                    AWSClusterTemplate is the schema for Amazon EC2 based Kubernetes Cluster Templates.

                    Field Description
                    metadata
                    Kubernetes meta/v1.ObjectMeta
                    Refer to the Kubernetes API documentation for the fields of the metadata field.
                    spec
                    AWSClusterTemplateSpec


                    template
                    AWSClusterTemplateResource

                    AWSClusterTemplateResource

                    (Appears on:AWSClusterTemplateSpec)

                    Field Description
                    metadata
                    Cluster API api/v1beta1.ObjectMeta
                    (Optional)

                    Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

                    Refer to the Kubernetes API documentation for the fields of the metadata field.
                    spec
                    AWSClusterSpec


                    network
                    NetworkSpec

                    NetworkSpec encapsulates all things related to AWS network.

                    region
                    string

                    The AWS Region the cluster lives in.

                    sshKeyName
                    string
                    (Optional)

                    SSHKeyName is the name of the ssh key to attach to the bastion host. Valid values are empty string (do not use SSH keys), a valid SSH key name, or omitted (use the default SSH key name)

                    controlPlaneEndpoint
                    Cluster API api/v1beta1.APIEndpoint
                    (Optional)

                    ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.

                    additionalTags
                    Tags
                    (Optional)

                    AdditionalTags is an optional set of tags to add to AWS resources managed by the AWS provider, in addition to the ones added by default.

                    controlPlaneLoadBalancer
                    AWSLoadBalancerSpec
                    (Optional)

                    ControlPlaneLoadBalancer is optional configuration for customizing control plane behavior.

                    imageLookupFormat
                    string
                    (Optional)

                    ImageLookupFormat is the AMI naming format to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupOrg. Supports substitutions for {{.BaseOS}} and {{.K8sVersion}} with the base OS and kubernetes version, respectively. The BaseOS will be the value in ImageLookupBaseOS or ubuntu (the default), and the kubernetes version as defined by the packages produced by kubernetes/release without v as a prefix: 1.13.0, 1.12.5-mybuild.1, or 1.17.3. For example, the default image format of capa-ami-{{.BaseOS}}-?{{.K8sVersion}}-* will end up searching for AMIs that match the pattern capa-ami-ubuntu-?1.18.0-* for a Machine that is targeting kubernetes v1.18.0 and the ubuntu base OS. See also: https://golang.org/pkg/text/template/

                    imageLookupOrg
                    string
                    (Optional)

                    ImageLookupOrg is the AWS Organization ID to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupOrg.

                    imageLookupBaseOS
                    string

                    ImageLookupBaseOS is the name of the base operating system used to look up machine images when a machine does not specify an AMI. When set, this will be used for all cluster machines unless a machine specifies a different ImageLookupBaseOS.

                    bastion
                    Bastion
                    (Optional)

                    Bastion contains options to configure the bastion host.

                    identityRef
                    AWSIdentityReference
                    (Optional)

                    IdentityRef is a reference to a identity to be used when reconciling this cluster

                    AWSClusterTemplateSpec

                    (Appears on:AWSClusterTemplate)

                    AWSClusterTemplateSpec defines the desired state of AWSClusterTemplate.

                    Field Description
                    template
                    AWSClusterTemplateResource

                    AWSIdentityKind (string alias)

                    (Appears on:AWSIdentityReference)

                    AWSIdentityKind defines allowed AWS identity types.

                    AWSIdentityReference

                    (Appears on:AWSClusterRoleIdentitySpec, AWSClusterSpec)

                    AWSIdentityReference specifies a identity.

                    Field Description
                    name
                    string

                    Name of the identity.

                    kind
                    AWSIdentityKind

                    Kind of the identity.

                    AWSLoadBalancerSpec

                    (Appears on:AWSClusterSpec)

                    AWSLoadBalancerSpec defines the desired state of an AWS load balancer.

                    Field Description
                    name
                    string
                    (Optional)

                    Name sets the name of the classic ELB load balancer. As per AWS, the name must be unique within your set of load balancers for the region, must have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and cannot begin or end with a hyphen. Once set, the value cannot be changed.

                    scheme
                    ClassicELBScheme
                    (Optional)

                    Scheme sets the scheme of the load balancer (defaults to internet-facing)

                    crossZoneLoadBalancing
                    bool
                    (Optional)

                    CrossZoneLoadBalancing enables the classic ELB cross availability zone balancing.

                    With cross-zone load balancing, each load balancer node for your Classic Load Balancer distributes requests evenly across the registered instances in all enabled Availability Zones. If cross-zone load balancing is disabled, each load balancer node distributes requests evenly across the registered instances in its Availability Zone only.

                    Defaults to false.

                    subnets
                    []string
                    (Optional)

                    Subnets sets the subnets that should be applied to the control plane load balancer (defaults to discovered subnets for managed VPCs or an empty set for unmanaged VPCs)

                    additionalSecurityGroups
                    []string
                    (Optional)

                    AdditionalSecurityGroups sets the security groups used by the load balancer. Expected to be security group IDs This is optional - if not provided new security groups will be created for the load balancer

                    AWSMachine

                    AWSMachine is the schema for Amazon EC2 machines.

                    Field Description
                    metadata
                    Kubernetes meta/v1.ObjectMeta
                    Refer to the Kubernetes API documentation for the fields of the metadata field.
                    spec
                    AWSMachineSpec


                    providerID
                    string

                    ProviderID is the unique identifier as specified by the cloud provider.

                    instanceID
                    string

                    InstanceID is the EC2 instance ID for this machine.

                    ami
                    AMIReference

                    AMI is the reference to the AMI from which to create the machine instance.

                    imageLookupFormat
                    string
                    (Optional)

                    ImageLookupFormat is the AMI naming format to look up the image for this machine It will be ignored if an explicit AMI is set. Supports substitutions for {{.BaseOS}} and {{.K8sVersion}} with the base OS and kubernetes version, respectively. The BaseOS will be the value in ImageLookupBaseOS or ubuntu (the default), and the kubernetes version as defined by the packages produced by kubernetes/release without v as a prefix: 1.13.0, 1.12.5-mybuild.1, or 1.17.3. For example, the default image format of capa-ami-{{.BaseOS}}-?{{.K8sVersion}}-* will end up searching for AMIs that match the pattern capa-ami-ubuntu-?1.18.0-* for a Machine that is targeting kubernetes v1.18.0 and the ubuntu base OS. See also: https://golang.org/pkg/text/template/

                    imageLookupOrg
                    string

                    ImageLookupOrg is the AWS Organization ID to use for image lookup if AMI is not set.

                    imageLookupBaseOS
                    string

                    ImageLookupBaseOS is the name of the base operating system to use for image lookup the AMI is not set.

                    instanceType
                    string

                    InstanceType is the type of instance to create. Example: m4.xlarge

                    additionalTags
                    Tags
                    (Optional)

                    AdditionalTags is an optional set of tags to add to an instance, in addition to the ones added by default by the AWS provider. If both the AWSCluster and the AWSMachine specify the same tag name with different values, the AWSMachine’s value takes precedence.

                    iamInstanceProfile
                    string
                    (Optional)

                    IAMInstanceProfile is a name of an IAM instance profile to assign to the instance

                    publicIP
                    bool
                    (Optional)

                    PublicIP specifies whether the instance should get a public IP. Precedence for this setting is as follows: 1. This field if set 2. Cluster/flavor setting 3. Subnet default

                    additionalSecurityGroups
                    []AWSResourceReference
                    (Optional)

                    AdditionalSecurityGroups is an array of references to security groups that should be applied to the instance. These security groups would be set in addition to any security groups defined at the cluster level or in the actuator. It is possible to specify either IDs of Filters. Using Filters will cause additional requests to AWS API and if tags change the attached security groups might change too.

                    failureDomain
                    string

                    FailureDomain is the failure domain unique identifier this Machine should be attached to, as defined in Cluster API. For this infrastructure provider, the ID is equivalent to an AWS Availability Zone. If multiple subnets are matched for the availability zone, the first one returned is picked.

                    subnet
                    AWSResourceReference
                    (Optional)

                    Subnet is a reference to the subnet to use for this instance. If not specified, the cluster subnet will be used.

                    sshKeyName
                    string
                    (Optional)

                    SSHKeyName is the name of the ssh key to attach to the instance. Valid values are empty string (do not use SSH keys), a valid SSH key name, or omitted (use the default SSH key name)

                    rootVolume
                    Volume
                    (Optional)

                    RootVolume encapsulates the configuration options for the root volume

                    nonRootVolumes
                    []Volume
                    (Optional)

                    Configuration options for the non root storage volumes.

                    networkInterfaces
                    []string
                    (Optional)

                    NetworkInterfaces is a list of ENIs to associate with the instance. A maximum of 2 may be specified.

                    uncompressedUserData
                    bool
                    (Optional)

                    UncompressedUserData specify whether the user data is gzip-compressed before it is sent to ec2 instance. cloud-init has built-in support for gzip-compressed user data user data stored in aws secret manager is always gzip-compressed.

                    cloudInit
                    CloudInit
                    (Optional)

                    CloudInit defines options related to the bootstrapping systems where CloudInit is used.

                    spotMarketOptions
                    SpotMarketOptions
                    (Optional)

                    SpotMarketOptions allows users to configure instances to be run using AWS Spot instances.

                    tenancy
                    string
                    (Optional)

                    Tenancy indicates if instance should run on shared or single-tenant hardware.

                    status
                    AWSMachineStatus

                    AWSMachineProviderConditionType (string alias)

                    AWSMachineProviderConditionType is a valid value for AWSMachineProviderCondition.Type.

                    AWSMachineSpec

                    (Appears on:AWSMachine, AWSMachineTemplateResource)

                    AWSMachineSpec defines the desired state of an Amazon EC2 instance.

                    Field Description
                    providerID
                    string

                    ProviderID is the unique identifier as specified by the cloud provider.

                    instanceID
                    string

                    InstanceID is the EC2 instance ID for this machine.

                    ami
                    AMIReference

                    AMI is the reference to the AMI from which to create the machine instance.

                    imageLookupFormat
                    string
                    (Optional)

                    ImageLookupFormat is the AMI naming format to look up the image for this machine It will be ignored if an explicit AMI is set. Supports substitutions for {{.BaseOS}} and {{.K8sVersion}} with the base OS and kubernetes version, respectively. The BaseOS will be the value in ImageLookupBaseOS or ubuntu (the default), and the kubernetes version as defined by the packages produced by kubernetes/release without v as a prefix: 1.13.0, 1.12.5-mybuild.1, or 1.17.3. For example, the default image format of capa-ami-{{.BaseOS}}-?{{.K8sVersion}}-* will end up searching for AMIs that match the pattern capa-ami-ubuntu-?1.18.0-* for a Machine that is targeting kubernetes v1.18.0 and the ubuntu base OS. See also: https://golang.org/pkg/text/template/

                    imageLookupOrg
                    string

                    ImageLookupOrg is the AWS Organization ID to use for image lookup if AMI is not set.

                    imageLookupBaseOS
                    string

                    ImageLookupBaseOS is the name of the base operating system to use for image lookup the AMI is not set.

                    instanceType
                    string

                    InstanceType is the type of instance to create. Example: m4.xlarge

                    additionalTags
                    Tags
                    (Optional)

                    AdditionalTags is an optional set of tags to add to an instance, in addition to the ones added by default by the AWS provider. If both the AWSCluster and the AWSMachine specify the same tag name with different values, the AWSMachine’s value takes precedence.

                    iamInstanceProfile
                    string
                    (Optional)

                    IAMInstanceProfile is a name of an IAM instance profile to assign to the instance

                    publicIP
                    bool
                    (Optional)

                    PublicIP specifies whether the instance should get a public IP. Precedence for this setting is as follows: 1. This field if set 2. Cluster/flavor setting 3. Subnet default

                    additionalSecurityGroups
                    []AWSResourceReference
                    (Optional)

                    AdditionalSecurityGroups is an array of references to security groups that should be applied to the instance. These security groups would be set in addition to any security groups defined at the cluster level or in the actuator. It is possible to specify either IDs of Filters. Using Filters will cause additional requests to AWS API and if tags change the attached security groups might change too.

                    failureDomain
                    string

                    FailureDomain is the failure domain unique identifier this Machine should be attached to, as defined in Cluster API. For this infrastructure provider, the ID is equivalent to an AWS Availability Zone. If multiple subnets are matched for the availability zone, the first one returned is picked.

                    subnet
                    AWSResourceReference
                    (Optional)

                    Subnet is a reference to the subnet to use for this instance. If not specified, the cluster subnet will be used.

                    sshKeyName
                    string
                    (Optional)

                    SSHKeyName is the name of the ssh key to attach to the instance. Valid values are empty string (do not use SSH keys), a valid SSH key name, or omitted (use the default SSH key name)

                    rootVolume
                    Volume
                    (Optional)

                    RootVolume encapsulates the configuration options for the root volume

                    nonRootVolumes
                    []Volume
                    (Optional)

                    Configuration options for the non root storage volumes.

                    networkInterfaces
                    []string
                    (Optional)

                    NetworkInterfaces is a list of ENIs to associate with the instance. A maximum of 2 may be specified.

                    uncompressedUserData
                    bool
                    (Optional)

                    UncompressedUserData specify whether the user data is gzip-compressed before it is sent to ec2 instance. cloud-init has built-in support for gzip-compressed user data user data stored in aws secret manager is always gzip-compressed.

                    cloudInit
                    CloudInit
                    (Optional)

                    CloudInit defines options related to the bootstrapping systems where CloudInit is used.

                    spotMarketOptions
                    SpotMarketOptions
                    (Optional)

                    SpotMarketOptions allows users to configure instances to be run using AWS Spot instances.

                    tenancy
                    string
                    (Optional)

                    Tenancy indicates if instance should run on shared or single-tenant hardware.

                    AWSMachineStatus

                    (Appears on:AWSMachine)

                    AWSMachineStatus defines the observed state of AWSMachine.

                    Field Description
                    ready
                    bool
                    (Optional)

                    Ready is true when the provider resource is ready.

                    interruptible
                    bool
                    (Optional)

                    Interruptible reports that this machine is using spot instances and can therefore be interrupted by CAPI when it receives a notice that the spot instance is to be terminated by AWS. This will be set to true when SpotMarketOptions is not nil (i.e. this machine is using a spot instance).

                    addresses
                    []Cluster API api/v1beta1.MachineAddress

                    Addresses contains the AWS instance associated addresses.

                    instanceState
                    InstanceState
                    (Optional)

                    InstanceState is the state of the AWS instance for this machine.

                    failureReason
                    Cluster API errors.MachineStatusError
                    (Optional)

                    FailureReason will be set in the event that there is a terminal problem reconciling the Machine and will contain a succinct value suitable for machine interpretation.

                    This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Machine’s spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.

                    Any transient errors that occur during the reconciliation of Machines can be added as events to the Machine object and/or logged in the controller’s output.

                    failureMessage
                    string
                    (Optional)

                    FailureMessage will be set in the event that there is a terminal problem reconciling the Machine and will contain a more verbose string suitable for logging and human consumption.

                    This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Machine’s spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.

                    Any transient errors that occur during the reconciliation of Machines can be added as events to the Machine object and/or logged in the controller’s output.

                    conditions
                    Cluster API api/v1beta1.Conditions
                    (Optional)

                    Conditions defines current service state of the AWSMachine.

                    AWSMachineTemplate

                    AWSMachineTemplate is the schema for the Amazon EC2 Machine Templates API.

                    Field Description
                    metadata
                    Kubernetes meta/v1.ObjectMeta
                    Refer to the Kubernetes API documentation for the fields of the metadata field.
                    spec
                    AWSMachineTemplateSpec


                    template
                    AWSMachineTemplateResource

                    AWSMachineTemplateResource

                    (Appears on:AWSMachineTemplateSpec)

                    AWSMachineTemplateResource describes the data needed to create am AWSMachine from a template.

                    Field Description
                    metadata
                    Cluster API api/v1beta1.ObjectMeta
                    (Optional)

                    Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

                    Refer to the Kubernetes API documentation for the fields of the metadata field.
                    spec
                    AWSMachineSpec

                    Spec is the specification of the desired behavior of the machine.



                    providerID
                    string

                    ProviderID is the unique identifier as specified by the cloud provider.

                    instanceID
                    string

                    InstanceID is the EC2 instance ID for this machine.

                    ami
                    AMIReference

                    AMI is the reference to the AMI from which to create the machine instance.

                    imageLookupFormat
                    string
                    (Optional)

                    ImageLookupFormat is the AMI naming format to look up the image for this machine It will be ignored if an explicit AMI is set. Supports substitutions for {{.BaseOS}} and {{.K8sVersion}} with the base OS and kubernetes version, respectively. The BaseOS will be the value in ImageLookupBaseOS or ubuntu (the default), and the kubernetes version as defined by the packages produced by kubernetes/release without v as a prefix: 1.13.0, 1.12.5-mybuild.1, or 1.17.3. For example, the default image format of capa-ami-{{.BaseOS}}-?{{.K8sVersion}}-* will end up searching for AMIs that match the pattern capa-ami-ubuntu-?1.18.0-* for a Machine that is targeting kubernetes v1.18.0 and the ubuntu base OS. See also: https://golang.org/pkg/text/template/

                    imageLookupOrg
                    string

                    ImageLookupOrg is the AWS Organization ID to use for image lookup if AMI is not set.

                    imageLookupBaseOS
                    string

                    ImageLookupBaseOS is the name of the base operating system to use for image lookup the AMI is not set.

                    instanceType
                    string

                    InstanceType is the type of instance to create. Example: m4.xlarge

                    additionalTags
                    Tags
                    (Optional)

                    AdditionalTags is an optional set of tags to add to an instance, in addition to the ones added by default by the AWS provider. If both the AWSCluster and the AWSMachine specify the same tag name with different values, the AWSMachine’s value takes precedence.

                    iamInstanceProfile
                    string
                    (Optional)

                    IAMInstanceProfile is a name of an IAM instance profile to assign to the instance

                    publicIP
                    bool
                    (Optional)

                    PublicIP specifies whether the instance should get a public IP. Precedence for this setting is as follows: 1. This field if set 2. Cluster/flavor setting 3. Subnet default

                    additionalSecurityGroups
                    []AWSResourceReference
                    (Optional)

                    AdditionalSecurityGroups is an array of references to security groups that should be applied to the instance. These security groups would be set in addition to any security groups defined at the cluster level or in the actuator. It is possible to specify either IDs of Filters. Using Filters will cause additional requests to AWS API and if tags change the attached security groups might change too.

                    failureDomain
                    string

                    FailureDomain is the failure domain unique identifier this Machine should be attached to, as defined in Cluster API. For this infrastructure provider, the ID is equivalent to an AWS Availability Zone. If multiple subnets are matched for the availability zone, the first one returned is picked.

                    subnet
                    AWSResourceReference
                    (Optional)

                    Subnet is a reference to the subnet to use for this instance. If not specified, the cluster subnet will be used.

                    sshKeyName
                    string
                    (Optional)

                    SSHKeyName is the name of the ssh key to attach to the instance. Valid values are empty string (do not use SSH keys), a valid SSH key name, or omitted (use the default SSH key name)

                    rootVolume
                    Volume
                    (Optional)

                    RootVolume encapsulates the configuration options for the root volume

                    nonRootVolumes
                    []Volume
                    (Optional)

                    Configuration options for the non root storage volumes.

                    networkInterfaces
                    []string
                    (Optional)

                    NetworkInterfaces is a list of ENIs to associate with the instance. A maximum of 2 may be specified.

                    uncompressedUserData
                    bool
                    (Optional)

                    UncompressedUserData specify whether the user data is gzip-compressed before it is sent to ec2 instance. cloud-init has built-in support for gzip-compressed user data user data stored in aws secret manager is always gzip-compressed.

                    cloudInit
                    CloudInit
                    (Optional)

                    CloudInit defines options related to the bootstrapping systems where CloudInit is used.

                    spotMarketOptions
                    SpotMarketOptions
                    (Optional)

                    SpotMarketOptions allows users to configure instances to be run using AWS Spot instances.

                    tenancy
                    string
                    (Optional)

                    Tenancy indicates if instance should run on shared or single-tenant hardware.

                    AWSMachineTemplateSpec

                    (Appears on:AWSMachineTemplate)

                    AWSMachineTemplateSpec defines the desired state of AWSMachineTemplate.

                    Field Description
                    template
                    AWSMachineTemplateResource

                    AWSResourceReference

                    (Appears on:AWSMachineSpec)

                    AWSResourceReference is a reference to a specific AWS resource by ID, ARN, or filters. Only one of ID, ARN or Filters may be specified. Specifying more than one will result in a validation error.

                    Field Description
                    id
                    string
                    (Optional)

                    ID of resource

                    arn
                    string
                    (Optional)

                    ARN of resource

                    filters
                    []Filter
                    (Optional)

                    Filters is a set of key/value pairs used to identify a resource They are applied according to the rules defined by the AWS API: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Filtering.html

                    AWSRoleSpec

                    (Appears on:AWSClusterRoleIdentitySpec)

                    AWSRoleSpec defines the specifications for all identities based around AWS roles.

                    Field Description
                    roleARN
                    string

                    The Amazon Resource Name (ARN) of the role to assume.

                    sessionName
                    string

                    An identifier for the assumed role session

                    durationSeconds
                    int32

                    The duration, in seconds, of the role session before it is renewed.

                    inlinePolicy
                    string

                    An IAM policy as a JSON-encoded string that you want to use as an inline session policy.

                    policyARNs
                    []string

                    The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.

                    AZSelectionScheme (string alias)

                    (Appears on:VPCSpec)

                    AZSelectionScheme defines the scheme of selecting AZs.

                    AllowedNamespaces

                    (Appears on:AWSClusterIdentitySpec)

                    AllowedNamespaces is a selector of namespaces that AWSClusters can use this ClusterPrincipal from. This is a standard Kubernetes LabelSelector, a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed.

                    Field Description
                    list
                    []string
                    (Optional)

                    An nil or empty list indicates that AWSClusters cannot use the identity from any namespace.

                    selector
                    Kubernetes meta/v1.LabelSelector
                    (Optional)

                    An empty selector indicates that AWSClusters cannot use this AWSClusterIdentity from any namespace.

                    Bastion

                    (Appears on:AWSClusterSpec)

                    Bastion defines a bastion host.

                    Field Description
                    enabled
                    bool
                    (Optional)

                    Enabled allows this provider to create a bastion host instance with a public ip to access the VPC private network.

                    disableIngressRules
                    bool
                    (Optional)

                    DisableIngressRules will ensure there are no Ingress rules in the bastion host’s security group. Requires AllowedCIDRBlocks to be empty.

                    allowedCIDRBlocks
                    []string
                    (Optional)

                    AllowedCIDRBlocks is a list of CIDR blocks allowed to access the bastion host. They are set as ingress rules for the Bastion host’s Security Group (defaults to 0.0.0.0/0).

                    instanceType
                    string

                    InstanceType will use the specified instance type for the bastion. If not specified, Cluster API Provider AWS will use t3.micro for all regions except us-east-1, where t2.micro will be the default.

                    ami
                    string
                    (Optional)

                    AMI will use the specified AMI to boot the bastion. If not specified, the AMI will default to one picked out in public space.

                    BuildParams

                    BuildParams is used to build tags around an aws resource.

                    Field Description
                    Lifecycle
                    ResourceLifecycle

                    Lifecycle determines the resource lifecycle.

                    ClusterName
                    string

                    ClusterName is the cluster associated with the resource.

                    ResourceID
                    string

                    ResourceID is the unique identifier of the resource to be tagged.

                    Name
                    string
                    (Optional)

                    Name is the name of the resource, it’s applied as the tag “Name” on AWS.

                    Role
                    string
                    (Optional)

                    Role is the role associated to the resource.

                    Additional
                    Tags
                    (Optional)

                    Any additional tags to be added to the resource.

                    CNIIngressRule

                    CNIIngressRule defines an AWS ingress rule for CNI requirements.

                    Field Description
                    description
                    string
                    protocol
                    SecurityGroupProtocol
                    fromPort
                    int64
                    toPort
                    int64

                    CNIIngressRules ([]../../api/v1beta1.CNIIngressRule alias)

                    (Appears on:CNISpec)

                    CNIIngressRules is a slice of CNIIngressRule.

                    CNISpec

                    (Appears on:NetworkSpec)

                    CNISpec defines configuration for CNI.

                    Field Description
                    cniIngressRules
                    CNIIngressRules

                    CNIIngressRules specify rules to apply to control plane and worker node security groups. The source for the rule will be set to control plane and worker security group IDs.

                    ClassicELB

                    (Appears on:NetworkStatus)

                    ClassicELB defines an AWS classic load balancer.

                    Field Description
                    name
                    string

                    The name of the load balancer. It must be unique within the set of load balancers defined in the region. It also serves as identifier.

                    dnsName
                    string

                    DNSName is the dns name of the load balancer.

                    scheme
                    ClassicELBScheme

                    Scheme is the load balancer scheme, either internet-facing or private.

                    availabilityZones
                    []string

                    AvailabilityZones is an array of availability zones in the VPC attached to the load balancer.

                    subnetIds
                    []string

                    SubnetIDs is an array of subnets in the VPC attached to the load balancer.

                    securityGroupIds
                    []string

                    SecurityGroupIDs is an array of security groups assigned to the load balancer.

                    listeners
                    []ClassicELBListener

                    Listeners is an array of classic elb listeners associated with the load balancer. There must be at least one.

                    healthChecks
                    ClassicELBHealthCheck

                    HealthCheck is the classic elb health check associated with the load balancer.

                    attributes
                    ClassicELBAttributes

                    Attributes defines extra attributes associated with the load balancer.

                    tags
                    map[string]string

                    Tags is a map of tags associated with the load balancer.

                    ClassicELBAttributes

                    (Appears on:ClassicELB)

                    ClassicELBAttributes defines extra attributes associated with a classic load balancer.

                    Field Description
                    idleTimeout
                    time.Duration

                    IdleTimeout is time that the connection is allowed to be idle (no data has been sent over the connection) before it is closed by the load balancer.

                    crossZoneLoadBalancing
                    bool
                    (Optional)

                    CrossZoneLoadBalancing enables the classic load balancer load balancing.

                    ClassicELBHealthCheck

                    (Appears on:ClassicELB)

                    ClassicELBHealthCheck defines an AWS classic load balancer health check.

                    Field Description
                    target
                    string
                    interval
                    time.Duration
                    timeout
                    time.Duration
                    healthyThreshold
                    int64
                    unhealthyThreshold
                    int64

                    ClassicELBListener

                    (Appears on:ClassicELB)

                    ClassicELBListener defines an AWS classic load balancer listener.

                    Field Description
                    protocol
                    ClassicELBProtocol
                    port
                    int64
                    instanceProtocol
                    ClassicELBProtocol
                    instancePort
                    int64

                    ClassicELBProtocol (string alias)

                    (Appears on:ClassicELBListener)

                    ClassicELBProtocol defines listener protocols for a classic load balancer.

                    ClassicELBScheme (string alias)

                    (Appears on:AWSLoadBalancerSpec, ClassicELB)

                    ClassicELBScheme defines the scheme of a classic load balancer.

                    CloudInit

                    (Appears on:AWSMachineSpec)

                    CloudInit defines options related to the bootstrapping systems where CloudInit is used.

                    Field Description
                    insecureSkipSecretsManager
                    bool

                    InsecureSkipSecretsManager, when set to true will not use AWS Secrets Manager or AWS Systems Manager Parameter Store to ensure privacy of userdata. By default, a cloud-init boothook shell script is prepended to download the userdata from Secrets Manager and additionally delete the secret.

                    secretCount
                    int32
                    (Optional)

                    SecretCount is the number of secrets used to form the complete secret

                    secretPrefix
                    string
                    (Optional)

                    SecretPrefix is the prefix for the secret name. This is stored temporarily, and deleted when the machine registers as a node against the workload cluster.

                    secureSecretsBackend
                    SecretBackend
                    (Optional)

                    SecureSecretsBackend, when set to parameter-store will utilize the AWS Systems Manager Parameter Storage to distribute secrets. By default or with the value of secrets-manager, will use AWS Secrets Manager instead.

                    EKSAMILookupType (string alias)

                    (Appears on:AMIReference)

                    EKSAMILookupType specifies which AWS AMI to use for a AWSMachine and AWSMachinePool.

                    Filter

                    (Appears on:AWSResourceReference)

                    Filter is a filter used to identify an AWS resource.

                    Field Description
                    name
                    string

                    Name of the filter. Filter names are case-sensitive.

                    values
                    []string

                    Values includes one or more filter values. Filter values are case-sensitive.

                    IngressRule

                    IngressRule defines an AWS ingress rule for security groups.

                    Field Description
                    description
                    string
                    protocol
                    SecurityGroupProtocol
                    fromPort
                    int64
                    toPort
                    int64
                    cidrBlocks
                    []string
                    (Optional)

                    List of CIDR blocks to allow access from. Cannot be specified with SourceSecurityGroupID.

                    sourceSecurityGroupIds
                    []string
                    (Optional)

                    The security group id to allow access from. Cannot be specified with CidrBlocks.

                    IngressRules ([]../../api/v1beta1.IngressRule alias)

                    (Appears on:SecurityGroup)

                    IngressRules is a slice of AWS ingress rules for security groups.

                    Instance

                    (Appears on:AWSClusterStatus)

                    Instance describes an AWS instance.

                    Field Description
                    id
                    string
                    instanceState
                    InstanceState

                    The current state of the instance.

                    type
                    string

                    The instance type.

                    subnetId
                    string

                    The ID of the subnet of the instance.

                    imageId
                    string

                    The ID of the AMI used to launch the instance.

                    sshKeyName
                    string

                    The name of the SSH key pair.

                    securityGroupIds
                    []string

                    SecurityGroupIDs are one or more security group IDs this instance belongs to.

                    userData
                    string

                    UserData is the raw data script passed to the instance which is run upon bootstrap. This field must not be base64 encoded and should only be used when running a new instance.

                    iamProfile
                    string

                    The name of the IAM instance profile associated with the instance, if applicable.

                    addresses
                    []Cluster API api/v1beta1.MachineAddress

                    Addresses contains the AWS instance associated addresses.

                    privateIp
                    string

                    The private IPv4 address assigned to the instance.

                    publicIp
                    string

                    The public IPv4 address assigned to the instance, if applicable.

                    enaSupport
                    bool

                    Specifies whether enhanced networking with ENA is enabled.

                    ebsOptimized
                    bool

                    Indicates whether the instance is optimized for Amazon EBS I/O.

                    rootVolume
                    Volume
                    (Optional)

                    Configuration options for the root storage volume.

                    nonRootVolumes
                    []Volume
                    (Optional)

                    Configuration options for the non root storage volumes.

                    networkInterfaces
                    []string

                    Specifies ENIs attached to instance

                    tags
                    map[string]string

                    The tags associated with the instance.

                    availabilityZone
                    string

                    Availability zone of instance

                    spotMarketOptions
                    SpotMarketOptions

                    SpotMarketOptions option for configuring instances to be run using AWS Spot instances.

                    tenancy
                    string
                    (Optional)

                    Tenancy indicates if instance should run on shared or single-tenant hardware.

                    volumeIDs
                    []string
                    (Optional)

                    IDs of the instance’s volumes

                    InstanceState (string alias)

                    (Appears on:AWSMachineStatus, Instance)

                    InstanceState describes the state of an AWS instance.

                    NetworkSpec

                    (Appears on:AWSClusterSpec)

                    NetworkSpec encapsulates all things related to AWS network.

                    Field Description
                    vpc
                    VPCSpec
                    (Optional)

                    VPC configuration.

                    subnets
                    Subnets
                    (Optional)

                    Subnets configuration.

                    cni
                    CNISpec
                    (Optional)

                    CNI configuration

                    securityGroupOverrides
                    map[../../api/v1beta1.SecurityGroupRole]string
                    (Optional)

                    SecurityGroupOverrides is an optional set of security groups to use for cluster instances This is optional - if not provided new security groups will be created for the cluster

                    NetworkStatus

                    (Appears on:AWSClusterStatus)

                    NetworkStatus encapsulates AWS networking resources.

                    Field Description
                    securityGroups
                    map[../../api/v1beta1.SecurityGroupRole]../../api/v1beta1.SecurityGroup

                    SecurityGroups is a map from the role/kind of the security group to its unique name, if any.

                    apiServerElb
                    ClassicELB

                    APIServerELB is the Kubernetes api server classic load balancer.

                    ResourceLifecycle (string alias)

                    (Appears on:BuildParams)

                    ResourceLifecycle configures the lifecycle of a resource.

                    RouteTable

                    RouteTable defines an AWS routing table.

                    Field Description
                    id
                    string

                    SecretBackend (string alias)

                    (Appears on:CloudInit)

                    SecretBackend defines variants for backend secret storage.

                    SecurityGroup

                    (Appears on:NetworkStatus)

                    SecurityGroup defines an AWS security group.

                    Field Description
                    id
                    string

                    ID is a unique identifier.

                    name
                    string

                    Name is the security group name.

                    ingressRule
                    IngressRules
                    (Optional)

                    IngressRules is the inbound rules associated with the security group.

                    tags
                    Tags

                    Tags is a map of tags associated with the security group.

                    SecurityGroupProtocol (string alias)

                    (Appears on:CNIIngressRule, IngressRule)

                    SecurityGroupProtocol defines the protocol type for a security group rule.

                    SecurityGroupRole (string alias)

                    SecurityGroupRole defines the unique role of a security group.

                    SpotMarketOptions

                    (Appears on:AWSMachineSpec, Instance)

                    SpotMarketOptions defines the options available to a user when configuring Machines to run on Spot instances. Most users should provide an empty struct.

                    Field Description
                    maxPrice
                    string
                    (Optional)

                    MaxPrice defines the maximum price the user is willing to pay for Spot VM instances

                    SubnetSpec

                    SubnetSpec configures an AWS Subnet.

                    Field Description
                    id
                    string

                    ID defines a unique identifier to reference this resource.

                    cidrBlock
                    string

                    CidrBlock is the CIDR block to be used when the provider creates a managed VPC.

                    availabilityZone
                    string

                    AvailabilityZone defines the availability zone to use for this subnet in the cluster’s region.

                    isPublic
                    bool
                    (Optional)

                    IsPublic defines the subnet as a public subnet. A subnet is public when it is associated with a route table that has a route to an internet gateway.

                    routeTableId
                    string
                    (Optional)

                    RouteTableID is the routing table id associated with the subnet.

                    natGatewayId
                    string
                    (Optional)

                    NatGatewayID is the NAT gateway id associated with the subnet. Ignored unless the subnet is managed by the provider, in which case this is set on the public subnet where the NAT gateway resides. It is then used to determine routes for private subnets in the same AZ as the public subnet.

                    tags
                    Tags

                    Tags is a collection of tags describing the resource.

                    Subnets ([]../../api/v1beta1.SubnetSpec alias)

                    (Appears on:NetworkSpec)

                    Subnets is a slice of Subnet.

                    Tags (map[string]string alias)

                    (Appears on:AWSClusterSpec, AWSMachineSpec, BuildParams, SecurityGroup, SubnetSpec, VPCSpec)

                    Tags defines a map of tags.

                    VPCSpec

                    (Appears on:NetworkSpec)

                    VPCSpec configures an AWS VPC.

                    Field Description
                    id
                    string

                    ID is the vpc-id of the VPC this provider should use to create resources.

                    cidrBlock
                    string

                    CidrBlock is the CIDR block to be used when the provider creates a managed VPC. Defaults to 10.0.0.0/16.

                    internetGatewayId
                    string
                    (Optional)

                    InternetGatewayID is the id of the internet gateway associated with the VPC.

                    tags
                    Tags

                    Tags is a collection of tags describing the resource.

                    availabilityZoneUsageLimit
                    int

                    AvailabilityZoneUsageLimit specifies the maximum number of availability zones (AZ) that should be used in a region when automatically creating subnets. If a region has more than this number of AZs then this number of AZs will be picked randomly when creating default subnets. Defaults to 3

                    availabilityZoneSelection
                    AZSelectionScheme

                    AvailabilityZoneSelection specifies how AZs should be selected if there are more AZs in a region than specified by AvailabilityZoneUsageLimit. There are 2 selection schemes: Ordered - selects based on alphabetical order Random - selects AZs randomly in a region Defaults to Ordered

                    Volume

                    (Appears on:AWSMachineSpec, Instance)

                    Volume encapsulates the configuration options for the storage device.

                    Field Description
                    deviceName
                    string
                    (Optional)

                    Device name

                    size
                    int64

                    Size specifies size (in Gi) of the storage device. Must be greater than the image snapshot size or 8 (whichever is greater).

                    type
                    VolumeType
                    (Optional)

                    Type is the type of the volume (e.g. gp2, io1, etc…).

                    iops
                    int64
                    (Optional)

                    IOPS is the number of IOPS requested for the disk. Not applicable to all types.

                    throughput
                    int64
                    (Optional)

                    Throughput to provision in MiB/s supported for the volume type. Not applicable to all types.

                    encrypted
                    bool
                    (Optional)

                    Encrypted is whether the volume should be encrypted or not.

                    encryptionKey
                    string
                    (Optional)

                    EncryptionKey is the KMS key to use to encrypt the volume. Can be either a KMS key ID or ARN. If Encrypted is set and this is omitted, the default AWS key will be used. The key must already exist and be accessible by the controller.

                    VolumeType (string alias)

                    (Appears on:Volume)

                    VolumeType describes the EBS volume type. See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html

                    ASGStatus (string alias)

                    (Appears on:AWSMachinePoolStatus, AutoScalingGroup)

                    ASGStatus is a status string returned by the autoscaling API.

                    AWSFargateProfile

                    AWSFargateProfile is the Schema for the awsfargateprofiles API.

                    Field Description
                    metadata
                    Kubernetes meta/v1.ObjectMeta
                    Refer to the Kubernetes API documentation for the fields of the metadata field.
                    spec
                    FargateProfileSpec


                    clusterName
                    string

                    ClusterName is the name of the Cluster this object belongs to.

                    profileName
                    string

                    ProfileName specifies the profile name.

                    subnetIDs
                    []string
                    (Optional)

                    SubnetIDs specifies which subnets are used for the auto scaling group of this nodegroup.

                    additionalTags
                    Cluster API AWS api/v1beta1.Tags
                    (Optional)

                    AdditionalTags is an optional set of tags to add to AWS resources managed by the AWS provider, in addition to the ones added by default.

                    roleName
                    string
                    (Optional)

                    RoleName specifies the name of IAM role for this fargate pool If the role is pre-existing we will treat it as unmanaged and not delete it on deletion. If the EKSEnableIAM feature flag is true and no name is supplied then a role is created.

                    selectors
                    []FargateSelector

                    Selectors specify fargate pod selectors.

                    status
                    FargateProfileStatus

                    AWSLaunchTemplate

                    (Appears on:AWSMachinePoolSpec)

                    AWSLaunchTemplate defines the desired state of AWSLaunchTemplate.

                    Field Description
                    name
                    string

                    The name of the launch template.

                    iamInstanceProfile
                    string

                    The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role.

                    ami
                    Cluster API AWS api/v1beta1.AMIReference
                    (Optional)

                    AMI is the reference to the AMI from which to create the machine instance.

                    imageLookupFormat
                    string
                    (Optional)

                    ImageLookupFormat is the AMI naming format to look up the image for this machine It will be ignored if an explicit AMI is set. Supports substitutions for {{.BaseOS}} and {{.K8sVersion}} with the base OS and kubernetes version, respectively. The BaseOS will be the value in ImageLookupBaseOS or ubuntu (the default), and the kubernetes version as defined by the packages produced by kubernetes/release without v as a prefix: 1.13.0, 1.12.5-mybuild.1, or 1.17.3. For example, the default image format of capa-ami-{{.BaseOS}}-?{{.K8sVersion}}-* will end up searching for AMIs that match the pattern capa-ami-ubuntu-?1.18.0-* for a Machine that is targeting kubernetes v1.18.0 and the ubuntu base OS. See also: https://golang.org/pkg/text/template/

                    imageLookupOrg
                    string

                    ImageLookupOrg is the AWS Organization ID to use for image lookup if AMI is not set.

                    imageLookupBaseOS
                    string

                    ImageLookupBaseOS is the name of the base operating system to use for image lookup the AMI is not set.

                    instanceType
                    string

                    InstanceType is the type of instance to create. Example: m4.xlarge

                    rootVolume
                    Cluster API AWS api/v1beta1.Volume
                    (Optional)

                    RootVolume encapsulates the configuration options for the root volume

                    sshKeyName
                    string
                    (Optional)

                    SSHKeyName is the name of the ssh key to attach to the instance. Valid values are empty string (do not use SSH keys), a valid SSH key name, or omitted (use the default SSH key name)

                    versionNumber
                    int64

                    VersionNumber is the version of the launch template that is applied. Typically a new version is created when at least one of the following happens: 1) A new launch template spec is applied. 2) One or more parameters in an existing template is changed. 3) A new AMI is discovered.

                    additionalSecurityGroups
                    []Cluster API AWS api/v1beta1.AWSResourceReference
                    (Optional)

                    AdditionalSecurityGroups is an array of references to security groups that should be applied to the instances. These security groups would be set in addition to any security groups defined at the cluster level or in the actuator.

                    AWSMachinePool

                    AWSMachinePool is the Schema for the awsmachinepools API.

                    Field Description
                    metadata
                    Kubernetes meta/v1.ObjectMeta
                    Refer to the Kubernetes API documentation for the fields of the metadata field.
                    spec
                    AWSMachinePoolSpec


                    providerID
                    string
                    (Optional)

                    ProviderID is the ARN of the associated ASG

                    minSize
                    int32

                    MinSize defines the minimum size of the group.

                    maxSize
                    int32

                    MaxSize defines the maximum size of the group.

                    availabilityZones
                    []string

                    AvailabilityZones is an array of availability zones instances can run in

                    subnets
                    []Cluster API AWS api/v1beta1.AWSResourceReference
                    (Optional)

                    Subnets is an array of subnet configurations

                    additionalTags
                    Cluster API AWS api/v1beta1.Tags
                    (Optional)

                    AdditionalTags is an optional set of tags to add to an instance, in addition to the ones added by default by the AWS provider.

                    awsLaunchTemplate
                    AWSLaunchTemplate

                    AWSLaunchTemplate specifies the launch template and version to use when an instance is launched.

                    mixedInstancesPolicy
                    MixedInstancesPolicy

                    MixedInstancesPolicy describes how multiple instance types will be used by the ASG.

                    providerIDList
                    []string
                    (Optional)

                    ProviderIDList are the identification IDs of machine instances provided by the provider. This field must match the provider IDs as seen on the node objects corresponding to a machine pool’s machine instances.

                    defaultCoolDown
                    Kubernetes meta/v1.Duration
                    (Optional)

                    The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. If no value is supplied by user a default value of 300 seconds is set

                    refreshPreferences
                    RefreshPreferences
                    (Optional)

                    RefreshPreferences describes set of preferences associated with the instance refresh request.

                    capacityRebalance
                    bool
                    (Optional)

                    Enable or disable the capacity rebalance autoscaling group feature

                    status
                    AWSMachinePoolStatus

                    AWSMachinePoolInstanceStatus

                    (Appears on:AWSMachinePoolStatus)

                    AWSMachinePoolInstanceStatus defines the status of the AWSMachinePoolInstance.

                    Field Description
                    instanceID
                    string
                    (Optional)

                    InstanceID is the identification of the Machine Instance within ASG

                    version
                    string
                    (Optional)

                    Version defines the Kubernetes version for the Machine Instance

                    AWSMachinePoolSpec

                    (Appears on:AWSMachinePool)

                    AWSMachinePoolSpec defines the desired state of AWSMachinePool.

                    Field Description
                    providerID
                    string
                    (Optional)

                    ProviderID is the ARN of the associated ASG

                    minSize
                    int32

                    MinSize defines the minimum size of the group.

                    maxSize
                    int32

                    MaxSize defines the maximum size of the group.

                    availabilityZones
                    []string

                    AvailabilityZones is an array of availability zones instances can run in

                    subnets
                    []Cluster API AWS api/v1beta1.AWSResourceReference
                    (Optional)

                    Subnets is an array of subnet configurations

                    additionalTags
                    Cluster API AWS api/v1beta1.Tags
                    (Optional)

                    AdditionalTags is an optional set of tags to add to an instance, in addition to the ones added by default by the AWS provider.

                    awsLaunchTemplate
                    AWSLaunchTemplate

                    AWSLaunchTemplate specifies the launch template and version to use when an instance is launched.

                    mixedInstancesPolicy
                    MixedInstancesPolicy

                    MixedInstancesPolicy describes how multiple instance types will be used by the ASG.

                    providerIDList
                    []string
                    (Optional)

                    ProviderIDList are the identification IDs of machine instances provided by the provider. This field must match the provider IDs as seen on the node objects corresponding to a machine pool’s machine instances.

                    defaultCoolDown
                    Kubernetes meta/v1.Duration
                    (Optional)

                    The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. If no value is supplied by user a default value of 300 seconds is set

                    refreshPreferences
                    RefreshPreferences
                    (Optional)

                    RefreshPreferences describes set of preferences associated with the instance refresh request.

                    capacityRebalance
                    bool
                    (Optional)

                    Enable or disable the capacity rebalance autoscaling group feature

                    AWSMachinePoolStatus

                    (Appears on:AWSMachinePool)

                    AWSMachinePoolStatus defines the observed state of AWSMachinePool.

                    Field Description
                    ready
                    bool
                    (Optional)

                    Ready is true when the provider resource is ready.

                    replicas
                    int32
                    (Optional)

                    Replicas is the most recently observed number of replicas

                    conditions
                    Cluster API api/v1beta1.Conditions
                    (Optional)

                    Conditions defines current service state of the AWSMachinePool.

                    instances
                    []AWSMachinePoolInstanceStatus
                    (Optional)

                    Instances contains the status for each instance in the pool

                    launchTemplateID
                    string

                    The ID of the launch template

                    failureReason
                    Cluster API errors.MachineStatusError
                    (Optional)

                    FailureReason will be set in the event that there is a terminal problem reconciling the Machine and will contain a succinct value suitable for machine interpretation.

                    This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Machine’s spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.

                    Any transient errors that occur during the reconciliation of Machines can be added as events to the Machine object and/or logged in the controller’s output.

                    failureMessage
                    string
                    (Optional)

                    FailureMessage will be set in the event that there is a terminal problem reconciling the Machine and will contain a more verbose string suitable for logging and human consumption.

                    This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Machine’s spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.

                    Any transient errors that occur during the reconciliation of Machines can be added as events to the Machine object and/or logged in the controller’s output.

                    asgStatus
                    ASGStatus

                    AWSManagedMachinePool

                    AWSManagedMachinePool is the Schema for the awsmanagedmachinepools API.

                    Field Description
                    metadata
                    Kubernetes meta/v1.ObjectMeta
                    Refer to the Kubernetes API documentation for the fields of the metadata field.
                    spec
                    AWSManagedMachinePoolSpec


                    eksNodegroupName
                    string
                    (Optional)

                    EKSNodegroupName specifies the name of the nodegroup in AWS corresponding to this MachinePool. If you don’t specify a name then a default name will be created based on the namespace and name of the managed machine pool.

                    availabilityZones
                    []string

                    AvailabilityZones is an array of availability zones instances can run in

                    subnetIDs
                    []string
                    (Optional)

                    SubnetIDs specifies which subnets are used for the auto scaling group of this nodegroup

                    additionalTags
                    Cluster API AWS api/v1beta1.Tags
                    (Optional)

                    AdditionalTags is an optional set of tags to add to AWS resources managed by the AWS provider, in addition to the ones added by default.

                    roleAdditionalPolicies
                    []string
                    (Optional)

                    RoleAdditionalPolicies allows you to attach additional polices to the node group role. You must enable the EKSAllowAddRoles feature flag to incorporate these into the created role.

                    roleName
                    string
                    (Optional)

                    RoleName specifies the name of IAM role for the node group. If the role is pre-existing we will treat it as unmanaged and not delete it on deletion. If the EKSEnableIAM feature flag is true and no name is supplied then a role is created.

                    amiVersion
                    string
                    (Optional)

                    AMIVersion defines the desired AMI release version. If no version number is supplied then the latest version for the Kubernetes version will be used

                    amiType
                    ManagedMachineAMIType
                    (Optional)

                    AMIType defines the AMI type

                    labels
                    map[string]string
                    (Optional)

                    Labels specifies labels for the Kubernetes node objects

                    taints
                    Taints
                    (Optional)

                    Taints specifies the taints to apply to the nodes of the machine pool

                    diskSize
                    int32
                    (Optional)

                    DiskSize specifies the root disk size

                    instanceType
                    string
                    (Optional)

                    InstanceType specifies the AWS instance type

                    scaling
                    ManagedMachinePoolScaling
                    (Optional)

                    Scaling specifies scaling for the ASG behind this pool

                    remoteAccess
                    ManagedRemoteAccess
                    (Optional)

                    RemoteAccess specifies how machines can be accessed remotely

                    providerIDList
                    []string
                    (Optional)

                    ProviderIDList are the provider IDs of instances in the autoscaling group corresponding to the nodegroup represented by this machine pool

                    capacityType
                    ManagedMachinePoolCapacityType
                    (Optional)

                    CapacityType specifies the capacity type for the ASG behind this pool

                    status
                    AWSManagedMachinePoolStatus

                    AWSManagedMachinePoolSpec

                    (Appears on:AWSManagedMachinePool)

                    AWSManagedMachinePoolSpec defines the desired state of AWSManagedMachinePool.

                    Field Description
                    eksNodegroupName
                    string
                    (Optional)

                    EKSNodegroupName specifies the name of the nodegroup in AWS corresponding to this MachinePool. If you don’t specify a name then a default name will be created based on the namespace and name of the managed machine pool.

                    availabilityZones
                    []string

                    AvailabilityZones is an array of availability zones instances can run in

                    subnetIDs
                    []string
                    (Optional)

                    SubnetIDs specifies which subnets are used for the auto scaling group of this nodegroup

                    additionalTags
                    Cluster API AWS api/v1beta1.Tags
                    (Optional)

                    AdditionalTags is an optional set of tags to add to AWS resources managed by the AWS provider, in addition to the ones added by default.

                    roleAdditionalPolicies
                    []string
                    (Optional)

                    RoleAdditionalPolicies allows you to attach additional polices to the node group role. You must enable the EKSAllowAddRoles feature flag to incorporate these into the created role.

                    roleName
                    string
                    (Optional)

                    RoleName specifies the name of IAM role for the node group. If the role is pre-existing we will treat it as unmanaged and not delete it on deletion. If the EKSEnableIAM feature flag is true and no name is supplied then a role is created.

                    amiVersion
                    string
                    (Optional)

                    AMIVersion defines the desired AMI release version. If no version number is supplied then the latest version for the Kubernetes version will be used

                    amiType
                    ManagedMachineAMIType
                    (Optional)

                    AMIType defines the AMI type

                    labels
                    map[string]string
                    (Optional)

                    Labels specifies labels for the Kubernetes node objects

                    taints
                    Taints
                    (Optional)

                    Taints specifies the taints to apply to the nodes of the machine pool

                    diskSize
                    int32
                    (Optional)

                    DiskSize specifies the root disk size

                    instanceType
                    string
                    (Optional)

                    InstanceType specifies the AWS instance type

                    scaling
                    ManagedMachinePoolScaling
                    (Optional)

                    Scaling specifies scaling for the ASG behind this pool

                    remoteAccess
                    ManagedRemoteAccess
                    (Optional)

                    RemoteAccess specifies how machines can be accessed remotely

                    providerIDList
                    []string
                    (Optional)

                    ProviderIDList are the provider IDs of instances in the autoscaling group corresponding to the nodegroup represented by this machine pool

                    capacityType
                    ManagedMachinePoolCapacityType
                    (Optional)

                    CapacityType specifies the capacity type for the ASG behind this pool

                    AWSManagedMachinePoolStatus

                    (Appears on:AWSManagedMachinePool)

                    AWSManagedMachinePoolStatus defines the observed state of AWSManagedMachinePool.

                    Field Description
                    ready
                    bool

                    Ready denotes that the AWSManagedMachinePool nodegroup has joined the cluster

                    replicas
                    int32
                    (Optional)

                    Replicas is the most recently observed number of replicas.

                    failureReason
                    Cluster API errors.MachineStatusError
                    (Optional)

                    FailureReason will be set in the event that there is a terminal problem reconciling the MachinePool and will contain a succinct value suitable for machine interpretation.

                    This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Machine’s spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.

                    Any transient errors that occur during the reconciliation of MachinePools can be added as events to the MachinePool object and/or logged in the controller’s output.

                    failureMessage
                    string
                    (Optional)

                    FailureMessage will be set in the event that there is a terminal problem reconciling the MachinePool and will contain a more verbose string suitable for logging and human consumption.

                    This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the MachinePool’s spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.

                    Any transient errors that occur during the reconciliation of MachinePools can be added as events to the MachinePool object and/or logged in the controller’s output.

                    conditions
                    Cluster API api/v1beta1.Conditions
                    (Optional)

                    Conditions defines current service state of the managed machine pool

                    AutoScalingGroup

                    AutoScalingGroup describes an AWS autoscaling group.

                    Field Description
                    id
                    string

                    The tags associated with the instance.

                    tags
                    Cluster API AWS api/v1beta1.Tags
                    name
                    string
                    desiredCapacity
                    int32
                    maxSize
                    int32
                    minSize
                    int32
                    placementGroup
                    string
                    subnets
                    []string
                    defaultCoolDown
                    Kubernetes meta/v1.Duration
                    capacityRebalance
                    bool
                    mixedInstancesPolicy
                    MixedInstancesPolicy
                    Status
                    ASGStatus
                    instances
                    []Cluster API AWS api/v1beta1.Instance

                    BlockDeviceMapping

                    BlockDeviceMapping specifies the block devices for the instance. You can specify virtual devices and EBS volumes.

                    Field Description
                    deviceName
                    string

                    The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh).

                    ebs
                    EBS
                    (Optional)

                    You can specify either VirtualName or Ebs, but not both.

                    EBS

                    (Appears on:BlockDeviceMapping)

                    EBS can be used to automatically set up EBS volumes when an instance is launched.

                    Field Description
                    encrypted
                    bool
                    (Optional)

                    Encrypted is whether the volume should be encrypted or not.

                    volumeSize
                    int64
                    (Optional)

                    The size of the volume, in GiB. This can be a number from 1-1,024 for standard, 4-16,384 for io1, 1-16,384 for gp2, and 500-16,384 for st1 and sc1. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

                    volumeType
                    string
                    (Optional)

                    The volume type For more information, see Amazon EBS Volume Types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html)

                    FargateProfileSpec

                    (Appears on:AWSFargateProfile)

                    FargateProfileSpec defines the desired state of FargateProfile.

                    Field Description
                    clusterName
                    string

                    ClusterName is the name of the Cluster this object belongs to.

                    profileName
                    string

                    ProfileName specifies the profile name.

                    subnetIDs
                    []string
                    (Optional)

                    SubnetIDs specifies which subnets are used for the auto scaling group of this nodegroup.

                    additionalTags
                    Cluster API AWS api/v1beta1.Tags
                    (Optional)

                    AdditionalTags is an optional set of tags to add to AWS resources managed by the AWS provider, in addition to the ones added by default.

                    roleName
                    string
                    (Optional)

                    RoleName specifies the name of IAM role for this fargate pool If the role is pre-existing we will treat it as unmanaged and not delete it on deletion. If the EKSEnableIAM feature flag is true and no name is supplied then a role is created.

                    selectors
                    []FargateSelector

                    Selectors specify fargate pod selectors.

                    FargateProfileStatus

                    (Appears on:AWSFargateProfile)

                    FargateProfileStatus defines the observed state of FargateProfile.

                    Field Description
                    ready
                    bool

                    Ready denotes that the FargateProfile is available.

                    failureReason
                    Cluster API errors.MachineStatusError
                    (Optional)

                    FailureReason will be set in the event that there is a terminal problem reconciling the FargateProfile and will contain a succinct value suitable for machine interpretation.

                    This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the FargateProfile’s spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.

                    Any transient errors that occur during the reconciliation of FargateProfiles can be added as events to the FargateProfile object and/or logged in the controller’s output.

                    failureMessage
                    string
                    (Optional)

                    FailureMessage will be set in the event that there is a terminal problem reconciling the FargateProfile and will contain a more verbose string suitable for logging and human consumption.

                    This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the FargateProfile’s spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.

                    Any transient errors that occur during the reconciliation of FargateProfiles can be added as events to the FargateProfile object and/or logged in the controller’s output.

                    conditions
                    Cluster API api/v1beta1.Conditions
                    (Optional)

                    Conditions defines current state of the Fargate profile.

                    FargateSelector

                    (Appears on:FargateProfileSpec)

                    FargateSelector specifies a selector for pods that should run on this fargate pool.

                    Field Description
                    labels
                    map[string]string

                    Labels specifies which pod labels this selector should match.

                    namespace
                    string

                    Namespace specifies which namespace this selector should match.

                    InstancesDistribution

                    (Appears on:MixedInstancesPolicy)

                    InstancesDistribution to configure distribution of On-Demand Instances and Spot Instances.

                    Field Description
                    onDemandAllocationStrategy
                    OnDemandAllocationStrategy
                    spotAllocationStrategy
                    SpotAllocationStrategy
                    onDemandBaseCapacity
                    int64
                    onDemandPercentageAboveBaseCapacity
                    int64

                    ManagedMachineAMIType (string alias)

                    (Appears on:AWSManagedMachinePoolSpec)

                    ManagedMachineAMIType specifies which AWS AMI to use for a managed MachinePool.

                    Value Description

                    "AL2_ARM_64"

                    Al2Arm64 is the Arm AMI type.

                    "AL2_x86_64"

                    Al2x86_64 is the default AMI type.

                    "AL2_x86_64_GPU"

                    Al2x86_64GPU is the x86-64 GPU AMI type.

                    ManagedMachinePoolCapacityType (string alias)

                    (Appears on:AWSManagedMachinePoolSpec)

                    ManagedMachinePoolCapacityType specifies the capacity type to be used for the managed MachinePool.

                    Value Description

                    "onDemand"

                    ManagedMachinePoolCapacityTypeOnDemand is the default capacity type, to launch on-demand instances.

                    "spot"

                    ManagedMachinePoolCapacityTypeSpot is the spot instance capacity type to launch spot instances.

                    ManagedMachinePoolScaling

                    (Appears on:AWSManagedMachinePoolSpec)

                    ManagedMachinePoolScaling specifies scaling options.

                    Field Description
                    minSize
                    int32
                    maxSize
                    int32

                    ManagedRemoteAccess

                    (Appears on:AWSManagedMachinePoolSpec)

                    ManagedRemoteAccess specifies remote access settings for EC2 instances.

                    Field Description
                    sshKeyName
                    string

                    SSHKeyName specifies which EC2 SSH key can be used to access machines. If left empty, the key from the control plane is used.

                    sourceSecurityGroups
                    []string

                    SourceSecurityGroups specifies which security groups are allowed access

                    public
                    bool

                    Public specifies whether to open port 22 to the public internet

                    MixedInstancesPolicy

                    (Appears on:AWSMachinePoolSpec, AutoScalingGroup)

                    MixedInstancesPolicy for an Auto Scaling group.

                    Field Description
                    instancesDistribution
                    InstancesDistribution
                    overrides
                    []Overrides

                    OnDemandAllocationStrategy (string alias)

                    (Appears on:InstancesDistribution)

                    OnDemandAllocationStrategy indicates how to allocate instance types to fulfill On-Demand capacity.

                    Overrides

                    (Appears on:MixedInstancesPolicy)

                    Overrides are used to override the instance type specified by the launch template with multiple instance types that can be used to launch On-Demand Instances and Spot Instances.

                    Field Description
                    instanceType
                    string

                    RefreshPreferences

                    (Appears on:AWSMachinePoolSpec)

                    RefreshPreferences defines the specs for instance refreshing.

                    Field Description
                    strategy
                    string
                    (Optional)

                    The strategy to use for the instance refresh. The only valid value is Rolling. A rolling update is an update that is applied to all instances in an Auto Scaling group until all instances have been updated.

                    instanceWarmup
                    int64
                    (Optional)

                    The number of seconds until a newly launched instance is configured and ready to use. During this time, the next replacement will not be initiated. The default is to use the value for the health check grace period defined for the group.

                    minHealthyPercentage
                    int64
                    (Optional)

                    The amount of capacity as a percentage in ASG that must remain healthy during an instance refresh. The default is 90.

                    SpotAllocationStrategy (string alias)

                    (Appears on:InstancesDistribution)

                    SpotAllocationStrategy indicates how to allocate instances across Spot Instance pools.

                    Tags (map[string]string alias)

                    Tags is a mapping for tags.

                    Taint

                    Taint defines the specs for a Kubernetes taint.

                    Field Description
                    effect
                    TaintEffect

                    Effect specifies the effect for the taint

                    key
                    string

                    Key is the key of the taint

                    value
                    string

                    Value is the value of the taint

                    TaintEffect (string alias)

                    (Appears on:Taint)

                    TaintEffect is the effect for a Kubernetes taint.

                    Taints ([]../../exp/api/v1beta1.Taint alias)

                    (Appears on:AWSManagedMachinePoolSpec)

                    Taints is an array of Taints.