« blib/lib/Paws/Proton/CompatibleEnvironmentTemplateInput.pm
↑ Summary
blib/lib/Paws/Proton/CreateEnvironmentAccountConnection.pm »
| 1 | |||
| 2 | package Paws::Proton::CreateEnvironment; | ||
| 3 | use Moose; | ||
| 4 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description' ); | ||
| 5 | has EnvironmentAccountConnectionId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'environmentAccountConnectionId' ); | ||
| 6 | has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name' , required => 1); | ||
| 7 | has ProtonServiceRoleArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'protonServiceRoleArn' ); | ||
| 8 | has Spec => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'spec' , required => 1); | ||
| 9 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Proton::Tag]', traits => ['NameInRequest'], request_name => 'tags' ); | ||
| 10 | has TemplateMajorVersion => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'templateMajorVersion' , required => 1); | ||
| 11 | has TemplateMinorVersion => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'templateMinorVersion' ); | ||
| 12 | has TemplateName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'templateName' , required => 1); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateEnvironment'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Proton::CreateEnvironmentOutput'); | ||
| 18 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::Proton::CreateEnvironment - Arguments for method CreateEnvironment on L<Paws::Proton> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method CreateEnvironment on the | ||
| 30 | L<AWS Proton|Paws::Proton> service. Use the attributes of this class | ||
| 31 | as arguments to method CreateEnvironment. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateEnvironment. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $proton = Paws->service('Proton'); | ||
| 38 | my $CreateEnvironmentOutput = $proton->CreateEnvironment( | ||
| 39 | Name => 'MyResourceName', | ||
| 40 | Spec => 'MySpecContents', | ||
| 41 | TemplateMajorVersion => 'MyTemplateVersionPart', | ||
| 42 | TemplateName => 'MyResourceName', | ||
| 43 | Description => 'MyDescription', # OPTIONAL | ||
| 44 | EnvironmentAccountConnectionId => | ||
| 45 | 'MyEnvironmentAccountConnectionId', # OPTIONAL | ||
| 46 | ProtonServiceRoleArn => 'MyArn', # OPTIONAL | ||
| 47 | Tags => [ | ||
| 48 | { | ||
| 49 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 50 | Value => 'MyTagValue', # max: 256 | ||
| 51 | |||
| 52 | }, | ||
| 53 | ... | ||
| 54 | ], # OPTIONAL | ||
| 55 | TemplateMinorVersion => 'MyTemplateVersionPart', # OPTIONAL | ||
| 56 | ); | ||
| 57 | |||
| 58 | # Results: | ||
| 59 | my $Environment = $CreateEnvironmentOutput->Environment; | ||
| 60 | |||
| 61 | # Returns a L<Paws::Proton::CreateEnvironmentOutput> object. | ||
| 62 | |||
| 63 | 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. | ||
| 64 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/proton/CreateEnvironment> | ||
| 65 | |||
| 66 | =head1 ATTRIBUTES | ||
| 67 | |||
| 68 | |||
| 69 | =head2 Description => Str | ||
| 70 | |||
| 71 | A description of the environment that's being created and deployed. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 EnvironmentAccountConnectionId => Str | ||
| 76 | |||
| 77 | The ID of the environment account connection that you provide if you're | ||
| 78 | provisioning your environment infrastructure resources to an | ||
| 79 | environment account. You must include either the | ||
| 80 | C<environmentAccountConnectionId> or C<protonServiceRoleArn> parameter | ||
| 81 | and value. For more information, see Environment account connections in | ||
| 82 | the I<AWS Proton Administration guide>. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 B<REQUIRED> Name => Str | ||
| 87 | |||
| 88 | The name of the environment. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 ProtonServiceRoleArn => Str | ||
| 93 | |||
| 94 | The Amazon Resource Name (ARN) of the AWS Proton service role that | ||
| 95 | allows AWS Proton to make calls to other services on your behalf. You | ||
| 96 | must include either the C<environmentAccountConnectionId> or | ||
| 97 | C<protonServiceRoleArn> parameter and value. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 B<REQUIRED> Spec => Str | ||
| 102 | |||
| 103 | A link to a YAML formatted spec file that provides inputs as defined in | ||
| 104 | the environment template bundle schema file. For more information, see | ||
| 105 | Environments | ||
| 106 | (https://docs.aws.amazon.com/proton/latest/adminguide/ag-managing-environments.html) | ||
| 107 | in the I<AWS Proton Administration Guide>. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 Tags => ArrayRef[L<Paws::Proton::Tag>] | ||
| 112 | |||
| 113 | Create tags for your environment. For more information, see I<AWS | ||
| 114 | Proton resources and tagging> in the AWS Proton Administration Guide | ||
| 115 | (https://docs.aws.amazon.com/proton/latest/adminguide/resources.html) | ||
| 116 | or AWS Proton User Guide | ||
| 117 | (https://docs.aws.amazon.com/proton/latest/userguide/resources.html). | ||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head2 B<REQUIRED> TemplateMajorVersion => Str | ||
| 122 | |||
| 123 | The ID of the major version of the environment template. | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head2 TemplateMinorVersion => Str | ||
| 128 | |||
| 129 | The ID of the minor version of the environment template. | ||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head2 B<REQUIRED> TemplateName => Str | ||
| 134 | |||
| 135 | The name of the environment template. For more information, see | ||
| 136 | Environment Templates | ||
| 137 | (https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-templates.html) | ||
| 138 | in the I<AWS Proton Administration Guide>. | ||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | =head1 SEE ALSO | ||
| 144 | |||
| 145 | This class forms part of L<Paws>, documenting arguments for method CreateEnvironment in L<Paws::Proton> | ||
| 146 | |||
| 147 | =head1 BUGS and CONTRIBUTIONS | ||
| 148 | |||
| 149 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 150 | |||
| 151 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 152 | |||
| 153 | =cut | ||
| 154 |