Package-level declarations

Types

Link copied to clipboard
class CachePolicy : KotlinCustomResource

A cache policy. When it's attached to a cache behavior, the cache policy determines the following:

Link copied to clipboard
data class CachePolicyArgs(val cachePolicyConfig: Output<CachePolicyConfigArgs>? = null) : ConvertibleToJava<CachePolicyArgs>

A cache policy. When it's attached to a cache behavior, the cache policy determines the following:

Link copied to clipboard
Link copied to clipboard
object CachePolicyMapper : ResourceMapper<CachePolicy>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class CloudFrontOriginAccessIdentity : KotlinCustomResource

The request to create a new origin access identity (OAI). An origin access identity is a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or just some of your Amazon S3 content. For more information, see Restricting Access to Amazon S3 Content by Using an Origin Access Identity in the Amazon CloudFront Developer Guide.

Link copied to clipboard
data class CloudFrontOriginAccessIdentityArgs(val cloudFrontOriginAccessIdentityConfig: Output<CloudFrontOriginAccessIdentityConfigArgs>? = null) : ConvertibleToJava<CloudFrontOriginAccessIdentityArgs>

The request to create a new origin access identity (OAI). An origin access identity is a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or just some of your Amazon S3 content. For more information, see Restricting Access to Amazon S3 Content by Using an Origin Access Identity in the Amazon CloudFront Developer Guide.

Link copied to clipboard
class ConnectionGroup : KotlinCustomResource

The connection group for your distribution tenants. When you first create a distribution tenant and you don't specify a connection group, CloudFront will automatically create a default connection group for you. When you create a new distribution tenant and don't specify a connection group, the default one will be associated with your distribution tenant.

Link copied to clipboard
data class ConnectionGroupArgs(val anycastIpListId: Output<String>? = null, val enabled: Output<Boolean>? = null, val ipv6Enabled: Output<Boolean>? = null, val name: Output<String>? = null, val tags: Output<List<TagArgs>>? = null) : ConvertibleToJava<ConnectionGroupArgs>

The connection group for your distribution tenants. When you first create a distribution tenant and you don't specify a connection group, CloudFront will automatically create a default connection group for you. When you create a new distribution tenant and don't specify a connection group, the default one will be associated with your distribution tenant.

Link copied to clipboard
object ConnectionGroupMapper : ResourceMapper<ConnectionGroup>
Link copied to clipboard
class ContinuousDeploymentPolicy : KotlinCustomResource

Creates a continuous deployment policy that routes a subset of production traffic from a primary distribution to a staging distribution. After you create and update a staging distribution, you can use a continuous deployment policy to incrementally move traffic to the staging distribution. This enables you to test changes to a distribution's configuration before moving all of your production traffic to the new configuration. For more information, see Using CloudFront continuous deployment to safely test CDN configuration changes in the Amazon CloudFront Developer Guide.

Link copied to clipboard
data class ContinuousDeploymentPolicyArgs(val continuousDeploymentPolicyConfig: Output<ContinuousDeploymentPolicyConfigArgs>? = null) : ConvertibleToJava<ContinuousDeploymentPolicyArgs>

Creates a continuous deployment policy that routes a subset of production traffic from a primary distribution to a staging distribution. After you create and update a staging distribution, you can use a continuous deployment policy to incrementally move traffic to the staging distribution. This enables you to test changes to a distribution's configuration before moving all of your production traffic to the new configuration. For more information, see Using CloudFront continuous deployment to safely test CDN configuration changes in the Amazon CloudFront Developer Guide.

Link copied to clipboard
class Distribution : KotlinCustomResource

A distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.

Link copied to clipboard
data class DistributionArgs(val distributionConfig: Output<DistributionConfigArgs>? = null, val tags: Output<List<TagArgs>>? = null) : ConvertibleToJava<DistributionArgs>

A distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.

Link copied to clipboard
Link copied to clipboard
object DistributionMapper : ResourceMapper<Distribution>
Link copied to clipboard
Link copied to clipboard
class DistributionTenant : KotlinCustomResource

The distribution tenant.

Link copied to clipboard
data class DistributionTenantArgs(val connectionGroupId: Output<String>? = null, val customizations: Output<DistributionTenantCustomizationsArgs>? = null, val distributionId: Output<String>? = null, val domains: Output<List<String>>? = null, val enabled: Output<Boolean>? = null, val managedCertificateRequest: Output<DistributionTenantManagedCertificateRequestArgs>? = null, val name: Output<String>? = null, val parameters: Output<List<DistributionTenantParameterArgs>>? = null, val tags: Output<List<TagArgs>>? = null) : ConvertibleToJava<DistributionTenantArgs>

The distribution tenant.

Link copied to clipboard
Link copied to clipboard
class Function : KotlinCustomResource

Creates a CF function. To create a function, you provide the function code and some configuration information about the function. The response contains an Amazon Resource Name (ARN) that uniquely identifies the function, and the function’s stage. By default, when you create a function, it’s in the `DEVELOPMENT` stage. In this stage, you can test the function in the CF console (or with `TestFunction` in the CF API). When you’re ready to use your function with a CF distribution, publish the function to the `LIVE` stage. You can do this in the CF console, with `PublishFunction` in the CF API, or by updating the `AWS::CloudFront::Function` resource with the `AutoPublish` property set to `true`. When the function is published to the `LIVE` stage, you can attach it to a distribution’s cache behavior, using the function’s ARN. To automatically publish the function to the `LIVE` stage when it’s created, set the `AutoPublish` property to `true`.

Link copied to clipboard
data class FunctionArgs(val autoPublish: Output<Boolean>? = null, val functionCode: Output<String>? = null, val functionConfig: Output<FunctionConfigArgs>? = null, val functionMetadata: Output<FunctionMetadataArgs>? = null, val name: Output<String>? = null) : ConvertibleToJava<FunctionArgs>

Creates a CF function. To create a function, you provide the function code and some configuration information about the function. The response contains an Amazon Resource Name (ARN) that uniquely identifies the function, and the function’s stage. By default, when you create a function, it’s in the `DEVELOPMENT` stage. In this stage, you can test the function in the CF console (or with `TestFunction` in the CF API). When you’re ready to use your function with a CF distribution, publish the function to the `LIVE` stage. You can do this in the CF console, with `PublishFunction` in the CF API, or by updating the `AWS::CloudFront::Function` resource with the `AutoPublish` property set to `true`. When the function is published to the `LIVE` stage, you can attach it to a distribution’s cache behavior, using the function’s ARN. To automatically publish the function to the `LIVE` stage when it’s created, set the `AutoPublish` property to `true`.

Link copied to clipboard
Link copied to clipboard
object FunctionMapper : ResourceMapper<Function>
Link copied to clipboard
Link copied to clipboard
class KeyGroup : KotlinCustomResource

A key group. A key group contains a list of public keys that you can use with CloudFront signed URLs and signed cookies.

Link copied to clipboard
data class KeyGroupArgs(val keyGroupConfig: Output<KeyGroupConfigArgs>? = null) : ConvertibleToJava<KeyGroupArgs>

A key group. A key group contains a list of public keys that you can use with CloudFront signed URLs and signed cookies.

Link copied to clipboard
Link copied to clipboard
object KeyGroupMapper : ResourceMapper<KeyGroup>
Link copied to clipboard
Link copied to clipboard
class KeyValueStore : KotlinCustomResource

The key value store. Use this to separate data from function code, allowing you to update data without having to publish a new version of a function. The key value store holds keys and their corresponding values.

Link copied to clipboard
data class KeyValueStoreArgs(val comment: Output<String>? = null, val importSource: Output<KeyValueStoreImportSourceArgs>? = null, val name: Output<String>? = null) : ConvertibleToJava<KeyValueStoreArgs>

The key value store. Use this to separate data from function code, allowing you to update data without having to publish a new version of a function. The key value store holds keys and their corresponding values.

Link copied to clipboard
Link copied to clipboard
object KeyValueStoreMapper : ResourceMapper<KeyValueStore>
Link copied to clipboard
Link copied to clipboard
class MonitoringSubscription : KotlinCustomResource

A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.

Link copied to clipboard
data class MonitoringSubscriptionArgs(val distributionId: Output<String>? = null, val monitoringSubscription: Output<MonitoringSubscriptionArgs>? = null) : ConvertibleToJava<MonitoringSubscriptionArgs>

A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.

Link copied to clipboard
Link copied to clipboard
class OriginAccessControl : KotlinCustomResource

Creates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin. This makes it possible to block public access to the origin, allowing viewers (users) to access the origin's content only through CloudFront. For more information about using a CloudFront origin access control, see Restricting access to an origin in the Amazon CloudFront Developer Guide.

Link copied to clipboard
data class OriginAccessControlArgs(val originAccessControlConfig: Output<OriginAccessControlConfigArgs>? = null) : ConvertibleToJava<OriginAccessControlArgs>

