Skip to content

containeraws.v1beta1.cluster

"Cluster is the Schema for the Clusters API. An Anthos cluster running on AWS."

Index

Fields

fn new

new(name)

new returns an instance of Cluster

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"ClusterSpec defines the desired state of Cluster"

fn spec.withDeletionPolicy

withDeletionPolicy(deletionPolicy)

"DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either \"Delete\" or \"Orphan\" the external resource. This field is planned to be deprecated in favor of the ManagementPolicies field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223"

fn spec.withManagementPolicies

withManagementPolicies(managementPolicies)

"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md"

fn spec.withManagementPoliciesMixin

withManagementPoliciesMixin(managementPolicies)

"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md"

Note: This function appends passed data to existing values

obj spec.forProvider

fn spec.forProvider.withAnnotations

withAnnotations(annotations)

"Optional. Annotations on the cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix and name , separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between."

fn spec.forProvider.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Optional. Annotations on the cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix and name , separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between."

Note: This function appends passed data to existing values

fn spec.forProvider.withAuthorization

withAuthorization(authorization)

"Configuration related to the cluster RBAC settings."

fn spec.forProvider.withAuthorizationMixin

withAuthorizationMixin(authorization)

"Configuration related to the cluster RBAC settings."

Note: This function appends passed data to existing values

fn spec.forProvider.withAwsRegion

withAwsRegion(awsRegion)

"The AWS region where the cluster runs. Each Google Cloud region supports a subset of nearby AWS regions. You can call to list all supported AWS regions within a given Google Cloud region."

fn spec.forProvider.withControlPlane

withControlPlane(controlPlane)

"Configuration related to the cluster control plane."

fn spec.forProvider.withControlPlaneMixin

withControlPlaneMixin(controlPlane)

"Configuration related to the cluster control plane."

Note: This function appends passed data to existing values

fn spec.forProvider.withDescription

withDescription(description)

"Optional. A human readable description of this cluster. Cannot be longer than 255 UTF-8 encoded bytes."

fn spec.forProvider.withFleet

withFleet(fleet)

"Fleet configuration."

fn spec.forProvider.withFleetMixin

withFleetMixin(fleet)

"Fleet configuration."

Note: This function appends passed data to existing values

fn spec.forProvider.withLocation

withLocation(location)

"The location for the resource"

fn spec.forProvider.withNetworking

withNetworking(networking)

"Cluster-wide networking configuration."

fn spec.forProvider.withNetworkingMixin

withNetworkingMixin(networking)

"Cluster-wide networking configuration."

Note: This function appends passed data to existing values

fn spec.forProvider.withProject

withProject(project)

"The project for the resource"

obj spec.forProvider.authorization

"Configuration related to the cluster RBAC settings."

fn spec.forProvider.authorization.withAdminUsers

withAdminUsers(adminUsers)

"Users to perform operations as a cluster admin. A managed ClusterRoleBinding will be created to grant the cluster-admin ClusterRole to the users. Up to ten admin users can be provided. For more info on RBAC, see https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles"

fn spec.forProvider.authorization.withAdminUsersMixin

withAdminUsersMixin(adminUsers)

"Users to perform operations as a cluster admin. A managed ClusterRoleBinding will be created to grant the cluster-admin ClusterRole to the users. Up to ten admin users can be provided. For more info on RBAC, see https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles"

Note: This function appends passed data to existing values

obj spec.forProvider.authorization.adminUsers

"Users to perform operations as a cluster admin. A managed ClusterRoleBinding will be created to grant the cluster-admin ClusterRole to the users. Up to ten admin users can be provided. For more info on RBAC, see https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles"

fn spec.forProvider.authorization.adminUsers.withUsername

withUsername(username)

"The name of the user, e.g. my-gcp-id@gmail.com."

obj spec.forProvider.controlPlane

"Configuration related to the cluster control plane."

fn spec.forProvider.controlPlane.withAwsServicesAuthentication

withAwsServicesAuthentication(awsServicesAuthentication)

"Authentication configuration for management of AWS resources."

fn spec.forProvider.controlPlane.withAwsServicesAuthenticationMixin

withAwsServicesAuthenticationMixin(awsServicesAuthentication)

"Authentication configuration for management of AWS resources."

