db_clusters_list_only
Lists db_clusters in a region or regions, for all properties use db_clusters
Overview
| Name | db_clusters_list_only |
| Type | Resource |
| Description | The AWS::Neptune::DBCluster resource creates an Amazon Neptune DB cluster. |
| Id | aws.neptune.db_clusters_list_only |
Fields
| Name | Datatype | Description |
|---|---|---|
endpoint | string | The connection endpoint for the DB cluster. For example: `mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com` |
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_id | 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. |
associated_roles | array | 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 | array | Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in. |
backup_retention_period | integer | Specifies the number of days for which automatic DB snapshots are retained. |
copy_tags_to_snapshot | 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. |
db_cluster_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. |
db_cluster_parameter_group_name | string | Provides the name of the DB cluster parameter group. |
db_instance_parameter_group_name | 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. |
db_port | 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. |
db_subnet_group_name | string | 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_logs_exports | array | Specifies a list of log types that are enabled for export to CloudWatch Logs. |
engine_version | string | Indicates the database engine version. |
iam_auth_enabled | boolean | True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. |
kms_key_id | string | If `StorageEncrypted` is true, the Amazon KMS key identifier for the encrypted DB cluster. |
port | string | The port number on which the DB cluster accepts connections. For example: `8182`. |
preferred_backup_window | string | Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. |
preferred_maintenance_window | string | Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). |
restore_to_time | 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. |
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_configuration | object | 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_db_cluster_identifier | 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. |
storage_encrypted | boolean | Indicates whether the DB cluster is encrypted. If you specify the `DBClusterIdentifier`, `DBSnapshotIdentifier`, or `SourceDBInstanceIdentifier` 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. |
tags | array | The tags assigned to this cluster. |
use_latest_restorable_time | 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. 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_group_ids | array | Provides a list of VPC security groups that the DB cluster belongs to. |
region | string | AWS region. |
Methods
| Name | Accessible by | Required Params |
|---|---|---|
list_resources | SELECT | region |
SELECT examples
Lists all db_clusters in a region.
SELECT
region,
db_cluster_identifier
FROM aws.neptune.db_clusters_list_only
WHERE region = 'us-east-1';
Permissions
For permissions required to operate on the db_clusters_list_only resource, see db_clusters