GetBucketResult

data class GetBucketResult(val accelerateConfiguration: BucketAccelerateConfiguration? = null, val analyticsConfigurations: List<BucketAnalyticsConfiguration>? = null, val arn: String? = null, val bucketEncryption: BucketEncryption? = null, val corsConfiguration: BucketCorsConfiguration? = null, val domainName: String? = null, val dualStackDomainName: String? = null, val intelligentTieringConfigurations: List<BucketIntelligentTieringConfiguration>? = null, val inventoryConfigurations: List<BucketInventoryConfiguration>? = null, val lifecycleConfiguration: BucketLifecycleConfiguration? = null, val loggingConfiguration: BucketLoggingConfiguration? = null, val metricsConfigurations: List<BucketMetricsConfiguration>? = null, val notificationConfiguration: BucketNotificationConfiguration? = null, val objectLockConfiguration: BucketObjectLockConfiguration? = null, val objectLockEnabled: Boolean? = null, val ownershipControls: BucketOwnershipControls? = null, val publicAccessBlockConfiguration: BucketPublicAccessBlockConfiguration? = null, val regionalDomainName: String? = null, val replicationConfiguration: BucketReplicationConfiguration? = null, val tags: List<Tag>? = null, val versioningConfiguration: BucketVersioningConfiguration? = null, val websiteConfiguration: BucketWebsiteConfiguration? = null, val websiteUrl: String? = null)

Constructors

Link copied to clipboard
constructor(accelerateConfiguration: BucketAccelerateConfiguration? = null, analyticsConfigurations: List<BucketAnalyticsConfiguration>? = null, arn: String? = null, bucketEncryption: BucketEncryption? = null, corsConfiguration: BucketCorsConfiguration? = null, domainName: String? = null, dualStackDomainName: String? = null, intelligentTieringConfigurations: List<BucketIntelligentTieringConfiguration>? = null, inventoryConfigurations: List<BucketInventoryConfiguration>? = null, lifecycleConfiguration: BucketLifecycleConfiguration? = null, loggingConfiguration: BucketLoggingConfiguration? = null, metricsConfigurations: List<BucketMetricsConfiguration>? = null, notificationConfiguration: BucketNotificationConfiguration? = null, objectLockConfiguration: BucketObjectLockConfiguration? = null, objectLockEnabled: Boolean? = null, ownershipControls: BucketOwnershipControls? = null, publicAccessBlockConfiguration: BucketPublicAccessBlockConfiguration? = null, regionalDomainName: String? = null, replicationConfiguration: BucketReplicationConfiguration? = null, tags: List<Tag>? = null, versioningConfiguration: BucketVersioningConfiguration? = null, websiteConfiguration: BucketWebsiteConfiguration? = null, websiteUrl: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see Amazon S3 Transfer Acceleration in the Amazon S3 User Guide.

Link copied to clipboard

Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.

Link copied to clipboard
val arn: String? = null

Returns the Amazon Resource Name (ARN) of the specified bucket. Example: arn:aws:s3:::DOC-EXAMPLE-BUCKET

Link copied to clipboard

Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For information about the Amazon S3 default encryption feature, see Amazon S3 Default Encryption for S3 Buckets in the Amazon S3 User Guide.

Link copied to clipboard

Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

Link copied to clipboard
val domainName: String? = null

Returns the IPv4 DNS name of the specified bucket. Example: DOC-EXAMPLE-BUCKET.s3.amazonaws.com

Link copied to clipboard

Returns the IPv6 DNS name of the specified bucket. Example: DOC-EXAMPLE-BUCKET.s3.dualstack.us-east-2.amazonaws.com For more information about dual-stack endpoints, see Using Amazon S3 Dual-Stack Endpoints .

Link copied to clipboard

Defines how Amazon S3 handles Intelligent-Tiering storage.

Link copied to clipboard

Specifies the inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory in the Amazon S3 API Reference.

Link copied to clipboard

Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see Object Lifecycle Management in the Amazon S3 User Guide.

Link copied to clipboard

Settings that define where logs are stored.

Link copied to clipboard

Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see PutBucketMetricsConfiguration.

Link copied to clipboard

Configuration that defines how Amazon S3 handles bucket notifications.

Link copied to clipboard

This operation is not supported by directory buckets. Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects. + The `DefaultRetention` settings require both a mode and a period.

Link copied to clipboard

Indicates whether this bucket has an Object Lock configuration enabled. Enable `ObjectLockEnabled` when you apply `ObjectLockConfiguration` to a bucket.

Link copied to clipboard

Configuration that defines how Amazon S3 handles Object Ownership rules.

Link copied to clipboard

Configuration that defines how Amazon S3 handles public access.

Link copied to clipboard

Returns the regional domain name of the specified bucket. Example: DOC-EXAMPLE-BUCKET.s3.us-east-2.amazonaws.com

Link copied to clipboard

Configuration for replicating objects in an S3 bucket. To enable replication, you must also enable versioning by using the `VersioningConfiguration` property. Amazon S3 can store replicated objects in a single destination bucket or multiple destination buckets. The destination bucket or buckets must already exist.

Link copied to clipboard
val tags: List<Tag>? = null

An arbitrary set of tags (key-value pairs) for this S3 bucket.

Link copied to clipboard

Enables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them. When you enable versioning on a bucket for the first time, it might take a short amount of time for the change to be fully propagated. We recommend that you wait for 15 minutes after enabling versioning before issuing write operations (`PUT` or `DELETE`) on objects in the bucket.

Link copied to clipboard

Information used to configure the bucket as a static website. For more information, see Hosting Websites on Amazon S3.

Link copied to clipboard
val websiteUrl: String? = null

Returns the Amazon S3 website endpoint for the specified bucket. Example (IPv4): http://DOC-EXAMPLE-BUCKET.s3-website.us-east-2.amazonaws.com Example (IPv6): http://DOC-EXAMPLE-BUCKET.s3.dualstack.us-east-2.amazonaws.com