Package-level declarations

Types

Link copied to clipboard
class AccessPoint : KotlinCustomResource

Provides a resource to manage an S3 Access Point.

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

Provides a resource to manage an S3 Access Point.

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

Manages S3 account-level Public Access Block configuration. For more information about these settings, see the AWS S3 Block Public Access documentation.

Link copied to clipboard
data class AccountPublicAccessBlockArgs(val accountId: Output<String>? = null, val blockPublicAcls: Output<Boolean>? = null, val blockPublicPolicy: Output<Boolean>? = null, val ignorePublicAcls: Output<Boolean>? = null, val restrictPublicBuckets: Output<Boolean>? = null) : ConvertibleToJava<AccountPublicAccessBlockArgs>

Manages S3 account-level Public Access Block configuration. For more information about these settings, see the AWS S3 Block Public Access documentation.

Link copied to clipboard
class AnalyticsConfiguration : KotlinCustomResource

Provides a S3 bucket analytics configuration resource.

Link copied to clipboard
data class AnalyticsConfigurationArgs(val bucket: Output<String>? = null, val filter: Output<AnalyticsConfigurationFilterArgs>? = null, val name: Output<String>? = null, val storageClassAnalysis: Output<AnalyticsConfigurationStorageClassAnalysisArgs>? = null) : ConvertibleToJava<AnalyticsConfigurationArgs>

Provides a S3 bucket analytics configuration resource.

Link copied to clipboard
Link copied to clipboard
class Bucket : KotlinCustomResource

Provides a S3 bucket resource.

Link copied to clipboard
class BucketAccelerateConfigurationV2 : KotlinCustomResource

Provides an S3 bucket accelerate configuration resource. See the Requirements for using Transfer Acceleration for more details.

Link copied to clipboard
data class BucketAccelerateConfigurationV2Args(val bucket: Output<String>? = null, val expectedBucketOwner: Output<String>? = null, val status: Output<String>? = null) : ConvertibleToJava<BucketAccelerateConfigurationV2Args>

Provides an S3 bucket accelerate configuration resource. See the Requirements for using Transfer Acceleration for more details.

Link copied to clipboard
class BucketAclV2 : KotlinCustomResource

Provides an S3 bucket ACL resource.

Link copied to clipboard
data class BucketAclV2Args(val accessControlPolicy: Output<BucketAclV2AccessControlPolicyArgs>? = null, val acl: Output<String>? = null, val bucket: Output<String>? = null, val expectedBucketOwner: Output<String>? = null) : ConvertibleToJava<BucketAclV2Args>

Provides an S3 bucket ACL resource.

Link copied to clipboard
Link copied to clipboard
object BucketAclV2Mapper : ResourceMapper<BucketAclV2>
Link copied to clipboard
Link copied to clipboard
data class BucketArgs(val accelerationStatus: Output<String>? = null, val acl: Output<Either<String, CannedAcl>>? = null, val arn: Output<String>? = null, val bucket: Output<String>? = null, val bucketPrefix: Output<String>? = null, val corsRules: Output<List<BucketCorsRuleArgs>>? = null, val forceDestroy: Output<Boolean>? = null, val grants: Output<List<BucketGrantArgs>>? = null, val hostedZoneId: Output<String>? = null, val lifecycleRules: Output<List<BucketLifecycleRuleArgs>>? = null, val loggings: Output<List<BucketLoggingArgs>>? = null, val objectLockConfiguration: Output<BucketObjectLockConfigurationArgs>? = null, val policy: Output<String>? = null, val replicationConfiguration: Output<BucketReplicationConfigurationArgs>? = null, val requestPayer: Output<String>? = null, val serverSideEncryptionConfiguration: Output<BucketServerSideEncryptionConfigurationArgs>? = null, val tags: Output<Map<String, String>>? = null, val versioning: Output<BucketVersioningArgs>? = null, val website: Output<BucketWebsiteArgs>? = null, val websiteDomain: Output<String>? = null, val websiteEndpoint: Output<String>? = null) : ConvertibleToJava<BucketArgs>

Provides a S3 bucket resource.

Link copied to clipboard

Builder for BucketArgs.

Link copied to clipboard
class BucketCorsConfigurationV2 : KotlinCustomResource

Provides an S3 bucket CORS configuration resource. For more information about CORS, go to Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

