We recommend new projects start with resources from the AWS provider.
We recommend new projects start with resources from the AWS provider.
Resource Type definition for AWS::Lightsail::DatabaseSnapshot
Create DatabaseSnapshot Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DatabaseSnapshot(name: string, args: DatabaseSnapshotArgs, opts?: CustomResourceOptions);@overload
def DatabaseSnapshot(resource_name: str,
args: DatabaseSnapshotArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DatabaseSnapshot(resource_name: str,
opts: Optional[ResourceOptions] = None,
relational_database_name: Optional[str] = None,
relational_database_snapshot_name: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)func NewDatabaseSnapshot(ctx *Context, name string, args DatabaseSnapshotArgs, opts ...ResourceOption) (*DatabaseSnapshot, error)public DatabaseSnapshot(string name, DatabaseSnapshotArgs args, CustomResourceOptions? opts = null)
public DatabaseSnapshot(String name, DatabaseSnapshotArgs args)
public DatabaseSnapshot(String name, DatabaseSnapshotArgs args, CustomResourceOptions options)
type: aws-native:lightsail:DatabaseSnapshot
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 DatabaseSnapshotArgs
- 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 DatabaseSnapshotArgs
- 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 DatabaseSnapshotArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DatabaseSnapshotArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DatabaseSnapshotArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
DatabaseSnapshot Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The DatabaseSnapshot resource accepts the following input properties:
- Relational
Database stringName - The name of the database on which to base your new snapshot.
- Relational
Database stringSnapshot Name - The name for your new database snapshot.
-
List<Pulumi.
Aws Native. Inputs. Tag> - An array of key-value pairs to apply to this resource.
- Relational
Database stringName - The name of the database on which to base your new snapshot.
- Relational
Database stringSnapshot Name - The name for your new database snapshot.
-
Tag
Args - An array of key-value pairs to apply to this resource.
- relational
Database StringName - The name of the database on which to base your new snapshot.
- relational
Database StringSnapshot Name - The name for your new database snapshot.
- List<Tag>
- An array of key-value pairs to apply to this resource.
- relational
Database stringName - The name of the database on which to base your new snapshot.
- relational
Database stringSnapshot Name - The name for your new database snapshot.
- Tag[]
- An array of key-value pairs to apply to this resource.
- relational_
database_ strname - The name of the database on which to base your new snapshot.
- relational_
database_ strsnapshot_ name - The name for your new database snapshot.
-
Sequence[Tag
Args] - An array of key-value pairs to apply to this resource.
- relational
Database StringName - The name of the database on which to base your new snapshot.
- relational
Database StringSnapshot Name - The name for your new database snapshot.
- 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 DatabaseSnapshot resource produces the following output properties:
- Arn string
- The Amazon Resource Name (ARN) of the database snapshot.
- Created
At string - The timestamp when the database snapshot was created.
- Engine string
- The software of the database snapshot (for example, MySQL).
- Engine
Version string - The database engine version for the database snapshot (for example, 5.7.23).
- From
Relational stringDatabase Arn - The Amazon Resource Name (ARN) of the database from which the database snapshot was created.
- From
Relational stringDatabase Blueprint Id - The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database.
- From
Relational stringDatabase Bundle Id - The bundle ID of the database from which the database snapshot was created.
- From
Relational stringDatabase Name - The name of the source database from which the database snapshot was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Location
Pulumi.
Aws Native. Lightsail. Outputs. Location Properties - The Region name and Availability Zone where the database snapshot is located.
- Name string
- The name of the database snapshot.
- Resource
Type Pulumi.Aws Native. Lightsail. Database Snapshot Resource Type - The Lightsail resource type.
- Size
In intGb - The size of the disk in GB (for example, 32) for the database snapshot.
- State string
- The state of the database snapshot.
- Support
Code string - The support code for the database snapshot. Include this code in your email to support when you have questions about a database snapshot in Lightsail. This code enables our support team to look up your Lightsail information more easily.
- Arn string
- The Amazon Resource Name (ARN) of the database snapshot.
- Created
At string - The timestamp when the database snapshot was created.
- Engine string
- The software of the database snapshot (for example, MySQL).
- Engine
Version string - The database engine version for the database snapshot (for example, 5.7.23).
- From
Relational stringDatabase Arn - The Amazon Resource Name (ARN) of the database from which the database snapshot was created.
- From
Relational stringDatabase Blueprint Id - The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database.
- From
Relational stringDatabase Bundle Id - The bundle ID of the database from which the database snapshot was created.
- From
Relational stringDatabase Name - The name of the source database from which the database snapshot was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Location
Location
Properties - The Region name and Availability Zone where the database snapshot is located.
- Name string
- The name of the database snapshot.
- Resource
Type DatabaseSnapshot Resource Type - The Lightsail resource type.
- Size
In intGb - The size of the disk in GB (for example, 32) for the database snapshot.
- State string
- The state of the database snapshot.
- Support
Code string - The support code for the database snapshot. Include this code in your email to support when you have questions about a database snapshot in Lightsail. This code enables our support team to look up your Lightsail information more easily.
- arn String
- The Amazon Resource Name (ARN) of the database snapshot.
- created
At String - The timestamp when the database snapshot was created.
- engine String
- The software of the database snapshot (for example, MySQL).
- engine
Version String - The database engine version for the database snapshot (for example, 5.7.23).
- from
Relational StringDatabase Arn - The Amazon Resource Name (ARN) of the database from which the database snapshot was created.
- from
Relational StringDatabase Blueprint Id - The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database.
- from
Relational StringDatabase Bundle Id - The bundle ID of the database from which the database snapshot was created.
- from
Relational StringDatabase Name - The name of the source database from which the database snapshot was created.
- id String
- The provider-assigned unique ID for this managed resource.
- location
Location
Properties - The Region name and Availability Zone where the database snapshot is located.
- name String
- The name of the database snapshot.
- resource
Type DatabaseSnapshot Resource Type - The Lightsail resource type.
- size
In IntegerGb - The size of the disk in GB (for example, 32) for the database snapshot.
- state String
- The state of the database snapshot.
- support
Code String - The support code for the database snapshot. Include this code in your email to support when you have questions about a database snapshot in Lightsail. This code enables our support team to look up your Lightsail information more easily.
- arn string
- The Amazon Resource Name (ARN) of the database snapshot.
- created
At string - The timestamp when the database snapshot was created.
- engine string
- The software of the database snapshot (for example, MySQL).
- engine
Version string - The database engine version for the database snapshot (for example, 5.7.23).
- from
Relational stringDatabase Arn - The Amazon Resource Name (ARN) of the database from which the database snapshot was created.
- from
Relational stringDatabase Blueprint Id - The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database.
- from
Relational stringDatabase Bundle Id - The bundle ID of the database from which the database snapshot was created.
- from
Relational stringDatabase Name - The name of the source database from which the database snapshot was created.
- id string
- The provider-assigned unique ID for this managed resource.
- location
Location
Properties - The Region name and Availability Zone where the database snapshot is located.
- name string
- The name of the database snapshot.
- resource
Type DatabaseSnapshot Resource Type - The Lightsail resource type.
- size
In numberGb - The size of the disk in GB (for example, 32) for the database snapshot.
- state string
- The state of the database snapshot.
- support
Code string - The support code for the database snapshot. Include this code in your email to support when you have questions about a database snapshot in Lightsail. This code enables our support team to look up your Lightsail information more easily.
- arn str
- The Amazon Resource Name (ARN) of the database snapshot.
- created_
at str - The timestamp when the database snapshot was created.
- engine str
- The software of the database snapshot (for example, MySQL).
- engine_
version str - The database engine version for the database snapshot (for example, 5.7.23).
- from_
relational_ strdatabase_ arn - The Amazon Resource Name (ARN) of the database from which the database snapshot was created.
- from_
relational_ strdatabase_ blueprint_ id - The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database.
- from_
relational_ strdatabase_ bundle_ id - The bundle ID of the database from which the database snapshot was created.
- from_
relational_ strdatabase_ name - The name of the source database from which the database snapshot was created.
- id str
- The provider-assigned unique ID for this managed resource.
- location
Location
Properties - The Region name and Availability Zone where the database snapshot is located.
- name str
- The name of the database snapshot.
- resource_
type DatabaseSnapshot Resource Type - The Lightsail resource type.
- size_
in_ intgb - The size of the disk in GB (for example, 32) for the database snapshot.
- state str
- The state of the database snapshot.
- support_
code str - The support code for the database snapshot. Include this code in your email to support when you have questions about a database snapshot in Lightsail. This code enables our support team to look up your Lightsail information more easily.
- arn String
- The Amazon Resource Name (ARN) of the database snapshot.
- created
At String - The timestamp when the database snapshot was created.
- engine String
- The software of the database snapshot (for example, MySQL).
- engine
Version String - The database engine version for the database snapshot (for example, 5.7.23).
- from
Relational StringDatabase Arn - The Amazon Resource Name (ARN) of the database from which the database snapshot was created.
- from
Relational StringDatabase Blueprint Id - The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database.
- from
Relational StringDatabase Bundle Id - The bundle ID of the database from which the database snapshot was created.
- from
Relational StringDatabase Name - The name of the source database from which the database snapshot was created.
- id String
- The provider-assigned unique ID for this managed resource.
- location Property Map
- The Region name and Availability Zone where the database snapshot is located.
- name String
- The name of the database snapshot.
- resource
Type "RelationalDatabase Snapshot" - The Lightsail resource type.
- size
In NumberGb - The size of the disk in GB (for example, 32) for the database snapshot.
- state String
- The state of the database snapshot.
- support
Code String - The support code for the database snapshot. Include this code in your email to support when you have questions about a database snapshot in Lightsail. This code enables our support team to look up your Lightsail information more easily.
Supporting Types
DatabaseSnapshotResourceType, DatabaseSnapshotResourceTypeArgs
- Relational
Database Snapshot RelationalDatabaseSnapshot
- Database
Snapshot Resource Type Relational Database Snapshot RelationalDatabaseSnapshot
- Relational
Database Snapshot RelationalDatabaseSnapshot
- Relational
Database Snapshot RelationalDatabaseSnapshot
- RELATIONAL_DATABASE_SNAPSHOT
RelationalDatabaseSnapshot
- "Relational
Database Snapshot" RelationalDatabaseSnapshot
LocationProperties, LocationPropertiesArgs
The AWS Region and Availability Zone where the disk snapshot was created.- Availability
Zone string - The Availability Zone where the disk snapshot was created.
- Region
Name string - The AWS Region where the disk snapshot was created.
- Availability
Zone string - The Availability Zone where the disk snapshot was created.
- Region
Name string - The AWS Region where the disk snapshot was created.
- availability
Zone String - The Availability Zone where the disk snapshot was created.
- region
Name String - The AWS Region where the disk snapshot was created.
- availability
Zone string - The Availability Zone where the disk snapshot was created.
- region
Name string - The AWS Region where the disk snapshot was created.
- availability_
zone str - The Availability Zone where the disk snapshot was created.
- region_
name str - The AWS Region where the disk snapshot was created.
- availability
Zone String - The Availability Zone where the disk snapshot was created.
- region
Name String - The AWS Region where the disk snapshot was created.
Tag, TagArgs
A set of tags to apply to the resource.Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
