« blib/lib/Paws/ElastiCache/ModifyCacheSubnetGroupResult.pm
↑ Summary
blib/lib/Paws/ElastiCache/ModifyGlobalReplicationGroupResult.pm »
| 1 | |||
| 2 | package Paws::ElastiCache::ModifyGlobalReplicationGroup; | ||
| 3 | use Moose; | ||
| 4 | has ApplyImmediately => (is => 'ro', isa => 'Bool', required => 1); | ||
| 5 | has AutomaticFailoverEnabled => (is => 'ro', isa => 'Bool'); | ||
| 6 | has CacheNodeType => (is => 'ro', isa => 'Str'); | ||
| 7 | has CacheParameterGroupName => (is => 'ro', isa => 'Str'); | ||
| 8 | has EngineVersion => (is => 'ro', isa => 'Str'); | ||
| 9 | has GlobalReplicationGroupDescription => (is => 'ro', isa => 'Str'); | ||
| 10 | has GlobalReplicationGroupId => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyGlobalReplicationGroup'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ElastiCache::ModifyGlobalReplicationGroupResult'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'ModifyGlobalReplicationGroupResult'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::ElastiCache::ModifyGlobalReplicationGroup - Arguments for method ModifyGlobalReplicationGroup on L<Paws::ElastiCache> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method ModifyGlobalReplicationGroup on the | ||
| 28 | L<Amazon ElastiCache|Paws::ElastiCache> service. Use the attributes of this class | ||
| 29 | as arguments to method ModifyGlobalReplicationGroup. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyGlobalReplicationGroup. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $elasticache = Paws->service('ElastiCache'); | ||
| 36 | my $ModifyGlobalReplicationGroupResult = | ||
| 37 | $elasticache->ModifyGlobalReplicationGroup( | ||
| 38 | ApplyImmediately => 1, | ||
| 39 | GlobalReplicationGroupId => 'MyString', | ||
| 40 | AutomaticFailoverEnabled => 1, # OPTIONAL | ||
| 41 | CacheNodeType => 'MyString', # OPTIONAL | ||
| 42 | CacheParameterGroupName => 'MyString', # OPTIONAL | ||
| 43 | EngineVersion => 'MyString', # OPTIONAL | ||
| 44 | GlobalReplicationGroupDescription => 'MyString', # OPTIONAL | ||
| 45 | ); | ||
| 46 | |||
| 47 | # Results: | ||
| 48 | my $GlobalReplicationGroup = | ||
| 49 | $ModifyGlobalReplicationGroupResult->GlobalReplicationGroup; | ||
| 50 | |||
| 51 | # Returns a L<Paws::ElastiCache::ModifyGlobalReplicationGroupResult> object. | ||
| 52 | |||
| 53 | 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. | ||
| 54 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/elasticache/ModifyGlobalReplicationGroup> | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 B<REQUIRED> ApplyImmediately => Bool | ||
| 60 | |||
| 61 | This parameter causes the modifications in this request and any pending | ||
| 62 | modifications to be applied, asynchronously and as soon as possible. | ||
| 63 | Modifications to Global Replication Groups cannot be requested to be | ||
| 64 | applied in PreferredMaintenceWindow. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 AutomaticFailoverEnabled => Bool | ||
| 69 | |||
| 70 | Determines whether a read replica is automatically promoted to | ||
| 71 | read/write primary if the existing primary encounters a failure. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 CacheNodeType => Str | ||
| 76 | |||
| 77 | A valid cache node type that you want to scale this Global datastore | ||
| 78 | to. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 CacheParameterGroupName => Str | ||
| 83 | |||
| 84 | The name of the cache parameter group to use with the Global datastore. | ||
| 85 | It must be compatible with the major engine version used by the Global | ||
| 86 | datastore. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 EngineVersion => Str | ||
| 91 | |||
| 92 | The upgraded version of the cache engine to be run on the clusters in | ||
| 93 | the Global datastore. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 GlobalReplicationGroupDescription => Str | ||
| 98 | |||
| 99 | A description of the Global datastore | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 B<REQUIRED> GlobalReplicationGroupId => Str | ||
| 104 | |||
| 105 | The name of the Global datastore | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head1 SEE ALSO | ||
| 111 | |||
| 112 | This class forms part of L<Paws>, documenting arguments for method ModifyGlobalReplicationGroup in L<Paws::ElastiCache> | ||
| 113 | |||
| 114 | =head1 BUGS and CONTRIBUTIONS | ||
| 115 | |||
| 116 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 117 | |||
| 118 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 119 | |||
| 120 | =cut | ||
| 121 |