Link copied to clipboard
data class BucketCorsConfigurationV2Args(val bucket: Output<String>? = null, val corsRules: Output<List<BucketCorsConfigurationV2CorsRuleArgs>>? = null, val expectedBucketOwner: Output<String>? = null) : ConvertibleToJava<BucketCorsConfigurationV2Args>

Provides an S3 bucket CORS configuration resource. For more information about CORS, go to Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

Link copied to clipboard
class BucketIntelligentTieringConfiguration : KotlinCustomResource

Provides an S3 Intelligent-Tiering configuration resource.

data class BucketIntelligentTieringConfigurationArgs(val bucket: Output<String>? = null, val filter: Output<BucketIntelligentTieringConfigurationFilterArgs>? = null, val name: Output<String>? = null, val status: Output<String>? = null, val tierings: Output<List<BucketIntelligentTieringConfigurationTieringArgs>>? = null) : ConvertibleToJava<BucketIntelligentTieringConfigurationArgs>

Provides an S3 Intelligent-Tiering configuration resource.

Link copied to clipboard
class BucketLifecycleConfigurationV2 : KotlinCustomResource

Provides an independent configuration resource for S3 bucket lifecycle configuration. An S3 Lifecycle configuration consists of one or more Lifecycle rules. Each rule consists of the following:

Link copied to clipboard
data class BucketLifecycleConfigurationV2Args(val bucket: Output<String>? = null, val expectedBucketOwner: Output<String>? = null, val rules: Output<List<BucketLifecycleConfigurationV2RuleArgs>>? = null) : ConvertibleToJava<BucketLifecycleConfigurationV2Args>

Provides an independent configuration resource for S3 bucket lifecycle configuration. An S3 Lifecycle configuration consists of one or more Lifecycle rules. Each rule consists of the following:

Link copied to clipboard
class BucketLoggingV2 : KotlinCustomResource

Provides an S3 bucket (server access) logging resource. For more information, see Logging requests using server access logging in the AWS S3 User Guide.

Link copied to clipboard
data class BucketLoggingV2Args(val bucket: Output<String>? = null, val expectedBucketOwner: Output<String>? = null, val targetBucket: Output<String>? = null, val targetGrants: Output<List<BucketLoggingV2TargetGrantArgs>>? = null, val targetPrefix: Output<String>? = null) : ConvertibleToJava<BucketLoggingV2Args>

Provides an S3 bucket (server access) logging resource. For more information, see Logging requests using server access logging in the AWS S3 User Guide.

Link copied to clipboard
object BucketLoggingV2Mapper : ResourceMapper<BucketLoggingV2>
Link copied to clipboard
object BucketMapper : ResourceMapper<Bucket>
Link copied to clipboard
class BucketMetric : KotlinCustomResource

Provides a S3 bucket metrics configuration resource.

Link copied to clipboard
data class BucketMetricArgs(val bucket: Output<String>? = null, val filter: Output<BucketMetricFilterArgs>? = null, val name: Output<String>? = null) : ConvertibleToJava<BucketMetricArgs>

Provides a S3 bucket metrics configuration resource.

Link copied to clipboard
Link copied to clipboard
object BucketMetricMapper : ResourceMapper<BucketMetric>
Link copied to clipboard
Link copied to clipboard
class BucketNotification : KotlinCustomResource

Manages a S3 Bucket Notification Configuration. For additional information, see the Configuring S3 Event Notifications section in the Amazon S3 Developer Guide.

Link copied to clipboard
data class BucketNotificationArgs(val bucket: Output<String>? = null, val eventbridge: Output<Boolean>? = null, val lambdaFunctions: Output<List<BucketNotificationLambdaFunctionArgs>>? = null, val queues: Output<List<BucketNotificationQueueArgs>>? = null, val topics: Output<List<BucketNotificationTopicArgs>>? = null) : ConvertibleToJava<BucketNotificationArgs>

Manages a S3 Bucket Notification Configuration. For additional information, see the Configuring S3 Event Notifications section in the Amazon S3 Developer Guide.

Link copied to clipboard
Link copied to clipboard
class BucketObject : KotlinCustomResource

Provides an S3 object resource.

