class Aws::SecurityHub::Types::AwsRdsDbClusterDetails
Information about an Amazon RDS DB cluster.
@note When making an API call, you may pass AwsRdsDbClusterDetails
data as a hash: { allocated_storage: 1, availability_zones: ["NonEmptyString"], backup_retention_period: 1, database_name: "NonEmptyString", status: "NonEmptyString", endpoint: "NonEmptyString", reader_endpoint: "NonEmptyString", custom_endpoints: ["NonEmptyString"], multi_az: false, engine: "NonEmptyString", engine_version: "NonEmptyString", port: 1, master_username: "NonEmptyString", preferred_backup_window: "NonEmptyString", preferred_maintenance_window: "NonEmptyString", read_replica_identifiers: ["NonEmptyString"], vpc_security_groups: [ { vpc_security_group_id: "NonEmptyString", status: "NonEmptyString", }, ], hosted_zone_id: "NonEmptyString", storage_encrypted: false, kms_key_id: "NonEmptyString", db_cluster_resource_id: "NonEmptyString", associated_roles: [ { role_arn: "NonEmptyString", status: "NonEmptyString", }, ], cluster_create_time: "NonEmptyString", enabled_cloud_watch_logs_exports: ["NonEmptyString"], engine_mode: "NonEmptyString", deletion_protection: false, http_endpoint_enabled: false, activity_stream_status: "NonEmptyString", copy_tags_to_snapshot: false, cross_account_clone: false, domain_memberships: [ { domain: "NonEmptyString", status: "NonEmptyString", fqdn: "NonEmptyString", iam_role_name: "NonEmptyString", }, ], db_cluster_parameter_group: "NonEmptyString", db_subnet_group: "NonEmptyString", db_cluster_option_group_memberships: [ { db_cluster_option_group_name: "NonEmptyString", status: "NonEmptyString", }, ], db_cluster_identifier: "NonEmptyString", db_cluster_members: [ { is_cluster_writer: false, promotion_tier: 1, db_instance_identifier: "NonEmptyString", db_cluster_parameter_group_status: "NonEmptyString", }, ], iam_database_authentication_enabled: false, }
@!attribute [rw] allocated_storage
For all database engines except Aurora, specifies the allocated storage size in gibibytes (GiB). @return [Integer]
@!attribute [rw] availability_zones
A list of Availability Zones (AZs) where instances in the DB cluster can be created. @return [Array<String>]
@!attribute [rw] backup_retention_period
The number of days for which automated backups are retained. @return [Integer]
@!attribute [rw] database_name
The name of the database. @return [String]
@!attribute [rw] status
The current status of this DB cluster. @return [String]
@!attribute [rw] endpoint
The connection endpoint for the primary instance of the DB cluster. @return [String]
@!attribute [rw] reader_endpoint
The reader endpoint for the DB cluster. @return [String]
@!attribute [rw] custom_endpoints
A list of custom endpoints for the DB cluster. @return [Array<String>]
@!attribute [rw] multi_az
Whether the DB cluster has instances in multiple Availability Zones. @return [Boolean]
@!attribute [rw] engine
The name of the database engine to use for this DB cluster. @return [String]
@!attribute [rw] engine_version
The version number of the database engine to use. @return [String]
@!attribute [rw] port
The port number on which the DB instances in the DB cluster accept connections. @return [Integer]
@!attribute [rw] master_username
The name of the master user for the DB cluster. @return [String]
@!attribute [rw] preferred_backup_window
The range of time each day when automated backups are created, if automated backups are enabled. Uses the format `HH:MM-HH:MM`. For example, `04:52-05:22`. @return [String]
@!attribute [rw] preferred_maintenance_window
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Uses the format `<day>:HH:MM-<day>:HH:MM`. For the day values, use `mon`\|`tue`\|`wed`\|`thu`\|`fri`\|`sat`\|`sun`. For example, `sun:09:32-sun:10:02`. @return [String]
@!attribute [rw] read_replica_identifiers
The identifiers of the read replicas that are associated with this DB cluster. @return [Array<String>]
@!attribute [rw] vpc_security_groups
A list of VPC security groups that the DB cluster belongs to. @return [Array<Types::AwsRdsDbInstanceVpcSecurityGroup>]
@!attribute [rw] hosted_zone_id
Specifies the identifier that Amazon Route 53 assigns when you create a hosted zone. @return [String]
@!attribute [rw] storage_encrypted
Whether the DB cluster is encrypted. @return [Boolean]
@!attribute [rw] kms_key_id
The ARN of the KMS master key that is used to encrypt the database instances in the DB cluster. @return [String]
@!attribute [rw] db_cluster_resource_id
The identifier of the DB cluster. The identifier must be unique within each Amazon Web Services Region and is immutable. @return [String]
@!attribute [rw] associated_roles
A list of the IAM roles that are associated with the DB cluster. @return [Array<Types::AwsRdsDbClusterAssociatedRole>]
@!attribute [rw] cluster_create_time
Indicates when the DB cluster was created, in Universal Coordinated Time (UTC). Uses the `date-time` format specified in [RFC 3339 section 5.6, Internet Date/Time Format][1]. The value cannot contain spaces. For example, `2020-03-22T13:22:13.933Z`. [1]: https://tools.ietf.org/html/rfc3339#section-5.6 @return [String]
@!attribute [rw] enabled_cloud_watch_logs_exports
A list of log types that this DB cluster is configured to export to CloudWatch Logs. @return [Array<String>]
@!attribute [rw] engine_mode
The database engine mode of the DB cluster. @return [String]
@!attribute [rw] deletion_protection
Whether the DB cluster has deletion protection enabled. @return [Boolean]
@!attribute [rw] http_endpoint_enabled
Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled. @return [Boolean]
@!attribute [rw] activity_stream_status
The status of the database activity stream. @return [String]
@!attribute [rw] copy_tags_to_snapshot
Whether tags are copied from the DB cluster to snapshots of the DB cluster. @return [Boolean]
@!attribute [rw] cross_account_clone
Whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account. @return [Boolean]
@!attribute [rw] domain_memberships
The Active Directory domain membership records that are associated with the DB cluster. @return [Array<Types::AwsRdsDbDomainMembership>]
@!attribute [rw] db_cluster_parameter_group
The name of the DB cluster parameter group for the DB cluster. @return [String]
@!attribute [rw] db_subnet_group
The subnet group that is associated with the DB cluster, including the name, description, and subnets in the subnet group. @return [String]
@!attribute [rw] db_cluster_option_group_memberships
The list of option group memberships for this DB cluster. @return [Array<Types::AwsRdsDbClusterOptionGroupMembership>]
@!attribute [rw] db_cluster_identifier
The DB cluster identifier that the user assigned to the cluster. This identifier is the unique key that identifies a DB cluster. @return [String]
@!attribute [rw] db_cluster_members
The list of instances that make up the DB cluster. @return [Array<Types::AwsRdsDbClusterMember>]
@!attribute [rw] iam_database_authentication_enabled
Whether the mapping of IAM accounts to database accounts is enabled. @return [Boolean]
@see docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/AwsRdsDbClusterDetails AWS API Documentation
Constants
- SENSITIVE