CfnBucketProps

class aws_cdk.aws_lightsail.CfnBucketProps(*, bucket_name, bundle_id, access_rules=None, object_versioning=None, read_only_access_accounts=None, resources_receiving_access=None, tags=None)

Bases: object

Properties for defining a CfnBucket.

Parameters
  • bucket_name (str) – The name of the bucket.

  • bundle_id (str) – The bundle ID for the bucket (for example, small_1_0 ). A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.

  • access_rules (Union[IResolvable, AccessRulesProperty, Dict[str, Any], None]) – An object that describes the access rules for the bucket.

  • object_versioning (Union[bool, IResolvable, None]) – Indicates whether object versioning is enabled for the bucket. The following options can be configured: - Enabled - Object versioning is enabled. - Suspended - Object versioning was previously enabled but is currently suspended. Existing object versions are retained. - NeverEnabled - Object versioning has never been enabled.

  • read_only_access_accounts (Optional[Sequence[str]]) – An array of AWS account IDs that have read-only access to the bucket.

  • resources_receiving_access (Optional[Sequence[str]]) – An array of Lightsail instances that have access to the bucket.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag in the AWS CloudFormation User Guide . .. epigraph:: The Value of Tags is optional for Lightsail resources.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_lightsail as lightsail

cfn_bucket_props = lightsail.CfnBucketProps(
    bucket_name="bucketName",
    bundle_id="bundleId",

    # the properties below are optional
    access_rules=lightsail.CfnBucket.AccessRulesProperty(
        allow_public_overrides=False,
        object_access="objectAccess"
    ),
    object_versioning=False,
    read_only_access_accounts=["readOnlyAccessAccounts"],
    resources_receiving_access=["resourcesReceivingAccess"],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

access_rules

An object that describes the access rules for the bucket.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-accessrules

Return type

Union[IResolvable, AccessRulesProperty, None]

bucket_name

The name of the bucket.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-bucketname

Return type

str

bundle_id

The bundle ID for the bucket (for example, small_1_0 ).

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-bundleid

Return type

str

object_versioning

Indicates whether object versioning is enabled for the bucket.

The following options can be configured:

  • Enabled - Object versioning is enabled.

  • Suspended - Object versioning was previously enabled but is currently suspended. Existing object versions are retained.

  • NeverEnabled - Object versioning has never been enabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-objectversioning

Return type

Union[bool, IResolvable, None]

read_only_access_accounts

An array of AWS account IDs that have read-only access to the bucket.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-readonlyaccessaccounts

Return type

Optional[List[str]]

resources_receiving_access

An array of Lightsail instances that have access to the bucket.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-resourcesreceivingaccess

Return type

Optional[List[str]]

tags

An array of key-value pairs to apply to this resource.

For more information, see Tag in the AWS CloudFormation User Guide . .. epigraph:

The ``Value`` of ``Tags`` is optional for Lightsail resources.
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html#cfn-lightsail-bucket-tags

Return type

Optional[List[CfnTag]]