AWSRDSDatabaseCluster
No description
type AWSRDSDatabaseCluster {
metadata: ResourceMetadata!
activityStreamKinesisStreamName: String!
activityStreamKmsKeyId: String!
activityStreamMode: AWSRDSDatabaseClusterActivityStreamModeType!
activityStreamStatus: AWSRDSDatabaseClusterActivityStreamStatusType!
allocatedStorage: Int!
associatedRoles: [AWSRDSDatabaseClusterRole!]!
autoMinorVersionUpgrade: Boolean!
automaticRestartedAt: DateTime
availabilityZones: [String!]!
backtrackConsumedChangeRecords: Int64!
backtrackWindow: Int64!
backupRetentionPeriod: Int!
capacity: Int!
characterSetName: String!
cloneGroupId: String!
createdAt: DateTime
copyTagsToSnapshot: Boolean!
crossAccountClone: Boolean!
customEndpoints: [String!]!
arn: String!
id: String!
instanceClass: String!
members: [AWSRDSDatabaseClusterMember!]!
optionGroupMemberships: [DBClusterOptionGroupStatus!]!
parameterGroup: String!
subnetGroup: String!
systemId: String!
databaseName: String!
resourceId: String!
deletionProtection: Boolean!
domainMemberships: [AWSRDSDatabaseClusterDomainMembership!]!
earliestBacktrackAt: DateTime
earliestRestorableTime: DateTime
enabledCloudwatchLogsExports: [String!]!
endpoint: String!
engine: AWSRDSDatabaseEngineType!
engineMode: String!
engineVersion: String!
globalWriteForwardingRequested: Boolean!
globalWriteForwardingStatus: AWSRDSDatabaseClusterWriteForwardingStatusType!
hostedZoneId: String!
httpEndpointEnabled: Boolean!
iamDatabaseAuthenticationEnabled: Boolean!
ioOptimizedNextAllowedModification: DateTime
iops: Int!
kmsKeyId: String!
latestRestorableTime: DateTime
masterUserSecret: AWSRDSDatabaseClusterMasterUserSecret
masterUsername: String!
monitoringInterval: Int!
monitoringRoleArn: String!
multiAz: Boolean!
networkType: String!
pendingModifiedValues: AWSRDSDatabaseClusterPendingModifiedValues
percentProgress: String!
performanceInsightsEnabled: Boolean!
performanceInsightsKmsKeyId: String!
performanceInsightsRetentionPeriod: Int!
port: Int!
preferredBackupWindow: String!
preferredMaintenanceWindow: String!
publiclyAccessible: Boolean!
readReplicaIdentifiers: [String!]!
readerEndpoint: String!
replicationSourceIdentifier: String!
scalingConfiguration: AWSRDSDatabaseClusterScalingConfiguration
serverlessScalingConfiguration: AWSRDSDatabaseClusterServerlessScalingConfiguration
status: String!
storageEncrypted: Boolean!
storageType: String!
tags: [AWSTag!]!
vpcSecurityGroups: [AWSRDSDatabaseClusterVpcSecurityGroupMembership!]!
snapshots: [AWSRDSDatabaseClusterSnapshot!]!
}
Fields
AWSRDSDatabaseCluster.metadata ● ResourceMetadata! non-null object
The metadata to identify this resource in Shisho Cloud
AWSRDSDatabaseCluster.activityStreamKinesisStreamName ● String! non-null scalar
The name of the Amazon Kinesis data stream used for the database activity stream
AWSRDSDatabaseCluster.activityStreamKmsKeyId ● String! non-null scalar
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream
AWSRDSDatabaseCluster.activityStreamMode ● AWSRDSDatabaseClusterActivityStreamModeType! non-null enum
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
AWSRDSDatabaseCluster.activityStreamStatus ● AWSRDSDatabaseClusterActivityStreamStatusType! non-null enum
The status of the database activity stream.
AWSRDSDatabaseCluster.allocatedStorage ● Int! non-null scalar
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
AWSRDSDatabaseCluster.associatedRoles ● [AWSRDSDatabaseClusterRole!]! non-null object
A list of the Amazon Web Services 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 Amazon Web Services on your behalf.
AWSRDSDatabaseCluster.autoMinorVersionUpgrade ● Boolean! non-null scalar
Indicates whether minor version patches are applied automatically. This setting is only for non-Aurora Multi-AZ DB clusters.
AWSRDSDatabaseCluster.automaticRestartedAt ● DateTime scalar
The time when a stopped DB cluster is restarted automatically.
AWSRDSDatabaseCluster.availabilityZones ● [String!]! non-null scalar
The list of Availability Zones (AZs) where instances in the DB cluster can be created
AWSRDSDatabaseCluster.backtrackConsumedChangeRecords ● Int64! non-null scalar
The number of change records stored for Backtrack.
AWSRDSDatabaseCluster.backtrackWindow ● Int64! non-null scalar
The target backtrack window, in seconds
AWSRDSDatabaseCluster.backupRetentionPeriod ● Int! non-null scalar
The number of days for which automatic DB snapshots are retained
AWSRDSDatabaseCluster.capacity ● Int! non-null scalar
The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused. For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
AWSRDSDatabaseCluster.characterSetName ● String! non-null scalar
If present, specifies the name of the character set that this cluster is associated with.
AWSRDSDatabaseCluster.cloneGroupId ● String! non-null scalar
The ID of the clone group with which the DB cluster is associated.
AWSRDSDatabaseCluster.createdAt ● DateTime scalar
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
AWSRDSDatabaseCluster.copyTagsToSnapshot ● Boolean! non-null scalar
Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
AWSRDSDatabaseCluster.crossAccountClone ● Boolean! non-null scalar
Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
AWSRDSDatabaseCluster.customEndpoints ● [String!]! non-null scalar
The custom endpoints associated with the DB cluster.
AWSRDSDatabaseCluster.arn ● String! non-null scalar
The Amazon Resource Name (ARN) for the DB cluster.
AWSRDSDatabaseCluster.id ● String! non-null scalar
The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.
AWSRDSDatabaseCluster.instanceClass ● String! non-null scalar
The name of the compute and memory capacity class of the DB instance. This setting is only for non-Aurora Multi-AZ DB clusters.
AWSRDSDatabaseCluster.members ● [AWSRDSDatabaseClusterMember!]! non-null object
The list of DB instances that make up the DB cluster
AWSRDSDatabaseCluster.optionGroupMemberships ● [DBClusterOptionGroupStatus!]! non-null object
The list of option group memberships for this DB cluster.
AWSRDSDatabaseCluster.parameterGroup ● String! non-null scalar
The name of the DB cluster parameter group for the DB cluster.
AWSRDSDatabaseCluster.subnetGroup ● String! non-null scalar
Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
AWSRDSDatabaseCluster.systemId ● String! non-null scalar
Reserved for future use.
AWSRDSDatabaseCluster.databaseName ● String! non-null scalar
The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.
AWSRDSDatabaseCluster.resourceId ● String! non-null scalar
The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
AWSRDSDatabaseCluster.deletionProtection ● Boolean! non-null scalar
Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
AWSRDSDatabaseCluster.domainMemberships ● [AWSRDSDatabaseClusterDomainMembership!]! non-null object
The Active Directory Domain membership records associated with the DB cluster.
AWSRDSDatabaseCluster.earliestBacktrackAt ● DateTime scalar
The earliest time to which a DB cluster can be backtracked
AWSRDSDatabaseCluster.earliestRestorableTime ● DateTime scalar
The earliest time to which a database can be restored with point-in-time restore.
AWSRDSDatabaseCluster.enabledCloudwatchLogsExports ● [String!]! non-null scalar
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
AWSRDSDatabaseCluster.endpoint ● String! non-null scalar
The connection endpoint for the primary instance of the DB cluster
AWSRDSDatabaseCluster.engine ● AWSRDSDatabaseEngineType! non-null enum
The database engine used by the DB cluster.
AWSRDSDatabaseCluster.engineMode ● String! non-null scalar
The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
AWSRDSDatabaseCluster.engineVersion ● String! non-null scalar
The DB engine version of the DB cluster.
AWSRDSDatabaseCluster.globalWriteForwardingRequested ● Boolean! non-null scalar
specifies whether write forwarding is enabled for a secondary cluster in an Aurora global database
AWSRDSDatabaseCluster.globalWriteForwardingStatus ● AWSRDSDatabaseClusterWriteForwardingStatusType! non-null enum
The status of write forwarding for a secondary cluster in an Aurora global database
AWSRDSDatabaseCluster.hostedZoneId ● String! non-null scalar
THe ID that Amazon Route 53 assigns when you create a hosted zone.
AWSRDSDatabaseCluster.httpEndpointEnabled ● Boolean! non-null scalar
Indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled. When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor. For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide.
AWSRDSDatabaseCluster.iamDatabaseAuthenticationEnabled ● Boolean! non-null scalar
Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
AWSRDSDatabaseCluster.ioOptimizedNextAllowedModification ● DateTime scalar
The next time you can modify the DB cluster to use the aurora-iopt1 storage type. This setting is only for Aurora DB clusters.
AWSRDSDatabaseCluster.iops ● Int! non-null scalar
The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters
AWSRDSDatabaseCluster.kmsKeyId ● String! non-null scalar
If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster
AWSRDSDatabaseCluster.latestRestorableTime ● DateTime scalar
The latest time to which a database can be restored with point-in-time restore
AWSRDSDatabaseCluster.masterUserSecret ● AWSRDSDatabaseClusterMasterUserSecret object
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password
AWSRDSDatabaseCluster.masterUsername ● String! non-null scalar
The master username for the DB cluster
AWSRDSDatabaseCluster.monitoringInterval ● Int! non-null scalar
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. This setting is only for non-Aurora Multi-AZ DB clusters.
AWSRDSDatabaseCluster.monitoringRoleArn ● String! non-null scalar
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.
AWSRDSDatabaseCluster.multiAz ● Boolean! non-null scalar
Indicates whether the DB cluster has instances in multiple Availability Zones
AWSRDSDatabaseCluster.networkType ● String! non-null scalar
The network type of the DB instance
AWSRDSDatabaseCluster.pendingModifiedValues ● AWSRDSDatabaseClusterPendingModifiedValues object
Information about pending changes to the DB cluster
AWSRDSDatabaseCluster.percentProgress ● String! non-null scalar
The progress of the operation as a percentage
AWSRDSDatabaseCluster.performanceInsightsEnabled ● Boolean! non-null scalar
Indicates whether Performance Insights is enabled for the DB cluster
AWSRDSDatabaseCluster.performanceInsightsKmsKeyId ● String! non-null scalar
The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. This setting is only for non-Aurora Multi-AZ DB clusters.
AWSRDSDatabaseCluster.performanceInsightsRetentionPeriod ● Int! non-null scalar
The number of days to retain Performance Insights data. This setting is only for non-Aurora Multi-AZ DB clusters. You can specify 7,
month31 (wheremonthis a number of months from 1-23), or 731. Examples: 93 (3 months 31), 341 (11 months 31), 589 (19 months 31) The default: 7 days
AWSRDSDatabaseCluster.port ● Int! non-null scalar
The port that the database engine is listening on
AWSRDSDatabaseCluster.preferredBackupWindow ● String! non-null scalar
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
AWSRDSDatabaseCluster.preferredMaintenanceWindow ● String! non-null scalar
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
AWSRDSDatabaseCluster.publiclyAccessible ● Boolean! non-null scalar
Indicates whether the DB cluster is publicly accessible
AWSRDSDatabaseCluster.readReplicaIdentifiers ● [String!]! non-null scalar
Contains one or more identifiers of the read replicas associated with this DB cluster
AWSRDSDatabaseCluster.readerEndpoint ● String! non-null scalar
The reader endpoint for the DB cluster
AWSRDSDatabaseCluster.replicationSourceIdentifier ● String! non-null scalar
The identifier of the source DB cluster if this DB cluster is a read replica
AWSRDSDatabaseCluster.scalingConfiguration ● AWSRDSDatabaseClusterScalingConfiguration object
The scaling configuration for an Aurora DB cluster in serverless DB engine mode. For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
AWSRDSDatabaseCluster.serverlessScalingConfiguration ● AWSRDSDatabaseClusterServerlessScalingConfiguration object
The scaling configuration for an Aurora Serverless v2 DB cluster
AWSRDSDatabaseCluster.status ● String! non-null scalar
The current status of this DB cluster
AWSRDSDatabaseCluster.storageEncrypted ● Boolean! non-null scalar
Indicates whether the DB cluster is encrypted
AWSRDSDatabaseCluster.storageType ● String! non-null scalar
The storage type for the DB cluster
AWSRDSDatabaseCluster.tags ● [AWSTag!]! non-null object
A list of tags
AWSRDSDatabaseCluster.vpcSecurityGroups ● [AWSRDSDatabaseClusterVpcSecurityGroupMembership!]! non-null object
A list of VPC security groups that the DB cluster belongs to
AWSRDSDatabaseCluster.snapshots ● [AWSRDSDatabaseClusterSnapshot!]! non-null object
A list of snapshots associated with the DB cluster
Member of
AWSRDS object