« blib/lib/Paws/DocDB/CloudwatchLogsExportConfiguration.pm
↑ Summary
blib/lib/Paws/DocDB/CopyDBClusterParameterGroupResult.pm »
| 1 | |||
| 2 | package Paws::DocDB::CopyDBClusterParameterGroup; | ||
| 3 | use Moose; | ||
| 4 | has SourceDBClusterParameterGroupIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::DocDB::Tag]'); | ||
| 6 | has TargetDBClusterParameterGroupDescription => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has TargetDBClusterParameterGroupIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CopyDBClusterParameterGroup'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DocDB::CopyDBClusterParameterGroupResult'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'CopyDBClusterParameterGroupResult'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::DocDB::CopyDBClusterParameterGroup - Arguments for method CopyDBClusterParameterGroup on L<Paws::DocDB> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method CopyDBClusterParameterGroup on the | ||
| 25 | L<Amazon DocumentDB with MongoDB compatibility|Paws::DocDB> service. Use the attributes of this class | ||
| 26 | as arguments to method CopyDBClusterParameterGroup. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CopyDBClusterParameterGroup. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $rds = Paws->service('DocDB'); | ||
| 33 | my $CopyDBClusterParameterGroupResult = $rds->CopyDBClusterParameterGroup( | ||
| 34 | SourceDBClusterParameterGroupIdentifier => 'MyString', | ||
| 35 | TargetDBClusterParameterGroupDescription => 'MyString', | ||
| 36 | TargetDBClusterParameterGroupIdentifier => 'MyString', | ||
| 37 | Tags => [ | ||
| 38 | { | ||
| 39 | Key => 'MyString', | ||
| 40 | Value => 'MyString', | ||
| 41 | }, | ||
| 42 | ... | ||
| 43 | ], # OPTIONAL | ||
| 44 | ); | ||
| 45 | |||
| 46 | # Results: | ||
| 47 | my $DBClusterParameterGroup = | ||
| 48 | $CopyDBClusterParameterGroupResult->DBClusterParameterGroup; | ||
| 49 | |||
| 50 | # Returns a L<Paws::DocDB::CopyDBClusterParameterGroupResult> object. | ||
| 51 | |||
| 52 | 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. | ||
| 53 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/CopyDBClusterParameterGroup> | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 B<REQUIRED> SourceDBClusterParameterGroupIdentifier => Str | ||
| 59 | |||
| 60 | The identifier or Amazon Resource Name (ARN) for the source cluster | ||
| 61 | parameter group. | ||
| 62 | |||
| 63 | Constraints: | ||
| 64 | |||
| 65 | =over | ||
| 66 | |||
| 67 | =item * | ||
| 68 | |||
| 69 | Must specify a valid cluster parameter group. | ||
| 70 | |||
| 71 | =item * | ||
| 72 | |||
| 73 | If the source cluster parameter group is in the same Region as the | ||
| 74 | copy, specify a valid parameter group identifier; for example, | ||
| 75 | C<my-db-cluster-param-group>, or a valid ARN. | ||
| 76 | |||
| 77 | =item * | ||
| 78 | |||
| 79 | If the source parameter group is in a different Region than the copy, | ||
| 80 | specify a valid cluster parameter group ARN; for example, | ||
| 81 | C<arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group>. | ||
| 82 | |||
| 83 | =back | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 Tags => ArrayRef[L<Paws::DocDB::Tag>] | ||
| 89 | |||
| 90 | The tags that are to be assigned to the parameter group. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 B<REQUIRED> TargetDBClusterParameterGroupDescription => Str | ||
| 95 | |||
| 96 | A description for the copied cluster parameter group. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 B<REQUIRED> TargetDBClusterParameterGroupIdentifier => Str | ||
| 101 | |||
| 102 | The identifier for the copied cluster parameter group. | ||
| 103 | |||
| 104 | Constraints: | ||
| 105 | |||
| 106 | =over | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | Cannot be null, empty, or blank. | ||
| 111 | |||
| 112 | =item * | ||
| 113 | |||
| 114 | Must contain from 1 to 255 letters, numbers, or hyphens. | ||
| 115 | |||
| 116 | =item * | ||
| 117 | |||
| 118 | The first character must be a letter. | ||
| 119 | |||
| 120 | =item * | ||
| 121 | |||
| 122 | Cannot end with a hyphen or contain two consecutive hyphens. | ||
| 123 | |||
| 124 | =back | ||
| 125 | |||
| 126 | Example: C<my-cluster-param-group1> | ||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head1 SEE ALSO | ||
| 132 | |||
| 133 | This class forms part of L<Paws>, documenting arguments for method CopyDBClusterParameterGroup in L<Paws::DocDB> | ||
| 134 | |||
| 135 | =head1 BUGS and CONTRIBUTIONS | ||
| 136 | |||
| 137 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 138 | |||
| 139 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 140 | |||
| 141 | =cut | ||
| 142 |