cloudfront.v1alpha1.distribution
"Distribution is the Schema for the Distributions 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 withRegion(region)
obj spec.forProvider.distributionConfig
fn withCallerReference(callerReference)
fn withComment(comment)
fn withDefaultRootObject(defaultRootObject)
fn withEnabled(enabled)
fn withHttpVersion(httpVersion)
fn withIsIPV6Enabled(isIPV6Enabled)
fn withPriceClass(priceClass)
fn withWebACLID(webACLID)
obj spec.forProvider.distributionConfig.aliases
obj spec.forProvider.distributionConfig.cacheBehaviors
fn withItems(items)
fn withItemsMixin(items)
obj spec.forProvider.distributionConfig.cacheBehaviors.items
fn withCachePolicyID(cachePolicyID)
fn withCompress(compress)
fn withDefaultTTL(defaultTTL)
fn withFieldLevelEncryptionID(fieldLevelEncryptionID)
fn withMaxTTL(maxTTL)
fn withMinTTL(minTTL)
fn withOriginRequestPolicyID(originRequestPolicyID)
fn withPathPattern(pathPattern)
fn withRealtimeLogConfigARN(realtimeLogConfigARN)
fn withResponseHeadersPolicyID(responseHeadersPolicyID)
fn withSmoothStreaming(smoothStreaming)
fn withTargetOriginID(targetOriginID)
fn withViewerProtocolPolicy(viewerProtocolPolicy)
obj spec.forProvider.distributionConfig.cacheBehaviors.items.allowedMethods
obj spec.forProvider.distributionConfig.cacheBehaviors.items.forwardedValues
obj spec.forProvider.distributionConfig.cacheBehaviors.items.functionAssociations
obj spec.forProvider.distributionConfig.cacheBehaviors.items.lambdaFunctionAssociations
obj spec.forProvider.distributionConfig.cacheBehaviors.items.trustedKeyGroups
obj spec.forProvider.distributionConfig.cacheBehaviors.items.trustedSigners
obj spec.forProvider.distributionConfig.customErrorResponses
obj spec.forProvider.distributionConfig.defaultCacheBehavior
fn withCachePolicyID(cachePolicyID)
fn withCompress(compress)
fn withDefaultTTL(defaultTTL)
fn withFieldLevelEncryptionID(fieldLevelEncryptionID)
fn withMaxTTL(maxTTL)
fn withMinTTL(minTTL)
fn withOriginRequestPolicyID(originRequestPolicyID)
fn withRealtimeLogConfigARN(realtimeLogConfigARN)
fn withResponseHeadersPolicyID(responseHeadersPolicyID)
fn withSmoothStreaming(smoothStreaming)
fn withTargetOriginID(targetOriginID)
fn withViewerProtocolPolicy(viewerProtocolPolicy)
obj spec.forProvider.distributionConfig.defaultCacheBehavior.allowedMethods
obj spec.forProvider.distributionConfig.defaultCacheBehavior.forwardedValues
obj spec.forProvider.distributionConfig.defaultCacheBehavior.functionAssociations
obj spec.forProvider.distributionConfig.defaultCacheBehavior.lambdaFunctionAssociations
obj spec.forProvider.distributionConfig.defaultCacheBehavior.trustedKeyGroups
obj spec.forProvider.distributionConfig.defaultCacheBehavior.trustedSigners
obj spec.forProvider.distributionConfig.logging
obj spec.forProvider.distributionConfig.originGroups
obj spec.forProvider.distributionConfig.origins
fn withItems(items)
fn withItemsMixin(items)
obj spec.forProvider.distributionConfig.origins.items
fn withConnectionAttempts(connectionAttempts)
fn withConnectionTimeout(connectionTimeout)
fn withDomainName(domainName)
fn withId(id)
fn withOriginPath(originPath)
obj spec.forProvider.distributionConfig.origins.items.customHeaders
obj spec.forProvider.distributionConfig.origins.items.customOriginConfig
obj spec.forProvider.distributionConfig.origins.items.originShield
obj spec.forProvider.distributionConfig.origins.items.s3OriginConfig
obj spec.forProvider.distributionConfig.restrictions
obj spec.forProvider.distributionConfig.viewerCertificate
fn withACMCertificateARN(aCMCertificateARN)
fn withCertificate(certificate)
fn withCertificateSource(certificateSource)
fn withCloudFrontDefaultCertificate(cloudFrontDefaultCertificate)
fn withIamCertificateID(iamCertificateID)
fn withMinimumProtocolVersion(minimumProtocolVersion)
fn withSslSupportMethod(sslSupportMethod)
obj spec.providerConfigRef
obj spec.providerRef
obj spec.publishConnectionDetailsTo
obj spec.writeConnectionSecretToRef
Fields
fn new
new(name)
new returns an instance of Distribution
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
"DistributionSpec defines the desired state of Distribution"
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
"DistributionParameters defines the desired state of Distribution"
fn spec.forProvider.withRegion
withRegion(region)
"Region is which region the Distribution will be created."
obj spec.forProvider.distributionConfig
"The distribution's configuration information."
fn spec.forProvider.distributionConfig.withCallerReference
withCallerReference(callerReference)
fn spec.forProvider.distributionConfig.withComment
withComment(comment)
fn spec.forProvider.distributionConfig.withDefaultRootObject
withDefaultRootObject(defaultRootObject)
fn spec.forProvider.distributionConfig.withEnabled
withEnabled(enabled)
fn spec.forProvider.distributionConfig.withHttpVersion
withHttpVersion(httpVersion)
fn spec.forProvider.distributionConfig.withIsIPV6Enabled
withIsIPV6Enabled(isIPV6Enabled)
fn spec.forProvider.distributionConfig.withPriceClass
withPriceClass(priceClass)
fn spec.forProvider.distributionConfig.withWebACLID
withWebACLID(webACLID)
obj spec.forProvider.distributionConfig.aliases
"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution."
fn spec.forProvider.distributionConfig.aliases.withItems
withItems(items)
fn spec.forProvider.distributionConfig.aliases.withItemsMixin
withItemsMixin(items)
Note: This function appends passed data to existing values
obj spec.forProvider.distributionConfig.cacheBehaviors
"A complex type that contains zero or more CacheBehavior elements."
fn spec.forProvider.distributionConfig.cacheBehaviors.withItems
withItems(items)
fn spec.forProvider.distributionConfig.cacheBehaviors.withItemsMixin
withItemsMixin(items)
Note: This function appends passed data to existing values
obj spec.forProvider.distributionConfig.cacheBehaviors.items
fn spec.forProvider.distributionConfig.cacheBehaviors.items.withCachePolicyID
withCachePolicyID(cachePolicyID)
fn spec.forProvider.distributionConfig.cacheBehaviors.items.withCompress
withCompress(compress)
fn spec.forProvider.distributionConfig.cacheBehaviors.items.withDefaultTTL
withDefaultTTL(defaultTTL)
fn spec.forProvider.distributionConfig.cacheBehaviors.items.withFieldLevelEncryptionID
withFieldLevelEncryptionID(fieldLevelEncryptionID)
fn spec.forProvider.distributionConfig.cacheBehaviors.items.withMaxTTL
withMaxTTL(maxTTL)
fn spec.forProvider.distributionConfig.cacheBehaviors.items.withMinTTL
withMinTTL(minTTL)
fn spec.forProvider.distributionConfig.cacheBehaviors.items.withOriginRequestPolicyID
withOriginRequestPolicyID(originRequestPolicyID)
fn spec.forProvider.distributionConfig.cacheBehaviors.items.withPathPattern
withPathPattern(pathPattern)
fn spec.forProvider.distributionConfig.cacheBehaviors.items.withRealtimeLogConfigARN
withRealtimeLogConfigARN(realtimeLogConfigARN)
fn spec.forProvider.distributionConfig.cacheBehaviors.items.withResponseHeadersPolicyID
withResponseHeadersPolicyID(responseHeadersPolicyID)
fn spec.forProvider.distributionConfig.cacheBehaviors.items.withSmoothStreaming
withSmoothStreaming(smoothStreaming)
fn spec.forProvider.distributionConfig.cacheBehaviors.items.withTargetOriginID
withTargetOriginID(targetOriginID)
fn spec.forProvider.distributionConfig.cacheBehaviors.items.withViewerProtocolPolicy
withViewerProtocolPolicy(viewerProtocolPolicy)
obj spec.forProvider.distributionConfig.cacheBehaviors.items.allowedMethods
"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: \n * CloudFront forwards only GET and HEAD requests. \n * CloudFront forwards only GET, HEAD, and OPTIONS requests. \n * CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. \n If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin."
fn spec.forProvider.distributionConfig.cacheBehaviors.items.allowedMethods.withItems
withItems(items)
fn spec.forProvider.distributionConfig.cacheBehaviors.items.allowedMethods.withItemsMixin
withItemsMixin(items)
Note: This function appends passed data to existing values
obj spec.forProvider.distributionConfig.cacheBehaviors.items.allowedMethods.cachedMethods
"A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: \n * CloudFront caches responses to GET and HEAD requests. \n * CloudFront caches responses to GET, HEAD, and OPTIONS requests. \n If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly."
fn spec.forProvider.distributionConfig.cacheBehaviors.items.allowedMethods.cachedMethods.withItems
withItems(items)
fn spec.forProvider.distributionConfig.cacheBehaviors.items.allowedMethods.cachedMethods.withItemsMixin
withItemsMixin(items)
Note: This function appends passed data to existing values
obj spec.forProvider.distributionConfig.cacheBehaviors.items.forwardedValues
"This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. \n If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the Amazon CloudFront Developer Guide. \n If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the Amazon CloudFront Developer Guide. \n A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers."
fn spec.forProvider.distributionConfig.cacheBehaviors.items.forwardedValues.withQueryString
withQueryString(queryString)
obj spec.forProvider.distributionConfig.cacheBehaviors.items.forwardedValues.cookies
"This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. \n If you want to include cookies in the cache key, use CookiesConfig in a cache policy. See CachePolicy. \n If you want to send cookies to the origin but not include them in the cache key, use CookiesConfig in an origin request policy. See OriginRequestPolicy. \n A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see Caching Content Based on Cookies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the Amazon CloudFront Developer Guide."
fn spec.forProvider.distributionConfig.cacheBehaviors.items.forwardedValues.cookies.withForward
withForward(forward)
obj spec.forProvider.distributionConfig.cacheBehaviors.items.forwardedValues.cookies.whitelistedNames
"Contains a list of cookie names."
fn spec.forProvider.distributionConfig.cacheBehaviors.items.forwardedValues.cookies.whitelistedNames.withItems
withItems(items)
fn spec.forProvider.distributionConfig.cacheBehaviors.items.forwardedValues.cookies.whitelistedNames.withItemsMixin
withItemsMixin(items)
Note: This function appends passed data to existing values
fn spec.forProvider.distributionConfig.cacheBehaviors.items.forwardedValues.cookies.whitelistedNames.withQuantity
withQuantity(quantity)
obj spec.forProvider.distributionConfig.cacheBehaviors.items.forwardedValues.headers
"Contains a list of HTTP header names."
fn spec.forProvider.distributionConfig.cacheBehaviors.items.forwardedValues.headers.withItems
withItems(items)
fn spec.forProvider.distributionConfig.cacheBehaviors.items.forwardedValues.headers.withItemsMixin
withItemsMixin(items)
Note: This function appends passed data to existing values
obj spec.forProvider.distributionConfig.cacheBehaviors.items.forwardedValues.queryStringCacheKeys
"This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. \n If you want to include query strings in the cache key, use QueryStringsConfig in a cache policy. See CachePolicy. \n If you want to send query strings to the origin but not include them in the cache key, use QueryStringsConfig in an origin request policy. See OriginRequestPolicy. \n A complex type that contains information about the query string parameters that you want CloudFront to use for caching for a cache behavior."
fn spec.forProvider.distributionConfig.cacheBehaviors.items.forwardedValues.queryStringCacheKeys.withItems
withItems(items)
fn spec.forProvider.distributionConfig.cacheBehaviors.items.forwardedValues.queryStringCacheKeys.withItemsMixin
withItemsMixin(items)
Note: This function appends passed data to existing values
obj spec.forProvider.distributionConfig.cacheBehaviors.items.functionAssociations
"A list of CloudFront functions that are associated with a cache behavior in a CloudFront distribution. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior."
fn spec.forProvider.distributionConfig.cacheBehaviors.items.functionAssociations.withItems
withItems(items)
fn spec.forProvider.distributionConfig.cacheBehaviors.items.functionAssociations.withItemsMixin
withItemsMixin(items)
Note: This function appends passed data to existing values
obj spec.forProvider.distributionConfig.cacheBehaviors.items.functionAssociations.items
fn spec.forProvider.distributionConfig.cacheBehaviors.items.functionAssociations.items.withEventType
withEventType(eventType)
fn spec.forProvider.distributionConfig.cacheBehaviors.items.functionAssociations.items.withFunctionARN
withFunctionARN(functionARN)
obj spec.forProvider.distributionConfig.cacheBehaviors.items.lambdaFunctionAssociations
"A complex type that specifies a list of Lambda@Edge functions associations for a cache behavior. \n If you want to invoke one or more Lambda@Edge functions triggered by requests that match the PathPattern of the cache behavior, specify the applicable values for Quantity and Items. Note that there can be up to 4 LambdaFunctionAssociation items in this list (one for each possible value of EventType) and each EventType can be associated with only one function. \n If you don't want to invoke any Lambda@Edge functions for the requests that match PathPattern, specify 0 for Quantity and omit Items."
fn spec.forProvider.distributionConfig.cacheBehaviors.items.lambdaFunctionAssociations.withItems
withItems(items)
fn spec.forProvider.distributionConfig.cacheBehaviors.items.lambdaFunctionAssociations.withItemsMixin
withItemsMixin(items)
Note: This function appends passed data to existing values
obj spec.forProvider.distributionConfig.cacheBehaviors.items.lambdaFunctionAssociations.items
fn spec.forProvider.distributionConfig.cacheBehaviors.items.lambdaFunctionAssociations.items.withEventType
withEventType(eventType)
fn spec.forProvider.distributionConfig.cacheBehaviors.items.lambdaFunctionAssociations.items.withIncludeBody
withIncludeBody(includeBody)
fn spec.forProvider.distributionConfig.cacheBehaviors.items.lambdaFunctionAssociations.items.withLambdaFunctionARN
withLambdaFunctionARN(lambdaFunctionARN)
obj spec.forProvider.distributionConfig.cacheBehaviors.items.trustedKeyGroups
"A list of key groups whose public keys CloudFront can use to verify the signatures of signed URLs and signed cookies."
fn spec.forProvider.distributionConfig.cacheBehaviors.items.trustedKeyGroups.withEnabled
withEnabled(enabled)
fn spec.forProvider.distributionConfig.cacheBehaviors.items.trustedKeyGroups.withItems
withItems(items)
fn spec.forProvider.distributionConfig.cacheBehaviors.items.trustedKeyGroups.withItemsMixin
withItemsMixin(items)
Note: This function appends passed data to existing values
obj spec.forProvider.distributionConfig.cacheBehaviors.items.trustedSigners
"A list of Amazon Web Services accounts whose public keys CloudFront can use to verify the signatures of signed URLs and signed cookies."
fn spec.forProvider.distributionConfig.cacheBehaviors.items.trustedSigners.withEnabled
withEnabled(enabled)
fn spec.forProvider.distributionConfig.cacheBehaviors.items.trustedSigners.withItems
withItems(items)
fn spec.forProvider.distributionConfig.cacheBehaviors.items.trustedSigners.withItemsMixin
withItemsMixin(items)
Note: This function appends passed data to existing values
obj spec.forProvider.distributionConfig.customErrorResponses
"A complex type that controls: \n * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. \n * How long CloudFront caches HTTP status codes in the 4xx and 5xx range. \n For more information about custom error pages, see Customizing Error Responses (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the Amazon CloudFront Developer Guide."
fn spec.forProvider.distributionConfig.customErrorResponses.withItems
withItems(items)
fn spec.forProvider.distributionConfig.customErrorResponses.withItemsMixin
withItemsMixin(items)
Note: This function appends passed data to existing values
obj spec.forProvider.distributionConfig.customErrorResponses.items
fn spec.forProvider.distributionConfig.customErrorResponses.items.withErrorCachingMinTTL
withErrorCachingMinTTL(errorCachingMinTTL)
fn spec.forProvider.distributionConfig.customErrorResponses.items.withErrorCode
withErrorCode(errorCode)
fn spec.forProvider.distributionConfig.customErrorResponses.items.withResponseCode
withResponseCode(responseCode)
fn spec.forProvider.distributionConfig.customErrorResponses.items.withResponsePagePath
withResponsePagePath(responsePagePath)
obj spec.forProvider.distributionConfig.defaultCacheBehavior
"A complex type that describes the default cache behavior if you don’t specify a CacheBehavior element or if request URLs don’t match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior."
fn spec.forProvider.distributionConfig.defaultCacheBehavior.withCachePolicyID
withCachePolicyID(cachePolicyID)
fn spec.forProvider.distributionConfig.defaultCacheBehavior.withCompress
withCompress(compress)
fn spec.forProvider.distributionConfig.defaultCacheBehavior.withDefaultTTL
withDefaultTTL(defaultTTL)
fn spec.forProvider.distributionConfig.defaultCacheBehavior.withFieldLevelEncryptionID
withFieldLevelEncryptionID(fieldLevelEncryptionID)
fn spec.forProvider.distributionConfig.defaultCacheBehavior.withMaxTTL
withMaxTTL(maxTTL)
fn spec.forProvider.distributionConfig.defaultCacheBehavior.withMinTTL
withMinTTL(minTTL)
fn spec.forProvider.distributionConfig.defaultCacheBehavior.withOriginRequestPolicyID
withOriginRequestPolicyID(originRequestPolicyID)
fn spec.forProvider.distributionConfig.defaultCacheBehavior.withRealtimeLogConfigARN
withRealtimeLogConfigARN(realtimeLogConfigARN)
fn spec.forProvider.distributionConfig.defaultCacheBehavior.withResponseHeadersPolicyID
withResponseHeadersPolicyID(responseHeadersPolicyID)
fn spec.forProvider.distributionConfig.defaultCacheBehavior.withSmoothStreaming
withSmoothStreaming(smoothStreaming)
fn spec.forProvider.distributionConfig.defaultCacheBehavior.withTargetOriginID
withTargetOriginID(targetOriginID)
fn spec.forProvider.distributionConfig.defaultCacheBehavior.withViewerProtocolPolicy
withViewerProtocolPolicy(viewerProtocolPolicy)
obj spec.forProvider.distributionConfig.defaultCacheBehavior.allowedMethods
"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: \n * CloudFront forwards only GET and HEAD requests. \n * CloudFront forwards only GET, HEAD, and OPTIONS requests. \n * CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. \n If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin."
fn spec.forProvider.distributionConfig.defaultCacheBehavior.allowedMethods.withItems
withItems(items)
fn spec.forProvider.distributionConfig.defaultCacheBehavior.allowedMethods.withItemsMixin
withItemsMixin(items)
Note: This function appends passed data to existing values
obj spec.forProvider.distributionConfig.defaultCacheBehavior.allowedMethods.cachedMethods
"A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: \n * CloudFront caches responses to GET and HEAD requests. \n * CloudFront caches responses to GET, HEAD, and OPTIONS requests. \n If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly."
fn spec.forProvider.distributionConfig.defaultCacheBehavior.allowedMethods.cachedMethods.withItems
withItems(items)
fn spec.forProvider.distributionConfig.defaultCacheBehavior.allowedMethods.cachedMethods.withItemsMixin
withItemsMixin(items)
Note: This function appends passed data to existing values
obj spec.forProvider.distributionConfig.defaultCacheBehavior.forwardedValues
"This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. \n If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the Amazon CloudFront Developer Guide. \n If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the Amazon CloudFront Developer Guide. \n A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers."
fn spec.forProvider.distributionConfig.defaultCacheBehavior.forwardedValues.withQueryString
withQueryString(queryString)
obj spec.forProvider.distributionConfig.defaultCacheBehavior.forwardedValues.cookies
"This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. \n If you want to include cookies in the cache key, use CookiesConfig in a cache policy. See CachePolicy. \n If you want to send cookies to the origin but not include them in the cache key, use CookiesConfig in an origin request policy. See OriginRequestPolicy. \n A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see Caching Content Based on Cookies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the Amazon CloudFront Developer Guide."
fn spec.forProvider.distributionConfig.defaultCacheBehavior.forwardedValues.cookies.withForward
withForward(forward)
obj spec.forProvider.distributionConfig.defaultCacheBehavior.forwardedValues.cookies.whitelistedNames
"Contains a list of cookie names."
fn spec.forProvider.distributionConfig.defaultCacheBehavior.forwardedValues.cookies.whitelistedNames.withItems
withItems(items)
fn spec.forProvider.distributionConfig.defaultCacheBehavior.forwardedValues.cookies.whitelistedNames.withItemsMixin
withItemsMixin(items)
Note: This function appends passed data to existing values
fn spec.forProvider.distributionConfig.defaultCacheBehavior.forwardedValues.cookies.whitelistedNames.withQuantity
withQuantity(quantity)
obj spec.forProvider.distributionConfig.defaultCacheBehavior.forwardedValues.headers
"Contains a list of HTTP header names."
fn spec.forProvider.distributionConfig.defaultCacheBehavior.forwardedValues.headers.withItems
withItems(items)
fn spec.forProvider.distributionConfig.defaultCacheBehavior.forwardedValues.headers.withItemsMixin
withItemsMixin(items)
Note: This function appends passed data to existing values
obj spec.forProvider.distributionConfig.defaultCacheBehavior.forwardedValues.queryStringCacheKeys
"This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. \n If you want to include query strings in the cache key, use QueryStringsConfig in a cache policy. See CachePolicy. \n If you want to send query strings to the origin but not include them in the cache key, use QueryStringsConfig in an origin request policy. See OriginRequestPolicy. \n A complex type that contains information about the query string parameters that you want CloudFront to use for caching for a cache behavior."
fn spec.forProvider.distributionConfig.defaultCacheBehavior.forwardedValues.queryStringCacheKeys.withItems
withItems(items)
fn spec.forProvider.distributionConfig.defaultCacheBehavior.forwardedValues.queryStringCacheKeys.withItemsMixin
withItemsMixin(items)
Note: This function appends passed data to existing values
obj spec.forProvider.distributionConfig.defaultCacheBehavior.functionAssociations
"A list of CloudFront functions that are associated with a cache behavior in a CloudFront distribution. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior."
fn spec.forProvider.distributionConfig.defaultCacheBehavior.functionAssociations.withItems
withItems(items)
fn spec.forProvider.distributionConfig.defaultCacheBehavior.functionAssociations.withItemsMixin
withItemsMixin(items)
Note: This function appends passed data to existing values
obj spec.forProvider.distributionConfig.defaultCacheBehavior.functionAssociations.items
fn spec.forProvider.distributionConfig.defaultCacheBehavior.functionAssociations.items.withEventType
withEventType(eventType)
fn spec.forProvider.distributionConfig.defaultCacheBehavior.functionAssociations.items.withFunctionARN
withFunctionARN(functionARN)
obj spec.forProvider.distributionConfig.defaultCacheBehavior.lambdaFunctionAssociations
"A complex type that specifies a list of Lambda@Edge functions associations for a cache behavior. \n If you want to invoke one or more Lambda@Edge functions triggered by requests that match the PathPattern of the cache behavior, specify the applicable values for Quantity and Items. Note that there can be up to 4 LambdaFunctionAssociation items in this list (one for each possible value of EventType) and each EventType can be associated with only one function. \n If you don't want to invoke any Lambda@Edge functions for the requests that match PathPattern, specify 0 for Quantity and omit Items."
fn spec.forProvider.distributionConfig.defaultCacheBehavior.lambdaFunctionAssociations.withItems
withItems(items)
fn spec.forProvider.distributionConfig.defaultCacheBehavior.lambdaFunctionAssociations.withItemsMixin
withItemsMixin(items)
Note: This function appends passed data to existing values
obj spec.forProvider.distributionConfig.defaultCacheBehavior.lambdaFunctionAssociations.items
fn spec.forProvider.distributionConfig.defaultCacheBehavior.lambdaFunctionAssociations.items.withEventType
withEventType(eventType)
fn spec.forProvider.distributionConfig.defaultCacheBehavior.lambdaFunctionAssociations.items.withIncludeBody
withIncludeBody(includeBody)
fn spec.forProvider.distributionConfig.defaultCacheBehavior.lambdaFunctionAssociations.items.withLambdaFunctionARN
withLambdaFunctionARN(lambdaFunctionARN)
obj spec.forProvider.distributionConfig.defaultCacheBehavior.trustedKeyGroups
"A list of key groups whose public keys CloudFront can use to verify the signatures of signed URLs and signed cookies."
fn spec.forProvider.distributionConfig.defaultCacheBehavior.trustedKeyGroups.withEnabled
withEnabled(enabled)
fn spec.forProvider.distributionConfig.defaultCacheBehavior.trustedKeyGroups.withItems
withItems(items)
fn spec.forProvider.distributionConfig.defaultCacheBehavior.trustedKeyGroups.withItemsMixin
withItemsMixin(items)
Note: This function appends passed data to existing values
obj spec.forProvider.distributionConfig.defaultCacheBehavior.trustedSigners
"A list of Amazon Web Services accounts whose public keys CloudFront can use to verify the signatures of signed URLs and signed cookies."
fn spec.forProvider.distributionConfig.defaultCacheBehavior.trustedSigners.withEnabled
withEnabled(enabled)
fn spec.forProvider.distributionConfig.defaultCacheBehavior.trustedSigners.withItems
withItems(items)
fn spec.forProvider.distributionConfig.defaultCacheBehavior.trustedSigners.withItemsMixin
withItemsMixin(items)
Note: This function appends passed data to existing values
obj spec.forProvider.distributionConfig.logging
"A complex type that controls whether access logs are written for the distribution."
fn spec.forProvider.distributionConfig.logging.withBucket
withBucket(bucket)
fn spec.forProvider.distributionConfig.logging.withEnabled
withEnabled(enabled)
fn spec.forProvider.distributionConfig.logging.withIncludeCookies
withIncludeCookies(includeCookies)
fn spec.forProvider.distributionConfig.logging.withPrefix
withPrefix(prefix)
obj spec.forProvider.distributionConfig.originGroups
"A complex data type for the origin groups specified for a distribution."
fn spec.forProvider.distributionConfig.originGroups.withItems
withItems(items)
"List of origin groups for a distribution."
fn spec.forProvider.distributionConfig.originGroups.withItemsMixin
withItemsMixin(items)
"List of origin groups for a distribution."
Note: This function appends passed data to existing values
obj spec.forProvider.distributionConfig.originGroups.items
"List of origin groups for a distribution."
fn spec.forProvider.distributionConfig.originGroups.items.withId
withId(id)
obj spec.forProvider.distributionConfig.originGroups.items.failoverCriteria
"A complex data type that includes information about the failover criteria for an origin group, including the status codes for which CloudFront will failover from the primary origin to the second origin."
obj spec.forProvider.distributionConfig.originGroups.items.failoverCriteria.statusCodes
"A complex data type for the status codes that you specify that, when returned by a primary origin, trigger CloudFront to failover to a second origin."
fn spec.forProvider.distributionConfig.originGroups.items.failoverCriteria.statusCodes.withItems
withItems(items)
"List of status codes for origin failover."
fn spec.forProvider.distributionConfig.originGroups.items.failoverCriteria.statusCodes.withItemsMixin
withItemsMixin(items)
"List of status codes for origin failover."
Note: This function appends passed data to existing values
obj spec.forProvider.distributionConfig.originGroups.items.members
"A complex data type for the origins included in an origin group."
fn spec.forProvider.distributionConfig.originGroups.items.members.withItems
withItems(items)
"List of origins in an origin group."
fn spec.forProvider.distributionConfig.originGroups.items.members.withItemsMixin
withItemsMixin(items)
"List of origins in an origin group."
Note: This function appends passed data to existing values
fn spec.forProvider.distributionConfig.originGroups.items.members.withQuantity
withQuantity(quantity)
obj spec.forProvider.distributionConfig.originGroups.items.members.items
"List of origins in an origin group."
fn spec.forProvider.distributionConfig.originGroups.items.members.items.withOriginID
withOriginID(originID)
obj spec.forProvider.distributionConfig.origins
"Contains information about the origins for this distribution."
fn spec.forProvider.distributionConfig.origins.withItems
withItems(items)
fn spec.forProvider.distributionConfig.origins.withItemsMixin
withItemsMixin(items)
Note: This function appends passed data to existing values
obj spec.forProvider.distributionConfig.origins.items
fn spec.forProvider.distributionConfig.origins.items.withConnectionAttempts
withConnectionAttempts(connectionAttempts)
fn spec.forProvider.distributionConfig.origins.items.withConnectionTimeout
withConnectionTimeout(connectionTimeout)
fn spec.forProvider.distributionConfig.origins.items.withDomainName
withDomainName(domainName)
fn spec.forProvider.distributionConfig.origins.items.withId
withId(id)
fn spec.forProvider.distributionConfig.origins.items.withOriginPath
withOriginPath(originPath)
obj spec.forProvider.distributionConfig.origins.items.customHeaders
"A complex type that contains the list of Custom Headers for each origin."
fn spec.forProvider.distributionConfig.origins.items.customHeaders.withItems
withItems(items)
fn spec.forProvider.distributionConfig.origins.items.customHeaders.withItemsMixin
withItemsMixin(items)
Note: This function appends passed data to existing values
obj spec.forProvider.distributionConfig.origins.items.customHeaders.items
fn spec.forProvider.distributionConfig.origins.items.customHeaders.items.withHeaderName
withHeaderName(headerName)
fn spec.forProvider.distributionConfig.origins.items.customHeaders.items.withHeaderValue
withHeaderValue(headerValue)
obj spec.forProvider.distributionConfig.origins.items.customOriginConfig
"A custom origin. A custom origin is any origin that is not an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is configured with static website hosting (https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html) is a custom origin."
fn spec.forProvider.distributionConfig.origins.items.customOriginConfig.withHttpPort
withHttpPort(httpPort)
fn spec.forProvider.distributionConfig.origins.items.customOriginConfig.withHttpSPort
withHttpSPort(httpSPort)
fn spec.forProvider.distributionConfig.origins.items.customOriginConfig.withOriginKeepaliveTimeout
withOriginKeepaliveTimeout(originKeepaliveTimeout)
fn spec.forProvider.distributionConfig.origins.items.customOriginConfig.withOriginProtocolPolicy
withOriginProtocolPolicy(originProtocolPolicy)
fn spec.forProvider.distributionConfig.origins.items.customOriginConfig.withOriginReadTimeout
withOriginReadTimeout(originReadTimeout)
obj spec.forProvider.distributionConfig.origins.items.customOriginConfig.originSSLProtocols
"A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin."
fn spec.forProvider.distributionConfig.origins.items.customOriginConfig.originSSLProtocols.withItems
withItems(items)
fn spec.forProvider.distributionConfig.origins.items.customOriginConfig.originSSLProtocols.withItemsMixin
withItemsMixin(items)
Note: This function appends passed data to existing values
obj spec.forProvider.distributionConfig.origins.items.originShield
"CloudFront Origin Shield. \n Using Origin Shield can help reduce the load on your origin. For more information, see Using Origin Shield (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html) in the Amazon CloudFront Developer Guide."
fn spec.forProvider.distributionConfig.origins.items.originShield.withEnabled
withEnabled(enabled)
fn spec.forProvider.distributionConfig.origins.items.originShield.withOriginShieldRegion
withOriginShieldRegion(originShieldRegion)
obj spec.forProvider.distributionConfig.origins.items.s3OriginConfig
"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin or an S3 bucket that is configured as a website endpoint, use the CustomOriginConfig element instead."
fn spec.forProvider.distributionConfig.origins.items.s3OriginConfig.withOriginAccessIdentity
withOriginAccessIdentity(originAccessIdentity)
obj spec.forProvider.distributionConfig.restrictions
"A complex type that identifies ways in which you want to restrict distribution of your content."
obj spec.forProvider.distributionConfig.restrictions.geoRestriction
"A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases."
fn spec.forProvider.distributionConfig.restrictions.geoRestriction.withItems
withItems(items)
fn spec.forProvider.distributionConfig.restrictions.geoRestriction.withItemsMixin
withItemsMixin(items)
Note: This function appends passed data to existing values
fn spec.forProvider.distributionConfig.restrictions.geoRestriction.withRestrictionType
withRestrictionType(restrictionType)
obj spec.forProvider.distributionConfig.viewerCertificate
"A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers. \n If the distribution doesn’t use Aliases (also known as alternate domain names or CNAMEs)—that is, if the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net—set CloudFrontDefaultCertificate to true and leave all other fields empty. \n If the distribution uses Aliases (alternate domain names or CNAMEs), use the fields in this type to specify the following settings: \n * Which viewers the distribution accepts HTTPS connections from: only viewers that support server name indication (SNI) (https://en.wikipedia.org/wiki/Server_Name_Indication) (recommended), or all viewers including those that don’t support SNI. To accept HTTPS connections from only viewers that support SNI, set SSLSupportMethod to sni-only. This is recommended. Most browsers and clients support SNI. To accept HTTPS connections from all viewers, including those that don’t support SNI, set SSLSupportMethod to vip. This is not recommended, and results in additional monthly charges from CloudFront. \n * The minimum SSL/TLS protocol version that the distribution can use to communicate with viewers. To specify a minimum version, choose a value for MinimumProtocolVersion. For more information, see Security Policy (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) in the Amazon CloudFront Developer Guide. \n * The location of the SSL/TLS certificate, Certificate Manager (ACM) (https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html) (recommended) or Identity and Access Management (IAM) (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html). You specify the location by setting a value in one of the following fields (not both): ACMCertificateArn IAMCertificateId \n All distributions support HTTPS connections from viewers. To require viewers to use HTTPS only, or to redirect them from HTTP to HTTPS, use ViewerProtocolPolicy in the CacheBehavior or DefaultCacheBehavior. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, use CustomOriginConfig. \n For more information, see Using HTTPS with CloudFront (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https.html) and Using Alternate Domain Names and HTTPS (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-alternate-domain-names.html) in the Amazon CloudFront Developer Guide."
fn spec.forProvider.distributionConfig.viewerCertificate.withACMCertificateARN
withACMCertificateARN(aCMCertificateARN)
fn spec.forProvider.distributionConfig.viewerCertificate.withCertificate
withCertificate(certificate)
fn spec.forProvider.distributionConfig.viewerCertificate.withCertificateSource
withCertificateSource(certificateSource)
fn spec.forProvider.distributionConfig.viewerCertificate.withCloudFrontDefaultCertificate
withCloudFrontDefaultCertificate(cloudFrontDefaultCertificate)
fn spec.forProvider.distributionConfig.viewerCertificate.withIamCertificateID
withIamCertificateID(iamCertificateID)
fn spec.forProvider.distributionConfig.viewerCertificate.withMinimumProtocolVersion
withMinimumProtocolVersion(minimumProtocolVersion)
fn spec.forProvider.distributionConfig.viewerCertificate.withSslSupportMethod
withSslSupportMethod(sslSupportMethod)
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."