AWS Cloud Control v1.9.0, Nov 18 24

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.neptune.DbCluster

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

Create DbCluster Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new DbCluster(name: string, args?: DbClusterArgs, opts?: CustomResourceOptions);

@overload
def DbCluster(resource_name: str,
              args: Optional[DbClusterArgs] = None,
              opts: Optional[ResourceOptions] = None)

@overload
def DbCluster(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              associated_roles: Optional[Sequence[DbClusterDbClusterRoleArgs]] = None,
              availability_zones: Optional[Sequence[str]] = None,
              backup_retention_period: Optional[int] = None,
              copy_tags_to_snapshot: Optional[bool] = None,
              db_cluster_identifier: Optional[str] = None,
              db_cluster_parameter_group_name: Optional[str] = None,
              db_instance_parameter_group_name: Optional[str] = None,
              db_port: Optional[int] = None,
              db_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[_root_inputs.TagArgs]] = None,
              use_latest_restorable_time: Optional[bool] = None,
              vpc_security_group_ids: Optional[Sequence[str]] = 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.

Parameters

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DbCluster resource accepts the following input properties:

AssociatedRoles List<Pulumi.AwsNative.Neptune.Inputs.DbClusterDbClusterRole>

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.

AvailabilityZones List<string>

Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

BackupRetentionPeriod int

Specifies the number of days for which automatic DB snapshots are retained.

CopyTagsToSnapshot 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.

DbClusterIdentifier 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.

DbClusterParameterGroupName string

Provides the name of the DB cluster parameter group.

DbInstanceParameterGroupName string

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.

DbPort int

The port number on which the DB instances in the DB cluster accept connections.

If not specified, the default port used is 8182.

Note: Port property will soon be deprecated from this resource. Please update existing templates to rename it with new property DBPort having same functionalities.

DbSubnetGroupName string

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

DeletionProtection bool

Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

EnableCloudwatchLogsExports List<string>

Specifies a list of log types that are enabled for export to CloudWatch Logs.

EngineVersion string

Indicates the database engine version.

IamAuthEnabled bool

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

KmsKeyId string

The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default KMS key is used. If you specify this property, you must set the StorageEncrypted property to true.

PreferredBackupWindow string

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

PreferredMaintenanceWindow string

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

RestoreToTime 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.

RestoreType 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.

ServerlessScalingConfiguration Pulumi.AwsNative.Neptune.Inputs.DbClusterServerlessScalingConfiguration

Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.

SnapshotIdentifier 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.

SourceDbClusterIdentifier 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.

StorageEncrypted bool

Indicates whether the DB cluster is encrypted.

If you specify the KmsKeyId property, then you must enable encryption and set this property to true.

If you enable the StorageEncrypted property but don't specify KmsKeyId property, then the default KMS key is used. If you specify KmsKeyId property, then that KMS Key is used to encrypt the database instances in the DB cluster.

If you specify the SourceDBClusterIdentifier property and don't specify this property or disable it. The value is inherited from the source DB cluster, and if the DB cluster is encrypted, the KmsKeyId property from the source cluster is used.

If you specify the DBSnapshotIdentifier and don't specify this property or disable it. The value is inherited from the snapshot, and the specified KmsKeyId property from the snapshot is used.

Tags List<Pulumi.AwsNative.Inputs.Tag>

The tags assigned to this cluster.

UseLatestRestorableTime bool

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.

VpcSecurityGroupIds List<string>

Provides a list of VPC security groups that the DB cluster belongs to.

AssociatedRoles []DbClusterDbClusterRoleArgs

AvailabilityZones []string

Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

BackupRetentionPeriod int

Specifies the number of days for which automatic DB snapshots are retained.

CopyTagsToSnapshot 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.

DbClusterIdentifier 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.

DbClusterParameterGroupName string

Provides the name of the DB cluster parameter group.

DbInstanceParameterGroupName string

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.

DbPort int

The port number on which the DB instances in the DB cluster accept connections.

If not specified, the default port used is 8182.

Note: Port property will soon be deprecated from this resource. Please update existing templates to rename it with new property DBPort having same functionalities.

DbSubnetGroupName string

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

DeletionProtection bool

Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

EnableCloudwatchLogsExports []string

Specifies a list of log types that are enabled for export to CloudWatch Logs.

EngineVersion string

Indicates the database engine version.

IamAuthEnabled bool

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

KmsKeyId string

PreferredBackupWindow string

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

PreferredMaintenanceWindow string

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

RestoreToTime 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.

RestoreType 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.

ServerlessScalingConfiguration DbClusterServerlessScalingConfigurationArgs

Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.

SnapshotIdentifier string

Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.

SourceDbClusterIdentifier 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.

StorageEncrypted bool

