« blib/lib/Paws/CloudFormation/ChangeSetSummary.pm
↑ Summary
blib/lib/Paws/CloudFormation/ContinueUpdateRollbackOutput.pm »
| 1 | |||
| 2 | package Paws::CloudFormation::ContinueUpdateRollback; | ||
| 3 | use Moose; | ||
| 4 | has ClientRequestToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has ResourcesToSkip => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 6 | has RoleARN => (is => 'ro', isa => 'Str'); | ||
| 7 | has StackName => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ContinueUpdateRollback'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudFormation::ContinueUpdateRollbackOutput'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'ContinueUpdateRollbackResult'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::CloudFormation::ContinueUpdateRollback - Arguments for method ContinueUpdateRollback on L<Paws::CloudFormation> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method ContinueUpdateRollback on the | ||
| 25 | L<AWS CloudFormation|Paws::CloudFormation> service. Use the attributes of this class | ||
| 26 | as arguments to method ContinueUpdateRollback. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ContinueUpdateRollback. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $cloudformation = Paws->service('CloudFormation'); | ||
| 33 | my $ContinueUpdateRollbackOutput = $cloudformation->ContinueUpdateRollback( | ||
| 34 | StackName => 'MyStackNameOrId', | ||
| 35 | ClientRequestToken => 'MyClientRequestToken', # OPTIONAL | ||
| 36 | ResourcesToSkip => [ 'MyResourceToSkip', ... ], # OPTIONAL | ||
| 37 | RoleARN => 'MyRoleARN', # OPTIONAL | ||
| 38 | ); | ||
| 39 | |||
| 40 | 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. | ||
| 41 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cloudformation/ContinueUpdateRollback> | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 ClientRequestToken => Str | ||
| 47 | |||
| 48 | A unique identifier for this C<ContinueUpdateRollback> request. Specify | ||
| 49 | this token if you plan to retry requests so that AWS CloudFormation | ||
| 50 | knows that you're not attempting to continue the rollback to a stack | ||
| 51 | with the same name. You might retry C<ContinueUpdateRollback> requests | ||
| 52 | to ensure that AWS CloudFormation successfully received them. | ||
| 53 | |||
| 54 | |||
| 55 | |||
| 56 | =head2 ResourcesToSkip => ArrayRef[Str|Undef] | ||
| 57 | |||
| 58 | A list of the logical IDs of the resources that AWS CloudFormation | ||
| 59 | skips during the continue update rollback operation. You can specify | ||
| 60 | only resources that are in the C<UPDATE_FAILED> state because a | ||
| 61 | rollback failed. You can't specify resources that are in the | ||
| 62 | C<UPDATE_FAILED> state for other reasons, for example, because an | ||
| 63 | update was cancelled. To check why a resource update failed, use the | ||
| 64 | DescribeStackResources action, and view the resource status reason. | ||
| 65 | |||
| 66 | Specify this property to skip rolling back resources that AWS | ||
| 67 | CloudFormation can't successfully roll back. We recommend that you | ||
| 68 | troubleshoot | ||
| 69 | (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed) | ||
| 70 | resources before skipping them. AWS CloudFormation sets the status of | ||
| 71 | the specified resources to C<UPDATE_COMPLETE> and continues to roll | ||
| 72 | back the stack. After the rollback is complete, the state of the | ||
| 73 | skipped resources will be inconsistent with the state of the resources | ||
| 74 | in the stack template. Before performing another stack update, you must | ||
| 75 | update the stack or resources to be consistent with each other. If you | ||
| 76 | don't, subsequent stack updates might fail, and the stack will become | ||
| 77 | unrecoverable. | ||
| 78 | |||
| 79 | Specify the minimum number of resources required to successfully roll | ||
| 80 | back your stack. For example, a failed resource update might cause | ||
| 81 | dependent resources to fail. In this case, it might not be necessary to | ||
| 82 | skip the dependent resources. | ||
| 83 | |||
| 84 | To skip resources that are part of nested stacks, use the following | ||
| 85 | format: C<NestedStackName.ResourceLogicalID>. If you want to specify | ||
| 86 | the logical ID of a stack resource (C<Type: | ||
| 87 | AWS::CloudFormation::Stack>) in the C<ResourcesToSkip> list, then its | ||
| 88 | corresponding embedded stack must be in one of the following states: | ||
| 89 | C<DELETE_IN_PROGRESS>, C<DELETE_COMPLETE>, or C<DELETE_FAILED>. | ||
| 90 | |||
| 91 | Don't confuse a child stack's name with its corresponding logical ID | ||
| 92 | defined in the parent stack. For an example of a continue update | ||
| 93 | rollback operation with nested stacks, see Using ResourcesToSkip to | ||
| 94 | recover a nested stacks hierarchy | ||
| 95 | (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html#nested-stacks). | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 RoleARN => Str | ||
| 100 | |||
| 101 | The Amazon Resource Name (ARN) of an AWS Identity and Access Management | ||
| 102 | (IAM) role that AWS CloudFormation assumes to roll back the stack. AWS | ||
| 103 | CloudFormation uses the role's credentials to make calls on your | ||
| 104 | behalf. AWS CloudFormation always uses this role for all future | ||
| 105 | operations on the stack. As long as users have permission to operate on | ||
| 106 | the stack, AWS CloudFormation uses this role even if the users don't | ||
| 107 | have permission to pass it. Ensure that the role grants least | ||
| 108 | privilege. | ||
| 109 | |||
| 110 | If you don't specify a value, AWS CloudFormation uses the role that was | ||
| 111 | previously associated with the stack. If no role is available, AWS | ||
| 112 | CloudFormation uses a temporary session that is generated from your | ||
| 113 | user credentials. | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | =head2 B<REQUIRED> StackName => Str | ||
| 118 | |||
| 119 | The name or the unique ID of the stack that you want to continue | ||
| 120 | rolling back. | ||
| 121 | |||
| 122 | Don't specify the name of a nested stack (a stack that was created by | ||
| 123 | using the C<AWS::CloudFormation::Stack> resource). Instead, use this | ||
| 124 | operation on the parent stack (the stack that contains the | ||
| 125 | C<AWS::CloudFormation::Stack> resource). | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head1 SEE ALSO | ||
| 131 | |||
| 132 | This class forms part of L<Paws>, documenting arguments for method ContinueUpdateRollback in L<Paws::CloudFormation> | ||
| 133 | |||
| 134 | =head1 BUGS and CONTRIBUTIONS | ||
| 135 | |||
| 136 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 137 | |||
| 138 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 139 | |||
| 140 | =cut | ||
| 141 |