cache.v1alpha1.cacheCluster
"A CacheCluster is a managed resource that represents an AWS ElastiCache Cache Cluster."
Index
fn new(name)
obj metadata
fn withAnnotations(annotations)
fn withAnnotationsMixin(annotations)
fn withClusterName(clusterName)
fn withCreationTimestamp(creationTimestamp)
fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
fn withDeletionTimestamp(deletionTimestamp)
fn withFinalizers(finalizers)
fn withFinalizersMixin(finalizers)
fn withGenerateName(generateName)
fn withGeneration(generation)
fn withLabels(labels)
fn withLabelsMixin(labels)
fn withName(name)
fn withNamespace(namespace)
fn withOwnerReferences(ownerReferences)
fn withOwnerReferencesMixin(ownerReferences)
fn withResourceVersion(resourceVersion)
fn withSelfLink(selfLink)
fn withUid(uid)
obj spec
fn withDeletionPolicy(deletionPolicy)
obj spec.forProvider
fn withApplyImmediately(applyImmediately)
fn withAuthToken(authToken)
fn withAuthTokenUpdateStrategy(authTokenUpdateStrategy)
fn withAzMode(azMode)
fn withCacheNodeIdsToRemove(cacheNodeIdsToRemove)
fn withCacheNodeIdsToRemoveMixin(cacheNodeIdsToRemove)
fn withCacheNodeType(cacheNodeType)
fn withCacheParameterGroupName(cacheParameterGroupName)
fn withCacheSecurityGroupNames(cacheSecurityGroupNames)
fn withCacheSecurityGroupNamesMixin(cacheSecurityGroupNames)
fn withCacheSubnetGroupName(cacheSubnetGroupName)
fn withEngine(engine)
fn withEngineVersion(engineVersion)
fn withNotificationTopicArn(notificationTopicArn)
fn withNumCacheNodes(numCacheNodes)
fn withPort(port)
fn withPreferredAvailabilityZone(preferredAvailabilityZone)
fn withPreferredAvailabilityZones(preferredAvailabilityZones)
fn withPreferredAvailabilityZonesMixin(preferredAvailabilityZones)
fn withPreferredMaintenanceWindow(preferredMaintenanceWindow)
fn withRegion(region)
fn withReplicationGroupId(replicationGroupId)
fn withSecurityGroupIDRefs(securityGroupIDRefs)
fn withSecurityGroupIDRefsMixin(securityGroupIDRefs)
fn withSecurityGroupIds(securityGroupIds)
fn withSecurityGroupIdsMixin(securityGroupIds)
fn withSnapshotArns(snapshotArns)
fn withSnapshotArnsMixin(snapshotArns)
fn withSnapshotName(snapshotName)
fn withSnapshotRetentionLimit(snapshotRetentionLimit)
fn withSnapshotWindow(snapshotWindow)
fn withTags(tags)
fn withTagsMixin(tags)
obj spec.forProvider.cacheSubnetGroupNameRef
obj spec.forProvider.cacheSubnetGroupNameSelector
obj spec.forProvider.notificationTopicArnRef
obj spec.forProvider.notificationTopicArnSelector
obj spec.forProvider.securityGroupIDRefs
obj spec.forProvider.securityGroupIDSelector
obj spec.forProvider.tags
obj spec.providerConfigRef
obj spec.providerRef
obj spec.publishConnectionDetailsTo
obj spec.writeConnectionSecretToRef
Fields
fn new
new(name)
new returns an instance of CacheCluster
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"
fn metadata.withSelfLink
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
"A CacheClusterSpec defines the desired state of a CacheCluster."
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
"CacheClusterParameters define the desired state of an AWS ElastiCache Cache Cluster. Most fields map directly to an AWS ReplicationGroup: https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateReplicationGroup.html#API_CreateReplicationGroup_RequestParameters"
fn spec.forProvider.withApplyImmediately
withApplyImmediately(applyImmediately)
"If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If false, changes to the cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first."
fn spec.forProvider.withAuthToken
withAuthToken(authToken)
"The password used to access a password protected server."
fn spec.forProvider.withAuthTokenUpdateStrategy
withAuthTokenUpdateStrategy(authTokenUpdateStrategy)
"Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:"
fn spec.forProvider.withAzMode
withAzMode(azMode)
"Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region. This parameter is only supported for Memcached clusters."
fn spec.forProvider.withCacheNodeIdsToRemove
withCacheNodeIdsToRemove(cacheNodeIdsToRemove)
"A list of cache node IDs to be removed."
fn spec.forProvider.withCacheNodeIdsToRemoveMixin
withCacheNodeIdsToRemoveMixin(cacheNodeIdsToRemove)
"A list of cache node IDs to be removed."
Note: This function appends passed data to existing values
fn spec.forProvider.withCacheNodeType
withCacheNodeType(cacheNodeType)
"The compute and memory capacity of the nodes in the node group (shard)."
fn spec.forProvider.withCacheParameterGroupName
withCacheParameterGroupName(cacheParameterGroupName)
"The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used."
fn spec.forProvider.withCacheSecurityGroupNames
withCacheSecurityGroupNames(cacheSecurityGroupNames)
"A list of security group names to associate with this cluster."
fn spec.forProvider.withCacheSecurityGroupNamesMixin
withCacheSecurityGroupNamesMixin(cacheSecurityGroupNames)
"A list of security group names to associate with this cluster."
Note: This function appends passed data to existing values
fn spec.forProvider.withCacheSubnetGroupName
withCacheSubnetGroupName(cacheSubnetGroupName)
"The name of the subnet group to be used for the cluster."
fn spec.forProvider.withEngine
withEngine(engine)
"The name of the cache engine to be used for this cluster."
fn spec.forProvider.withEngineVersion
withEngineVersion(engineVersion)
"The version number of the cache engine to be used for this cluster."
fn spec.forProvider.withNotificationTopicArn
withNotificationTopicArn(notificationTopicArn)
"The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent."
fn spec.forProvider.withNumCacheNodes
withNumCacheNodes(numCacheNodes)
"The initial number of cache nodes that the cluster has."
fn spec.forProvider.withPort
withPort(port)
"The port number on which each of the cache nodes accepts connections."
fn spec.forProvider.withPreferredAvailabilityZone
withPreferredAvailabilityZone(preferredAvailabilityZone)
"The EC2 Availability Zone in which the cluster is created. Default: System chosen Availability Zone."
fn spec.forProvider.withPreferredAvailabilityZones
withPreferredAvailabilityZones(preferredAvailabilityZones)
"A list of the Availability Zones in which cache nodes are created."
fn spec.forProvider.withPreferredAvailabilityZonesMixin
withPreferredAvailabilityZonesMixin(preferredAvailabilityZones)
"A list of the Availability Zones in which cache nodes are created."
Note: This function appends passed data to existing values
fn spec.forProvider.withPreferredMaintenanceWindow
withPreferredMaintenanceWindow(preferredMaintenanceWindow)
"Specifies the weekly time range during which maintenance on the cluster is performed."
fn spec.forProvider.withRegion
withRegion(region)
"Region is the region you'd like your CacheSubnetGroup to be created in."
fn spec.forProvider.withReplicationGroupId
withReplicationGroupId(replicationGroupId)
"The ID of the replication group to which this cluster should belong."
fn spec.forProvider.withSecurityGroupIDRefs
withSecurityGroupIDRefs(securityGroupIDRefs)
"A referencer to retrieve the ID of a Security group"
fn spec.forProvider.withSecurityGroupIDRefsMixin
withSecurityGroupIDRefsMixin(securityGroupIDRefs)
"A referencer to retrieve the ID of a Security group"
Note: This function appends passed data to existing values
fn spec.forProvider.withSecurityGroupIds
withSecurityGroupIds(securityGroupIds)
"One or more VPC security groups associated with the cluster."
fn spec.forProvider.withSecurityGroupIdsMixin
withSecurityGroupIdsMixin(securityGroupIds)
"One or more VPC security groups associated with the cluster."
Note: This function appends passed data to existing values
fn spec.forProvider.withSnapshotArns
withSnapshotArns(snapshotArns)
"A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3."
fn spec.forProvider.withSnapshotArnsMixin
withSnapshotArnsMixin(snapshotArns)
"A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3."
Note: This function appends passed data to existing values
fn spec.forProvider.withSnapshotName
withSnapshotName(snapshotName)
"The name of a Redis snapshot from which to restore data into the new node group (shard)."
fn spec.forProvider.withSnapshotRetentionLimit
withSnapshotRetentionLimit(snapshotRetentionLimit)
"The number of days for which ElastiCache retains automatic snapshots before deleting them."
fn spec.forProvider.withSnapshotWindow
withSnapshotWindow(snapshotWindow)
"The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard)."
fn spec.forProvider.withTags
withTags(tags)
"A list of cost allocation tags to be added to this resource."
fn spec.forProvider.withTagsMixin
withTagsMixin(tags)
"A list of cost allocation tags to be added to this resource."
Note: This function appends passed data to existing values
obj spec.forProvider.cacheSubnetGroupNameRef
"A referencer to retrieve the name of a CacheSubnetGroup"
fn spec.forProvider.cacheSubnetGroupNameRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.cacheSubnetGroupNameRef.policy
"Policies for referencing."
fn spec.forProvider.cacheSubnetGroupNameRef.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.cacheSubnetGroupNameRef.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.cacheSubnetGroupNameSelector
"A selector to select a referencer to retrieve the name of a CacheSubnetGroup"
fn spec.forProvider.cacheSubnetGroupNameSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.cacheSubnetGroupNameSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.cacheSubnetGroupNameSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.cacheSubnetGroupNameSelector.policy
"Policies for selection."
fn spec.forProvider.cacheSubnetGroupNameSelector.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.cacheSubnetGroupNameSelector.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.notificationTopicArnRef
"NotificationTopicARNRef references an SNS Topic to retrieve its NotificationTopicARN"
fn spec.forProvider.notificationTopicArnRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.notificationTopicArnRef.policy
"Policies for referencing."
fn spec.forProvider.notificationTopicArnRef.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.notificationTopicArnRef.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.notificationTopicArnSelector
"NotificationTopicARNSelector selects a reference to an SNS Topic to retrieve its NotificationTopicARN"
fn spec.forProvider.notificationTopicArnSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.notificationTopicArnSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.notificationTopicArnSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.notificationTopicArnSelector.policy
"Policies for selection."
fn spec.forProvider.notificationTopicArnSelector.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.notificationTopicArnSelector.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.securityGroupIDRefs
"A referencer to retrieve the ID of a Security group"
fn spec.forProvider.securityGroupIDRefs.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.securityGroupIDRefs.policy
"Policies for referencing."
fn spec.forProvider.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.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.securityGroupIDSelector
"A selector to select a referencer to retrieve the ID of a Security Group"
fn spec.forProvider.securityGroupIDSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.securityGroupIDSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.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.securityGroupIDSelector.policy
"Policies for selection."
fn spec.forProvider.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.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.tags
"A list of cost allocation tags to be added to this resource."
fn spec.forProvider.tags.withKey
withKey(key)
"Key for the tag."
fn spec.forProvider.tags.withValue
withValue(value)
"Value of the tag."
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."