Package-level declarations

Types

Link copied to clipboard
class AccessGrant : KotlinCustomResource

The AWS::S3::AccessGrant resource is an Amazon S3 resource type representing permissions to a specific S3 bucket or prefix hosted in an S3 Access Grants instance.

Link copied to clipboard
data class AccessGrantArgs(val accessGrantsLocationConfiguration: Output<AccessGrantsLocationConfigurationArgs>? = null, val accessGrantsLocationId: Output<String>? = null, val applicationArn: Output<String>? = null, val grantee: Output<AccessGrantGranteeArgs>? = null, val permission: Output<AccessGrantPermission>? = null, val s3PrefixType: Output<AccessGrantS3PrefixType>? = null, val tags: Output<List<CreateOnlyTagArgs>>? = null) : ConvertibleToJava<AccessGrantArgs>

The AWS::S3::AccessGrant resource is an Amazon S3 resource type representing permissions to a specific S3 bucket or prefix hosted in an S3 Access Grants instance.

Link copied to clipboard
Link copied to clipboard
object AccessGrantMapper : ResourceMapper<AccessGrant>
Link copied to clipboard
Link copied to clipboard
class AccessGrantsInstance : KotlinCustomResource

The AWS::S3::AccessGrantsInstance resource is an Amazon S3 resource type that hosts Access Grants and their associated locations

Link copied to clipboard
data class AccessGrantsInstanceArgs(val identityCenterArn: Output<String>? = null, val tags: Output<List<CreateOnlyTagArgs>>? = null) : ConvertibleToJava<AccessGrantsInstanceArgs>

The AWS::S3::AccessGrantsInstance resource is an Amazon S3 resource type that hosts Access Grants and their associated locations

Link copied to clipboard
Link copied to clipboard
class AccessGrantsLocation : KotlinCustomResource

The AWS::S3::AccessGrantsLocation resource is an Amazon S3 resource type hosted in an access grants instance which can be the target of S3 access grants.

Link copied to clipboard
data class AccessGrantsLocationArgs(val iamRoleArn: Output<String>? = null, val locationScope: Output<String>? = null, val tags: Output<List<CreateOnlyTagArgs>>? = null) : ConvertibleToJava<AccessGrantsLocationArgs>

The AWS::S3::AccessGrantsLocation resource is an Amazon S3 resource type hosted in an access grants instance which can be the target of S3 access grants.

Link copied to clipboard
Link copied to clipboard
class AccessPoint : KotlinCustomResource

The AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets.

Link copied to clipboard
data class AccessPointArgs(val bucket: Output<String>? = null, val bucketAccountId: Output<String>? = null, val name: Output<String>? = null, val policy: Output<Any>? = null, val publicAccessBlockConfiguration: Output<AccessPointPublicAccessBlockConfigurationArgs>? = null, val vpcConfiguration: Output<AccessPointVpcConfigurationArgs>? = null) : ConvertibleToJava<AccessPointArgs>

The AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets.

Link copied to clipboard
Link copied to clipboard
object AccessPointMapper : ResourceMapper<AccessPoint>
Link copied to clipboard
Link copied to clipboard
class Bucket : KotlinCustomResource

The `AWS::S3::Bucket` resource creates an Amazon S3 bucket in the same AWS Region where you create the AWS CloudFormation stack. To control how AWS CloudFormation handles the bucket when the stack is deleted, you can set a deletion policy for your bucket. You can choose to retain the bucket or to delete the bucket. For more information, see DeletionPolicy Attribute. You can only delete empty buckets. Deletion fails for buckets that have contents.

