« blib/lib/Paws/XRay/ListTagsForResourceResponse.pm
↑ Summary
blib/lib/Paws/XRay/PutEncryptionConfigResult.pm »
| 1 | |||
| 2 | package Paws::XRay::PutEncryptionConfig; | ||
| 3 | use Moose; | ||
| 4 | has KeyId => (is => 'ro', isa => 'Str'); | ||
| 5 | has Type => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutEncryptionConfig'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/PutEncryptionConfig'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::XRay::PutEncryptionConfigResult'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::XRay::PutEncryptionConfig - Arguments for method PutEncryptionConfig on L<Paws::XRay> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method PutEncryptionConfig on the | ||
| 24 | L<AWS X-Ray|Paws::XRay> service. Use the attributes of this class | ||
| 25 | as arguments to method PutEncryptionConfig. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutEncryptionConfig. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $xray = Paws->service('XRay'); | ||
| 32 | my $PutEncryptionConfigResult = $xray->PutEncryptionConfig( | ||
| 33 | Type => 'NONE', | ||
| 34 | KeyId => 'MyEncryptionKeyId', # OPTIONAL | ||
| 35 | ); | ||
| 36 | |||
| 37 | # Results: | ||
| 38 | my $EncryptionConfig = $PutEncryptionConfigResult->EncryptionConfig; | ||
| 39 | |||
| 40 | # Returns a L<Paws::XRay::PutEncryptionConfigResult> object. | ||
| 41 | |||
| 42 | 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. | ||
| 43 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/xray/PutEncryptionConfig> | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 KeyId => Str | ||
| 49 | |||
| 50 | An AWS KMS customer master key (CMK) in one of the following formats: | ||
| 51 | |||
| 52 | =over | ||
| 53 | |||
| 54 | =item * | ||
| 55 | |||
| 56 | B<Alias> - The name of the key. For example, C<alias/MyKey>. | ||
| 57 | |||
| 58 | =item * | ||
| 59 | |||
| 60 | B<Key ID> - The KMS key ID of the key. For example, | ||
| 61 | C<ae4aa6d49-a4d8-9df9-a475-4ff6d7898456>. AWS X-Ray does not support | ||
| 62 | asymmetric CMKs. | ||
| 63 | |||
| 64 | =item * | ||
| 65 | |||
| 66 | B<ARN> - The full Amazon Resource Name of the key ID or alias. For | ||
| 67 | example, | ||
| 68 | C<arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456>. | ||
| 69 | Use this format to specify a key in a different account. | ||
| 70 | |||
| 71 | =back | ||
| 72 | |||
| 73 | Omit this key if you set C<Type> to C<NONE>. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 B<REQUIRED> Type => Str | ||
| 78 | |||
| 79 | The type of encryption. Set to C<KMS> to use your own key for | ||
| 80 | encryption. Set to C<NONE> for default encryption. | ||
| 81 | |||
| 82 | Valid values are: C<"NONE">, C<"KMS"> | ||
| 83 | |||
| 84 | |||
| 85 | =head1 SEE ALSO | ||
| 86 | |||
| 87 | This class forms part of L<Paws>, documenting arguments for method PutEncryptionConfig in L<Paws::XRay> | ||
| 88 | |||
| 89 | =head1 BUGS and CONTRIBUTIONS | ||
| 90 | |||
| 91 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 92 | |||
| 93 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 94 | |||
| 95 | =cut | ||
| 96 |