AWS Native v0.63.0, May 25 23

aws-native.lightsail.getBucket

Explore with Pulumi AI

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)
// Output-based functions aren't available in Java yet

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
BucketArn string
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.Lightsail.Outputs.BucketTag>: 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
BucketArn string
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 []BucketTag: 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
bucketArn String
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<BucketTag>: 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
bucketArn string
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 BucketTag[]: 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
bucket_arn str
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[BucketTag]: 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
bucketArn String
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.

BucketTag

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key str: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value str: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Package Details

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