AWS Native v0.64.0, Jun 2 23
AWS Native v0.64.0, Jun 2 23
aws-native.neptune.DBCluster
Explore with Pulumi AI
The AWS::Neptune::DBCluster resource creates an Amazon Neptune DB cluster.
Create DBCluster Resource
new DBCluster(name: string, args?: DBClusterArgs, opts?: CustomResourceOptions);
@overload
def DBCluster(resource_name: str,
opts: Optional[ResourceOptions] = None,
associated_roles: Optional[Sequence[DBClusterRoleArgs]] = None,
availability_zones: Optional[Sequence[str]] = None,
backup_retention_period: Optional[int] = None,
copy_tags_to_snapshot: Optional[bool] = None,
d_b_cluster_identifier: Optional[str] = None,
d_b_cluster_parameter_group_name: Optional[str] = None,
d_b_instance_parameter_group_name: Optional[str] = None,
d_b_subnet_group_name: Optional[str] = None,
deletion_protection: Optional[bool] = None,
enable_cloudwatch_logs_exports: Optional[Sequence[str]] = None,
engine_version: Optional[str] = None,
iam_auth_enabled: Optional[bool] = None,
kms_key_id: Optional[str] = None,
preferred_backup_window: Optional[str] = None,
preferred_maintenance_window: Optional[str] = None,
restore_to_time: Optional[str] = None,
restore_type: Optional[str] = None,
serverless_scaling_configuration: Optional[DBClusterServerlessScalingConfigurationArgs] = None,
snapshot_identifier: Optional[str] = None,
source_db_cluster_identifier: Optional[str] = None,
storage_encrypted: Optional[bool] = None,
tags: Optional[Sequence[DBClusterTagArgs]] = None,
use_latest_restorable_time: Optional[bool] = None,
vpc_security_group_ids: Optional[Sequence[str]] = None)
@overload
def DBCluster(resource_name: str,
args: Optional[DBClusterArgs] = None,
opts: Optional[ResourceOptions] = None)
func NewDBCluster(ctx *Context, name string, args *DBClusterArgs, opts ...ResourceOption) (*DBCluster, error)
public DBCluster(string name, DBClusterArgs? args = null, CustomResourceOptions? opts = null)
public DBCluster(String name, DBClusterArgs args)
public DBCluster(String name, DBClusterArgs args, CustomResourceOptions options)
type: aws-native:neptune:DBCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DBClusterArgs
- 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 DBClusterArgs
- 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 DBClusterArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DBClusterArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DBClusterArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
DBCluster 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 DBCluster resource accepts the following input properties:
- Associated
Roles List<Pulumi.Aws Native. Neptune. Inputs. DBCluster Role Args> Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
- Availability
Zones List<string> Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
- Backup
Retention intPeriod Specifies the number of days for which automatic DB snapshots are retained.
- bool
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default behaviour is not to copy them.
- DBCluster
Identifier string The DB cluster identifier. Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster stored as a lowercase string.
- DBCluster
Parameter stringGroup Name Provides the name of the DB cluster parameter group.
- DBInstance
Parameter stringGroup Name The name of the DB parameter group to apply to all instances of the DB cluster. Used only in case of a major EngineVersion upgrade request.
- DBSubnet
Group stringName Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
- Deletion
Protection bool Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
- Enable
Cloudwatch List<string>Logs Exports Specifies a list of log types that are enabled for export to CloudWatch Logs.
- Engine
Version string Indicates the database engine version.
- Iam
Auth boolEnabled True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
- Kms
Key stringId If
StorageEncrypted
is true, the Amazon KMS key identifier for the encrypted DB cluster.- Preferred
Backup stringWindow Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
- Preferred
Maintenance stringWindow Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
- Restore
To stringTime Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
- Restore
Type string Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
- Serverless
Scaling Pulumi.Configuration Aws Native. Neptune. Inputs. DBCluster Serverless Scaling Configuration Args Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.
- Snapshot
Identifier string Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.
After you restore a DB cluster using a SnapshotIdentifier, you must specify the same SnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.
However, if you don't specify the SnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the SnapshotIdentifier, and the original DB cluster is deleted.
- Source
DBCluster stringIdentifier Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
- Storage
Encrypted bool Indicates whether the DB cluster is encrypted.
If you specify the
DBClusterIdentifier
,DBSnapshotIdentifier
, orSourceDBInstanceIdentifier
property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. If you specify the KmsKeyId property, you must enable encryption.If you specify the KmsKeyId, you must enable encryption by setting StorageEncrypted to true.
- List<Pulumi.
Aws Native. Neptune. Inputs. DBCluster Tag Args> The tags assigned to this cluster.
- Use
Latest boolRestorable Time Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
- Vpc
Security List<string>Group Ids Provides a list of VPC security groups that the DB cluster belongs to.
- Associated
Roles []DBClusterRole Args Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
- Availability
Zones []string Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
- Backup
Retention intPeriod Specifies the number of days for which automatic DB snapshots are retained.
- bool
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default behaviour is not to copy them.
- DBCluster
Identifier string The DB cluster identifier. Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster stored as a lowercase string.
- DBCluster
Parameter stringGroup Name Provides the name of the DB cluster parameter group.
- DBInstance
Parameter stringGroup Name The name of the DB parameter group to apply to all instances of the DB cluster. Used only in case of a major EngineVersion upgrade request.
- DBSubnet
Group stringName Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
- Deletion
Protection bool Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
- Enable
Cloudwatch []stringLogs Exports Specifies a list of log types that are enabled for export to CloudWatch Logs.
- Engine
Version string Indicates the database engine version.
- Iam
Auth boolEnabled True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
- Kms
Key stringId If
StorageEncrypted
is true, the Amazon KMS key identifier for the encrypted DB cluster.- Preferred
Backup stringWindow Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
- Preferred
Maintenance stringWindow Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
- Restore
To stringTime Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
- Restore
Type string Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
- Serverless
Scaling DBClusterConfiguration Serverless Scaling Configuration Args Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.
- Snapshot
Identifier string Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.
After you restore a DB cluster using a SnapshotIdentifier, you must specify the same SnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.
However, if you don't specify the SnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the SnapshotIdentifier, and the original DB cluster is deleted.
- Source
DBCluster stringIdentifier Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
- Storage
Encrypted bool Indicates whether the DB cluster is encrypted.
If you specify the
DBClusterIdentifier
,DBSnapshotIdentifier
, orSourceDBInstanceIdentifier
property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. If you specify the KmsKeyId property, you must enable encryption.If you specify the KmsKeyId, you must enable encryption by setting StorageEncrypted to true.
- []DBCluster
Tag Args The tags assigned to this cluster.
- Use
Latest boolRestorable Time Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
- Vpc
Security []stringGroup Ids Provides a list of VPC security groups that the DB cluster belongs to.
- associated
Roles List<DBClusterRole Args> Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
- availability
Zones List<String> Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
- backup
Retention IntegerPeriod Specifies the number of days for which automatic DB snapshots are retained.
- Boolean
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default behaviour is not to copy them.
- d
BCluster StringIdentifier The DB cluster identifier. Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster stored as a lowercase string.
- d
BCluster StringParameter Group Name Provides the name of the DB cluster parameter group.
- d
BInstance StringParameter Group Name The name of the DB parameter group to apply to all instances of the DB cluster. Used only in case of a major EngineVersion upgrade request.
- d
BSubnet StringGroup Name Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
- deletion
Protection Boolean Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
- enable
Cloudwatch List<String>Logs Exports Specifies a list of log types that are enabled for export to CloudWatch Logs.
- engine
Version String Indicates the database engine version.
- iam
Auth BooleanEnabled True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
- kms
Key StringId If
StorageEncrypted
is true, the Amazon KMS key identifier for the encrypted DB cluster.- preferred
Backup StringWindow Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
- preferred
Maintenance StringWindow Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
- restore
To StringTime Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
- restore
Type String Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
- serverless
Scaling DBClusterConfiguration Serverless Scaling Configuration Args Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.
- snapshot
Identifier String Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.
After you restore a DB cluster using a SnapshotIdentifier, you must specify the same SnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.
However, if you don't specify the SnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the SnapshotIdentifier, and the original DB cluster is deleted.
- source
DBCluster StringIdentifier Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
- storage
Encrypted Boolean Indicates whether the DB cluster is encrypted.
If you specify the
DBClusterIdentifier
,DBSnapshotIdentifier
, orSourceDBInstanceIdentifier
property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. If you specify the KmsKeyId property, you must enable encryption.If you specify the KmsKeyId, you must enable encryption by setting StorageEncrypted to true.
- List<DBCluster
Tag Args> The tags assigned to this cluster.
- use
Latest BooleanRestorable Time Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
- vpc
Security List<String>Group Ids Provides a list of VPC security groups that the DB cluster belongs to.
- associated
Roles DBClusterRole Args[] Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
- availability
Zones string[] Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
- backup
Retention numberPeriod Specifies the number of days for which automatic DB snapshots are retained.
- boolean
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default behaviour is not to copy them.
- d
BCluster stringIdentifier The DB cluster identifier. Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster stored as a lowercase string.
- d
BCluster stringParameter Group Name Provides the name of the DB cluster parameter group.
- d
BInstance stringParameter Group Name The name of the DB parameter group to apply to all instances of the DB cluster. Used only in case of a major EngineVersion upgrade request.
- d
BSubnet stringGroup Name Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
- deletion
Protection boolean Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
- enable
Cloudwatch string[]Logs Exports Specifies a list of log types that are enabled for export to CloudWatch Logs.
- engine
Version string Indicates the database engine version.
- iam
Auth booleanEnabled True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
- kms
Key stringId If
StorageEncrypted
is true, the Amazon KMS key identifier for the encrypted DB cluster.- preferred
Backup stringWindow Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
- preferred
Maintenance stringWindow Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
- restore
To stringTime Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
- restore
Type string Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
- serverless
Scaling DBClusterConfiguration Serverless Scaling Configuration Args Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.
- snapshot
Identifier string Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.
After you restore a DB cluster using a SnapshotIdentifier, you must specify the same SnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.
However, if you don't specify the SnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the SnapshotIdentifier, and the original DB cluster is deleted.
- source
DBCluster stringIdentifier Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
- storage
Encrypted boolean Indicates whether the DB cluster is encrypted.
If you specify the
DBClusterIdentifier
,DBSnapshotIdentifier
, orSourceDBInstanceIdentifier
property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. If you specify the KmsKeyId property, you must enable encryption.If you specify the KmsKeyId, you must enable encryption by setting StorageEncrypted to true.
- DBCluster
Tag Args[] The tags assigned to this cluster.
- use
Latest booleanRestorable Time Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
- vpc
Security string[]Group Ids Provides a list of VPC security groups that the DB cluster belongs to.
- associated_
roles Sequence[DBClusterRole Args] Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
- availability_
zones Sequence[str] Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
- backup_
retention_ intperiod Specifies the number of days for which automatic DB snapshots are retained.
- bool
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default behaviour is not to copy them.
- d_
b_ strcluster_ identifier The DB cluster identifier. Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster stored as a lowercase string.
- d_
b_ strcluster_ parameter_ group_ name Provides the name of the DB cluster parameter group.
- d_
b_ strinstance_ parameter_ group_ name The name of the DB parameter group to apply to all instances of the DB cluster. Used only in case of a major EngineVersion upgrade request.
- d_
b_ strsubnet_ group_ name Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
- deletion_
protection bool Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
- enable_
cloudwatch_ Sequence[str]logs_ exports Specifies a list of log types that are enabled for export to CloudWatch Logs.
- engine_
version str Indicates the database engine version.
- iam_
auth_ boolenabled True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
- kms_
key_ strid If
StorageEncrypted
is true, the Amazon KMS key identifier for the encrypted DB cluster.- preferred_
backup_ strwindow Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
- preferred_
maintenance_ strwindow Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
- restore_
to_ strtime Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
- restore_
type str Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
- serverless_
scaling_ DBClusterconfiguration Serverless Scaling Configuration Args Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.
- snapshot_
identifier str Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.
After you restore a DB cluster using a SnapshotIdentifier, you must specify the same SnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.
However, if you don't specify the SnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the SnapshotIdentifier, and the original DB cluster is deleted.
- source_
db_ strcluster_ identifier Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
- storage_
encrypted bool Indicates whether the DB cluster is encrypted.
If you specify the
DBClusterIdentifier
,DBSnapshotIdentifier
, orSourceDBInstanceIdentifier
property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. If you specify the KmsKeyId property, you must enable encryption.If you specify the KmsKeyId, you must enable encryption by setting StorageEncrypted to true.
- Sequence[DBCluster
Tag Args] The tags assigned to this cluster.
- use_
latest_ boolrestorable_ time Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
- vpc_
security_ Sequence[str]group_ ids Provides a list of VPC security groups that the DB cluster belongs to.
- associated
Roles List<Property Map> Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
- availability
Zones List<String> Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
- backup
Retention NumberPeriod Specifies the number of days for which automatic DB snapshots are retained.
- Boolean
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default behaviour is not to copy them.
- d
BCluster StringIdentifier The DB cluster identifier. Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster stored as a lowercase string.
- d
BCluster StringParameter Group Name Provides the name of the DB cluster parameter group.
- d
BInstance StringParameter Group Name The name of the DB parameter group to apply to all instances of the DB cluster. Used only in case of a major EngineVersion upgrade request.
- d
BSubnet StringGroup Name Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
- deletion
Protection Boolean Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
- enable
Cloudwatch List<String>Logs Exports Specifies a list of log types that are enabled for export to CloudWatch Logs.
- engine
Version String Indicates the database engine version.
- iam
Auth BooleanEnabled True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
- kms
Key StringId If
StorageEncrypted
is true, the Amazon KMS key identifier for the encrypted DB cluster.- preferred
Backup StringWindow Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
- preferred
Maintenance StringWindow Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
- restore
To StringTime Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
- restore
Type String Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
- serverless
Scaling Property MapConfiguration Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.
- snapshot
Identifier String Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.
After you restore a DB cluster using a SnapshotIdentifier, you must specify the same SnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.
However, if you don't specify the SnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the SnapshotIdentifier, and the original DB cluster is deleted.
- source
DBCluster StringIdentifier Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
- storage
Encrypted Boolean Indicates whether the DB cluster is encrypted.
If you specify the
DBClusterIdentifier
,DBSnapshotIdentifier
, orSourceDBInstanceIdentifier
property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. If you specify the KmsKeyId property, you must enable encryption.If you specify the KmsKeyId, you must enable encryption by setting StorageEncrypted to true.
- List<Property Map>
The tags assigned to this cluster.
- use
Latest BooleanRestorable Time Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
- vpc
Security List<String>Group Ids Provides a list of VPC security groups that the DB cluster belongs to.
Outputs
All input properties are implicitly available as output properties. Additionally, the DBCluster resource produces the following output properties:
- Cluster
Resource stringId The resource id for the DB cluster. For example:
cluster-ABCD1234EFGH5678IJKL90MNOP
. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.- Endpoint string
The connection endpoint for the DB cluster. For example: mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com
- Id string
The provider-assigned unique ID for this managed resource.
- Port string
Specifies the port that the database engine is listening on.
- Read
Endpoint string The reader endpoint for the DB cluster. For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com
- Cluster
Resource stringId The resource id for the DB cluster. For example:
cluster-ABCD1234EFGH5678IJKL90MNOP
. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.- Endpoint string
The connection endpoint for the DB cluster. For example: mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com
- Id string
The provider-assigned unique ID for this managed resource.
- Port string
Specifies the port that the database engine is listening on.
- Read
Endpoint string The reader endpoint for the DB cluster. For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com
- cluster
Resource StringId The resource id for the DB cluster. For example:
cluster-ABCD1234EFGH5678IJKL90MNOP
. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.- endpoint String
The connection endpoint for the DB cluster. For example: mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com
- id String
The provider-assigned unique ID for this managed resource.
- port String
Specifies the port that the database engine is listening on.
- read
Endpoint String The reader endpoint for the DB cluster. For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com
- cluster
Resource stringId The resource id for the DB cluster. For example:
cluster-ABCD1234EFGH5678IJKL90MNOP
. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.- endpoint string
The connection endpoint for the DB cluster. For example: mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com
- id string
The provider-assigned unique ID for this managed resource.
- port string
Specifies the port that the database engine is listening on.
- read
Endpoint string The reader endpoint for the DB cluster. For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com
- cluster_
resource_ strid The resource id for the DB cluster. For example:
cluster-ABCD1234EFGH5678IJKL90MNOP
. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.- endpoint str
The connection endpoint for the DB cluster. For example: mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com
- id str
The provider-assigned unique ID for this managed resource.
- port str
Specifies the port that the database engine is listening on.
- read_
endpoint str The reader endpoint for the DB cluster. For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com
- cluster
Resource StringId The resource id for the DB cluster. For example:
cluster-ABCD1234EFGH5678IJKL90MNOP
. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.- endpoint String
The connection endpoint for the DB cluster. For example: mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com
- id String
The provider-assigned unique ID for this managed resource.
- port String
Specifies the port that the database engine is listening on.
- read
Endpoint String The reader endpoint for the DB cluster. For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com
Supporting Types
DBClusterRole
- Role
Arn string The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
- Feature
Name string The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon Neptune API Reference.
- Role
Arn string The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
- Feature
Name string The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon Neptune API Reference.
- role
Arn String The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
- feature
Name String The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon Neptune API Reference.
- role
Arn string The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
- feature
Name string The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon Neptune API Reference.
- role_
arn str The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
- feature_
name str The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon Neptune API Reference.
- role
Arn String The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
- feature
Name String The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon Neptune API Reference.
DBClusterServerlessScalingConfiguration
- Max
Capacity double The maximum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on. The smallest value you can use is 2.5, whereas the largest is 128.
- Min
Capacity double The minimum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value you can use is 1, whereas the largest is 128.
- Max
Capacity float64 The maximum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on. The smallest value you can use is 2.5, whereas the largest is 128.
- Min
Capacity float64 The minimum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value you can use is 1, whereas the largest is 128.
- max
Capacity Double The maximum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on. The smallest value you can use is 2.5, whereas the largest is 128.
- min
Capacity Double The minimum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value you can use is 1, whereas the largest is 128.
- max
Capacity number The maximum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on. The smallest value you can use is 2.5, whereas the largest is 128.
- min
Capacity number The minimum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value you can use is 1, whereas the largest is 128.
- max_
capacity float The maximum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on. The smallest value you can use is 2.5, whereas the largest is 128.
- min_
capacity float The minimum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value you can use is 1, whereas the largest is 128.
- max
Capacity Number The maximum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on. The smallest value you can use is 2.5, whereas the largest is 128.
- min
Capacity Number The minimum number of Neptune capacity units (NCUs) for a DB instance in an Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value you can use is 1, whereas the largest is 128.
DBClusterTag
- Key string
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Key string
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key string
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value string
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key str
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value str
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0