« blib/lib/Paws/EC2/ModifyDefaultCreditSpecificationResult.pm
↑ Summary
blib/lib/Paws/EC2/ModifyEbsDefaultKmsKeyIdResult.pm »
| 1 | |||
| 2 | package Paws::EC2::ModifyEbsDefaultKmsKeyId; | ||
| 3 | use Moose; | ||
| 4 | has DryRun => (is => 'ro', isa => 'Bool'); | ||
| 5 | has KmsKeyId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyEbsDefaultKmsKeyId'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::ModifyEbsDefaultKmsKeyIdResult'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::EC2::ModifyEbsDefaultKmsKeyId - Arguments for method ModifyEbsDefaultKmsKeyId on L<Paws::EC2> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method ModifyEbsDefaultKmsKeyId on the | ||
| 23 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 24 | as arguments to method ModifyEbsDefaultKmsKeyId. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyEbsDefaultKmsKeyId. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $ec2 = Paws->service('EC2'); | ||
| 31 | my $ModifyEbsDefaultKmsKeyIdResult = $ec2->ModifyEbsDefaultKmsKeyId( | ||
| 32 | KmsKeyId => 'MyKmsKeyId', | ||
| 33 | DryRun => 1, # OPTIONAL | ||
| 34 | ); | ||
| 35 | |||
| 36 | # Results: | ||
| 37 | my $KmsKeyId = $ModifyEbsDefaultKmsKeyIdResult->KmsKeyId; | ||
| 38 | |||
| 39 | # Returns a L<Paws::EC2::ModifyEbsDefaultKmsKeyIdResult> object. | ||
| 40 | |||
| 41 | 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. | ||
| 42 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/ModifyEbsDefaultKmsKeyId> | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 DryRun => Bool | ||
| 48 | |||
| 49 | Checks whether you have the required permissions for the action, | ||
| 50 | without actually making the request, and provides an error response. If | ||
| 51 | you have the required permissions, the error response is | ||
| 52 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 53 | |||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> KmsKeyId => Str | ||
| 57 | |||
| 58 | The identifier of the AWS Key Management Service (AWS KMS) customer | ||
| 59 | master key (CMK) to use for Amazon EBS encryption. If this parameter is | ||
| 60 | not specified, your AWS managed CMK for EBS is used. If C<KmsKeyId> is | ||
| 61 | specified, the encrypted state must be C<true>. | ||
| 62 | |||
| 63 | You can specify the CMK using any of the following: | ||
| 64 | |||
| 65 | =over | ||
| 66 | |||
| 67 | =item * | ||
| 68 | |||
| 69 | Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. | ||
| 70 | |||
| 71 | =item * | ||
| 72 | |||
| 73 | Key alias. For example, alias/ExampleAlias. | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | Key ARN. For example, | ||
| 78 | arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. | ||
| 79 | |||
| 80 | =item * | ||
| 81 | |||
| 82 | Alias ARN. For example, | ||
| 83 | arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. | ||
| 84 | |||
| 85 | =back | ||
| 86 | |||
| 87 | AWS authenticates the CMK asynchronously. Therefore, if you specify an | ||
| 88 | ID, alias, or ARN that is not valid, the action can appear to complete, | ||
| 89 | but eventually fails. | ||
| 90 | |||
| 91 | Amazon EBS does not support asymmetric CMKs. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head1 SEE ALSO | ||
| 97 | |||
| 98 | This class forms part of L<Paws>, documenting arguments for method ModifyEbsDefaultKmsKeyId in L<Paws::EC2> | ||
| 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 |