The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Paws::Neptune::DBClusterEndpoint

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::Neptune::DBClusterEndpoint object:

  $service_obj->Method(Att1 => { CustomEndpointType => $value, ..., Status => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::Neptune::DBClusterEndpoint object:

  $result = $service_obj->Method(...);
  $result->Att1->CustomEndpointType

DESCRIPTION

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.

ATTRIBUTES

CustomEndpointType => Str

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

DBClusterEndpointArn => Str

The Amazon Resource Name (ARN) for the endpoint.

DBClusterEndpointIdentifier => Str

The identifier associated with the endpoint. This parameter is stored as a lowercase string.

DBClusterEndpointResourceIdentifier => Str

A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

DBClusterIdentifier => Str

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

Endpoint => Str

The DNS address of the endpoint.

EndpointType => Str

The type of the endpoint. One of: READER, WRITER, CUSTOM.

ExcludedMembers => ArrayRef[Str|Undef]

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.

StaticMembers => ArrayRef[Str|Undef]

List of DB instance identifiers that are part of the custom endpoint group.

Status => Str

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.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::Neptune

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues