1. Packages
  2. AWS Native
  3. API Docs
  4. lightsail
  5. Bucket

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

aws-native.lightsail.Bucket

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

    Resource Type definition for AWS::Lightsail::Bucket

    Create Bucket Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Bucket(name: string, args: BucketArgs, opts?: CustomResourceOptions);
    @overload
    def Bucket(resource_name: str,
               args: BucketArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Bucket(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               bundle_id: Optional[str] = None,
               access_rules: Optional[BucketAccessRulesArgs] = None,
               bucket_name: Optional[str] = None,
               object_versioning: Optional[bool] = None,
               read_only_access_accounts: Optional[Sequence[str]] = None,
               resources_receiving_access: Optional[Sequence[str]] = None,
               tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewBucket(ctx *Context, name string, args BucketArgs, opts ...ResourceOption) (*Bucket, error)
    public Bucket(string name, BucketArgs args, CustomResourceOptions? opts = null)
    public Bucket(String name, BucketArgs args)
    public Bucket(String name, BucketArgs args, CustomResourceOptions options)
    
    type: aws-native:lightsail:Bucket
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args BucketArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BucketArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BucketArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BucketArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BucketArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const bucketResource = new aws_native.lightsail.Bucket("bucketResource", {
        bundleId: "string",
        accessRules: {
            allowPublicOverrides: false,
            getObject: "string",
        },
        bucketName: "string",
        objectVersioning: false,
        readOnlyAccessAccounts: ["string"],
        resourcesReceivingAccess: ["string"],
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    Coming soon!
    

    Bucket Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Bucket resource accepts the following input properties:

    BundleId string
    The ID of the bundle to use for the bucket.
    AccessRules Pulumi.AwsNative.Lightsail.Inputs.BucketAccessRules
    An object that describes the access rules for the bucket.
    BucketName string
    The name 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.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    BundleId string
    The ID of the bundle to use for the bucket.
    AccessRules BucketAccessRulesArgs
    An object that describes the access rules for the bucket.
    BucketName string
    The name 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 TagArgs
    An array of key-value pairs to apply to this resource.
    bundleId String
    The ID of the bundle to use for the bucket.
    accessRules BucketAccessRules
    An object that describes the access rules for the bucket.
    bucketName String
    The name 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.
    bundleId string
    The ID of the bundle to use for the bucket.
    accessRules BucketAccessRules
    An object that describes the access rules for the bucket.
    bucketName string
    The name 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.
    bundle_id str
    The ID of the bundle to use for the bucket.
    access_rules BucketAccessRulesArgs
    An object that describes the access rules for the bucket.
    bucket_name str
    The name 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[TagArgs]
    An array of key-value pairs to apply to this resource.
    bundleId String
    The ID of the bundle to use for the bucket.
    accessRules Property Map
    An object that describes the access rules for the bucket.
    bucketName String
    The name 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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Bucket resource produces the following output properties:

    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.
    BucketArn string
    The Amazon Resource Name (ARN) of the bucket.
    Id string
    The provider-assigned unique ID for this managed 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.
    BucketArn string
    The Amazon Resource Name (ARN) of the bucket.
    Id string
    The provider-assigned unique ID for this managed 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.
    bucketArn String
    The Amazon Resource Name (ARN) of the bucket.
    id String
    The provider-assigned unique ID for this managed 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.
    bucketArn string
    The Amazon Resource Name (ARN) of the bucket.
    id string
    The provider-assigned unique ID for this managed 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.
    bucket_arn str
    The Amazon Resource Name (ARN) of the bucket.
    id str
    The provider-assigned unique ID for this managed 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.
    bucketArn String
    The Amazon Resource Name (ARN) of the bucket.
    id String
    The provider-assigned unique ID for this managed resource.
    url String
    The URL of the bucket.

    Supporting Types

    BucketAccessRules, BucketAccessRulesArgs

    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, TagArgs

    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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi