« blib/lib/Paws/CodeArtifact/CopyPackageVersionsResult.pm
↑ Summary
blib/lib/Paws/CodeArtifact/CreateDomainResult.pm »
| 1 | |||
| 2 | package Paws::CodeArtifact::CreateDomain; | ||
| 3 | use Moose; | ||
| 4 | has Domain => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'domain', required => 1); | ||
| 5 | has EncryptionKey => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'encryptionKey'); | ||
| 6 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::CodeArtifact::Tag]', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDomain'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/domain'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodeArtifact::CreateDomainResult'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::CodeArtifact::CreateDomain - Arguments for method CreateDomain on L<Paws::CodeArtifact> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method CreateDomain on the | ||
| 25 | L<CodeArtifact|Paws::CodeArtifact> service. Use the attributes of this class | ||
| 26 | as arguments to method CreateDomain. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDomain. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $codeartifact = Paws->service('CodeArtifact'); | ||
| 33 | my $CreateDomainResult = $codeartifact->CreateDomain( | ||
| 34 | Domain => 'MyDomainName', | ||
| 35 | EncryptionKey => 'MyArn', # OPTIONAL | ||
| 36 | Tags => [ | ||
| 37 | { | ||
| 38 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 39 | Value => 'MyTagValue', # max: 256 | ||
| 40 | |||
| 41 | }, | ||
| 42 | ... | ||
| 43 | ], # OPTIONAL | ||
| 44 | ); | ||
| 45 | |||
| 46 | # Results: | ||
| 47 | my $Domain = $CreateDomainResult->Domain; | ||
| 48 | |||
| 49 | # Returns a L<Paws::CodeArtifact::CreateDomainResult> object. | ||
| 50 | |||
| 51 | 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. | ||
| 52 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/codeartifact/CreateDomain> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> Domain => Str | ||
| 58 | |||
| 59 | The name of the domain to create. All domain names in an AWS Region | ||
| 60 | that are in the same AWS account must be unique. The domain name is | ||
| 61 | used as the prefix in DNS hostnames. Do not use sensitive information | ||
| 62 | in a domain name because it is publicly discoverable. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 EncryptionKey => Str | ||
| 67 | |||
| 68 | The encryption key for the domain. This is used to encrypt content | ||
| 69 | stored in a domain. An encryption key can be a key ID, a key Amazon | ||
| 70 | Resource Name (ARN), a key alias, or a key alias ARN. To specify an | ||
| 71 | C<encryptionKey>, your IAM role must have C<kms:DescribeKey> and | ||
| 72 | C<kms:CreateGrant> permissions on the encryption key that is used. For | ||
| 73 | more information, see DescribeKey | ||
| 74 | (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestSyntax) | ||
| 75 | in the I<AWS Key Management Service API Reference> and AWS KMS API | ||
| 76 | Permissions Reference | ||
| 77 | (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html) | ||
| 78 | in the I<AWS Key Management Service Developer Guide>. | ||
| 79 | |||
| 80 | CodeArtifact supports only symmetric CMKs. Do not associate an | ||
| 81 | asymmetric CMK with your domain. For more information, see Using | ||
| 82 | symmetric and asymmetric keys | ||
| 83 | (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) | ||
| 84 | in the I<AWS Key Management Service Developer Guide>. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 Tags => ArrayRef[L<Paws::CodeArtifact::Tag>] | ||
| 89 | |||
| 90 | One or more tag key-value pairs for the domain. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head1 SEE ALSO | ||
| 96 | |||
| 97 | This class forms part of L<Paws>, documenting arguments for method CreateDomain in L<Paws::CodeArtifact> | ||
| 98 | |||
| 99 | =head1 BUGS and CONTRIBUTIONS | ||
| 100 | |||
| 101 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 102 | |||
| 103 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 104 | |||
| 105 | =cut | ||
| 106 |