Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. s3outposts
  5. getBucket

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.s3outposts.getBucket

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type Definition for AWS::S3Outposts::Bucket

    Using getBucket

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getBucket(args: GetBucketArgs, opts?: InvokeOptions): Promise<GetBucketResult>
function getBucketOutput(args: GetBucketOutputArgs, opts?: InvokeOptions): Output<GetBucketResult>
    def get_bucket(arn: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetBucketResult
def get_bucket_output(arn: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetBucketResult]
    func LookupBucket(ctx *Context, args *LookupBucketArgs, opts ...InvokeOption) (*LookupBucketResult, error)
func LookupBucketOutput(ctx *Context, args *LookupBucketOutputArgs, opts ...InvokeOption) LookupBucketResultOutput

    > Note: This function is named LookupBucket in the Go SDK.

    public static class GetBucket 
{
    public static Task<GetBucketResult> InvokeAsync(GetBucketArgs args, InvokeOptions? opts = null)
    public static Output<GetBucketResult> Invoke(GetBucketInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBucketResult> getBucket(GetBucketArgs args, InvokeOptions options)
public static Output<GetBucketResult> getBucket(GetBucketArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:s3outposts:getBucket
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string
    The Amazon Resource Name (ARN) of the specified bucket.
    Arn string
    The Amazon Resource Name (ARN) of the specified bucket.
    arn String
    The Amazon Resource Name (ARN) of the specified bucket.
    arn string
    The Amazon Resource Name (ARN) of the specified bucket.
    arn str
    The Amazon Resource Name (ARN) of the specified bucket.
    arn String
    The Amazon Resource Name (ARN) of the specified bucket.

    getBucket Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the specified bucket.
    LifecycleConfiguration Pulumi.AwsNative.S3Outposts.Outputs.BucketLifecycleConfiguration
    Rules that define how Amazon S3Outposts manages objects during their lifetime.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An arbitrary set of tags (key-value pairs) for this S3Outposts bucket.
    Arn string
    The Amazon Resource Name (ARN) of the specified bucket.
    LifecycleConfiguration BucketLifecycleConfiguration
    Rules that define how Amazon S3Outposts manages objects during their lifetime.
    Tags Tag
    An arbitrary set of tags (key-value pairs) for this S3Outposts bucket.
    arn String
    The Amazon Resource Name (ARN) of the specified bucket.
    lifecycleConfiguration BucketLifecycleConfiguration
    Rules that define how Amazon S3Outposts manages objects during their lifetime.
    tags List<Tag>
    An arbitrary set of tags (key-value pairs) for this S3Outposts bucket.
    arn string
    The Amazon Resource Name (ARN) of the specified bucket.
    lifecycleConfiguration BucketLifecycleConfiguration
    Rules that define how Amazon S3Outposts manages objects during their lifetime.
    tags Tag[]
    An arbitrary set of tags (key-value pairs) for this S3Outposts bucket.
    arn str
    The Amazon Resource Name (ARN) of the specified bucket.
    lifecycle_configuration BucketLifecycleConfiguration
    Rules that define how Amazon S3Outposts manages objects during their lifetime.
    tags Sequence[root_Tag]
    An arbitrary set of tags (key-value pairs) for this S3Outposts bucket.
    arn String
    The Amazon Resource Name (ARN) of the specified bucket.
    lifecycleConfiguration Property Map
    Rules that define how Amazon S3Outposts manages objects during their lifetime.
    tags List<Property Map>
    An arbitrary set of tags (key-value pairs) for this S3Outposts bucket.

    Supporting Types

    BucketAbortIncompleteMultipartUpload

    DaysAfterInitiation int
    Specifies the number of days after which Amazon S3Outposts aborts an incomplete multipart upload.
    DaysAfterInitiation int
    Specifies the number of days after which Amazon S3Outposts aborts an incomplete multipart upload.
    daysAfterInitiation Integer
    Specifies the number of days after which Amazon S3Outposts aborts an incomplete multipart upload.
    daysAfterInitiation number
    Specifies the number of days after which Amazon S3Outposts aborts an incomplete multipart upload.
    days_after_initiation int
    Specifies the number of days after which Amazon S3Outposts aborts an incomplete multipart upload.
    daysAfterInitiation Number
    Specifies the number of days after which Amazon S3Outposts aborts an incomplete multipart upload.

    BucketFilterAndOperatorProperties

    Tags List<Pulumi.AwsNative.S3Outposts.Inputs.BucketFilterTag>
    All of these tags must exist in the object's tag set in order for the rule to apply.
    Prefix string
    Prefix identifies one or more objects to which the rule applies.
    Tags []BucketFilterTag
    All of these tags must exist in the object's tag set in order for the rule to apply.
    Prefix string
    Prefix identifies one or more objects to which the rule applies.
    tags List<BucketFilterTag>
    All of these tags must exist in the object's tag set in order for the rule to apply.
    prefix String
    Prefix identifies one or more objects to which the rule applies.
    tags BucketFilterTag[]
    All of these tags must exist in the object's tag set in order for the rule to apply.
    prefix string
    Prefix identifies one or more objects to which the rule applies.
    tags Sequence[BucketFilterTag]
    All of these tags must exist in the object's tag set in order for the rule to apply.
    prefix str
    Prefix identifies one or more objects to which the rule applies.
    tags List<Property Map>
    All of these tags must exist in the object's tag set in order for the rule to apply.
    prefix String
    Prefix identifies one or more objects to which the rule applies.

    BucketFilterTag

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    BucketLifecycleConfiguration

    Rules List<Pulumi.AwsNative.S3Outposts.Inputs.BucketRule>
    A list of lifecycle rules for individual objects in an Amazon S3Outposts bucket.
    Rules []BucketRule
    A list of lifecycle rules for individual objects in an Amazon S3Outposts bucket.
    rules List<BucketRule>
    A list of lifecycle rules for individual objects in an Amazon S3Outposts bucket.
    rules BucketRule[]
    A list of lifecycle rules for individual objects in an Amazon S3Outposts bucket.
    rules Sequence[BucketRule]
    A list of lifecycle rules for individual objects in an Amazon S3Outposts bucket.
    rules List<Property Map>
    A list of lifecycle rules for individual objects in an Amazon S3Outposts bucket.

    BucketRule

    AbortIncompleteMultipartUpload Pulumi.AwsNative.S3Outposts.Inputs.BucketAbortIncompleteMultipartUpload
    Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3Outposts bucket.
    ExpirationDate string
    Indicates when objects are deleted from Amazon S3Outposts. The date value must be in ISO 8601 format. The time is always midnight UTC.
    ExpirationInDays int
    Indicates the number of days after creation when objects are deleted from Amazon S3Outposts.
    Filter Pulumi.AwsNative.S3Outposts.Inputs.BucketRuleFilterProperties
    The container for the filter of the lifecycle rule.
    Id string
    Unique identifier for the lifecycle rule. The value can't be longer than 255 characters.
    Status Pulumi.AwsNative.S3Outposts.BucketRuleStatus
    If Enabled , the rule is currently being applied. If Disabled , the rule is not currently being applied.
    AbortIncompleteMultipartUpload BucketAbortIncompleteMultipartUpload
    Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3Outposts bucket.
    ExpirationDate string
    Indicates when objects are deleted from Amazon S3Outposts. The date value must be in ISO 8601 format. The time is always midnight UTC.
    ExpirationInDays int
    Indicates the number of days after creation when objects are deleted from Amazon S3Outposts.
    Filter BucketRuleFilterProperties
    The container for the filter of the lifecycle rule.
    Id string
    Unique identifier for the lifecycle rule. The value can't be longer than 255 characters.
    Status BucketRuleStatus
    If Enabled , the rule is currently being applied. If Disabled , the rule is not currently being applied.
    abortIncompleteMultipartUpload BucketAbortIncompleteMultipartUpload
    Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3Outposts bucket.
    expirationDate String
    Indicates when objects are deleted from Amazon S3Outposts. The date value must be in ISO 8601 format. The time is always midnight UTC.
    expirationInDays Integer
    Indicates the number of days after creation when objects are deleted from Amazon S3Outposts.
    filter BucketRuleFilterProperties
    The container for the filter of the lifecycle rule.
    id String
    Unique identifier for the lifecycle rule. The value can't be longer than 255 characters.
    status BucketRuleStatus
    If Enabled , the rule is currently being applied. If Disabled , the rule is not currently being applied.
    abortIncompleteMultipartUpload BucketAbortIncompleteMultipartUpload
    Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3Outposts bucket.
    expirationDate string
    Indicates when objects are deleted from Amazon S3Outposts. The date value must be in ISO 8601 format. The time is always midnight UTC.
    expirationInDays number
    Indicates the number of days after creation when objects are deleted from Amazon S3Outposts.
    filter BucketRuleFilterProperties
    The container for the filter of the lifecycle rule.
    id string
    Unique identifier for the lifecycle rule. The value can't be longer than 255 characters.
    status BucketRuleStatus
    If Enabled , the rule is currently being applied. If Disabled , the rule is not currently being applied.
    abort_incomplete_multipart_upload BucketAbortIncompleteMultipartUpload
    Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3Outposts bucket.
    expiration_date str
    Indicates when objects are deleted from Amazon S3Outposts. The date value must be in ISO 8601 format. The time is always midnight UTC.
    expiration_in_days int
    Indicates the number of days after creation when objects are deleted from Amazon S3Outposts.
    filter BucketRuleFilterProperties
    The container for the filter of the lifecycle rule.
    id str
    Unique identifier for the lifecycle rule. The value can't be longer than 255 characters.
    status BucketRuleStatus
    If Enabled , the rule is currently being applied. If Disabled , the rule is not currently being applied.
    abortIncompleteMultipartUpload Property Map
    Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3Outposts bucket.
    expirationDate String
    Indicates when objects are deleted from Amazon S3Outposts. The date value must be in ISO 8601 format. The time is always midnight UTC.
    expirationInDays Number
    Indicates the number of days after creation when objects are deleted from Amazon S3Outposts.
    filter Property Map
    The container for the filter of the lifecycle rule.
    id String
    Unique identifier for the lifecycle rule. The value can't be longer than 255 characters.
    status "Enabled" | "Disabled"
    If Enabled , the rule is currently being applied. If Disabled , the rule is not currently being applied.

    BucketRuleFilterProperties

    AndOperator Pulumi.AwsNative.S3Outposts.Inputs.BucketFilterAndOperatorProperties
    The container for the AND condition for the lifecycle rule. A combination of Prefix and 1 or more Tags OR a minimum of 2 or more tags.
    Prefix string
    Object key prefix that identifies one or more objects to which this rule applies.
    Tag Pulumi.AwsNative.S3Outposts.Inputs.BucketFilterTag
    Specifies a tag used to identify a subset of objects for an Amazon S3Outposts bucket.
    AndOperator BucketFilterAndOperatorProperties
    The container for the AND condition for the lifecycle rule. A combination of Prefix and 1 or more Tags OR a minimum of 2 or more tags.
    Prefix string
    Object key prefix that identifies one or more objects to which this rule applies.
    Tag BucketFilterTag
    Specifies a tag used to identify a subset of objects for an Amazon S3Outposts bucket.
    andOperator BucketFilterAndOperatorProperties
    The container for the AND condition for the lifecycle rule. A combination of Prefix and 1 or more Tags OR a minimum of 2 or more tags.
    prefix String
    Object key prefix that identifies one or more objects to which this rule applies.
    tag BucketFilterTag
    Specifies a tag used to identify a subset of objects for an Amazon S3Outposts bucket.
    andOperator BucketFilterAndOperatorProperties
    The container for the AND condition for the lifecycle rule. A combination of Prefix and 1 or more Tags OR a minimum of 2 or more tags.
    prefix string
    Object key prefix that identifies one or more objects to which this rule applies.
    tag BucketFilterTag
    Specifies a tag used to identify a subset of objects for an Amazon S3Outposts bucket.
    and_operator BucketFilterAndOperatorProperties
    The container for the AND condition for the lifecycle rule. A combination of Prefix and 1 or more Tags OR a minimum of 2 or more tags.
    prefix str
    Object key prefix that identifies one or more objects to which this rule applies.
    tag BucketFilterTag
    Specifies a tag used to identify a subset of objects for an Amazon S3Outposts bucket.
    andOperator Property Map
    The container for the AND condition for the lifecycle rule. A combination of Prefix and 1 or more Tags OR a minimum of 2 or more tags.
    prefix String
    Object key prefix that identifies one or more objects to which this rule applies.
    tag Property Map
    Specifies a tag used to identify a subset of objects for an Amazon S3Outposts bucket.

    BucketRuleStatus

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native