Note: This function appends passed data to existing values

fn spec.forProvider.controlPlane.withConfigEncryption

withConfigEncryption(configEncryption)

"The ARN of the AWS KMS key used to encrypt cluster configuration."

fn spec.forProvider.controlPlane.withConfigEncryptionMixin

withConfigEncryptionMixin(configEncryption)

"The ARN of the AWS KMS key used to encrypt cluster configuration."

Note: This function appends passed data to existing values

fn spec.forProvider.controlPlane.withDatabaseEncryption

withDatabaseEncryption(databaseEncryption)

"The ARN of the AWS KMS key used to encrypt cluster secrets."

fn spec.forProvider.controlPlane.withDatabaseEncryptionMixin

withDatabaseEncryptionMixin(databaseEncryption)

"The ARN of the AWS KMS key used to encrypt cluster secrets."

Note: This function appends passed data to existing values

fn spec.forProvider.controlPlane.withIamInstanceProfile

withIamInstanceProfile(iamInstanceProfile)

"The name of the AWS IAM instance pofile to assign to each control plane replica."

fn spec.forProvider.controlPlane.withInstanceType

withInstanceType(instanceType)

"Optional. The AWS instance type. When unspecified, it defaults to m5.large."

fn spec.forProvider.controlPlane.withMainVolume

withMainVolume(mainVolume)

"Optional. Configuration related to the main volume provisioned for each control plane replica. The main volume is in charge of storing all of the cluster's etcd state. Volumes will be provisioned in the availability zone associated with the corresponding subnet. When unspecified, it defaults to 8 GiB with the GP2 volume type."

fn spec.forProvider.controlPlane.withMainVolumeMixin

withMainVolumeMixin(mainVolume)

"Optional. Configuration related to the main volume provisioned for each control plane replica. The main volume is in charge of storing all of the cluster's etcd state. Volumes will be provisioned in the availability zone associated with the corresponding subnet. When unspecified, it defaults to 8 GiB with the GP2 volume type."

Note: This function appends passed data to existing values

fn spec.forProvider.controlPlane.withProxyConfig

withProxyConfig(proxyConfig)

"Proxy configuration for outbound HTTP(S) traffic."

fn spec.forProvider.controlPlane.withProxyConfigMixin

withProxyConfigMixin(proxyConfig)

"Proxy configuration for outbound HTTP(S) traffic."

Note: This function appends passed data to existing values

fn spec.forProvider.controlPlane.withRootVolume

withRootVolume(rootVolume)

"Optional. Configuration related to the root volume provisioned for each control plane replica. Volumes will be provisioned in the availability zone associated with the corresponding subnet. When unspecified, it defaults to 32 GiB with the GP2 volume type."

fn spec.forProvider.controlPlane.withRootVolumeMixin

withRootVolumeMixin(rootVolume)

"Optional. Configuration related to the root volume provisioned for each control plane replica. Volumes will be provisioned in the availability zone associated with the corresponding subnet. When unspecified, it defaults to 32 GiB with the GP2 volume type."

Note: This function appends passed data to existing values

fn spec.forProvider.controlPlane.withSecurityGroupIds

withSecurityGroupIds(securityGroupIds)

"Optional. The IDs of additional security groups to add to control plane replicas. The Anthos Multi-Cloud API will automatically create and manage security groups with the minimum rules needed for a functioning cluster."

fn spec.forProvider.controlPlane.withSecurityGroupIdsMixin

withSecurityGroupIdsMixin(securityGroupIds)

"Optional. The IDs of additional security groups to add to control plane replicas. The Anthos Multi-Cloud API will automatically create and manage security groups with the minimum rules needed for a functioning cluster."

Note: This function appends passed data to existing values

fn spec.forProvider.controlPlane.withSshConfig

withSshConfig(sshConfig)

"Optional. SSH configuration for how to access the underlying control plane machines."

fn spec.forProvider.controlPlane.withSshConfigMixin

withSshConfigMixin(sshConfig)

"Optional. SSH configuration for how to access the underlying control plane machines."

Note: This function appends passed data to existing values

fn spec.forProvider.controlPlane.withSubnetIds

withSubnetIds(subnetIds)

