CfnBucket
- class aws_cdk.aws_lightsail.CfnBucket(scope, id, *, bucket_name, bundle_id, access_rules=None, object_versioning=None, read_only_access_accounts=None, resources_receiving_access=None, tags=None)
Bases:
CfnResource
The
AWS::Lightsail::Bucket
resource specifies a bucket.- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-bucket.html
- CloudformationResource:
AWS::Lightsail::Bucket
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_lightsail as lightsail cfn_bucket = lightsail.CfnBucket(self, "MyCfnBucket", 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" )] )
- Parameters:
scope (
Construct
) – Scope in which this resource is defined.id (
str
) – Construct identifier for this resource (unique in its scope).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:: TheValue
ofTags
is optional for Lightsail resources.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_dependency(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource
) –- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –value (
Any
) –
- See:
- Return type:
None
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT
). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str
) – The name of the attribute.type_hint (
Optional
[ResolutionTypeHint
]) –
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List
[Union
[Stack
,CfnResource
]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List
[CfnResource
]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource
) – The dependency to replace.new_target (
CfnResource
) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::Lightsail::Bucket'
- access_rules
An object that describes the access rules for the bucket.
- attr_able_to_update_bundle
A Boolean value indicating whether the bundle that is currently applied to your distribution can be changed to another bundle.
- CloudformationAttribute:
AbleToUpdateBundle
- attr_bucket_arn
The Amazon Resource Name (ARN) of the bucket.
- CloudformationAttribute:
BucketArn
- attr_url
The URL of the bucket.
- CloudformationAttribute:
Url
- bucket_name
The name of the bucket.
- bundle_id
The bundle ID for the bucket (for example,
small_1_0
).
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- node
The tree node.
- object_versioning
Indicates whether object versioning is enabled for the bucket.
- read_only_access_accounts
An array of AWS account IDs that have read-only access to the bucket.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.
- resources_receiving_access
An array of Lightsail instances that have access to the bucket.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
Tag Manager which manages the tags for this resource.
- tags_raw
An array of key-value pairs to apply to this resource.
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any
) –- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any
) –- Return type:
bool
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
AccessRulesProperty
- class CfnBucket.AccessRulesProperty(*, allow_public_overrides=None, object_access=None)
Bases:
object
AccessRules
is a property of the AWS::Lightsail::Bucket resource. It describes access rules for a bucket.- Parameters:
allow_public_overrides (
Union
[bool
,IResolvable
,None
]) – A Boolean value indicating whether the access control list (ACL) permissions that are applied to individual objects override theGetObject
option that is currently specified. When this is true, you can use the PutObjectAcl Amazon S3 API operation to set individual objects to public (read-only) or private, using either thepublic-read
ACL or theprivate
ACL.object_access (
Optional
[str
]) – Specifies the anonymous access to all objects in a bucket. The following options can be specified: -public
- Sets all objects in the bucket to public (read-only), making them readable by everyone on the internet. If theGetObject
value is set topublic
, then all objects in the bucket default to public regardless of theallowPublicOverrides
value. -private
- Sets all objects in the bucket to private, making them readable only by you and anyone that you grant access to. If theGetObject
value is set toprivate
, and theallowPublicOverrides
value is set totrue
, then all objects in the bucket default to private unless they are configured with apublic-read
ACL. Individual objects with apublic-read
ACL are readable by everyone on the internet.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_lightsail as lightsail access_rules_property = lightsail.CfnBucket.AccessRulesProperty( allow_public_overrides=False, object_access="objectAccess" )
Attributes
- allow_public_overrides
A Boolean value indicating whether the access control list (ACL) permissions that are applied to individual objects override the
GetObject
option that is currently specified.When this is true, you can use the PutObjectAcl Amazon S3 API operation to set individual objects to public (read-only) or private, using either the
public-read
ACL or theprivate
ACL.
- object_access
Specifies the anonymous access to all objects in a bucket.
The following options can be specified:
public
- Sets all objects in the bucket to public (read-only), making them readable by everyone on the internet.
If the
GetObject
value is set topublic
, then all objects in the bucket default to public regardless of theallowPublicOverrides
value.private
- Sets all objects in the bucket to private, making them readable only by you and anyone that you grant access to.
If the
GetObject
value is set toprivate
, and theallowPublicOverrides
value is set totrue
, then all objects in the bucket default to private unless they are configured with apublic-read
ACL. Individual objects with apublic-read
ACL are readable by everyone on the internet.