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

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.lightsail.getBucket

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Lightsail::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(bucket_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetBucketResult
def get_bucket_output(bucket_name: 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:lightsail:getBucket
  arguments:
    # arguments dictionary

    The following arguments are supported:

    BucketName string
    The name for the bucket.
    BucketName string
    The name for the bucket.
    bucketName String
    The name for the bucket.
    bucketName string
    The name for the bucket.
    bucket_name str
    The name for the bucket.
    bucketName String
    The name for the bucket.

    getBucket Result

    The following output properties are available:

    AbleToUpdateBundle bool
    Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle. You can update a bucket's bundle only one time within a monthly AWS billing cycle.
    AccessRules Pulumi.AwsNative.Lightsail.Outputs.BucketAccessRules
    An object that describes the access rules for the bucket.
    BucketArn string
    The Amazon Resource Name (ARN) of the bucket.
    BundleId string
    The ID of the bundle to use for the bucket.
    ObjectVersioning bool
    Specifies whether to enable or disable versioning of objects in the bucket.
    ReadOnlyAccessAccounts List<string>
    An array of strings to specify the AWS account IDs that can access the bucket.
    ResourcesReceivingAccess List<string>
    The names of the Lightsail resources for which to set bucket access.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    Url string
    The URL of the bucket.
    AbleToUpdateBundle bool
    Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle. You can update a bucket's bundle only one time within a monthly AWS billing cycle.
    AccessRules BucketAccessRules
    An object that describes the access rules for the bucket.
    BucketArn string
    The Amazon Resource Name (ARN) of the bucket.
    BundleId string
    The ID of the bundle to use for the bucket.
    ObjectVersioning bool
    Specifies whether to enable or disable versioning of objects in the bucket.
    ReadOnlyAccessAccounts []string
    An array of strings to specify the AWS account IDs that can access the bucket.
    ResourcesReceivingAccess []string
    The names of the Lightsail resources for which to set bucket access.
    Tags Tag
    An array of key-value pairs to apply to this resource.
    Url string
    The URL of the bucket.
    ableToUpdateBundle Boolean
    Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle. You can update a bucket's bundle only one time within a monthly AWS billing cycle.
    accessRules BucketAccessRules
    An object that describes the access rules for the bucket.
    bucketArn String
    The Amazon Resource Name (ARN) of the bucket.
    bundleId String
    The ID of the bundle to use for the bucket.
    objectVersioning Boolean
    Specifies whether to enable or disable versioning of objects in the bucket.
    readOnlyAccessAccounts List<String>
    An array of strings to specify the AWS account IDs that can access the bucket.
    resourcesReceivingAccess List<String>
    The names of the Lightsail resources for which to set bucket access.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    url String
    The URL of the bucket.
    ableToUpdateBundle boolean
    Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle. You can update a bucket's bundle only one time within a monthly AWS billing cycle.
    accessRules BucketAccessRules
    An object that describes the access rules for the bucket.
    bucketArn string
    The Amazon Resource Name (ARN) of the bucket.
    bundleId string
    The ID of the bundle to use for the bucket.
    objectVersioning boolean
    Specifies whether to enable or disable versioning of objects in the bucket.
    readOnlyAccessAccounts string[]
    An array of strings to specify the AWS account IDs that can access the bucket.
    resourcesReceivingAccess string[]
    The names of the Lightsail resources for which to set bucket access.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    url string
    The URL of the bucket.
    able_to_update_bundle bool
    Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle. You can update a bucket's bundle only one time within a monthly AWS billing cycle.
    access_rules BucketAccessRules
    An object that describes the access rules for the bucket.
    bucket_arn str
    The Amazon Resource Name (ARN) of the bucket.
    bundle_id str
    The ID of the bundle to use for the bucket.
    object_versioning bool
    Specifies whether to enable or disable versioning of objects in the bucket.
    read_only_access_accounts Sequence[str]
    An array of strings to specify the AWS account IDs that can access the bucket.
    resources_receiving_access Sequence[str]
    The names of the Lightsail resources for which to set bucket access.
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    url str
    The URL of the bucket.
    ableToUpdateBundle Boolean
    Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle. You can update a bucket's bundle only one time within a monthly AWS billing cycle.
    accessRules Property Map
    An object that describes the access rules for the bucket.
    bucketArn String
    The Amazon Resource Name (ARN) of the bucket.
    bundleId String
    The ID of the bundle to use for the bucket.
    objectVersioning Boolean
    Specifies whether to enable or disable versioning of objects in the bucket.
    readOnlyAccessAccounts List<String>
    An array of strings to specify the AWS account IDs that can access the bucket.
    resourcesReceivingAccess List<String>
    The names of the Lightsail resources for which to set bucket access.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    url String
    The URL of the bucket.

    Supporting Types

    BucketAccessRules

    AllowPublicOverrides bool
    A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified.
    GetObject string
    Specifies the anonymous access to all objects in a bucket.
    AllowPublicOverrides bool
    A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified.
    GetObject string
    Specifies the anonymous access to all objects in a bucket.
    allowPublicOverrides Boolean
    A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified.
    getObject String
    Specifies the anonymous access to all objects in a bucket.
    allowPublicOverrides boolean
    A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified.
    getObject string
    Specifies the anonymous access to all objects in a bucket.
    allow_public_overrides bool
    A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified.
    get_object str
    Specifies the anonymous access to all objects in a bucket.
    allowPublicOverrides Boolean
    A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified.
    getObject String
    Specifies the anonymous access to all objects in a bucket.

    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.27.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-aws-native