Link copied to clipboard
data class BucketArgs(val accelerateConfiguration: Output<BucketAccelerateConfigurationArgs>? = null, val accessControl: Output<BucketAccessControl>? = null, val analyticsConfigurations: Output<List<BucketAnalyticsConfigurationArgs>>? = null, val bucketEncryption: Output<BucketEncryptionArgs>? = null, val bucketName: Output<String>? = null, val corsConfiguration: Output<BucketCorsConfigurationArgs>? = null, val intelligentTieringConfigurations: Output<List<BucketIntelligentTieringConfigurationArgs>>? = null, val inventoryConfigurations: Output<List<BucketInventoryConfigurationArgs>>? = null, val lifecycleConfiguration: Output<BucketLifecycleConfigurationArgs>? = null, val loggingConfiguration: Output<BucketLoggingConfigurationArgs>? = null, val metadataTableConfiguration: Output<BucketMetadataTableConfigurationArgs>? = null, val metricsConfigurations: Output<List<BucketMetricsConfigurationArgs>>? = null, val notificationConfiguration: Output<BucketNotificationConfigurationArgs>? = null, val objectLockConfiguration: Output<BucketObjectLockConfigurationArgs>? = null, val objectLockEnabled: Output<Boolean>? = null, val ownershipControls: Output<BucketOwnershipControlsArgs>? = null, val publicAccessBlockConfiguration: Output<BucketPublicAccessBlockConfigurationArgs>? = null, val replicationConfiguration: Output<BucketReplicationConfigurationArgs>? = null, val tags: Output<List<TagArgs>>? = null, val versioningConfiguration: Output<BucketVersioningConfigurationArgs>? = null, val websiteConfiguration: Output<BucketWebsiteConfigurationArgs>? = null) : ConvertibleToJava<BucketArgs>

The `AWS::S3::Bucket` resource creates an Amazon S3 bucket in the same AWS Region where you create the AWS CloudFormation stack. To control how AWS CloudFormation handles the bucket when the stack is deleted, you can set a deletion policy for your bucket. You can choose to retain the bucket or to delete the bucket. For more information, see DeletionPolicy Attribute. You can only delete empty buckets. Deletion fails for buckets that have contents.

Link copied to clipboard

Builder for BucketArgs.

Link copied to clipboard
object BucketMapper : ResourceMapper<Bucket>
Link copied to clipboard
class BucketPolicy : KotlinCustomResource

Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS-account that owns the bucket, the calling identity must have the `PutBucketPolicy` permissions on the specified bucket and belong to the bucket owner's account in order to use this operation. If you don't have `PutBucketPolicy` permissions, Amazon S3 returns a `403 Access Denied` error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a `405 Method Not Allowed` error. As a security precaution, the root user of the AWS-account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. When using the `AWS::S3::BucketPolicy` resource, you can create, update, and delete bucket policies for S3 buckets located in regions different from the stack's region. This cross-region bucket policy modification functionality is supported for backward compatibility with existing workflows. If the DeletionPolicy attribute is not specified or set to `Delete`, the bucket policy will be removed when the stack is deleted. If set to `Retain`, the bucket policy will be preserved even after the stack is deleted. For example, a CloudFormation stack in `us-east-1` can use the `AWS::S3::BucketPolicy` resource to manage the bucket policy for an S3 bucket in `us-west-2`. The retention or removal of the bucket policy during the stack deletion is determined by the `DeletionPolicy` attribute specified in the stack template. For more information, see Bucket policy examples. The following operations are related to `PutBucketPolicy`:

Link copied to clipboard
data class BucketPolicyArgs(val bucket: Output<String>? = null, val policyDocument: Output<Any>? = null) : ConvertibleToJava<BucketPolicyArgs>

Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS-account that owns the bucket, the calling identity must have the `PutBucketPolicy` permissions on the specified bucket and belong to the bucket owner's account in order to use this operation. If you don't have `PutBucketPolicy` permissions, Amazon S3 returns a `403 Access Denied` error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a `405 Method Not Allowed` error. As a security precaution, the root user of the AWS-account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. When using the `AWS::S3::BucketPolicy` resource, you can create, update, and delete bucket policies for S3 buckets located in regions different from the stack's region. This cross-region bucket policy modification functionality is supported for backward compatibility with existing workflows. If the DeletionPolicy attribute is not specified or set to `Delete`, the bucket policy will be removed when the stack is deleted. If set to `Retain`, the bucket policy will be preserved even after the stack is deleted. For example, a CloudFormation stack in `us-east-1` can use the `AWS::S3::BucketPolicy` resource to manage the bucket policy for an S3 bucket in `us-west-2`. The retention or removal of the bucket policy during the stack deletion is determined by the `DeletionPolicy` attribute specified in the stack template. For more information, see Bucket policy examples. The following operations are related to `PutBucketPolicy`:

Link copied to clipboard
Link copied to clipboard
object BucketPolicyMapper : ResourceMapper<BucketPolicy>
Link copied to clipboard
Link copied to clipboard

Builder for Bucket.

Link copied to clipboard
class MultiRegionAccessPoint : KotlinCustomResource

AWS::S3::MultiRegionAccessPoint is an Amazon S3 resource type that dynamically routes S3 requests to easily satisfy geographic compliance requirements based on customer-defined routing policies.

Link copied to clipboard
data class MultiRegionAccessPointArgs(val name: Output<String>? = null, val publicAccessBlockConfiguration: Output<MultiRegionAccessPointPublicAccessBlockConfigurationArgs>? = null, val regions: Output<List<MultiRegionAccessPointRegionArgs>>? = null) : ConvertibleToJava<MultiRegionAccessPointArgs>

AWS::S3::MultiRegionAccessPoint is an Amazon S3 resource type that dynamically routes S3 requests to easily satisfy geographic compliance requirements based on customer-defined routing policies.

Link copied to clipboard
Link copied to clipboard
class MultiRegionAccessPointPolicy : KotlinCustomResource

The policy to be attached to a Multi Region Access Point

Link copied to clipboard
data class MultiRegionAccessPointPolicyArgs(val mrapName: Output<String>? = null, val policy: Output<Any>? = null) : ConvertibleToJava<MultiRegionAccessPointPolicyArgs>

The policy to be attached to a Multi Region Access Point

Link copied to clipboard
Link copied to clipboard
class StorageLens : KotlinCustomResource

The AWS::S3::StorageLens resource is an Amazon S3 resource type that you can use to create Storage Lens configurations.

Link copied to clipboard
data class StorageLensArgs(val storageLensConfiguration: Output<StorageLensConfigurationArgs>? = null, val tags: Output<List<TagArgs>>? = null) : ConvertibleToJava<StorageLensArgs>

The AWS::S3::StorageLens resource is an Amazon S3 resource type that you can use to create Storage Lens configurations.

Link copied to clipboard
Link copied to clipboard
class StorageLensGroup : KotlinCustomResource

The AWS::S3::StorageLensGroup resource is an Amazon S3 resource type that you can use to create Storage Lens Group.

Link copied to clipboard
data class StorageLensGroupArgs(val filter: Output<StorageLensGroupFilterArgs>? = null, val name: Output<String>? = null, val tags: Output<List<TagArgs>>? = null) : ConvertibleToJava<StorageLensGroupArgs>

The AWS::S3::StorageLensGroup resource is an Amazon S3 resource type that you can use to create Storage Lens Group.

Link copied to clipboard
object StorageLensGroupMapper : ResourceMapper<StorageLensGroup>
Link copied to clipboard
object StorageLensMapper : ResourceMapper<StorageLens>
Link copied to clipboard

Functions

Link copied to clipboard
suspend fun accessGrant(name: String, block: suspend AccessGrantResourceBuilder.() -> Unit): AccessGrant
Link copied to clipboard
suspend fun accessPoint(name: String, block: suspend AccessPointResourceBuilder.() -> Unit): AccessPoint
Link copied to clipboard
fun bucket(name: String): Bucket
suspend fun bucket(name: String, block: suspend BucketResourceBuilder.() -> Unit): Bucket
Link copied to clipboard
Link copied to clipboard
suspend fun storageLens(name: String, block: suspend StorageLensResourceBuilder.() -> Unit): StorageLens
Link copied to clipboard