Package com.pulumi.aws.s3.inputs

Class BucketState

  • public final class BucketState
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  BucketState.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static BucketState Empty  

    • Method Detail

      • accelerationStatus

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> accelerationStatus()
        Deprecated.
        acceleration_status is deprecated. Use the aws.s3.BucketAccelerateConfiguration resource instead.
        Returns:
        Sets the accelerate configuration of an existing bucket. Can be `Enabled` or `Suspended`. Cannot be used in `cn-north-1` or `us-gov-west-1`. This provider will only perform drift detection if a configuration value is provided. Use the resource `aws.s3.BucketAccelerateConfiguration` instead.

      • acl

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,​CannedAcl>>> acl()
        Deprecated.
        acl is deprecated. Use the aws.s3.BucketAcl resource instead.
        Returns:
        [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) to apply. Valid values are `private`, `public-read`, `public-read-write`, `aws-exec-read`, `authenticated-read`, and `log-delivery-write`. Defaults to `private`. Conflicts with `grant`. The provider will only perform drift detection if a configuration value is provided. Use the resource `aws.s3.BucketAcl` instead.

      • arn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
        Returns:
        ARN of the bucket. Will be of format `arn:aws:s3:::bucketname`.

      • bucket

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> bucket()
        Returns:
        Name of the bucket. If omitted, the provider will assign a random, unique name. Must be lowercase and less than or equal to 63 characters in length. A full list of bucket naming rules [may be found here](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html). The name must not be in the format `[bucketName]--[azid]--x-s3`. Use the `aws.s3.DirectoryBucket` resource to manage S3 Express buckets.

      • bucketDomainName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> bucketDomainName()
        Returns:
        Bucket domain name. Will be of format `bucketname.s3.amazonaws.com`.

      • bucketNamespace

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> bucketNamespace()
        Returns:
        Namespace for the bucket. Determines bucket naming scope. Valid values: `account-regional`, `global`. Defaults to `global` (AWS).

      • bucketPrefix

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> bucketPrefix()
        Returns:
        Creates a unique bucket name beginning with the specified prefix. Conflicts with `bucket`. Must be lowercase and less than or equal to 37 characters in length. A full list of bucket naming rules [may be found here](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html).

      • bucketRegion

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> bucketRegion()
        Returns:
        AWS region this bucket resides in.

      • bucketRegionalDomainName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> bucketRegionalDomainName()
        Returns:
        Bucket region-specific domain name. The bucket domain name including the region name. Please refer to the [S3 endpoints reference](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_region) for format. Note: AWS CloudFront allows specifying an S3 region-specific endpoint when creating an S3 origin. This will prevent redirect issues from CloudFront to the S3 Origin URL. For more information, see the [Virtual Hosted-Style Requests for Other Regions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/VirtualHosting.html#deprecated-global-endpoint) section in the AWS S3 User Guide.

      • corsRules

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<java.util.List<BucketCorsRuleArgs>>> corsRules()
        Deprecated.
        cors_rule is deprecated. Use the aws.s3.BucketCorsConfiguration resource instead.
        Returns:
        Rule of [Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html). See `corsRule` Block below for details. The provider will only perform drift detection if a configuration value is provided. Use the resource `aws.s3.BucketCorsConfiguration` instead.

      • forceDestroy

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> forceDestroy()
        Returns:
        Boolean that indicates all objects (including any [locked objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html)) should be deleted from the bucket *when the bucket is destroyed* so that the bucket can be destroyed without error. These objects are *not* recoverable. This only deletes objects when the bucket is destroyed, *not* when setting this parameter to `true`. Once this parameter is set to `true`, there must be a successful `pulumi up` run before a destroy is required to update this value in the resource state. Without a successful `pulumi up` after this parameter is set, this flag will have no effect. If setting this field in the same operation that would require replacing the bucket or destroying the bucket, this flag will not work. Additionally when importing a bucket, a successful `pulumi up` is required to set this value in state before it will take effect on a destroy operation.

      • grants

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<java.util.List<BucketGrantArgs>>> grants()
        Deprecated.
        grant is deprecated. Use the aws.s3.BucketAcl resource instead.
        Returns:
        [ACL policy grant](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#sample-acl). See `grant` Block below for details. Conflicts with `acl`. The provider will only perform drift detection if a configuration value is provided. Use the resource `aws.s3.BucketAcl` instead.

      • hostedZoneId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> hostedZoneId()
        Returns:
        [Route 53 Hosted Zone ID](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_website_region_endpoints) for this bucket's region.

      • lifecycleRules

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<java.util.List<BucketLifecycleRuleArgs>>> lifecycleRules()
        Deprecated.
        lifecycle_rule is deprecated. Use the aws.s3.BucketLifecycleConfiguration resource instead.
        Returns:
        Configuration of [object lifecycle management](http://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html). See `lifecycleRule` Block below for details. The provider will only perform drift detection if a configuration value is provided. Use the resource `aws.s3.BucketLifecycleConfiguration` instead.

      • logging

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<BucketLoggingArgs>> logging()
        Deprecated.
        logging is deprecated. Use the aws.s3.BucketLogging resource instead.
        Returns:
        Configuration of [S3 bucket logging](https://docs.aws.amazon.com/AmazonS3/latest/UG/ManagingBucketLogging.html) parameters. See `logging` Block below for details. The provider will only perform drift detection if a configuration value is provided. Use the resource `aws.s3.BucketLogging` instead.

      • objectLockConfiguration

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<BucketObjectLockConfigurationArgs>> objectLockConfiguration()
        Deprecated.
        object_lock_configuration is deprecated. Use the top-level parameter objectLockEnabled and the aws.s3.BucketObjectLockConfiguration resource instead.
        Returns:
        Configuration of [S3 object locking](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). See `objectLockConfiguration` Block below for details. The provider will only perform drift detection if a configuration value is provided. Use the `objectLockEnabled` parameter and the resource `aws.s3.BucketObjectLockConfiguration` instead.

      • objectLockEnabled

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> objectLockEnabled()
        Returns:
        Whether this bucket has an Object Lock configuration enabled. Valid values are `true` or `false`. This argument is not supported in all regions or partitions.

      • policy

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<com.pulumi.core.Either<java.lang.String,​PolicyDocumentArgs>>> policy()
        Deprecated.
        policy is deprecated. Use the aws.s3.BucketPolicy resource instead.
        Returns:
        Valid [bucket policy](https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html) JSON document. Note that if the policy document is not specific enough (but still valid), this provider may view the policy as constantly changing. In this case, please make sure you use the verbose/specific version of the policy. For more information about building AWS IAM policy documents with this provider, see the AWS IAM Policy Document Guide. The provider will only perform drift detection if a configuration value is provided. Use the resource `aws.s3.BucketPolicy` instead.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • replicationConfiguration

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<BucketReplicationConfigurationArgs>> replicationConfiguration()
        Deprecated.
        replication_configuration is deprecated. Use the aws.s3.BucketReplicationConfig resource instead.
        Returns:
        Configuration of [replication configuration](http://docs.aws.amazon.com/AmazonS3/latest/dev/crr.html). See `replicationConfiguration` Block below for details. The provider will only perform drift detection if a configuration value is provided. Use the resource `aws.s3.BucketReplicationConfig` instead.

      • requestPayer

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> requestPayer()
        Deprecated.
        request_payer is deprecated. Use the aws.s3.BucketRequestPaymentConfiguration resource instead.
        Returns:
        Who should bear the cost of Amazon S3 data transfer. Can be either `BucketOwner` or `Requester`. By default, the owner of the S3 bucket would incur the costs of any data transfer. See [Requester Pays Buckets](http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html) developer guide for more information. The provider will only perform drift detection if a configuration value is provided. Use the resource `aws.s3.BucketRequestPaymentConfiguration` instead.

      • serverSideEncryptionConfiguration

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<BucketServerSideEncryptionConfigurationArgs>> serverSideEncryptionConfiguration()
        Deprecated.
        server_side_encryption_configuration is deprecated. Use the aws.s3.BucketServerSideEncryptionConfiguration resource instead.
        Returns:
        Configuration of [server-side encryption configuration](http://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html). See `serverSideEncryptionConfiguration` Block below for details. The provider will only perform drift detection if a configuration value is provided. Use the resource `aws.s3.BucketServerSideEncryptionConfiguration` instead.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the bucket. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • versioning

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<BucketVersioningArgs>> versioning()
        Deprecated.
        versioning is deprecated. Use the aws.s3.BucketVersioning resource instead.
        Returns:
        Configuration of the [S3 bucket versioning state](https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html). See `versioning` Block below for details. The provider will only perform drift detection if a configuration value is provided. Use the resource `aws.s3.BucketVersioning` instead.

      • website

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<BucketWebsiteArgs>> website()
        Deprecated.
        website is deprecated. Use the aws.s3.BucketWebsiteConfiguration resource instead.
        Returns:
        Configuration of the [S3 bucket website](https://docs.aws.amazon.com/AmazonS3/latest/userguide/WebsiteHosting.html). See `website` Block below for details. The provider will only perform drift detection if a configuration value is provided. Use the resource `aws.s3.BucketWebsiteConfiguration` instead.

      • websiteDomain

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> websiteDomain()
        Deprecated.
        website_domain is deprecated. Use the aws.s3.BucketWebsiteConfiguration resource instead.
        Returns:
        (**Deprecated**) Domain of the website endpoint, if the bucket is configured with a website. If not, this will be an empty string. This is used to create Route 53 alias records. Use the resource `aws.s3.BucketWebsiteConfiguration` instead.

      • websiteEndpoint

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> websiteEndpoint()
        Deprecated.
        website_endpoint is deprecated. Use the aws.s3.BucketWebsiteConfiguration resource instead.
        Returns:
        (**Deprecated**) Website endpoint, if the bucket is configured with a website. If not, this will be an empty string. Use the resource `aws.s3.BucketWebsiteConfiguration` instead.