« blib/lib/Paws/RDS/CreateDBCluster.pm
↑ Summary
blib/lib/Paws/RDS/CreateDBClusterParameterGroup.pm »
| 1 | |||
| 2 | package Paws::RDS::CreateDBClusterEndpoint; | ||
| 3 | use Moose; | ||
| 4 | has DBClusterEndpointIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has DBClusterIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has EndpointType => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has ExcludedMembers => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 8 | has StaticMembers => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 9 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Tag]'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDBClusterEndpoint'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::DBClusterEndpoint'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'CreateDBClusterEndpointResult'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::RDS::CreateDBClusterEndpoint - Arguments for method CreateDBClusterEndpoint on L<Paws::RDS> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method CreateDBClusterEndpoint on the | ||
| 27 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 28 | as arguments to method CreateDBClusterEndpoint. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDBClusterEndpoint. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $rds = Paws->service('RDS'); | ||
| 35 | my $DBClusterEndpoint = $rds->CreateDBClusterEndpoint( | ||
| 36 | DBClusterEndpointIdentifier => 'MyString', | ||
| 37 | DBClusterIdentifier => 'MyString', | ||
| 38 | EndpointType => 'MyString', | ||
| 39 | ExcludedMembers => [ 'MyString', ... ], # OPTIONAL | ||
| 40 | StaticMembers => [ 'MyString', ... ], # OPTIONAL | ||
| 41 | Tags => [ | ||
| 42 | { | ||
| 43 | Key => 'MyString', | ||
| 44 | Value => 'MyString', | ||
| 45 | }, | ||
| 46 | ... | ||
| 47 | ], # OPTIONAL | ||
| 48 | ); | ||
| 49 | |||
| 50 | # Results: | ||
| 51 | my $CustomEndpointType = $DBClusterEndpoint->CustomEndpointType; | ||
| 52 | my $DBClusterEndpointArn = $DBClusterEndpoint->DBClusterEndpointArn; | ||
| 53 | my $DBClusterEndpointIdentifier = | ||
| 54 | $DBClusterEndpoint->DBClusterEndpointIdentifier; | ||
| 55 | my $DBClusterEndpointResourceIdentifier = | ||
| 56 | $DBClusterEndpoint->DBClusterEndpointResourceIdentifier; | ||
| 57 | my $DBClusterIdentifier = $DBClusterEndpoint->DBClusterIdentifier; | ||
| 58 | my $Endpoint = $DBClusterEndpoint->Endpoint; | ||
| 59 | my $EndpointType = $DBClusterEndpoint->EndpointType; | ||
| 60 | my $ExcludedMembers = $DBClusterEndpoint->ExcludedMembers; | ||
| 61 | my $StaticMembers = $DBClusterEndpoint->StaticMembers; | ||
| 62 | my $Status = $DBClusterEndpoint->Status; | ||
| 63 | |||
| 64 | # Returns a L<Paws::RDS::DBClusterEndpoint> object. | ||
| 65 | |||
| 66 | 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. | ||
| 67 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/CreateDBClusterEndpoint> | ||
| 68 | |||
| 69 | =head1 ATTRIBUTES | ||
| 70 | |||
| 71 | |||
| 72 | =head2 B<REQUIRED> DBClusterEndpointIdentifier => Str | ||
| 73 | |||
| 74 | The identifier to use for the new endpoint. This parameter is stored as | ||
| 75 | a lowercase string. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 B<REQUIRED> DBClusterIdentifier => Str | ||
| 80 | |||
| 81 | The DB cluster identifier of the DB cluster associated with the | ||
| 82 | endpoint. This parameter is stored as a lowercase string. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 B<REQUIRED> EndpointType => Str | ||
| 87 | |||
| 88 | The type of the endpoint. One of: C<READER>, C<WRITER>, C<ANY>. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 ExcludedMembers => ArrayRef[Str|Undef] | ||
| 93 | |||
| 94 | List of DB instance identifiers that aren't part of the custom endpoint | ||
| 95 | group. All other eligible instances are reachable through the custom | ||
| 96 | endpoint. Only relevant if the list of static members is empty. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 StaticMembers => ArrayRef[Str|Undef] | ||
| 101 | |||
| 102 | List of DB instance identifiers that are part of the custom endpoint | ||
| 103 | group. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 Tags => ArrayRef[L<Paws::RDS::Tag>] | ||
| 108 | |||
| 109 | The tags to be assigned to the Amazon RDS resource. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head1 SEE ALSO | ||
| 115 | |||
| 116 | This class forms part of L<Paws>, documenting arguments for method CreateDBClusterEndpoint in L<Paws::RDS> | ||
| 117 | |||
| 118 | =head1 BUGS and CONTRIBUTIONS | ||
| 119 | |||
| 120 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 121 | |||
| 122 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 123 | |||
| 124 | =cut | ||
| 125 |