lambda.v1beta1.function
"Function is the Schema for the Functions API"
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 withArchitectures(architectures)
fn withArchitecturesMixin(architectures)
fn withCodeSigningConfigARN(codeSigningConfigARN)
fn withDescription(description)
fn withFileSystemConfigs(fileSystemConfigs)
fn withFileSystemConfigsMixin(fileSystemConfigs)
fn withHandler(handler)
fn withKmsKeyARN(kmsKeyARN)
fn withLayers(layers)
fn withLayersMixin(layers)
fn withMemorySize(memorySize)
fn withPackageType(packageType)
fn withPublish(publish)
fn withRegion(region)
fn withRole(role)
fn withRuntime(runtime)
fn withTags(tags)
fn withTagsMixin(tags)
fn withTimeout(timeout)
obj spec.forProvider.code
obj spec.forProvider.deadLetterConfig
obj spec.forProvider.environment
obj spec.forProvider.ephemeralStorage
obj spec.forProvider.fileSystemConfigs
obj spec.forProvider.imageConfig
obj spec.forProvider.kmsKeyARNRef
obj spec.forProvider.kmsKeyARNSelector
obj spec.forProvider.roleRef
obj spec.forProvider.roleSelector
obj spec.forProvider.tracingConfig
obj spec.forProvider.vpcConfig
fn withSecurityGroupIDRefs(securityGroupIDRefs)
fn withSecurityGroupIDRefsMixin(securityGroupIDRefs)
fn withSecurityGroupIDs(securityGroupIDs)
fn withSecurityGroupIDsMixin(securityGroupIDs)
fn withSubnetIDRefs(subnetIDRefs)
fn withSubnetIDRefsMixin(subnetIDRefs)
fn withSubnetIDs(subnetIDs)
fn withSubnetIDsMixin(subnetIDs)
obj spec.forProvider.vpcConfig.securityGroupIDRefs
obj spec.forProvider.vpcConfig.securityGroupIDSelector
obj spec.forProvider.vpcConfig.subnetIDRefs
obj spec.forProvider.vpcConfig.subnetIDSelector
obj spec.providerConfigRef
obj spec.providerRef
obj spec.publishConnectionDetailsTo
obj spec.writeConnectionSecretToRef
Fields
fn new
new(name)
new returns an instance of Function
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
"FunctionSpec defines the desired state of Function"
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
"FunctionParameters defines the desired state of Function"
fn spec.forProvider.withArchitectures
withArchitectures(architectures)
"The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64."
fn spec.forProvider.withArchitecturesMixin
withArchitecturesMixin(architectures)
"The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64."
Note: This function appends passed data to existing values
fn spec.forProvider.withCodeSigningConfigARN
withCodeSigningConfigARN(codeSigningConfigARN)
"To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function."
fn spec.forProvider.withDescription
withDescription(description)
"A description of the function."
fn spec.forProvider.withFileSystemConfigs
withFileSystemConfigs(fileSystemConfigs)
"Connection settings for an Amazon EFS file system."
fn spec.forProvider.withFileSystemConfigsMixin
withFileSystemConfigsMixin(fileSystemConfigs)
"Connection settings for an Amazon EFS file system."
Note: This function appends passed data to existing values
fn spec.forProvider.withHandler
withHandler(handler)
"The name of the method within your code that Lambda calls to execute your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model (https://docs.aws.amazon.com/lambda/latest/dg/programming-model-v2.html)."
fn spec.forProvider.withKmsKeyARN
withKmsKeyARN(kmsKeyARN)
"The ARN of the Amazon Web Services Key Management Service (KMS) key that's used to encrypt your function's environment variables. If it's not provided, Lambda uses a default service key."
fn spec.forProvider.withLayers
withLayers(layers)
"A list of function layers (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment. Specify each layer by its ARN, including the version."
fn spec.forProvider.withLayersMixin
withLayersMixin(layers)
"A list of function layers (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment. Specify each layer by its ARN, including the version."
Note: This function appends passed data to existing values
fn spec.forProvider.withMemorySize
withMemorySize(memorySize)
"The amount of memory available to the function (https://docs.aws.amazon.com/lambda/latest/dg/configuration-memory.html) at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB."
fn spec.forProvider.withPackageType
withPackageType(packageType)
"The type of deployment package. Set to Image for container image and set Zip for ZIP archive."
fn spec.forProvider.withPublish
withPublish(publish)
"Set to true to publish the first version of the function during creation."
fn spec.forProvider.withRegion
withRegion(region)
"Region is which region the Function will be created."
fn spec.forProvider.withRole
withRole(role)
"The Amazon Resource Name (ARN) of the function's execution role. One of role, roleRef or roleSelector is required."
fn spec.forProvider.withRuntime
withRuntime(runtime)
"The identifier of the function's runtime (https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). Runtime is required if the deployment package is a .zip file archive."
fn spec.forProvider.withTags
withTags(tags)
"A list of tags (https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function."
fn spec.forProvider.withTagsMixin
withTagsMixin(tags)
"A list of tags (https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function."
Note: This function appends passed data to existing values
fn spec.forProvider.withTimeout
withTimeout(timeout)
"The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For additional information, see Lambda execution environment (https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html)."
obj spec.forProvider.code
"The code for the function."
fn spec.forProvider.code.withImageURI
withImageURI(imageURI)
fn spec.forProvider.code.withS3Bucket
withS3Bucket(s3Bucket)
fn spec.forProvider.code.withS3Key
withS3Key(s3Key)
fn spec.forProvider.code.withS3ObjectVersion
withS3ObjectVersion(s3ObjectVersion)
obj spec.forProvider.code.s3BucketRef
"S3BucketRef is a reference to an S3 Bucket."
fn spec.forProvider.code.s3BucketRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.code.s3BucketRef.policy
"Policies for referencing."
fn spec.forProvider.code.s3BucketRef.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.code.s3BucketRef.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.code.s3BucketSelector
"S3BucketSelector selects references to an S3 Bucket."
fn spec.forProvider.code.s3BucketSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.code.s3BucketSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.code.s3BucketSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.code.s3BucketSelector.policy
"Policies for selection."
fn spec.forProvider.code.s3BucketSelector.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.code.s3BucketSelector.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.deadLetterConfig
"A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues (https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#dlq)."
fn spec.forProvider.deadLetterConfig.withTargetARN
withTargetARN(targetARN)
obj spec.forProvider.environment
"Environment variables that are accessible from function code during execution."
fn spec.forProvider.environment.withVariables
withVariables(variables)
fn spec.forProvider.environment.withVariablesMixin
withVariablesMixin(variables)
Note: This function appends passed data to existing values
obj spec.forProvider.ephemeralStorage
"The size of the function’s /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10240 MB."
fn spec.forProvider.ephemeralStorage.withSize
withSize(size)
obj spec.forProvider.fileSystemConfigs
"Connection settings for an Amazon EFS file system."
fn spec.forProvider.fileSystemConfigs.withArn
withArn(arn)
fn spec.forProvider.fileSystemConfigs.withLocalMountPath
withLocalMountPath(localMountPath)
obj spec.forProvider.imageConfig
"Container image configuration values (https://docs.aws.amazon.com/lambda/latest/dg/configuration-images.html#configuration-images-settings) that override the values in the container image Dockerfile."
fn spec.forProvider.imageConfig.withCommand
withCommand(command)
fn spec.forProvider.imageConfig.withCommandMixin
withCommandMixin(command)
Note: This function appends passed data to existing values
fn spec.forProvider.imageConfig.withEntryPoint
withEntryPoint(entryPoint)
fn spec.forProvider.imageConfig.withEntryPointMixin
withEntryPointMixin(entryPoint)
Note: This function appends passed data to existing values
fn spec.forProvider.imageConfig.withWorkingDirectory
withWorkingDirectory(workingDirectory)
obj spec.forProvider.kmsKeyARNRef
"KMSKeyARNRef is a reference to a kms key used to set the KMSKeyARN."
fn spec.forProvider.kmsKeyARNRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.kmsKeyARNRef.policy
"Policies for referencing."
fn spec.forProvider.kmsKeyARNRef.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.kmsKeyARNRef.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.kmsKeyARNSelector
"KMSKeyARNSelector selects references to kms key arn used to set the KMSKeyARN."
fn spec.forProvider.kmsKeyARNSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.kmsKeyARNSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.kmsKeyARNSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.kmsKeyARNSelector.policy
"Policies for selection."
fn spec.forProvider.kmsKeyARNSelector.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.kmsKeyARNSelector.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.roleRef
"RoleRef is a reference to an iam role"
fn spec.forProvider.roleRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.roleRef.policy
"Policies for referencing."
fn spec.forProvider.roleRef.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.roleRef.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.roleSelector
"RoleSelector selects references to iam role arn used to set the lambda Role."
fn spec.forProvider.roleSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.roleSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.roleSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.roleSelector.policy
"Policies for selection."
fn spec.forProvider.roleSelector.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.roleSelector.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.tracingConfig
"Set Mode to Active to sample and trace a subset of incoming requests with X-Ray (https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html)."
fn spec.forProvider.tracingConfig.withMode
withMode(mode)
obj spec.forProvider.vpcConfig
"For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings (https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html)."
fn spec.forProvider.vpcConfig.withSecurityGroupIDRefs
withSecurityGroupIDRefs(securityGroupIDRefs)
"SecurityGroupIDRefs is a list of references to SecurityGroups used to set the SecurityGroupIDs."
fn spec.forProvider.vpcConfig.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.vpcConfig.withSecurityGroupIDs
withSecurityGroupIDs(securityGroupIDs)
fn spec.forProvider.vpcConfig.withSecurityGroupIDsMixin
withSecurityGroupIDsMixin(securityGroupIDs)
Note: This function appends passed data to existing values
fn spec.forProvider.vpcConfig.withSubnetIDRefs
withSubnetIDRefs(subnetIDRefs)
"SubnetIDRefs is a list of references to Subnets used to set the SubnetIDs."
fn spec.forProvider.vpcConfig.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.vpcConfig.withSubnetIDs
withSubnetIDs(subnetIDs)
fn spec.forProvider.vpcConfig.withSubnetIDsMixin
withSubnetIDsMixin(subnetIDs)
Note: This function appends passed data to existing values
obj spec.forProvider.vpcConfig.securityGroupIDRefs
"SecurityGroupIDRefs is a list of references to SecurityGroups used to set the SecurityGroupIDs."
fn spec.forProvider.vpcConfig.securityGroupIDRefs.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.vpcConfig.securityGroupIDRefs.policy
"Policies for referencing."
fn spec.forProvider.vpcConfig.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.vpcConfig.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.vpcConfig.securityGroupIDSelector
"SecurityGroupIDsSelector selects references to SecurityGroupID used to set the SecurityGroupIDs."
fn spec.forProvider.vpcConfig.securityGroupIDSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.vpcConfig.securityGroupIDSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.vpcConfig.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.vpcConfig.securityGroupIDSelector.policy
"Policies for selection."
fn spec.forProvider.vpcConfig.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.vpcConfig.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.vpcConfig.subnetIDRefs
"SubnetIDRefs is a list of references to Subnets used to set the SubnetIDs."
fn spec.forProvider.vpcConfig.subnetIDRefs.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.vpcConfig.subnetIDRefs.policy
"Policies for referencing."
fn spec.forProvider.vpcConfig.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.vpcConfig.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.vpcConfig.subnetIDSelector
"SubnetIDsSelector selects references to Subnets used to set the SubnetIDs."
fn spec.forProvider.vpcConfig.subnetIDSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.vpcConfig.subnetIDSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.vpcConfig.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.vpcConfig.subnetIDSelector.policy
"Policies for selection."
fn spec.forProvider.vpcConfig.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.vpcConfig.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."