Indicates whether the DB cluster is encrypted.

If you specify the KmsKeyId property, then you must enable encryption and set this property to true.

If you specify the DBSnapshotIdentifier and don't specify this property or disable it. The value is inherited from the snapshot, and the specified KmsKeyId property from the snapshot is used.

Tags TagArgs

The tags assigned to this cluster.

UseLatestRestorableTime bool

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.

VpcSecurityGroupIds []string

Provides a list of VPC security groups that the DB cluster belongs to.

associatedRoles List<DbClusterDbClusterRole>

availabilityZones List<String>

Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

backupRetentionPeriod Integer

Specifies the number of days for which automatic DB snapshots are retained.

copyTagsToSnapshot 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.

dbClusterIdentifier 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.

dbClusterParameterGroupName String

Provides the name of the DB cluster parameter group.

dbInstanceParameterGroupName String

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.

dbPort Integer

The port number on which the DB instances in the DB cluster accept connections.

If not specified, the default port used is 8182.

Note: Port property will soon be deprecated from this resource. Please update existing templates to rename it with new property DBPort having same functionalities.

dbSubnetGroupName String

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

deletionProtection Boolean

Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

enableCloudwatchLogsExports List<String>

Specifies a list of log types that are enabled for export to CloudWatch Logs.

engineVersion String

Indicates the database engine version.

iamAuthEnabled Boolean

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

kmsKeyId String

preferredBackupWindow String

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

preferredMaintenanceWindow String

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

restoreToTime 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.

restoreType 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.

serverlessScalingConfiguration DbClusterServerlessScalingConfiguration

Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.

snapshotIdentifier String

Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.

sourceDbClusterIdentifier 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.

storageEncrypted Boolean

Indicates whether the DB cluster is encrypted.

If you specify the KmsKeyId property, then you must enable encryption and set this property to true.

If you specify the DBSnapshotIdentifier and don't specify this property or disable it. The value is inherited from the snapshot, and the specified KmsKeyId property from the snapshot is used.

tags List<Tag>

The tags assigned to this cluster.

useLatestRestorableTime Boolean

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.

vpcSecurityGroupIds List<String>

Provides a list of VPC security groups that the DB cluster belongs to.

associatedRoles DbClusterDbClusterRole[]

availabilityZones string[]

Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

backupRetentionPeriod number

Specifies the number of days for which automatic DB snapshots are retained.

copyTagsToSnapshot 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.

dbClusterIdentifier 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.

dbClusterParameterGroupName string

Provides the name of the DB cluster parameter group.

dbInstanceParameterGroupName string

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.

dbPort number

The port number on which the DB instances in the DB cluster accept connections.

If not specified, the default port used is 8182.

Note: Port property will soon be deprecated from this resource. Please update existing templates to rename it with new property DBPort having same functionalities.

dbSubnetGroupName string

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

deletionProtection boolean

Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

enableCloudwatchLogsExports string[]

Specifies a list of log types that are enabled for export to CloudWatch Logs.

engineVersion string

Indicates the database engine version.

iamAuthEnabled boolean

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

kmsKeyId string

preferredBackupWindow string

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

preferredMaintenanceWindow string

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

restoreToTime 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.

restoreType 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.

serverlessScalingConfiguration DbClusterServerlessScalingConfiguration

Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.

snapshotIdentifier string

Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.

sourceDbClusterIdentifier 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.

storageEncrypted boolean

Indicates whether the DB cluster is encrypted.

If you specify the KmsKeyId property, then you must enable encryption and set this property to true.

If you specify the DBSnapshotIdentifier and don't specify this property or disable it. The value is inherited from the snapshot, and the specified KmsKeyId property from the snapshot is used.

tags Tag[]

The tags assigned to this cluster.

useLatestRestorableTime boolean

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.

vpcSecurityGroupIds string[]

Provides a list of VPC security groups that the DB cluster belongs to.

associated_roles Sequence[DbClusterDbClusterRoleArgs]

availability_zones Sequence[str]

Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

backup_retention_period int

Specifies the number of days for which automatic DB snapshots are retained.

copy_tags_to_snapshot 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.

db_cluster_identifier str

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.

db_cluster_parameter_group_name str

Provides the name of the DB cluster parameter group.

db_instance_parameter_group_name str

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.

db_port int

The port number on which the DB instances in the DB cluster accept connections.

If not specified, the default port used is 8182.

Note: Port property will soon be deprecated from this resource. Please update existing templates to rename it with new property DBPort having same functionalities.

db_subnet_group_name str

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_logs_exports Sequence[str]

Specifies a list of log types that are enabled for export to CloudWatch Logs.

engine_version str

Indicates the database engine version.

iam_auth_enabled bool

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

kms_key_id str

preferred_backup_window str

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

