« blib/lib/Paws/RDS/ModifyEventSubscriptionResult.pm
↑ Summary
blib/lib/Paws/RDS/ModifyGlobalClusterResult.pm »
| 1 | |||
| 2 | package Paws::RDS::ModifyGlobalCluster; | ||
| 3 | use Moose; | ||
| 4 | has AllowMajorVersionUpgrade => (is => 'ro', isa => 'Bool'); | ||
| 5 | has DeletionProtection => (is => 'ro', isa => 'Bool'); | ||
| 6 | has EngineVersion => (is => 'ro', isa => 'Str'); | ||
| 7 | has GlobalClusterIdentifier => (is => 'ro', isa => 'Str'); | ||
| 8 | has NewGlobalClusterIdentifier => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyGlobalCluster'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::ModifyGlobalClusterResult'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'ModifyGlobalClusterResult'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::RDS::ModifyGlobalCluster - Arguments for method ModifyGlobalCluster on L<Paws::RDS> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method ModifyGlobalCluster on the | ||
| 26 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 27 | as arguments to method ModifyGlobalCluster. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyGlobalCluster. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $rds = Paws->service('RDS'); | ||
| 34 | my $ModifyGlobalClusterResult = $rds->ModifyGlobalCluster( | ||
| 35 | AllowMajorVersionUpgrade => 1, # OPTIONAL | ||
| 36 | DeletionProtection => 1, # OPTIONAL | ||
| 37 | EngineVersion => 'MyString', # OPTIONAL | ||
| 38 | GlobalClusterIdentifier => 'MyString', # OPTIONAL | ||
| 39 | NewGlobalClusterIdentifier => 'MyString', # OPTIONAL | ||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $GlobalCluster = $ModifyGlobalClusterResult->GlobalCluster; | ||
| 44 | |||
| 45 | # Returns a L<Paws::RDS::ModifyGlobalClusterResult> object. | ||
| 46 | |||
| 47 | 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. | ||
| 48 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/ModifyGlobalCluster> | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 AllowMajorVersionUpgrade => Bool | ||
| 54 | |||
| 55 | A value that indicates whether major version upgrades are allowed. | ||
| 56 | |||
| 57 | Constraints: You must allow major version upgrades when specifying a | ||
| 58 | value for the C<EngineVersion> parameter that is a different major | ||
| 59 | version than the DB cluster's current version. | ||
| 60 | |||
| 61 | If you upgrade the major version of a global database, the cluster and | ||
| 62 | DB instance parameter groups are set to the default parameter groups | ||
| 63 | for the new version. Apply any custom parameter groups after completing | ||
| 64 | the upgrade. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 DeletionProtection => Bool | ||
| 69 | |||
| 70 | Indicates if the global database cluster has deletion protection | ||
| 71 | enabled. The global database cluster can't be deleted when deletion | ||
| 72 | protection is enabled. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 EngineVersion => Str | ||
| 77 | |||
| 78 | The version number of the database engine to which you want to upgrade. | ||
| 79 | Changing this parameter results in an outage. The change is applied | ||
| 80 | during the next maintenance window unless C<ApplyImmediately> is | ||
| 81 | enabled. | ||
| 82 | |||
| 83 | To list all of the available engine versions for C<aurora> (for MySQL | ||
| 84 | 5.6-compatible Aurora), use the following command: | ||
| 85 | |||
| 86 | C<aws rds describe-db-engine-versions --engine aurora --query | ||
| 87 | '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'> | ||
| 88 | |||
| 89 | To list all of the available engine versions for C<aurora-mysql> (for | ||
| 90 | MySQL 5.7-compatible Aurora), use the following command: | ||
| 91 | |||
| 92 | C<aws rds describe-db-engine-versions --engine aurora-mysql --query | ||
| 93 | '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'> | ||
| 94 | |||
| 95 | To list all of the available engine versions for C<aurora-postgresql>, | ||
| 96 | use the following command: | ||
| 97 | |||
| 98 | C<aws rds describe-db-engine-versions --engine aurora-postgresql | ||
| 99 | --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'> | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 GlobalClusterIdentifier => Str | ||
| 104 | |||
| 105 | The DB cluster identifier for the global cluster being modified. This | ||
| 106 | parameter isn't case-sensitive. | ||
| 107 | |||
| 108 | Constraints: | ||
| 109 | |||
| 110 | =over | ||
| 111 | |||
| 112 | =item * | ||
| 113 | |||
| 114 | Must match the identifier of an existing global database cluster. | ||
| 115 | |||
| 116 | =back | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head2 NewGlobalClusterIdentifier => Str | ||
| 122 | |||
| 123 | The new cluster identifier for the global database cluster when | ||
| 124 | modifying a global database cluster. This value is stored as a | ||
| 125 | lowercase string. | ||
| 126 | |||
| 127 | Constraints: | ||
| 128 | |||
| 129 | =over | ||
| 130 | |||
| 131 | =item * | ||
| 132 | |||
| 133 | Must contain from 1 to 63 letters, numbers, or hyphens | ||
| 134 | |||
| 135 | =item * | ||
| 136 | |||
| 137 | The first character must be a letter | ||
| 138 | |||
| 139 | =item * | ||
| 140 | |||
| 141 | Can't end with a hyphen or contain two consecutive hyphens | ||
| 142 | |||
| 143 | =back | ||
| 144 | |||
| 145 | Example: C<my-cluster2> | ||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | =head1 SEE ALSO | ||
| 151 | |||
| 152 | This class forms part of L<Paws>, documenting arguments for method ModifyGlobalCluster in L<Paws::RDS> | ||
| 153 | |||
| 154 | =head1 BUGS and CONTRIBUTIONS | ||
| 155 | |||
| 156 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 157 | |||
| 158 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 159 | |||
| 160 | =cut | ||
| 161 |