Link copied to clipboard
data class BucketObjectArgs(val acl: Output<String>? = null, val bucket: Output<String>? = null, val bucketKeyEnabled: Output<Boolean>? = null, val cacheControl: Output<String>? = null, val content: Output<String>? = null, val contentBase64: Output<String>? = null, val contentDisposition: Output<String>? = null, val contentEncoding: Output<String>? = null, val contentLanguage: Output<String>? = null, val contentType: Output<String>? = null, val etag: Output<String>? = null, val forceDestroy: Output<Boolean>? = null, val key: Output<String>? = null, val kmsKeyId: Output<String>? = null, val metadata: Output<Map<String, String>>? = null, val objectLockLegalHoldStatus: Output<String>? = null, val objectLockMode: Output<String>? = null, val objectLockRetainUntilDate: Output<String>? = null, val serverSideEncryption: Output<String>? = null, val source: Output<AssetOrArchive>? = null, val sourceHash: Output<String>? = null, val storageClass: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val websiteRedirect: Output<String>? = null) : ConvertibleToJava<BucketObjectArgs>

Provides an S3 object resource.

Link copied to clipboard
Link copied to clipboard
class BucketObjectLockConfigurationV2 : KotlinCustomResource

Provides an S3 bucket Object Lock configuration resource. For more information about Object Locking, go to Using S3 Object Lock in the Amazon S3 User Guide.

Link copied to clipboard
data class BucketObjectLockConfigurationV2Args(val bucket: Output<String>? = null, val expectedBucketOwner: Output<String>? = null, val objectLockEnabled: Output<String>? = null, val rule: Output<BucketObjectLockConfigurationV2RuleArgs>? = null, val token: Output<String>? = null) : ConvertibleToJava<BucketObjectLockConfigurationV2Args>

Provides an S3 bucket Object Lock configuration resource. For more information about Object Locking, go to Using S3 Object Lock in the Amazon S3 User Guide.

Link copied to clipboard
object BucketObjectMapper : ResourceMapper<BucketObject>
Link copied to clipboard
Link copied to clipboard
class BucketObjectv2 : KotlinCustomResource

Provides an S3 object resource.

Link copied to clipboard
data class BucketObjectv2Args(val acl: Output<String>? = null, val bucket: Output<String>? = null, val bucketKeyEnabled: Output<Boolean>? = null, val cacheControl: Output<String>? = null, val content: Output<String>? = null, val contentBase64: Output<String>? = null, val contentDisposition: Output<String>? = null, val contentEncoding: Output<String>? = null, val contentLanguage: Output<String>? = null, val contentType: Output<String>? = null, val etag: Output<String>? = null, val forceDestroy: Output<Boolean>? = null, val key: Output<String>? = null, val kmsKeyId: Output<String>? = null, val metadata: Output<Map<String, String>>? = null, val objectLockLegalHoldStatus: Output<String>? = null, val objectLockMode: Output<String>? = null, val objectLockRetainUntilDate: Output<String>? = null, val serverSideEncryption: Output<String>? = null, val source: Output<AssetOrArchive>? = null, val sourceHash: Output<String>? = null, val storageClass: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val websiteRedirect: Output<String>? = null) : ConvertibleToJava<BucketObjectv2Args>

Provides an S3 object resource.

Link copied to clipboard
Link copied to clipboard
object BucketObjectv2Mapper : ResourceMapper<BucketObjectv2>
Link copied to clipboard
class BucketOwnershipControls : KotlinCustomResource

Provides a resource to manage S3 Bucket Ownership Controls. For more information, see the S3 Developer Guide.

Link copied to clipboard
data class BucketOwnershipControlsArgs(val bucket: Output<String>? = null, val rule: Output<BucketOwnershipControlsRuleArgs>? = null) : ConvertibleToJava<BucketOwnershipControlsArgs>

Provides a resource to manage S3 Bucket Ownership Controls. For more information, see the S3 Developer Guide.

Link copied to clipboard
Link copied to clipboard
class BucketPolicy : KotlinCustomResource

Attaches a policy to an S3 bucket resource.

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

Attaches a policy to an S3 bucket resource.

Link copied to clipboard
Link copied to clipboard
object BucketPolicyMapper : ResourceMapper<BucketPolicy>
Link copied to clipboard
Link copied to clipboard
class BucketPublicAccessBlock : KotlinCustomResource

Manages S3 bucket-level Public Access Block configuration. For more information about these settings, see the AWS S3 Block Public Access documentation.

Link copied to clipboard
data class BucketPublicAccessBlockArgs(val blockPublicAcls: Output<Boolean>? = null, val blockPublicPolicy: Output<Boolean>? = null, val bucket: Output<String>? = null, val ignorePublicAcls: Output<Boolean>? = null, val restrictPublicBuckets: Output<Boolean>? = null) : ConvertibleToJava<BucketPublicAccessBlockArgs>