preferred_maintenance_window str

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

restore_to_time 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.

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.

serverless_scaling_configuration DbClusterServerlessScalingConfigurationArgs

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.

source_db_cluster_identifier 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.

storage_encrypted bool

Indicates whether the DB cluster is encrypted.

If you specify the KmsKeyId property, then you must enable encryption and set this property to true.

If you specify the DBSnapshotIdentifier and don't specify this property or disable it. The value is inherited from the snapshot, and the specified KmsKeyId property from the snapshot is used.

tags Sequence[TagArgs]

The tags assigned to this cluster.

use_latest_restorable_time bool

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.

vpc_security_group_ids Sequence[str]

Provides a list of VPC security groups that the DB cluster belongs to.

associatedRoles List<Property Map>

availabilityZones List<String>

Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

backupRetentionPeriod Number

Specifies the number of days for which automatic DB snapshots are retained.

copyTagsToSnapshot 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.

dbClusterIdentifier 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.

dbClusterParameterGroupName String

Provides the name of the DB cluster parameter group.

dbInstanceParameterGroupName String

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.

dbPort Number

The port number on which the DB instances in the DB cluster accept connections.

If not specified, the default port used is 8182.

Note: Port property will soon be deprecated from this resource. Please update existing templates to rename it with new property DBPort having same functionalities.

dbSubnetGroupName String

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

deletionProtection Boolean

Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

enableCloudwatchLogsExports List<String>

Specifies a list of log types that are enabled for export to CloudWatch Logs.

engineVersion String

Indicates the database engine version.

iamAuthEnabled Boolean

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

kmsKeyId String

preferredBackupWindow String

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

preferredMaintenanceWindow String

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

restoreToTime 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.

restoreType 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.

serverlessScalingConfiguration Property Map

Contains the scaling configuration used by the Neptune Serverless Instances within this DB cluster.

snapshotIdentifier String

Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.

sourceDbClusterIdentifier 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.

storageEncrypted Boolean

Indicates whether the DB cluster is encrypted.

If you specify the KmsKeyId property, then you must enable encryption and set this property to true.

If you specify the DBSnapshotIdentifier and don't specify this property or disable it. The value is inherited from the snapshot, and the specified KmsKeyId property from the snapshot is used.

tags List<Property Map>

The tags assigned to this cluster.

useLatestRestorableTime Boolean

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.

vpcSecurityGroupIds List<String>

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:

ClusterResourceId string: 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: The port number on which the DB cluster accepts connections. For example: 8182.
ReadEndpoint string: The reader endpoint for the DB cluster. For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com

ClusterResourceId string: 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: The port number on which the DB cluster accepts connections. For example: 8182.
ReadEndpoint string: The reader endpoint for the DB cluster. For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com

clusterResourceId String: 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: The port number on which the DB cluster accepts connections. For example: 8182.
readEndpoint String: The reader endpoint for the DB cluster. For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com

clusterResourceId string: 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: The port number on which the DB cluster accepts connections. For example: 8182.
readEndpoint string: The reader endpoint for the DB cluster. For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com

cluster_resource_id str: 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: The port number on which the DB cluster accepts connections. For example: 8182.
read_endpoint str: The reader endpoint for the DB cluster. For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com

clusterResourceId String: 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: The port number on which the DB cluster accepts connections. For example: 8182.
readEndpoint String: The reader endpoint for the DB cluster. For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com

Supporting Types

DbClusterDbClusterRole, DbClusterDbClusterRoleArgs

RoleArn string: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
FeatureName 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.

RoleArn string: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
FeatureName 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.

roleArn String: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
featureName 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.

roleArn string: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
featureName 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.

roleArn String: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
featureName 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, DbClusterServerlessScalingConfigurationArgs

MaxCapacity 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.
MinCapacity 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.

MaxCapacity 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.
MinCapacity 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.

maxCapacity 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.
minCapacity 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.

maxCapacity 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.
minCapacity 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.

maxCapacity 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.
minCapacity 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.

Tag, TagArgs

Key string: The key name of the tag
Value string: The value of the tag

Key string: The key name of the tag
Value string: The value of the tag

key String: The key name of the tag
value String: The value of the tag

key string: The key name of the tag
value string: The value of the tag

key str: The key name of the tag
value str: The value of the tag

key String: The key name of the tag
value String: The value of the tag

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.neptune.DbCluster

On this page

On this page

Create DbCluster Resource

Constructor syntax

Parameters

DbCluster Resource Properties

Inputs

Outputs

Supporting Types

DbClusterDbClusterRole, DbClusterDbClusterRoleArgs

DbClusterServerlessScalingConfiguration, DbClusterServerlessScalingConfigurationArgs

Tag, TagArgs

Package Details

On this page

On this page