« blib/lib/Paws/DocDB/ModifyEventSubscriptionResult.pm
↑ Summary
blib/lib/Paws/DocDB/ModifyGlobalClusterResult.pm »
| 1 | |||
| 2 | package Paws::DocDB::ModifyGlobalCluster; | ||
| 3 | use Moose; | ||
| 4 | has DeletionProtection => (is => 'ro', isa => 'Bool'); | ||
| 5 | has GlobalClusterIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has NewGlobalClusterIdentifier => (is => 'ro', isa => 'Str'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyGlobalCluster'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DocDB::ModifyGlobalClusterResult'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'ModifyGlobalClusterResult'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::DocDB::ModifyGlobalCluster - Arguments for method ModifyGlobalCluster on L<Paws::DocDB> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method ModifyGlobalCluster on the | ||
| 24 | L<Amazon DocumentDB with MongoDB compatibility|Paws::DocDB> service. Use the attributes of this class | ||
| 25 | as arguments to method ModifyGlobalCluster. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyGlobalCluster. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $rds = Paws->service('DocDB'); | ||
| 32 | my $ModifyGlobalClusterResult = $rds->ModifyGlobalCluster( | ||
| 33 | GlobalClusterIdentifier => 'MyGlobalClusterIdentifier', | ||
| 34 | DeletionProtection => 1, # OPTIONAL | ||
| 35 | NewGlobalClusterIdentifier => 'MyGlobalClusterIdentifier', # OPTIONAL | ||
| 36 | ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $GlobalCluster = $ModifyGlobalClusterResult->GlobalCluster; | ||
| 40 | |||
| 41 | # Returns a L<Paws::DocDB::ModifyGlobalClusterResult> object. | ||
| 42 | |||
| 43 | 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. | ||
| 44 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/ModifyGlobalCluster> | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 DeletionProtection => Bool | ||
| 50 | |||
| 51 | Indicates if the global cluster has deletion protection enabled. The | ||
| 52 | global cluster can't be deleted when deletion protection is enabled. | ||
| 53 | |||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> GlobalClusterIdentifier => Str | ||
| 57 | |||
| 58 | The identifier for the global cluster being modified. This parameter | ||
| 59 | isn't case-sensitive. | ||
| 60 | |||
| 61 | Constraints: | ||
| 62 | |||
| 63 | =over | ||
| 64 | |||
| 65 | =item * | ||
| 66 | |||
| 67 | Must match the identifier of an existing global cluster. | ||
| 68 | |||
| 69 | =back | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 NewGlobalClusterIdentifier => Str | ||
| 75 | |||
| 76 | The new identifier for a global cluster when you modify a global | ||
| 77 | cluster. This value is stored as a lowercase string. | ||
| 78 | |||
| 79 | =over | ||
| 80 | |||
| 81 | =item * | ||
| 82 | |||
| 83 | Must contain from 1 to 63 letters, numbers, or hyphens | ||
| 84 | |||
| 85 | The first character must be a letter | ||
| 86 | |||
| 87 | Can't end with a hyphen or contain two consecutive hyphens | ||
| 88 | |||
| 89 | =back | ||
| 90 | |||
| 91 | Example: C<my-cluster2> | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head1 SEE ALSO | ||
| 97 | |||
| 98 | This class forms part of L<Paws>, documenting arguments for method ModifyGlobalCluster in L<Paws::DocDB> | ||
| 99 | |||
| 100 | =head1 BUGS and CONTRIBUTIONS | ||
| 101 | |||
| 102 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 103 | |||
| 104 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 105 | |||
| 106 | =cut | ||
| 107 |