Manages S3 bucket-level Public Access Block configuration. For more information about these settings, see the AWS S3 Block Public Access documentation.

Link copied to clipboard
Link copied to clipboard
class BucketReplicationConfig : KotlinCustomResource

Provides an independent configuration resource for S3 bucket replication configuration.

Link copied to clipboard
data class BucketReplicationConfigArgs(val bucket: Output<String>? = null, val role: Output<String>? = null, val rules: Output<List<BucketReplicationConfigRuleArgs>>? = null, val token: Output<String>? = null) : ConvertibleToJava<BucketReplicationConfigArgs>

Provides an independent configuration resource for S3 bucket replication configuration.

Link copied to clipboard
Link copied to clipboard
class BucketRequestPaymentConfigurationV2 : KotlinCustomResource

Provides an S3 bucket request payment configuration resource. For more information, see Requester Pays Buckets.

Link copied to clipboard
data class BucketRequestPaymentConfigurationV2Args(val bucket: Output<String>? = null, val expectedBucketOwner: Output<String>? = null, val payer: Output<String>? = null) : ConvertibleToJava<BucketRequestPaymentConfigurationV2Args>

Provides an S3 bucket request payment configuration resource. For more information, see Requester Pays Buckets.

Link copied to clipboard

Builder for Bucket.

class BucketServerSideEncryptionConfigurationV2 : KotlinCustomResource

Provides a S3 bucket server-side encryption configuration resource.

data class BucketServerSideEncryptionConfigurationV2Args(val bucket: Output<String>? = null, val expectedBucketOwner: Output<String>? = null, val rules: Output<List<BucketServerSideEncryptionConfigurationV2RuleArgs>>? = null) : ConvertibleToJava<BucketServerSideEncryptionConfigurationV2Args>

Provides a S3 bucket server-side encryption configuration resource.

Link copied to clipboard
class BucketV2 : KotlinCustomResource

Provides a S3 bucket resource.

Link copied to clipboard
data class BucketV2Args(val accelerationStatus: Output<String>? = null, val acl: Output<String>? = null, val bucket: Output<String>? = null, val bucketPrefix: Output<String>? = null, val corsRules: Output<List<BucketV2CorsRuleArgs>>? = null, val forceDestroy: Output<Boolean>? = null, val grants: Output<List<BucketV2GrantArgs>>? = null, val lifecycleRules: Output<List<BucketV2LifecycleRuleArgs>>? = null, val loggings: Output<List<BucketV2LoggingArgs>>? = null, val objectLockConfiguration: Output<BucketV2ObjectLockConfigurationArgs>? = null, val objectLockEnabled: Output<Boolean>? = null, val policy: Output<String>? = null, val replicationConfigurations: Output<List<BucketV2ReplicationConfigurationArgs>>? = null, val requestPayer: Output<String>? = null, val serverSideEncryptionConfigurations: Output<List<BucketV2ServerSideEncryptionConfigurationArgs>>? = null, val tags: Output<Map<String, String>>? = null, val versionings: Output<List<BucketV2VersioningArgs>>? = null, val websites: Output<List<BucketV2WebsiteArgs>>? = null) : ConvertibleToJava<BucketV2Args>

Provides a S3 bucket resource.

Link copied to clipboard
Link copied to clipboard
object BucketV2Mapper : ResourceMapper<BucketV2>
Link copied to clipboard
Link copied to clipboard
class BucketVersioningV2 : KotlinCustomResource

Provides a resource for controlling versioning on an S3 bucket. Deleting this resource will either suspend versioning on the associated S3 bucket or simply remove the resource from state if the associated S3 bucket is unversioned. For more information, see How S3 versioning works.

Link copied to clipboard
data class BucketVersioningV2Args(val bucket: Output<String>? = null, val expectedBucketOwner: Output<String>? = null, val mfa: Output<String>? = null, val versioningConfiguration: Output<BucketVersioningV2VersioningConfigurationArgs>? = null) : ConvertibleToJava<BucketVersioningV2Args>

Provides a resource for controlling versioning on an S3 bucket. Deleting this resource will either suspend versioning on the associated S3 bucket or simply remove the resource from state if the associated S3 bucket is unversioned. For more information, see How S3 versioning works.

Link copied to clipboard
Link copied to clipboard
class BucketWebsiteConfigurationV2 : KotlinCustomResource