"The list of subnets where control plane replicas will run. A replica will be provisioned on each subnet and up to three values can be provided. Each subnet must be in a different AWS Availability Zone (AZ)."

fn spec.forProvider.controlPlane.withSubnetIdsMixin

withSubnetIdsMixin(subnetIds)

"The list of subnets where control plane replicas will run. A replica will be provisioned on each subnet and up to three values can be provided. Each subnet must be in a different AWS Availability Zone (AZ)."

Note: This function appends passed data to existing values

fn spec.forProvider.controlPlane.withTags

withTags(tags)

"Optional. A set of AWS resource tags to propagate to all underlying managed AWS resources. Specify at most 50 pairs containing alphanumerics, spaces, and symbols (.+-=_:@/). Keys can be up to 127 Unicode characters. Values can be up to 255 Unicode characters."

fn spec.forProvider.controlPlane.withTagsMixin

withTagsMixin(tags)

"Optional. A set of AWS resource tags to propagate to all underlying managed AWS resources. Specify at most 50 pairs containing alphanumerics, spaces, and symbols (.+-=_:@/). Keys can be up to 127 Unicode characters. Values can be up to 255 Unicode characters."

Note: This function appends passed data to existing values

fn spec.forProvider.controlPlane.withVersion

withVersion(version)

"The Kubernetes version to run on control plane replicas (e.g. 1.19.10-gke.1000). You can list all supported versions on a given Google Cloud region by calling ."

obj spec.forProvider.controlPlane.awsServicesAuthentication

"Authentication configuration for management of AWS resources."

fn spec.forProvider.controlPlane.awsServicesAuthentication.withRoleArn

withRoleArn(roleArn)

"The Amazon Resource Name (ARN) of the role that the Anthos Multi-Cloud API will assume when managing AWS resources on your account."

fn spec.forProvider.controlPlane.awsServicesAuthentication.withRoleSessionName

withRoleSessionName(roleSessionName)

"Optional. An identifier for the assumed role session. When unspecified, it defaults to multicloud-service-agent."

obj spec.forProvider.controlPlane.configEncryption

"The ARN of the AWS KMS key used to encrypt cluster configuration."

fn spec.forProvider.controlPlane.configEncryption.withKmsKeyArn

withKmsKeyArn(kmsKeyArn)

"Optional. The Amazon Resource Name (ARN) of the Customer Managed Key (CMK) used to encrypt AWS EBS volumes. If not specified, the default Amazon managed key associated to the AWS region where this cluster runs will be used."

obj spec.forProvider.controlPlane.databaseEncryption

"The ARN of the AWS KMS key used to encrypt cluster secrets."

fn spec.forProvider.controlPlane.databaseEncryption.withKmsKeyArn

withKmsKeyArn(kmsKeyArn)

"Optional. The Amazon Resource Name (ARN) of the Customer Managed Key (CMK) used to encrypt AWS EBS volumes. If not specified, the default Amazon managed key associated to the AWS region where this cluster runs will be used."

obj spec.forProvider.controlPlane.mainVolume

"Optional. Configuration related to the main volume provisioned for each control plane replica. The main volume is in charge of storing all of the cluster's etcd state. Volumes will be provisioned in the availability zone associated with the corresponding subnet. When unspecified, it defaults to 8 GiB with the GP2 volume type."

fn spec.forProvider.controlPlane.mainVolume.withIops

withIops(iops)

"Optional. The number of I/O operations per second (IOPS) to provision for GP3 volume."

fn spec.forProvider.controlPlane.mainVolume.withKmsKeyArn

withKmsKeyArn(kmsKeyArn)

"Optional. The Amazon Resource Name (ARN) of the Customer Managed Key (CMK) used to encrypt AWS EBS volumes. If not specified, the default Amazon managed key associated to the AWS region where this cluster runs will be used."

fn spec.forProvider.controlPlane.mainVolume.withSizeGib

withSizeGib(sizeGib)

"Optional. The size of the volume, in GiBs. When unspecified, a default value is provided. See the specific reference in the parent resource."

fn spec.forProvider.controlPlane.mainVolume.withVolumeType

withVolumeType(volumeType)

"Optional. Type of the EBS volume. When unspecified, it defaults to GP2 volume. Possible values: VOLUME_TYPE_UNSPECIFIED, GP2, GP3"

