« blib/lib/Paws/Neptune/DeleteEventSubscriptionResult.pm
↑ Summary
blib/lib/Paws/Neptune/DescribeDBClusterParameterGroups.pm »
| 1 | |||
| 2 | package Paws::Neptune::DescribeDBClusterEndpoints; | ||
| 3 | use Moose; | ||
| 4 | has DBClusterEndpointIdentifier => (is => 'ro', isa => 'Str'); | ||
| 5 | has DBClusterIdentifier => (is => 'ro', isa => 'Str'); | ||
| 6 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::Neptune::Filter]'); | ||
| 7 | has Marker => (is => 'ro', isa => 'Str'); | ||
| 8 | has MaxRecords => (is => 'ro', isa => 'Int'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeDBClusterEndpoints'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Neptune::DBClusterEndpointMessage'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeDBClusterEndpointsResult'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Neptune::DescribeDBClusterEndpoints - Arguments for method DescribeDBClusterEndpoints on L<Paws::Neptune> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method DescribeDBClusterEndpoints on the | ||
| 26 | L<Amazon Neptune|Paws::Neptune> service. Use the attributes of this class | ||
| 27 | as arguments to method DescribeDBClusterEndpoints. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeDBClusterEndpoints. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $rds = Paws->service('Neptune'); | ||
| 34 | my $DBClusterEndpointMessage = $rds->DescribeDBClusterEndpoints( | ||
| 35 | DBClusterEndpointIdentifier => 'MyString', # OPTIONAL | ||
| 36 | DBClusterIdentifier => 'MyString', # OPTIONAL | ||
| 37 | Filters => [ | ||
| 38 | { | ||
| 39 | Name => 'MyString', | ||
| 40 | Values => [ 'MyString', ... ], | ||
| 41 | |||
| 42 | }, | ||
| 43 | ... | ||
| 44 | ], # OPTIONAL | ||
| 45 | Marker => 'MyString', # OPTIONAL | ||
| 46 | MaxRecords => 1, # OPTIONAL | ||
| 47 | ); | ||
| 48 | |||
| 49 | # Results: | ||
| 50 | my $DBClusterEndpoints = $DBClusterEndpointMessage->DBClusterEndpoints; | ||
| 51 | my $Marker = $DBClusterEndpointMessage->Marker; | ||
| 52 | |||
| 53 | # Returns a L<Paws::Neptune::DBClusterEndpointMessage> object. | ||
| 54 | |||
| 55 | 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. | ||
| 56 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/DescribeDBClusterEndpoints> | ||
| 57 | |||
| 58 | =head1 ATTRIBUTES | ||
| 59 | |||
| 60 | |||
| 61 | =head2 DBClusterEndpointIdentifier => Str | ||
| 62 | |||
| 63 | The identifier of the endpoint to describe. This parameter is stored as | ||
| 64 | a lowercase string. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 DBClusterIdentifier => Str | ||
| 69 | |||
| 70 | The DB cluster identifier of the DB cluster associated with the | ||
| 71 | endpoint. This parameter is stored as a lowercase string. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 Filters => ArrayRef[L<Paws::Neptune::Filter>] | ||
| 76 | |||
| 77 | A set of name-value pairs that define which endpoints to include in the | ||
| 78 | output. The filters are specified as name-value pairs, in the format | ||
| 79 | C<Name=I<endpoint_type>,Values=I<endpoint_type1>,I<endpoint_type2>,...>. | ||
| 80 | C<Name> can be one of: C<db-cluster-endpoint-type>, | ||
| 81 | C<db-cluster-endpoint-custom-type>, C<db-cluster-endpoint-id>, | ||
| 82 | C<db-cluster-endpoint-status>. C<Values> for the C< | ||
| 83 | db-cluster-endpoint-type> filter can be one or more of: C<reader>, | ||
| 84 | C<writer>, C<custom>. C<Values> for the | ||
| 85 | C<db-cluster-endpoint-custom-type> filter can be one or more of: | ||
| 86 | C<reader>, C<any>. C<Values> for the C<db-cluster-endpoint-status> | ||
| 87 | filter can be one or more of: C<available>, C<creating>, C<deleting>, | ||
| 88 | C<inactive>, C<modifying>. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 Marker => Str | ||
| 93 | |||
| 94 | An optional pagination token provided by a previous | ||
| 95 | C<DescribeDBClusterEndpoints> request. If this parameter is specified, | ||
| 96 | the response includes only records beyond the marker, up to the value | ||
| 97 | specified by C<MaxRecords>. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 MaxRecords => Int | ||
| 102 | |||
| 103 | The maximum number of records to include in the response. If more | ||
| 104 | records exist than the specified C<MaxRecords> value, a pagination | ||
| 105 | token called a marker is included in the response so you can retrieve | ||
| 106 | the remaining results. | ||
| 107 | |||
| 108 | Default: 100 | ||
| 109 | |||
| 110 | Constraints: Minimum 20, maximum 100. | ||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | =head1 SEE ALSO | ||
| 116 | |||
| 117 | This class forms part of L<Paws>, documenting arguments for method DescribeDBClusterEndpoints in L<Paws::Neptune> | ||
| 118 | |||
| 119 | =head1 BUGS and CONTRIBUTIONS | ||
| 120 | |||
| 121 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 122 | |||
| 123 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 124 | |||
| 125 | =cut | ||
| 126 |