Provides an S3 bucket website configuration resource. For more information, see Hosting Websites on S3.

Link copied to clipboard
data class BucketWebsiteConfigurationV2Args(val bucket: Output<String>? = null, val errorDocument: Output<BucketWebsiteConfigurationV2ErrorDocumentArgs>? = null, val expectedBucketOwner: Output<String>? = null, val indexDocument: Output<BucketWebsiteConfigurationV2IndexDocumentArgs>? = null, val redirectAllRequestsTo: Output<BucketWebsiteConfigurationV2RedirectAllRequestsToArgs>? = null, val routingRuleDetails: Output<String>? = null, val routingRules: Output<List<BucketWebsiteConfigurationV2RoutingRuleArgs>>? = null) : ConvertibleToJava<BucketWebsiteConfigurationV2Args>

Provides an S3 bucket website configuration resource. For more information, see Hosting Websites on S3.

Link copied to clipboard
class Inventory : KotlinCustomResource

Provides a S3 bucket inventory configuration resource.

Link copied to clipboard
data class InventoryArgs(val bucket: Output<String>? = null, val destination: Output<InventoryDestinationArgs>? = null, val enabled: Output<Boolean>? = null, val filter: Output<InventoryFilterArgs>? = null, val includedObjectVersions: Output<String>? = null, val name: Output<String>? = null, val optionalFields: Output<List<String>>? = null, val schedule: Output<InventoryScheduleArgs>? = null) : ConvertibleToJava<InventoryArgs>

Provides a S3 bucket inventory configuration resource.

Link copied to clipboard
Link copied to clipboard
object InventoryMapper : ResourceMapper<Inventory>
Link copied to clipboard
Link copied to clipboard
class ObjectCopy : KotlinCustomResource

Provides a resource for copying an S3 object.

Link copied to clipboard
data class ObjectCopyArgs(val acl: Output<String>? = null, val bucket: Output<String>? = null, val bucketKeyEnabled: Output<Boolean>? = null, val cacheControl: Output<String>? = null, val contentDisposition: Output<String>? = null, val contentEncoding: Output<String>? = null, val contentLanguage: Output<String>? = null, val contentType: Output<String>? = null, val copyIfMatch: Output<String>? = null, val copyIfModifiedSince: Output<String>? = null, val copyIfNoneMatch: Output<String>? = null, val copyIfUnmodifiedSince: Output<String>? = null, val customerAlgorithm: Output<String>? = null, val customerKey: Output<String>? = null, val customerKeyMd5: Output<String>? = null, val expectedBucketOwner: Output<String>? = null, val expectedSourceBucketOwner: Output<String>? = null, val expires: Output<String>? = null, val forceDestroy: Output<Boolean>? = null, val grants: Output<List<ObjectCopyGrantArgs>>? = null, val key: Output<String>? = null, val kmsEncryptionContext: Output<String>? = null, val kmsKeyId: Output<String>? = null, val metadata: Output<Map<String, String>>? = null, val metadataDirective: Output<String>? = null, val objectLockLegalHoldStatus: Output<String>? = null, val objectLockMode: Output<String>? = null, val objectLockRetainUntilDate: Output<String>? = null, val requestPayer: Output<String>? = null, val serverSideEncryption: Output<String>? = null, val source: Output<String>? = null, val sourceCustomerAlgorithm: Output<String>? = null, val sourceCustomerKey: Output<String>? = null, val sourceCustomerKeyMd5: Output<String>? = null, val storageClass: Output<String>? = null, val taggingDirective: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val websiteRedirect: Output<String>? = null) : ConvertibleToJava<ObjectCopyArgs>

Provides a resource for copying an S3 object.

Link copied to clipboard
Link copied to clipboard
object ObjectCopyMapper : ResourceMapper<ObjectCopy>
Link copied to clipboard
Link copied to clipboard

Functions

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
suspend fun bucketAclV2(name: String, block: suspend BucketAclV2ResourceBuilder.() -> Unit): BucketAclV2
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
suspend fun bucketV2(name: String, block: suspend BucketV2ResourceBuilder.() -> Unit): BucketV2
Link copied to clipboard
suspend fun inventory(name: String, block: suspend InventoryResourceBuilder.() -> Unit): Inventory
Link copied to clipboard
suspend fun objectCopy(name: String, block: suspend ObjectCopyResourceBuilder.() -> Unit): ObjectCopy