CfnDisk¶
-
class
aws_cdk.aws_lightsail.
CfnDisk
(scope, id, *, disk_name, size_in_gb, add_ons=None, availability_zone=None, tags=None)¶ Bases:
aws_cdk.core.CfnResource
A CloudFormation
AWS::Lightsail::Disk
.The
AWS::Lightsail::Disk
resource specifies a disk that can be attached to an Amazon Lightsail instance that is in the same AWS Region and Availability Zone.- CloudformationResource
AWS::Lightsail::Disk
- Link
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-disk.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_disk = lightsail.CfnDisk(self, "MyCfnDisk", disk_name="diskName", size_in_gb=123, # the properties below are optional add_ons=[lightsail.CfnDisk.AddOnProperty( add_on_type="addOnType", # the properties below are optional auto_snapshot_add_on_request=lightsail.CfnDisk.AutoSnapshotAddOnProperty( snapshot_time_of_day="snapshotTimeOfDay" ), status="status" )], availability_zone="availabilityZone", tags=[CfnTag( key="key", value="value" )] )
Create a new
AWS::Lightsail::Disk
.- Parameters
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
disk_name (
str
) – The name of the disk.size_in_gb (
Union
[int
,float
]) – The size of the disk in GB.add_ons (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,AddOnProperty
]],None
]) – An array of add-ons for the disk. .. epigraph:: If the disk has an add-on enabled when performing a delete disk request, the add-on is automatically disabled before the disk is deleted.availability_zone (
Optional
[str
]) – The AWS Region and Availability Zone location for the disk (for example,us-east-1a
).tags (
Optional
[Sequence
[CfnTag
]]) – 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_depends_on
(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_metadata
(key, value)¶ Add a value to the CloudFormation Resource Metadata.
- Parameters
key (
str
) –value (
Any
) –
- See
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.
- Return type
None
-
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 intermdediate 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
).- 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 resoure, please consult that specific resource’s documentation.
- Return type
None
-
get_att
(attribute_name)¶ 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.- Return type
-
get_metadata
(key)¶ Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters
key (
str
) –- See
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.
- Return type
Any
-
inspect
(inspector)¶ Examines the CloudFormation resource and discloses attributes.
- Parameters
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type
None
-
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
-
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::Disk'¶
-
add_ons
¶ An array of add-ons for the disk.
If the disk has an add-on enabled when performing a delete disk request, the add-on is automatically disabled before the disk is deleted.
- Link
- Return type
Union
[IResolvable
,List
[Union
[IResolvable
,AddOnProperty
]],None
]
-
attr_attached_to
¶ The instance to which the disk is attached.
- CloudformationAttribute
AttachedTo
- Return type
str
-
attr_attachment_state
¶ (Deprecated) The attachment state of the disk.
In releases prior to November 14, 2017, this parameter returned
attached
for system disks in the API response. It is now deprecated, but still included in the response. UseisAttached
instead.- CloudformationAttribute
AttachmentState
- Return type
str
-
attr_disk_arn
¶ The Amazon Resource Name (ARN) of the disk.
- CloudformationAttribute
DiskArn
- Return type
str
-
attr_iops
¶ The input/output operations per second (IOPS) of the disk.
- CloudformationAttribute
Iops
- Return type
Union
[int
,float
]
-
attr_is_attached
¶ A Boolean value indicating whether the disk is attached to an instance.
- CloudformationAttribute
IsAttached
- Return type
-
attr_path
¶ The path of the disk.
- CloudformationAttribute
Path
- Return type
str
-
attr_resource_type
¶ The resource type of the disk (for example,
Disk
).- CloudformationAttribute
ResourceType
- Return type
str
-
attr_state
¶ The state of the disk (for example,
in-use
).- CloudformationAttribute
State
- Return type
str
-
attr_support_code
¶ The support code of the disk.
Include this code in your email to support when you have questions about a disk or another resource in Lightsail . This code helps our support team to look up your Lightsail information.
- CloudformationAttribute
SupportCode
- Return type
str
-
availability_zone
¶ The AWS Region and Availability Zone location for the disk (for example,
us-east-1a
).
-
cfn_options
¶ Options for this resource, such as condition, update policy etc.
- Return type
-
cfn_resource_type
¶ AWS resource type.
- Return type
str
-
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.
- Return type
List
[str
]
-
disk_name
¶ The name of the disk.
-
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)
.- Return type
str
- Returns
the logical ID as a stringified token. This value will only get resolved during synthesis.
-
node
¶ The construct tree node associated with this construct.
- Return type
-
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 })
.- Return type
str
-
size_in_gb
¶ The size of the disk in GB.
- Link
- Return type
Union
[int
,float
]
-
stack
¶ The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- Return type
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.
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
(construct)¶ Check whether the given construct is a CfnResource.
- Parameters
construct (
IConstruct
) –- Return type
bool
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool
AddOnProperty¶
-
class
CfnDisk.
AddOnProperty
(*, add_on_type, auto_snapshot_add_on_request=None, status=None)¶ Bases:
object
AddOn
is a property of the AWS::Lightsail::Disk resource. It describes the add-ons for a disk.- Parameters
add_on_type (
str
) – The add-on type (for example,AutoSnapshot
). .. epigraph::AutoSnapshot
is the only add-on that can be enabled for a disk.auto_snapshot_add_on_request (
Union
[IResolvable
,AutoSnapshotAddOnProperty
,None
]) – The parameters for the automatic snapshot add-on, such as the daily time when an automatic snapshot will be created.status (
Optional
[str
]) – The status of the add-on. Valid Values:Enabled
|Disabled
- Link
- 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 add_on_property = lightsail.CfnDisk.AddOnProperty( add_on_type="addOnType", # the properties below are optional auto_snapshot_add_on_request=lightsail.CfnDisk.AutoSnapshotAddOnProperty( snapshot_time_of_day="snapshotTimeOfDay" ), status="status" )
Attributes
-
add_on_type
¶ The add-on type (for example,
AutoSnapshot
).AutoSnapshot
is the only add-on that can be enabled for a disk.
-
auto_snapshot_add_on_request
¶ The parameters for the automatic snapshot add-on, such as the daily time when an automatic snapshot will be created.
-
status
¶ The status of the add-on.
Valid Values:
Enabled
|Disabled
AutoSnapshotAddOnProperty¶
-
class
CfnDisk.
AutoSnapshotAddOnProperty
(*, snapshot_time_of_day=None)¶ Bases:
object
AutoSnapshotAddOn
is a property of the AddOn property. It describes the automatic snapshot add-on for a disk.- Parameters
snapshot_time_of_day (
Optional
[str
]) – The daily time when an automatic snapshot will be created. Constraints: - Must be inHH:00
format, and in an hourly increment. - Specified in Coordinated Universal Time (UTC). - The snapshot will be automatically created between the time specified and up to 45 minutes after.- Link
- 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 auto_snapshot_add_on_property = lightsail.CfnDisk.AutoSnapshotAddOnProperty( snapshot_time_of_day="snapshotTimeOfDay" )
Attributes
-
snapshot_time_of_day
¶ The daily time when an automatic snapshot will be created.
Constraints:
Must be in
HH:00
format, and in an hourly increment.Specified in Coordinated Universal Time (UTC).
The snapshot will be automatically created between the time specified and up to 45 minutes after.