Skip to content

opensearchservice.v1alpha1.domain

"Domain is the Schema for the Domains API"

Index

Fields

fn new

new(name)

new returns an instance of Domain

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

"DomainSpec defines the desired state of Domain"

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."

obj spec.forProvider

"DomainParameters defines the desired state of Domain"

fn spec.forProvider.withAccessPolicies

withAccessPolicies(accessPolicies)

"IAM access policy as a JSON-formatted string."

fn spec.forProvider.withAdvancedOptions

withAdvancedOptions(advancedOptions)

"Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options) for more information."

fn spec.forProvider.withAdvancedOptionsMixin

withAdvancedOptionsMixin(advancedOptions)

"Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options) for more information."

Note: This function appends passed data to existing values

fn spec.forProvider.withEngineVersion

withEngineVersion(engineVersion)

"String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the Amazon OpenSearch Service domain. For example, \"OpenSearch_1.0\" or \"Elasticsearch_7.9\". For more information, see Creating and managing Amazon OpenSearch Service domains (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomains)."

fn spec.forProvider.withLogPublishingOptions

withLogPublishingOptions(logPublishingOptions)

"Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log."

fn spec.forProvider.withLogPublishingOptionsMixin

withLogPublishingOptionsMixin(logPublishingOptions)

"Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log."

Note: This function appends passed data to existing values

fn spec.forProvider.withName

withName(name)

"The name of the Amazon OpenSearch Service domain you're creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen)."

fn spec.forProvider.withRegion

withRegion(region)

"Region is which region the Domain will be created."

fn spec.forProvider.withTags

withTags(tags)

"A list of Tag added during domain creation."

fn spec.forProvider.withTagsMixin

withTagsMixin(tags)

"A list of Tag added during domain creation."

Note: This function appends passed data to existing values

obj spec.forProvider.advancedSecurityOptions

"Specifies advanced security options."

fn spec.forProvider.advancedSecurityOptions.withAnonymousAuthEnabled

withAnonymousAuthEnabled(anonymousAuthEnabled)

fn spec.forProvider.advancedSecurityOptions.withEnabled

withEnabled(enabled)

fn spec.forProvider.advancedSecurityOptions.withInternalUserDatabaseEnabled

withInternalUserDatabaseEnabled(internalUserDatabaseEnabled)

obj spec.forProvider.advancedSecurityOptions.masterUserOptions

"Credentials for the master user: username and password, ARN, or both."

fn spec.forProvider.advancedSecurityOptions.masterUserOptions.withMasterUserARN

withMasterUserARN(masterUserARN)

"The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities (http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html) in Using AWS Identity and Access Management for more information."

fn spec.forProvider.advancedSecurityOptions.masterUserOptions.withMasterUserName

withMasterUserName(masterUserName)

fn spec.forProvider.advancedSecurityOptions.masterUserOptions.withMasterUserPassword

withMasterUserPassword(masterUserPassword)

obj spec.forProvider.advancedSecurityOptions.sAMLOptions

"The SAML application configuration for the domain."

fn spec.forProvider.advancedSecurityOptions.sAMLOptions.withEnabled

withEnabled(enabled)

fn spec.forProvider.advancedSecurityOptions.sAMLOptions.withMasterBackendRole

withMasterBackendRole(masterBackendRole)

fn spec.forProvider.advancedSecurityOptions.sAMLOptions.withMasterUserName

withMasterUserName(masterUserName)

fn spec.forProvider.advancedSecurityOptions.sAMLOptions.withRolesKey

withRolesKey(rolesKey)

fn spec.forProvider.advancedSecurityOptions.sAMLOptions.withSessionTimeoutMinutes

withSessionTimeoutMinutes(sessionTimeoutMinutes)

fn spec.forProvider.advancedSecurityOptions.sAMLOptions.withSubjectKey

withSubjectKey(subjectKey)

obj spec.forProvider.advancedSecurityOptions.sAMLOptions.idp

"The SAML identity povider's information."

fn spec.forProvider.advancedSecurityOptions.sAMLOptions.idp.withEntityID

withEntityID(entityID)

fn spec.forProvider.advancedSecurityOptions.sAMLOptions.idp.withMetadataContent

withMetadataContent(metadataContent)

obj spec.forProvider.autoTuneOptions

"Specifies Auto-Tune options."

fn spec.forProvider.autoTuneOptions.withDesiredState

withDesiredState(desiredState)

"The Auto-Tune desired state. Valid values are ENABLED and DISABLED."

fn spec.forProvider.autoTuneOptions.withMaintenanceSchedules

withMaintenanceSchedules(maintenanceSchedules)

fn spec.forProvider.autoTuneOptions.withMaintenanceSchedulesMixin

withMaintenanceSchedulesMixin(maintenanceSchedules)

Note: This function appends passed data to existing values

obj spec.forProvider.autoTuneOptions.maintenanceSchedules

fn spec.forProvider.autoTuneOptions.maintenanceSchedules.withCronExpressionForRecurrence

withCronExpressionForRecurrence(cronExpressionForRecurrence)

