Class: Aws::RDS::Types::DBClusterEndpoint
- Inherits:
-
Struct
- Object
- Struct
- Aws::RDS::Types::DBClusterEndpoint
- Defined in:
- gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb
Overview
This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:
CreateDBClusterEndpoint
DescribeDBClusterEndpoints
ModifyDBClusterEndpoint
DeleteDBClusterEndpoint
For the data structure that represents Amazon RDS DB instance
endpoints, see Endpoint
.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#custom_endpoint_type ⇒ String
The type associated with a custom endpoint.
-
#db_cluster_endpoint_arn ⇒ String
The Amazon Resource Name (ARN) for the endpoint.
-
#db_cluster_endpoint_identifier ⇒ String
The identifier associated with the endpoint.
-
#db_cluster_endpoint_resource_identifier ⇒ String
A unique system-generated identifier for an endpoint.
-
#db_cluster_identifier ⇒ String
The DB cluster identifier of the DB cluster associated with the endpoint.
-
#endpoint ⇒ String
The DNS address of the endpoint.
-
#endpoint_type ⇒ String
The type of the endpoint.
-
#excluded_members ⇒ Array<String>
List of DB instance identifiers that aren't part of the custom endpoint group.
-
#static_members ⇒ Array<String>
List of DB instance identifiers that are part of the custom endpoint group.
-
#status ⇒ String
The current status of the endpoint.
Instance Attribute Details
#custom_endpoint_type ⇒ String
The type associated with a custom endpoint. One of: READER
,
WRITER
, ANY
.
7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7460 class DBClusterEndpoint < Struct.new( :db_cluster_endpoint_identifier, :db_cluster_identifier, :db_cluster_endpoint_resource_identifier, :endpoint, :status, :endpoint_type, :custom_endpoint_type, :static_members, :excluded_members, :db_cluster_endpoint_arn) SENSITIVE = [] include Aws::Structure end |
#db_cluster_endpoint_arn ⇒ String
The Amazon Resource Name (ARN) for the endpoint.
7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7460 class DBClusterEndpoint < Struct.new( :db_cluster_endpoint_identifier, :db_cluster_identifier, :db_cluster_endpoint_resource_identifier, :endpoint, :status, :endpoint_type, :custom_endpoint_type, :static_members, :excluded_members, :db_cluster_endpoint_arn) SENSITIVE = [] include Aws::Structure end |
#db_cluster_endpoint_identifier ⇒ String
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7460 class DBClusterEndpoint < Struct.new( :db_cluster_endpoint_identifier, :db_cluster_identifier, :db_cluster_endpoint_resource_identifier, :endpoint, :status, :endpoint_type, :custom_endpoint_type, :static_members, :excluded_members, :db_cluster_endpoint_arn) SENSITIVE = [] include Aws::Structure end |
#db_cluster_endpoint_resource_identifier ⇒ String
A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7460 class DBClusterEndpoint < Struct.new( :db_cluster_endpoint_identifier, :db_cluster_identifier, :db_cluster_endpoint_resource_identifier, :endpoint, :status, :endpoint_type, :custom_endpoint_type, :static_members, :excluded_members, :db_cluster_endpoint_arn) SENSITIVE = [] include Aws::Structure end |
#db_cluster_identifier ⇒ String
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7460 class DBClusterEndpoint < Struct.new( :db_cluster_endpoint_identifier, :db_cluster_identifier, :db_cluster_endpoint_resource_identifier, :endpoint, :status, :endpoint_type, :custom_endpoint_type, :static_members, :excluded_members, :db_cluster_endpoint_arn) SENSITIVE = [] include Aws::Structure end |
#endpoint ⇒ String
The DNS address of the endpoint.
7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7460 class DBClusterEndpoint < Struct.new( :db_cluster_endpoint_identifier, :db_cluster_identifier, :db_cluster_endpoint_resource_identifier, :endpoint, :status, :endpoint_type, :custom_endpoint_type, :static_members, :excluded_members, :db_cluster_endpoint_arn) SENSITIVE = [] include Aws::Structure end |
#endpoint_type ⇒ String
The type of the endpoint. One of: READER
, WRITER
, CUSTOM
.
7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7460 class DBClusterEndpoint < Struct.new( :db_cluster_endpoint_identifier, :db_cluster_identifier, :db_cluster_endpoint_resource_identifier, :endpoint, :status, :endpoint_type, :custom_endpoint_type, :static_members, :excluded_members, :db_cluster_endpoint_arn) SENSITIVE = [] include Aws::Structure end |
#excluded_members ⇒ Array<String>
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7460 class DBClusterEndpoint < Struct.new( :db_cluster_endpoint_identifier, :db_cluster_identifier, :db_cluster_endpoint_resource_identifier, :endpoint, :status, :endpoint_type, :custom_endpoint_type, :static_members, :excluded_members, :db_cluster_endpoint_arn) SENSITIVE = [] include Aws::Structure end |
#static_members ⇒ Array<String>
List of DB instance identifiers that are part of the custom endpoint group.
7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7460 class DBClusterEndpoint < Struct.new( :db_cluster_endpoint_identifier, :db_cluster_identifier, :db_cluster_endpoint_resource_identifier, :endpoint, :status, :endpoint_type, :custom_endpoint_type, :static_members, :excluded_members, :db_cluster_endpoint_arn) SENSITIVE = [] include Aws::Structure end |
#status ⇒ String
The current status of the endpoint. One of: creating
, available
,
deleting
, inactive
, modifying
. The inactive
state applies to
an endpoint that can't be used for a certain kind of cluster, such
as a writer
endpoint for a read-only secondary cluster in a global
database.
7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7460 class DBClusterEndpoint < Struct.new( :db_cluster_endpoint_identifier, :db_cluster_identifier, :db_cluster_endpoint_resource_identifier, :endpoint, :status, :endpoint_type, :custom_endpoint_type, :static_members, :excluded_members, :db_cluster_endpoint_arn) SENSITIVE = [] include Aws::Structure end |