Packages:

infrastructure.cluster.x-k8s.io/v1alpha4

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.

    Value Description

    "MachineCreated"

    MachineCreated indicates whether the machine has been created or not. If not, it should include a reason and message for the failure.

    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.

    Value Description

    "StringEquals"

    StringEquals is an AWS IAM policy condition operator.

    "StringEqualsIgnoreCase"

    StringEqualsIgnoreCase is an AWS IAM policy condition operator.

    "StringLike"

    StringLike is an AWS IAM policy condition operator.

    "StringNotEquals"

    StringNotEquals is an AWS IAM policy condition operator.

    "StringNotLike"

    StringNotLike is an AWS IAM policy 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.

    Value Description

    "AmazonLinux"

    AmazonLinux is the default AMI type.

    "AmazonLinuxGPU"

    AmazonLinuxGPU is the AmazonLinux GPU AMI type.

    Effect (string alias)

    (Appears on:StatementEntry)

    Effect defines an AWS IAM effect.

    Value Description

    "Allow"

    EffectAllow is the Allow effect in an AWS IAM policy statement entry.

    "Deny"

    EffectDeny is the Deny effect in an AWS IAM policy statement entry.

    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.

    Value Description

    "AWS"

    PrincipalAWS is the identity type covering AWS ARNs.

    "Federated"

    PrincipalFederated is the identity type covering federated identities.

    "Service"

    PrincipalService is the identity type covering AWS services.

    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.

    Value Description

    "owned"

    ResourceLifecycleOwned is the value we use when tagging resources to indicate that the resource is considered owned and managed by the cluster, and in particular that the lifecycle is tied to the lifecycle of the cluster.

    "shared"

    ResourceLifecycleShared is the value we use when tagging resources to indicate that the resource is shared between multiple clusters, and should not be destroyed if the cluster is destroyed.

    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
    string
    (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.

    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.


    Generated with gen-crd-api-reference-docs on git commit f19c125c.