fn spec.forProvider.autoTuneOptions.maintenanceSchedules.withStartAt

withStartAt(startAt)

obj spec.forProvider.autoTuneOptions.maintenanceSchedules.duration

"The maintenance schedule duration: duration value and duration unit. See Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html) for more information."

fn spec.forProvider.autoTuneOptions.maintenanceSchedules.duration.withUnit

withUnit(unit)

"The unit of a maintenance schedule duration. Valid value is HOUR. See Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html) for more information."

fn spec.forProvider.autoTuneOptions.maintenanceSchedules.duration.withValue

withValue(value)

"Integer to specify the value of a maintenance schedule duration. See Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html) for more information."

obj spec.forProvider.clusterConfig

"Configuration options for a domain. Specifies the instance type and number of instances in the domain."

fn spec.forProvider.clusterConfig.withDedicatedMasterCount

withDedicatedMasterCount(dedicatedMasterCount)

fn spec.forProvider.clusterConfig.withDedicatedMasterEnabled

withDedicatedMasterEnabled(dedicatedMasterEnabled)

fn spec.forProvider.clusterConfig.withDedicatedMasterType

withDedicatedMasterType(dedicatedMasterType)

fn spec.forProvider.clusterConfig.withInstanceCount

withInstanceCount(instanceCount)

fn spec.forProvider.clusterConfig.withInstanceType

withInstanceType(instanceType)

fn spec.forProvider.clusterConfig.withWarmCount

withWarmCount(warmCount)

fn spec.forProvider.clusterConfig.withWarmEnabled

withWarmEnabled(warmEnabled)

fn spec.forProvider.clusterConfig.withWarmType

withWarmType(warmType)

fn spec.forProvider.clusterConfig.withZoneAwarenessEnabled

withZoneAwarenessEnabled(zoneAwarenessEnabled)

obj spec.forProvider.clusterConfig.coldStorageOptions

"Specifies the configuration for cold storage options such as enabled"

fn spec.forProvider.clusterConfig.coldStorageOptions.withEnabled

withEnabled(enabled)

obj spec.forProvider.clusterConfig.zoneAwarenessConfig

"The zone awareness configuration for the domain cluster, such as the number of availability zones."

fn spec.forProvider.clusterConfig.zoneAwarenessConfig.withAvailabilityZoneCount

withAvailabilityZoneCount(availabilityZoneCount)

obj spec.forProvider.cognitoOptions

"Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html)."

fn spec.forProvider.cognitoOptions.withEnabled

withEnabled(enabled)

fn spec.forProvider.cognitoOptions.withIdentityPoolID

withIdentityPoolID(identityPoolID)

fn spec.forProvider.cognitoOptions.withRoleARN

withRoleARN(roleARN)

fn spec.forProvider.cognitoOptions.withUserPoolID

withUserPoolID(userPoolID)

obj spec.forProvider.domainEndpointOptions

"Options to specify configurations that will be applied to the domain endpoint."

fn spec.forProvider.domainEndpointOptions.withCustomEndpoint

withCustomEndpoint(customEndpoint)

fn spec.forProvider.domainEndpointOptions.withCustomEndpointCertificateARN

withCustomEndpointCertificateARN(customEndpointCertificateARN)

"The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities (http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html) in Using AWS Identity and Access Management for more information."

fn spec.forProvider.domainEndpointOptions.withCustomEndpointEnabled

withCustomEndpointEnabled(customEndpointEnabled)

fn spec.forProvider.domainEndpointOptions.withEnforceHTTPS

withEnforceHTTPS(enforceHTTPS)

fn spec.forProvider.domainEndpointOptions.withTlsSecurityPolicy

withTlsSecurityPolicy(tlsSecurityPolicy)

obj spec.forProvider.ebsOptions

"Options to enable, disable, and specify the type and size of EBS storage volumes."

fn spec.forProvider.ebsOptions.withEbsEnabled

withEbsEnabled(ebsEnabled)

fn spec.forProvider.ebsOptions.withIops

withIops(iops)

fn spec.forProvider.ebsOptions.withVolumeSize

withVolumeSize(volumeSize)

fn spec.forProvider.ebsOptions.withVolumeType

withVolumeType(volumeType)

"The type of EBS volume, standard, gp2, or io1. See Configuring EBS-based Storage (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/opensearch-createupdatedomains.html#opensearch-createdomain-configure-ebs) for more information."

obj spec.forProvider.encryptionAtRestOptions

"Options for encryption of data at rest."

fn spec.forProvider.encryptionAtRestOptions.withEnabled

withEnabled(enabled)

fn spec.forProvider.encryptionAtRestOptions.withKmsKeyId

withKmsKeyId(kmsKeyId)

obj spec.forProvider.encryptionAtRestOptions.kmsKeyIdRef

"KMSKeyIDRef is a reference to a KMS Key used to set KMSKeyID."

fn spec.forProvider.encryptionAtRestOptions.kmsKeyIdRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.encryptionAtRestOptions.kmsKeyIdRef.policy

"Policies for referencing."

fn spec.forProvider.encryptionAtRestOptions.kmsKeyIdRef.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.forProvider.encryptionAtRestOptions.kmsKeyIdRef.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.forProvider.encryptionAtRestOptions.kmsKeyIdSelector

"KMSKeyIDSelector selects a reference to a KMS Key used to set KMSKeyID."

fn spec.forProvider.encryptionAtRestOptions.kmsKeyIdSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.encryptionAtRestOptions.kmsKeyIdSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.encryptionAtRestOptions.kmsKeyIdSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.encryptionAtRestOptions.kmsKeyIdSelector.policy

"Policies for selection."

fn spec.forProvider.encryptionAtRestOptions.kmsKeyIdSelector.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.forProvider.encryptionAtRestOptions.kmsKeyIdSelector.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.forProvider.nodeToNodeEncryptionOptions

"Node-to-node encryption options."

fn spec.forProvider.nodeToNodeEncryptionOptions.withEnabled

withEnabled(enabled)

obj spec.forProvider.tags

"A list of Tag added during domain creation."

fn spec.forProvider.tags.withKey

withKey(key)

"A string of length from 1 to 128 characters that specifies the key for a tag. Tag keys must be unique for the domain to which they're attached."

fn spec.forProvider.tags.withValue

withValue(value)

"A string of length from 0 to 256 characters that specifies the value for a tag. Tag values can be null and don't have to be unique in a tag set."

obj spec.forProvider.vpcOptions

"Options to specify the subnets and security groups for the VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html)."

fn spec.forProvider.vpcOptions.withSecurityGroupIdRefs

withSecurityGroupIdRefs(securityGroupIdRefs)

"SecurityGroupIDRefs is a list of references to SecurityGroups used to set the SecurityGroupIDs."

fn spec.forProvider.vpcOptions.withSecurityGroupIdRefsMixin

withSecurityGroupIdRefsMixin(securityGroupIdRefs)

"SecurityGroupIDRefs is a list of references to SecurityGroups used to set the SecurityGroupIDs."

Note: This function appends passed data to existing values

fn spec.forProvider.vpcOptions.withSecurityGroupIds

withSecurityGroupIds(securityGroupIds)

fn spec.forProvider.vpcOptions.withSecurityGroupIdsMixin

withSecurityGroupIdsMixin(securityGroupIds)

Note: This function appends passed data to existing values

fn spec.forProvider.vpcOptions.withSubnetIdRefs

withSubnetIdRefs(subnetIdRefs)

"SubnetIDRefs is a list of references to Subnets used to set the SubnetIDs."

fn spec.forProvider.vpcOptions.withSubnetIdRefsMixin

withSubnetIdRefsMixin(subnetIdRefs)

"SubnetIDRefs is a list of references to Subnets used to set the SubnetIDs."

Note: This function appends passed data to existing values

fn spec.forProvider.vpcOptions.withSubnetIds

withSubnetIds(subnetIds)

"SecurityGroupIDs is the list of IDs for the SecurityGroups."

fn spec.forProvider.vpcOptions.withSubnetIdsMixin

withSubnetIdsMixin(subnetIds)

"SecurityGroupIDs is the list of IDs for the SecurityGroups."

Note: This function appends passed data to existing values

obj spec.forProvider.vpcOptions.securityGroupIdRefs

"SecurityGroupIDRefs is a list of references to SecurityGroups used to set the SecurityGroupIDs."

fn spec.forProvider.vpcOptions.securityGroupIdRefs.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.vpcOptions.securityGroupIdRefs.policy

"Policies for referencing."

fn spec.forProvider.vpcOptions.securityGroupIdRefs.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.forProvider.vpcOptions.securityGroupIdRefs.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.forProvider.vpcOptions.securityGroupIdSelector

"SecurityGroupIDsSelector selects references to SecurityGroupID used to set the SecurityGroupIDs."

fn spec.forProvider.vpcOptions.securityGroupIdSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.vpcOptions.securityGroupIdSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.vpcOptions.securityGroupIdSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.vpcOptions.securityGroupIdSelector.policy

"Policies for selection."

fn spec.forProvider.vpcOptions.securityGroupIdSelector.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.forProvider.vpcOptions.securityGroupIdSelector.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.forProvider.vpcOptions.subnetIdRefs

"SubnetIDRefs is a list of references to Subnets used to set the SubnetIDs."

fn spec.forProvider.vpcOptions.subnetIdRefs.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.vpcOptions.subnetIdRefs.policy

"Policies for referencing."

fn spec.forProvider.vpcOptions.subnetIdRefs.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.forProvider.vpcOptions.subnetIdRefs.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.forProvider.vpcOptions.subnetIdSelector

"SubnetIDsSelector selects references to Subnets used to set the SubnetIDs."

fn spec.forProvider.vpcOptions.subnetIdSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.vpcOptions.subnetIdSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.vpcOptions.subnetIdSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.vpcOptions.subnetIdSelector.policy

"Policies for selection."

fn spec.forProvider.vpcOptions.subnetIdSelector.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.forProvider.vpcOptions.subnetIdSelector.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.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."