/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::RDS::DescribeDBClusterEndpoints

NAME

Paws::RDS::DescribeDBClusterEndpoints - Arguments for method DescribeDBClusterEndpoints on Paws::RDS

DESCRIPTION

This class represents the parameters used for calling the method DescribeDBClusterEndpoints on the Amazon Relational Database Service service. Use the attributes of this class as arguments to method DescribeDBClusterEndpoints.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeDBClusterEndpoints.

SYNOPSIS

my $rds = Paws->service('RDS');
my $DBClusterEndpointMessage = $rds->DescribeDBClusterEndpoints(
  DBClusterEndpointIdentifier => 'MyString',    # OPTIONAL
  DBClusterIdentifier         => 'MyString',    # OPTIONAL
  Filters                     => [
    {
      Name   => 'MyString',
      Values => [ 'MyString', ... ],

    },
    ...
  ],                                            # OPTIONAL
  Marker     => 'MyString',                     # OPTIONAL
  MaxRecords => 1,                              # OPTIONAL
);

# Results:
my $DBClusterEndpoints = $DBClusterEndpointMessage->DBClusterEndpoints;
my $Marker             = $DBClusterEndpointMessage->Marker;

# Returns a L<Paws::RDS::DBClusterEndpointMessage> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/rds/DescribeDBClusterEndpoints

ATTRIBUTES

DBClusterEndpointIdentifier => Str

The identifier of the endpoint to describe. This parameter is stored as a lowercase string.

DBClusterIdentifier => Str

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

Filters => ArrayRef[Paws::RDS::Filter]

A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, inactive, modifying.

Marker => Str

An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

MaxRecords => Int

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

SEE ALSO

This class forms part of Paws, documenting arguments for method DescribeDBClusterEndpoints in Paws::RDS

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