obj spec.forProvider.controlPlane.proxyConfig

"Proxy configuration for outbound HTTP(S) traffic."

fn spec.forProvider.controlPlane.proxyConfig.withSecretArn

withSecretArn(secretArn)

"The ARN of the AWS Secret Manager secret that contains the HTTP(S) proxy configuration."

fn spec.forProvider.controlPlane.proxyConfig.withSecretVersion

withSecretVersion(secretVersion)

"The version string of the AWS Secret Manager secret that contains the HTTP(S) proxy configuration."

obj spec.forProvider.controlPlane.rootVolume

"Optional. Configuration related to the root volume provisioned for each control plane replica. Volumes will be provisioned in the availability zone associated with the corresponding subnet. When unspecified, it defaults to 32 GiB with the GP2 volume type."

fn spec.forProvider.controlPlane.rootVolume.withIops

withIops(iops)

"Optional. The number of I/O operations per second (IOPS) to provision for GP3 volume."

fn spec.forProvider.controlPlane.rootVolume.withKmsKeyArn

withKmsKeyArn(kmsKeyArn)

"Optional. The Amazon Resource Name (ARN) of the Customer Managed Key (CMK) used to encrypt AWS EBS volumes. If not specified, the default Amazon managed key associated to the AWS region where this cluster runs will be used."

fn spec.forProvider.controlPlane.rootVolume.withSizeGib

withSizeGib(sizeGib)

"Optional. The size of the volume, in GiBs. When unspecified, a default value is provided. See the specific reference in the parent resource."

fn spec.forProvider.controlPlane.rootVolume.withVolumeType

withVolumeType(volumeType)

"Optional. Type of the EBS volume. When unspecified, it defaults to GP2 volume. Possible values: VOLUME_TYPE_UNSPECIFIED, GP2, GP3"

obj spec.forProvider.controlPlane.sshConfig

"Optional. SSH configuration for how to access the underlying control plane machines."

fn spec.forProvider.controlPlane.sshConfig.withEc2KeyPair

withEc2KeyPair(ec2KeyPair)

"The name of the EC2 key pair used to login into cluster machines."

obj spec.forProvider.fleet

"Fleet configuration."

fn spec.forProvider.fleet.withProject

withProject(project)

"The number of the Fleet host project where this cluster will be registered."

obj spec.forProvider.networking

"Cluster-wide networking configuration."

fn spec.forProvider.networking.withPodAddressCidrBlocks

withPodAddressCidrBlocks(podAddressCidrBlocks)

"All pods in the cluster are assigned an RFC1918 IPv4 address from these ranges. Only a single range is supported. This field cannot be changed after creation."

fn spec.forProvider.networking.withPodAddressCidrBlocksMixin

withPodAddressCidrBlocksMixin(podAddressCidrBlocks)

"All pods in the cluster are assigned an RFC1918 IPv4 address from these ranges. Only a single range is supported. This field cannot be changed after creation."

Note: This function appends passed data to existing values

fn spec.forProvider.networking.withServiceAddressCidrBlocks

withServiceAddressCidrBlocks(serviceAddressCidrBlocks)

"All services in the cluster are assigned an RFC1918 IPv4 address from these ranges. Only a single range is supported. This field cannot be changed after creation."

fn spec.forProvider.networking.withServiceAddressCidrBlocksMixin

withServiceAddressCidrBlocksMixin(serviceAddressCidrBlocks)

"All services in the cluster are assigned an RFC1918 IPv4 address from these ranges. Only a single range is supported. This field cannot be changed after creation."

Note: This function appends passed data to existing values

fn spec.forProvider.networking.withVpcId

withVpcId(vpcId)

"The VPC associated with the cluster. All component clusters (i.e. control plane and node pools) run on a single VPC. This field cannot be changed after creation."

obj spec.initProvider

"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler."

fn spec.initProvider.withAnnotations

withAnnotations(annotations)

"Optional. Annotations on the cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix and name , separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between."

fn spec.initProvider.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Optional. Annotations on the cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix and name , separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between."

Note: This function appends passed data to existing values

fn spec.initProvider.withAuthorization

withAuthorization(authorization)

"Configuration related to the cluster RBAC settings."

fn spec.initProvider.withAuthorizationMixin

withAuthorizationMixin(authorization)

"Configuration related to the cluster RBAC settings."

Note: This function appends passed data to existing values

fn spec.initProvider.withAwsRegion

withAwsRegion(awsRegion)

"The AWS region where the cluster runs. Each Google Cloud region supports a subset of nearby AWS regions. You can call to list all supported AWS regions within a given Google Cloud region."

fn spec.initProvider.withControlPlane

withControlPlane(controlPlane)

"Configuration related to the cluster control plane."

fn spec.initProvider.withControlPlaneMixin

withControlPlaneMixin(controlPlane)

"Configuration related to the cluster control plane."

Note: This function appends passed data to existing values

fn spec.initProvider.withDescription

withDescription(description)

"Optional. A human readable description of this cluster. Cannot be longer than 255 UTF-8 encoded bytes."

fn spec.initProvider.withFleet

withFleet(fleet)

"Fleet configuration."

fn spec.initProvider.withFleetMixin

withFleetMixin(fleet)

"Fleet configuration."

Note: This function appends passed data to existing values

fn spec.initProvider.withNetworking

withNetworking(networking)

"Cluster-wide networking configuration."

fn spec.initProvider.withNetworkingMixin

withNetworkingMixin(networking)

"Cluster-wide networking configuration."

Note: This function appends passed data to existing values

fn spec.initProvider.withProject

withProject(project)

"The project for the resource"

obj spec.initProvider.authorization

"Configuration related to the cluster RBAC settings."

fn spec.initProvider.authorization.withAdminUsers

withAdminUsers(adminUsers)

"Users to perform operations as a cluster admin. A managed ClusterRoleBinding will be created to grant the cluster-admin ClusterRole to the users. Up to ten admin users can be provided. For more info on RBAC, see https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles"

fn spec.initProvider.authorization.withAdminUsersMixin

withAdminUsersMixin(adminUsers)

"Users to perform operations as a cluster admin. A managed ClusterRoleBinding will be created to grant the cluster-admin ClusterRole to the users. Up to ten admin users can be provided. For more info on RBAC, see https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles"

Note: This function appends passed data to existing values

obj spec.initProvider.authorization.adminUsers

"Users to perform operations as a cluster admin. A managed ClusterRoleBinding will be created to grant the cluster-admin ClusterRole to the users. Up to ten admin users can be provided. For more info on RBAC, see https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles"

fn spec.initProvider.authorization.adminUsers.withUsername

withUsername(username)

"The name of the user, e.g. my-gcp-id@gmail.com."

obj spec.initProvider.controlPlane

"Configuration related to the cluster control plane."

fn spec.initProvider.controlPlane.withAwsServicesAuthentication

withAwsServicesAuthentication(awsServicesAuthentication)

"Authentication configuration for management of AWS resources."

fn spec.initProvider.controlPlane.withAwsServicesAuthenticationMixin

withAwsServicesAuthenticationMixin(awsServicesAuthentication)

"Authentication configuration for management of AWS resources."

Note: This function appends passed data to existing values

fn spec.initProvider.controlPlane.withConfigEncryption

withConfigEncryption(configEncryption)

"The ARN of the AWS KMS key used to encrypt cluster configuration."

fn spec.initProvider.controlPlane.withConfigEncryptionMixin

withConfigEncryptionMixin(configEncryption)

"The ARN of the AWS KMS key used to encrypt cluster configuration."

Note: This function appends passed data to existing values

fn spec.initProvider.controlPlane.withDatabaseEncryption

withDatabaseEncryption(databaseEncryption)

"The ARN of the AWS KMS key used to encrypt cluster secrets."

fn spec.initProvider.controlPlane.withDatabaseEncryptionMixin

withDatabaseEncryptionMixin(databaseEncryption)

"The ARN of the AWS KMS key used to encrypt cluster secrets."

Note: This function appends passed data to existing values

fn spec.initProvider.controlPlane.withIamInstanceProfile

withIamInstanceProfile(iamInstanceProfile)

"The name of the AWS IAM instance pofile to assign to each control plane replica."

fn spec.initProvider.controlPlane.withInstanceType

withInstanceType(instanceType)