Creates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin. This makes it possible to block public access to the origin, allowing viewers (users) to access the origin's content only through CloudFront. For more information about using a CloudFront origin access control, see Restricting access to an origin in the Amazon CloudFront Developer Guide.

Link copied to clipboard
Link copied to clipboard
class OriginRequestPolicy : KotlinCustomResource

An origin request policy. When it's attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:

Link copied to clipboard
data class OriginRequestPolicyArgs(val originRequestPolicyConfig: Output<OriginRequestPolicyConfigArgs>? = null) : ConvertibleToJava<OriginRequestPolicyArgs>

An origin request policy. When it's attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:

Link copied to clipboard
Link copied to clipboard
class PublicKey : KotlinCustomResource

A public key that you can use with signed URLs and signed cookies, or with field-level encryption.

Link copied to clipboard
data class PublicKeyArgs(val publicKeyConfig: Output<PublicKeyConfigArgs>? = null) : ConvertibleToJava<PublicKeyArgs>

A public key that you can use with signed URLs and signed cookies, or with field-level encryption.

Link copied to clipboard
Link copied to clipboard
object PublicKeyMapper : ResourceMapper<PublicKey>
Link copied to clipboard
Link copied to clipboard
class RealtimeLogConfig : KotlinCustomResource

A real-time log configuration.

Link copied to clipboard
data class RealtimeLogConfigArgs(val endPoints: Output<List<RealtimeLogConfigEndPointArgs>>? = null, val fields: Output<List<String>>? = null, val name: Output<String>? = null, val samplingRate: Output<Double>? = null) : ConvertibleToJava<RealtimeLogConfigArgs>

A real-time log configuration.

Link copied to clipboard
object RealtimeLogConfigMapper : ResourceMapper<RealtimeLogConfig>
Link copied to clipboard
class ResponseHeadersPolicy : KotlinCustomResource

A response headers policy. A response headers policy contains information about a set of HTTP response headers. After you create a response headers policy, you can use its ID to attach it to one or more cache behaviors in a CloudFront distribution. When it's attached to a cache behavior, the response headers policy affects the HTTP headers that CloudFront includes in HTTP responses to requests that match the cache behavior. CloudFront adds or removes response headers according to the configuration of the response headers policy. For more information, see Adding or removing HTTP headers in CloudFront responses in the Amazon CloudFront Developer Guide.

Link copied to clipboard
data class ResponseHeadersPolicyArgs(val responseHeadersPolicyConfig: Output<ResponseHeadersPolicyConfigArgs>? = null) : ConvertibleToJava<ResponseHeadersPolicyArgs>

A response headers policy. A response headers policy contains information about a set of HTTP response headers. After you create a response headers policy, you can use its ID to attach it to one or more cache behaviors in a CloudFront distribution. When it's attached to a cache behavior, the response headers policy affects the HTTP headers that CloudFront includes in HTTP responses to requests that match the cache behavior. CloudFront adds or removes response headers according to the configuration of the response headers policy. For more information, see Adding or removing HTTP headers in CloudFront responses in the Amazon CloudFront Developer Guide.

Link copied to clipboard
Link copied to clipboard
class VpcOrigin : KotlinCustomResource

An Amazon CloudFront VPC origin.

Link copied to clipboard
data class VpcOriginArgs(val tags: Output<List<TagArgs>>? = null, val vpcOriginEndpointConfig: Output<VpcOriginEndpointConfigArgs>? = null) : ConvertibleToJava<VpcOriginArgs>

An Amazon CloudFront VPC origin.

Link copied to clipboard
Link copied to clipboard
object VpcOriginMapper : ResourceMapper<VpcOrigin>
Link copied to clipboard

Functions

Link copied to clipboard
suspend fun cachePolicy(name: String, block: suspend CachePolicyResourceBuilder.() -> Unit): CachePolicy
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
suspend fun function(name: String, block: suspend FunctionResourceBuilder.() -> Unit): Function
Link copied to clipboard
suspend fun keyGroup(name: String, block: suspend KeyGroupResourceBuilder.() -> Unit): KeyGroup
Link copied to clipboard
Link copied to clipboard
suspend fun publicKey(name: String, block: suspend PublicKeyResourceBuilder.() -> Unit): PublicKey
Link copied to clipboard
suspend fun vpcOrigin(name: String, block: suspend VpcOriginResourceBuilder.() -> Unit): VpcOrigin