Class: Aws::Neptune::Types::CreateDBClusterEndpointOutput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-neptune/types.rb

Overview

This data type represents the information you need to connect to an Amazon Neptune 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 Neptune DB instance endpoints, see ‘Endpoint`.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#custom_endpoint_type ⇒ String

The type associated with a custom endpoint. One of: ‘READER`, `WRITER`, `ANY`.

Returns:

  • (String) 


652
653
654
655
656
657
658
659
660
661
662
663
664
665
 
# File 'lib/aws-sdk-neptune/types.rb', line 652

class CreateDBClusterEndpointOutput < 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.

Returns:

  • (String) 


652
653
654
655
656
657
658
659
660
661
662
663
664
665
 
# File 'lib/aws-sdk-neptune/types.rb', line 652

class CreateDBClusterEndpointOutput < 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.

Returns:

  • (String) 


652
653
654
655
656
657
658
659
660
661
662
663
664
665
 
# File 'lib/aws-sdk-neptune/types.rb', line 652

class CreateDBClusterEndpointOutput < 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.

Returns:

  • (String) 


652
653
654
655
656
657
658
659
660
661
662
663
664
665
 
# File 'lib/aws-sdk-neptune/types.rb', line 652

class CreateDBClusterEndpointOutput < 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.

Returns:

  • (String) 


652
653
654
655
656
657
658
659
660
661
662
663
664
665
 
# File 'lib/aws-sdk-neptune/types.rb', line 652

class CreateDBClusterEndpointOutput < 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.

Returns:

  • (String) 


652
653
654
655
656
657
658
659
660
661
662
663
664
665
 
# File 'lib/aws-sdk-neptune/types.rb', line 652

class CreateDBClusterEndpointOutput < 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`.

Returns:

  • (String) 


652
653
654
655
656
657
658
659
660
661
662
663
664
665
 
# File 'lib/aws-sdk-neptune/types.rb', line 652

class CreateDBClusterEndpointOutput < 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.

Returns:

  • (Array<String>) 


652
653
654
655
656
657
658
659
660
661
662
663
664
665
 
# File 'lib/aws-sdk-neptune/types.rb', line 652

class CreateDBClusterEndpointOutput < 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.

Returns:

  • (Array<String>) 


652
653
654
655
656
657
658
659
660
661
662
663
664
665
 
# File 'lib/aws-sdk-neptune/types.rb', line 652

class CreateDBClusterEndpointOutput < 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 cannot be used for a certain kind of cluster, such as a `writer` endpoint for a read-only secondary cluster in a global database.

Returns:

  • (String) 


652
653
654
655
656
657
658
659
660
661
662
663
664
665
 
# File 'lib/aws-sdk-neptune/types.rb', line 652

class CreateDBClusterEndpointOutput < 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