"Optional. The AWS instance type. When unspecified, it defaults to m5.large."

fn spec.initProvider.controlPlane.withMainVolume

withMainVolume(mainVolume)

"Optional. Configuration related to the main volume provisioned for each control plane replica. The main volume is in charge of storing all of the cluster's etcd state. Volumes will be provisioned in the availability zone associated with the corresponding subnet. When unspecified, it defaults to 8 GiB with the GP2 volume type."

fn spec.initProvider.controlPlane.withMainVolumeMixin

withMainVolumeMixin(mainVolume)

"Optional. Configuration related to the main volume provisioned for each control plane replica. The main volume is in charge of storing all of the cluster's etcd state. Volumes will be provisioned in the availability zone associated with the corresponding subnet. When unspecified, it defaults to 8 GiB with the GP2 volume type."

Note: This function appends passed data to existing values

fn spec.initProvider.controlPlane.withProxyConfig

withProxyConfig(proxyConfig)

"Proxy configuration for outbound HTTP(S) traffic."

fn spec.initProvider.controlPlane.withProxyConfigMixin

withProxyConfigMixin(proxyConfig)

"Proxy configuration for outbound HTTP(S) traffic."

Note: This function appends passed data to existing values

fn spec.initProvider.controlPlane.withRootVolume

withRootVolume(rootVolume)

"Optional. Configuration related to the root volume provisioned for each control plane replica. Volumes will be provisioned in the availability zone associated with the corresponding subnet. When unspecified, it defaults to 32 GiB with the GP2 volume type."

fn spec.initProvider.controlPlane.withRootVolumeMixin

withRootVolumeMixin(rootVolume)

"Optional. Configuration related to the root volume provisioned for each control plane replica. Volumes will be provisioned in the availability zone associated with the corresponding subnet. When unspecified, it defaults to 32 GiB with the GP2 volume type."

Note: This function appends passed data to existing values

fn spec.initProvider.controlPlane.withSecurityGroupIds

withSecurityGroupIds(securityGroupIds)

"Optional. The IDs of additional security groups to add to control plane replicas. The Anthos Multi-Cloud API will automatically create and manage security groups with the minimum rules needed for a functioning cluster."

fn spec.initProvider.controlPlane.withSecurityGroupIdsMixin

withSecurityGroupIdsMixin(securityGroupIds)

"Optional. The IDs of additional security groups to add to control plane replicas. The Anthos Multi-Cloud API will automatically create and manage security groups with the minimum rules needed for a functioning cluster."

Note: This function appends passed data to existing values

fn spec.initProvider.controlPlane.withSshConfig

withSshConfig(sshConfig)

"Optional. SSH configuration for how to access the underlying control plane machines."

fn spec.initProvider.controlPlane.withSshConfigMixin

withSshConfigMixin(sshConfig)

"Optional. SSH configuration for how to access the underlying control plane machines."

Note: This function appends passed data to existing values

fn spec.initProvider.controlPlane.withSubnetIds

withSubnetIds(subnetIds)

"The list of subnets where control plane replicas will run. A replica will be provisioned on each subnet and up to three values can be provided. Each subnet must be in a different AWS Availability Zone (AZ)."

fn spec.initProvider.controlPlane.withSubnetIdsMixin

withSubnetIdsMixin(subnetIds)

"The list of subnets where control plane replicas will run. A replica will be provisioned on each subnet and up to three values can be provided. Each subnet must be in a different AWS Availability Zone (AZ)."

Note: This function appends passed data to existing values

fn spec.initProvider.controlPlane.withTags

withTags(tags)

"Optional. A set of AWS resource tags to propagate to all underlying managed AWS resources. Specify at most 50 pairs containing alphanumerics, spaces, and symbols (.+-=_:@/). Keys can be up to 127 Unicode characters. Values can be up to 255 Unicode characters."

fn spec.initProvider.controlPlane.withTagsMixin

withTagsMixin(tags)

"Optional. A set of AWS resource tags to propagate to all underlying managed AWS resources. Specify at most 50 pairs containing alphanumerics, spaces, and symbols (.+-=_:@/). Keys can be up to 127 Unicode characters. Values can be up to 255 Unicode characters."

Note: This function appends passed data to existing values

