« blib/lib/Paws/Proton/UpdateAccountSettingsOutput.pm
↑ Summary
blib/lib/Paws/Proton/UpdateEnvironmentAccountConnection.pm »
| 1 | |||
| 2 | package Paws::Proton::UpdateEnvironment; | ||
| 3 | use Moose; | ||
| 4 | has DeploymentType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'deploymentType' , required => 1); | ||
| 5 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description' ); | ||
| 6 | has EnvironmentAccountConnectionId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'environmentAccountConnectionId' ); | ||
| 7 | has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name' , required => 1); | ||
| 8 | has ProtonServiceRoleArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'protonServiceRoleArn' ); | ||
| 9 | has Spec => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'spec' ); | ||
| 10 | has TemplateMajorVersion => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'templateMajorVersion' ); | ||
| 11 | has TemplateMinorVersion => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'templateMinorVersion' ); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateEnvironment'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Proton::UpdateEnvironmentOutput'); | ||
| 17 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::Proton::UpdateEnvironment - Arguments for method UpdateEnvironment on L<Paws::Proton> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method UpdateEnvironment on the | ||
| 29 | L<AWS Proton|Paws::Proton> service. Use the attributes of this class | ||
| 30 | as arguments to method UpdateEnvironment. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateEnvironment. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $proton = Paws->service('Proton'); | ||
| 37 | my $UpdateEnvironmentOutput = $proton->UpdateEnvironment( | ||
| 38 | DeploymentType => 'NONE', | ||
| 39 | Name => 'MyResourceName', | ||
| 40 | Description => 'MyDescription', # OPTIONAL | ||
| 41 | EnvironmentAccountConnectionId => | ||
| 42 | 'MyEnvironmentAccountConnectionId', # OPTIONAL | ||
| 43 | ProtonServiceRoleArn => 'MyArn', # OPTIONAL | ||
| 44 | Spec => 'MySpecContents', # OPTIONAL | ||
| 45 | TemplateMajorVersion => 'MyTemplateVersionPart', # OPTIONAL | ||
| 46 | TemplateMinorVersion => 'MyTemplateVersionPart', # OPTIONAL | ||
| 47 | ); | ||
| 48 | |||
| 49 | # Results: | ||
| 50 | my $Environment = $UpdateEnvironmentOutput->Environment; | ||
| 51 | |||
| 52 | # Returns a L<Paws::Proton::UpdateEnvironmentOutput> object. | ||
| 53 | |||
| 54 | 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. | ||
| 55 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/proton/UpdateEnvironment> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> DeploymentType => Str | ||
| 61 | |||
| 62 | There are four modes for updating an environment as described in the | ||
| 63 | following. The C<deploymentType> field defines the mode. | ||
| 64 | |||
| 65 | =over | ||
| 66 | |||
| 67 | =item C<NONE> | ||
| 68 | |||
| 69 | In this mode, a deployment I<doesn't> occur. Only the requested | ||
| 70 | metadata parameters are updated. | ||
| 71 | |||
| 72 | =item C<CURRENT_VERSION> | ||
| 73 | |||
| 74 | In this mode, the environment is deployed and updated with the new spec | ||
| 75 | that you provide. Only requested parameters are updated. | ||
| 76 | I<DonE<rsquo>t> include minor or major version parameters when you use | ||
| 77 | this C<deployment-type>. | ||
| 78 | |||
| 79 | =item C<MINOR_VERSION> | ||
| 80 | |||
| 81 | In this mode, the environment is deployed and updated with the | ||
| 82 | published, recommended (latest) minor version of the current major | ||
| 83 | version in use, by default. You can also specify a different minor | ||
| 84 | version of the current major version in use. | ||
| 85 | |||
| 86 | =item C<MAJOR_VERSION> | ||
| 87 | |||
| 88 | In this mode, the environment is deployed and updated with the | ||
| 89 | published, recommended (latest) major and minor version of the current | ||
| 90 | template, by default. You can also specify a different major version | ||
| 91 | that is higher than the major version in use and a minor version | ||
| 92 | (optional). | ||
| 93 | |||
| 94 | =back | ||
| 95 | |||
| 96 | |||
| 97 | Valid values are: C<"NONE">, C<"CURRENT_VERSION">, C<"MINOR_VERSION">, C<"MAJOR_VERSION"> | ||
| 98 | |||
| 99 | =head2 Description => Str | ||
| 100 | |||
| 101 | A description of the environment update. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 EnvironmentAccountConnectionId => Str | ||
| 106 | |||
| 107 | The ID of the environment account connection. | ||
| 108 | |||
| 109 | You can only update to a new environment account connection if it was | ||
| 110 | created in the same environment account that the current environment | ||
| 111 | account connection was created in and associated with the current | ||
| 112 | environment. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 B<REQUIRED> Name => Str | ||
| 117 | |||
| 118 | The name of the environment to update. | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head2 ProtonServiceRoleArn => Str | ||
| 123 | |||
| 124 | The ARN of the AWS Proton service role that allows AWS Proton to make | ||
| 125 | API calls to other services your behalf. | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head2 Spec => Str | ||
| 130 | |||
| 131 | The formatted specification that defines the update. | ||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head2 TemplateMajorVersion => Str | ||
| 136 | |||
| 137 | The ID of the major version of the environment to update. | ||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | =head2 TemplateMinorVersion => Str | ||
| 142 | |||
| 143 | The ID of the minor version of the environment to update. | ||
| 144 | |||
| 145 | |||
| 146 | |||
| 147 | |||
| 148 | =head1 SEE ALSO | ||
| 149 | |||
| 150 | This class forms part of L<Paws>, documenting arguments for method UpdateEnvironment in L<Paws::Proton> | ||
| 151 | |||
| 152 | =head1 BUGS and CONTRIBUTIONS | ||
| 153 | |||
| 154 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 155 | |||
| 156 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 157 | |||
| 158 | =cut | ||
| 159 |