fn spec.initProvider.controlPlane.withVersion

withVersion(version)

"The Kubernetes version to run on control plane replicas (e.g. 1.19.10-gke.1000). You can list all supported versions on a given Google Cloud region by calling ."

obj spec.initProvider.controlPlane.awsServicesAuthentication

"Authentication configuration for management of AWS resources."

fn spec.initProvider.controlPlane.awsServicesAuthentication.withRoleArn

withRoleArn(roleArn)

"The Amazon Resource Name (ARN) of the role that the Anthos Multi-Cloud API will assume when managing AWS resources on your account."

fn spec.initProvider.controlPlane.awsServicesAuthentication.withRoleSessionName

withRoleSessionName(roleSessionName)

"Optional. An identifier for the assumed role session. When unspecified, it defaults to multicloud-service-agent."

obj spec.initProvider.controlPlane.configEncryption

"The ARN of the AWS KMS key used to encrypt cluster configuration."

fn spec.initProvider.controlPlane.configEncryption.withKmsKeyArn

withKmsKeyArn(kmsKeyArn)

"Optional. The Amazon Resource Name (ARN) of the Customer Managed Key (CMK) used to encrypt AWS EBS volumes. If not specified, the default Amazon managed key associated to the AWS region where this cluster runs will be used."

obj spec.initProvider.controlPlane.databaseEncryption

"The ARN of the AWS KMS key used to encrypt cluster secrets."

fn spec.initProvider.controlPlane.databaseEncryption.withKmsKeyArn

withKmsKeyArn(kmsKeyArn)

"Optional. The Amazon Resource Name (ARN) of the Customer Managed Key (CMK) used to encrypt AWS EBS volumes. If not specified, the default Amazon managed key associated to the AWS region where this cluster runs will be used."

obj spec.initProvider.controlPlane.mainVolume

"Optional. Configuration related to the main volume provisioned for each control plane replica. The main volume is in charge of storing all of the cluster's etcd state. Volumes will be provisioned in the availability zone associated with the corresponding subnet. When unspecified, it defaults to 8 GiB with the GP2 volume type."

fn spec.initProvider.controlPlane.mainVolume.withIops

withIops(iops)

"Optional. The number of I/O operations per second (IOPS) to provision for GP3 volume."

fn spec.initProvider.controlPlane.mainVolume.withKmsKeyArn

withKmsKeyArn(kmsKeyArn)

"Optional. The Amazon Resource Name (ARN) of the Customer Managed Key (CMK) used to encrypt AWS EBS volumes. If not specified, the default Amazon managed key associated to the AWS region where this cluster runs will be used."

fn spec.initProvider.controlPlane.mainVolume.withSizeGib

withSizeGib(sizeGib)

"Optional. The size of the volume, in GiBs. When unspecified, a default value is provided. See the specific reference in the parent resource."

fn spec.initProvider.controlPlane.mainVolume.withVolumeType

withVolumeType(volumeType)

"Optional. Type of the EBS volume. When unspecified, it defaults to GP2 volume. Possible values: VOLUME_TYPE_UNSPECIFIED, GP2, GP3"

obj spec.initProvider.controlPlane.proxyConfig

"Proxy configuration for outbound HTTP(S) traffic."

fn spec.initProvider.controlPlane.proxyConfig.withSecretArn

withSecretArn(secretArn)

"The ARN of the AWS Secret Manager secret that contains the HTTP(S) proxy configuration."

fn spec.initProvider.controlPlane.proxyConfig.withSecretVersion

withSecretVersion(secretVersion)

"The version string of the AWS Secret Manager secret that contains the HTTP(S) proxy configuration."

obj spec.initProvider.controlPlane.rootVolume

"Optional. Configuration related to the root volume provisioned for each control plane replica. Volumes will be provisioned in the availability zone associated with the corresponding subnet. When unspecified, it defaults to 32 GiB with the GP2 volume type."

fn spec.initProvider.controlPlane.rootVolume.withIops

withIops(iops)

"Optional. The number of I/O operations per second (IOPS) to provision for GP3 volume."

fn spec.initProvider.controlPlane.rootVolume.withKmsKeyArn

withKmsKeyArn(kmsKeyArn)

"Optional. The Amazon Resource Name (ARN) of the Customer Managed Key (CMK) used to encrypt AWS EBS volumes. If not specified, the default Amazon managed key associated to the AWS region where this cluster runs will be used."

fn spec.initProvider.controlPlane.rootVolume.withSizeGib

withSizeGib(sizeGib)

"Optional. The size of the volume, in GiBs. When unspecified, a default value is provided. See the specific reference in the parent resource."

fn spec.initProvider.controlPlane.rootVolume.withVolumeType

withVolumeType(volumeType)

"Optional. Type of the EBS volume. When unspecified, it defaults to GP2 volume. Possible values: VOLUME_TYPE_UNSPECIFIED, GP2, GP3"

obj spec.initProvider.controlPlane.sshConfig

"Optional. SSH configuration for how to access the underlying control plane machines."

fn spec.initProvider.controlPlane.sshConfig.withEc2KeyPair

withEc2KeyPair(ec2KeyPair)

"The name of the EC2 key pair used to login into cluster machines."

obj spec.initProvider.fleet

"Fleet configuration."

fn spec.initProvider.fleet.withProject

withProject(project)

"The number of the Fleet host project where this cluster will be registered."

obj spec.initProvider.networking

"Cluster-wide networking configuration."

fn spec.initProvider.networking.withPodAddressCidrBlocks

withPodAddressCidrBlocks(podAddressCidrBlocks)

"All pods in the cluster are assigned an RFC1918 IPv4 address from these ranges. Only a single range is supported. This field cannot be changed after creation."

fn spec.initProvider.networking.withPodAddressCidrBlocksMixin

withPodAddressCidrBlocksMixin(podAddressCidrBlocks)

"All pods in the cluster are assigned an RFC1918 IPv4 address from these ranges. Only a single range is supported. This field cannot be changed after creation."

Note: This function appends passed data to existing values

fn spec.initProvider.networking.withServiceAddressCidrBlocks

withServiceAddressCidrBlocks(serviceAddressCidrBlocks)

"All services in the cluster are assigned an RFC1918 IPv4 address from these ranges. Only a single range is supported. This field cannot be changed after creation."

fn spec.initProvider.networking.withServiceAddressCidrBlocksMixin

withServiceAddressCidrBlocksMixin(serviceAddressCidrBlocks)

"All services in the cluster are assigned an RFC1918 IPv4 address from these ranges. Only a single range is supported. This field cannot be changed after creation."

Note: This function appends passed data to existing values

fn spec.initProvider.networking.withVpcId

withVpcId(vpcId)

"The VPC associated with the cluster. All component clusters (i.e. control plane and node pools) run on a single VPC. This field cannot be changed after creation."

obj spec.providerConfigRef

"ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured."

fn spec.providerConfigRef.withName

withName(name)

"Name of the referenced object."

obj spec.providerConfigRef.policy

"Policies for referencing."

fn spec.providerConfigRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.providerConfigRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.providerRef

"ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource. Deprecated: Please use ProviderConfigReference, i.e. providerConfigRef"

fn spec.providerRef.withName

withName(name)

"Name of the referenced object."

obj spec.providerRef.policy

"Policies for referencing."

fn spec.providerRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.providerRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.publishConnectionDetailsTo

"PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource."

fn spec.publishConnectionDetailsTo.withName

withName(name)

"Name is the name of the connection secret."

obj spec.publishConnectionDetailsTo.configRef

"SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret."

fn spec.publishConnectionDetailsTo.configRef.withName

withName(name)

"Name of the referenced object."

obj spec.publishConnectionDetailsTo.configRef.policy

"Policies for referencing."

fn spec.publishConnectionDetailsTo.configRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.publishConnectionDetailsTo.configRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.publishConnectionDetailsTo.metadata

"Metadata is the metadata for connection secret."

fn spec.publishConnectionDetailsTo.metadata.withAnnotations

withAnnotations(annotations)

"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withLabels

withLabels(labels)

"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withType

withType(type)

"Type is the SecretType for the connection secret. - Only valid for Kubernetes Secret Stores."

obj spec.writeConnectionSecretToRef

"WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other."

fn spec.writeConnectionSecretToRef.withName

withName(name)

"Name of the secret."

fn spec.writeConnectionSecretToRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."