Documentation ¶
Overview ¶
Package cloudformation provides the client and types for making API requests to AWS CloudFormation.
AWS CloudFormation allows you to create and manage AWS infrastructure deployments predictably and repeatedly. You can use AWS CloudFormation to leverage AWS products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly-reliable, highly scalable, cost-effective applications without creating or configuring the underlying AWS infrastructure.
With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.
For more information about AWS CloudFormation, see the AWS CloudFormation Product Page (http://aws.amazon.com/cloudformation/).
Amazon CloudFormation makes use of other AWS products. If you need additional technical information about a specific AWS product, you can find the product's technical documentation at docs.aws.amazon.com (https://docs.aws.amazon.com/).
See https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15 for more information on this service.
See cloudformation package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/cloudformation/
Using the Client ¶
To use AWS CloudFormation with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the AWS CloudFormation client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/cloudformation/#New
Index ¶
- Constants
- type AccountGateResult
- type AccountGateStatus
- type AccountLimit
- type CancelUpdateStackInput
- type CancelUpdateStackOutput
- type CancelUpdateStackRequest
- type CancelUpdateStackResponse
- type Capability
- type Change
- type ChangeAction
- type ChangeSetStatus
- type ChangeSetSummary
- type ChangeSetType
- type ChangeSource
- type ChangeType
- type Client
- func (c *Client) CancelUpdateStackRequest(input *CancelUpdateStackInput) CancelUpdateStackRequest
- func (c *Client) ContinueUpdateRollbackRequest(input *ContinueUpdateRollbackInput) ContinueUpdateRollbackRequest
- func (c *Client) CreateChangeSetRequest(input *CreateChangeSetInput) CreateChangeSetRequest
- func (c *Client) CreateStackInstancesRequest(input *CreateStackInstancesInput) CreateStackInstancesRequest
- func (c *Client) CreateStackRequest(input *CreateStackInput) CreateStackRequest
- func (c *Client) CreateStackSetRequest(input *CreateStackSetInput) CreateStackSetRequest
- func (c *Client) DeleteChangeSetRequest(input *DeleteChangeSetInput) DeleteChangeSetRequest
- func (c *Client) DeleteStackInstancesRequest(input *DeleteStackInstancesInput) DeleteStackInstancesRequest
- func (c *Client) DeleteStackRequest(input *DeleteStackInput) DeleteStackRequest
- func (c *Client) DeleteStackSetRequest(input *DeleteStackSetInput) DeleteStackSetRequest
- func (c *Client) DescribeAccountLimitsRequest(input *DescribeAccountLimitsInput) DescribeAccountLimitsRequest
- func (c *Client) DescribeChangeSetRequest(input *DescribeChangeSetInput) DescribeChangeSetRequest
- func (c *Client) DescribeStackDriftDetectionStatusRequest(input *DescribeStackDriftDetectionStatusInput) DescribeStackDriftDetectionStatusRequest
- func (c *Client) DescribeStackEventsRequest(input *DescribeStackEventsInput) DescribeStackEventsRequest
- func (c *Client) DescribeStackInstanceRequest(input *DescribeStackInstanceInput) DescribeStackInstanceRequest
- func (c *Client) DescribeStackResourceDriftsRequest(input *DescribeStackResourceDriftsInput) DescribeStackResourceDriftsRequest
- func (c *Client) DescribeStackResourceRequest(input *DescribeStackResourceInput) DescribeStackResourceRequest
- func (c *Client) DescribeStackResourcesRequest(input *DescribeStackResourcesInput) DescribeStackResourcesRequest
- func (c *Client) DescribeStackSetOperationRequest(input *DescribeStackSetOperationInput) DescribeStackSetOperationRequest
- func (c *Client) DescribeStackSetRequest(input *DescribeStackSetInput) DescribeStackSetRequest
- func (c *Client) DescribeStacksRequest(input *DescribeStacksInput) DescribeStacksRequest
- func (c *Client) DetectStackDriftRequest(input *DetectStackDriftInput) DetectStackDriftRequest
- func (c *Client) DetectStackResourceDriftRequest(input *DetectStackResourceDriftInput) DetectStackResourceDriftRequest
- func (c *Client) EstimateTemplateCostRequest(input *EstimateTemplateCostInput) EstimateTemplateCostRequest
- func (c *Client) ExecuteChangeSetRequest(input *ExecuteChangeSetInput) ExecuteChangeSetRequest
- func (c *Client) GetStackPolicyRequest(input *GetStackPolicyInput) GetStackPolicyRequest
- func (c *Client) GetTemplateRequest(input *GetTemplateInput) GetTemplateRequest
- func (c *Client) GetTemplateSummaryRequest(input *GetTemplateSummaryInput) GetTemplateSummaryRequest
- func (c *Client) ListChangeSetsRequest(input *ListChangeSetsInput) ListChangeSetsRequest
- func (c *Client) ListExportsRequest(input *ListExportsInput) ListExportsRequest
- func (c *Client) ListImportsRequest(input *ListImportsInput) ListImportsRequest
- func (c *Client) ListStackInstancesRequest(input *ListStackInstancesInput) ListStackInstancesRequest
- func (c *Client) ListStackResourcesRequest(input *ListStackResourcesInput) ListStackResourcesRequest
- func (c *Client) ListStackSetOperationResultsRequest(input *ListStackSetOperationResultsInput) ListStackSetOperationResultsRequest
- func (c *Client) ListStackSetOperationsRequest(input *ListStackSetOperationsInput) ListStackSetOperationsRequest
- func (c *Client) ListStackSetsRequest(input *ListStackSetsInput) ListStackSetsRequest
- func (c *Client) ListStacksRequest(input *ListStacksInput) ListStacksRequest
- func (c *Client) SetStackPolicyRequest(input *SetStackPolicyInput) SetStackPolicyRequest
- func (c *Client) SignalResourceRequest(input *SignalResourceInput) SignalResourceRequest
- func (c *Client) StopStackSetOperationRequest(input *StopStackSetOperationInput) StopStackSetOperationRequest
- func (c *Client) UpdateStackInstancesRequest(input *UpdateStackInstancesInput) UpdateStackInstancesRequest
- func (c *Client) UpdateStackRequest(input *UpdateStackInput) UpdateStackRequest
- func (c *Client) UpdateStackSetRequest(input *UpdateStackSetInput) UpdateStackSetRequest
- func (c *Client) UpdateTerminationProtectionRequest(input *UpdateTerminationProtectionInput) UpdateTerminationProtectionRequest
- func (c *Client) ValidateTemplateRequest(input *ValidateTemplateInput) ValidateTemplateRequest
- func (c *Client) WaitUntilChangeSetCreateComplete(ctx context.Context, input *DescribeChangeSetInput, opts ...aws.WaiterOption) error
- func (c *Client) WaitUntilStackCreateComplete(ctx context.Context, input *DescribeStacksInput, opts ...aws.WaiterOption) error
- func (c *Client) WaitUntilStackDeleteComplete(ctx context.Context, input *DescribeStacksInput, opts ...aws.WaiterOption) error
- func (c *Client) WaitUntilStackExists(ctx context.Context, input *DescribeStacksInput, opts ...aws.WaiterOption) error
- func (c *Client) WaitUntilStackImportComplete(ctx context.Context, input *DescribeStacksInput, opts ...aws.WaiterOption) error
- func (c *Client) WaitUntilStackUpdateComplete(ctx context.Context, input *DescribeStacksInput, opts ...aws.WaiterOption) error
- type ContinueUpdateRollbackInput
- type ContinueUpdateRollbackOutput
- type ContinueUpdateRollbackRequest
- type ContinueUpdateRollbackResponse
- type CreateChangeSetInput
- type CreateChangeSetOutput
- type CreateChangeSetRequest
- type CreateChangeSetResponse
- type CreateStackInput
- type CreateStackInstancesInput
- type CreateStackInstancesOutput
- type CreateStackInstancesRequest
- type CreateStackInstancesResponse
- type CreateStackOutput
- type CreateStackRequest
- type CreateStackResponse
- type CreateStackSetInput
- type CreateStackSetOutput
- type CreateStackSetRequest
- type CreateStackSetResponse
- type DeleteChangeSetInput
- type DeleteChangeSetOutput
- type DeleteChangeSetRequest
- type DeleteChangeSetResponse
- type DeleteStackInput
- type DeleteStackInstancesInput
- type DeleteStackInstancesOutput
- type DeleteStackInstancesRequest
- type DeleteStackInstancesResponse
- type DeleteStackOutput
- type DeleteStackRequest
- type DeleteStackResponse
- type DeleteStackSetInput
- type DeleteStackSetOutput
- type DeleteStackSetRequest
- type DeleteStackSetResponse
- type DescribeAccountLimitsInput
- type DescribeAccountLimitsOutput
- type DescribeAccountLimitsRequest
- type DescribeAccountLimitsResponse
- type DescribeChangeSetInput
- type DescribeChangeSetOutput
- type DescribeChangeSetRequest
- type DescribeChangeSetResponse
- type DescribeStackDriftDetectionStatusInput
- type DescribeStackDriftDetectionStatusOutput
- type DescribeStackDriftDetectionStatusRequest
- type DescribeStackDriftDetectionStatusResponse
- type DescribeStackEventsInput
- type DescribeStackEventsOutput
- type DescribeStackEventsPaginator
- type DescribeStackEventsRequest
- type DescribeStackEventsResponse
- type DescribeStackInstanceInput
- type DescribeStackInstanceOutput
- type DescribeStackInstanceRequest
- type DescribeStackInstanceResponse
- type DescribeStackResourceDriftsInput
- type DescribeStackResourceDriftsOutput
- type DescribeStackResourceDriftsPaginator
- type DescribeStackResourceDriftsRequest
- type DescribeStackResourceDriftsResponse
- type DescribeStackResourceInput
- type DescribeStackResourceOutput
- type DescribeStackResourceRequest
- type DescribeStackResourceResponse
- type DescribeStackResourcesInput
- type DescribeStackResourcesOutput
- type DescribeStackResourcesRequest
- type DescribeStackResourcesResponse
- type DescribeStackSetInput
- type DescribeStackSetOperationInput
- type DescribeStackSetOperationOutput
- type DescribeStackSetOperationRequest
- type DescribeStackSetOperationResponse
- type DescribeStackSetOutput
- type DescribeStackSetRequest
- type DescribeStackSetResponse
- type DescribeStacksInput
- type DescribeStacksOutput
- type DescribeStacksPaginator
- type DescribeStacksRequest
- type DescribeStacksResponse
- type DetectStackDriftInput
- type DetectStackDriftOutput
- type DetectStackDriftRequest
- type DetectStackDriftResponse
- type DetectStackResourceDriftInput
- type DetectStackResourceDriftOutput
- type DetectStackResourceDriftRequest
- type DetectStackResourceDriftResponse
- type DifferenceType
- type EstimateTemplateCostInput
- type EstimateTemplateCostOutput
- type EstimateTemplateCostRequest
- type EstimateTemplateCostResponse
- type EvaluationType
- type ExecuteChangeSetInput
- type ExecuteChangeSetOutput
- type ExecuteChangeSetRequest
- type ExecuteChangeSetResponse
- type ExecutionStatus
- type Export
- type GetStackPolicyInput
- type GetStackPolicyOutput
- type GetStackPolicyRequest
- type GetStackPolicyResponse
- type GetTemplateInput
- type GetTemplateOutput
- type GetTemplateRequest
- type GetTemplateResponse
- type GetTemplateSummaryInput
- type GetTemplateSummaryOutput
- type GetTemplateSummaryRequest
- type GetTemplateSummaryResponse
- type ListChangeSetsInput
- type ListChangeSetsOutput
- type ListChangeSetsRequest
- type ListChangeSetsResponse
- type ListExportsInput
- type ListExportsOutput
- type ListExportsPaginator
- type ListExportsRequest
- type ListExportsResponse
- type ListImportsInput
- type ListImportsOutput
- type ListImportsPaginator
- type ListImportsRequest
- type ListImportsResponse
- type ListStackInstancesInput
- type ListStackInstancesOutput
- type ListStackInstancesRequest
- type ListStackInstancesResponse
- type ListStackResourcesInput
- type ListStackResourcesOutput
- type ListStackResourcesPaginator
- type ListStackResourcesRequest
- type ListStackResourcesResponse
- type ListStackSetOperationResultsInput
- type ListStackSetOperationResultsOutput
- type ListStackSetOperationResultsRequest
- type ListStackSetOperationResultsResponse
- type ListStackSetOperationsInput
- type ListStackSetOperationsOutput
- type ListStackSetOperationsRequest
- type ListStackSetOperationsResponse
- type ListStackSetsInput
- type ListStackSetsOutput
- type ListStackSetsRequest
- type ListStackSetsResponse
- type ListStacksInput
- type ListStacksOutput
- type ListStacksPaginator
- type ListStacksRequest
- type ListStacksResponse
- type OnFailure
- type Output
- type Parameter
- type ParameterConstraints
- type ParameterDeclaration
- type PhysicalResourceIdContextKeyValuePair
- type PropertyDifference
- type Replacement
- type RequiresRecreation
- type ResourceAttribute
- type ResourceChange
- type ResourceChangeDetail
- type ResourceIdentifierSummary
- type ResourceSignalStatus
- type ResourceStatus
- type ResourceTargetDefinition
- type ResourceToImport
- type RollbackConfiguration
- type RollbackTrigger
- type SetStackPolicyInput
- type SetStackPolicyOutput
- type SetStackPolicyRequest
- type SetStackPolicyResponse
- type SignalResourceInput
- type SignalResourceOutput
- type SignalResourceRequest
- type SignalResourceResponse
- type Stack
- type StackDriftDetectionStatus
- type StackDriftInformation
- type StackDriftInformationSummary
- type StackDriftStatus
- type StackEvent
- type StackInstance
- type StackInstanceStatus
- type StackInstanceSummary
- type StackResource
- type StackResourceDetail
- type StackResourceDrift
- type StackResourceDriftInformation
- type StackResourceDriftInformationSummary
- type StackResourceDriftStatus
- type StackResourceSummary
- type StackSet
- type StackSetOperation
- type StackSetOperationAction
- type StackSetOperationPreferences
- type StackSetOperationResultStatus
- type StackSetOperationResultSummary
- type StackSetOperationStatus
- type StackSetOperationSummary
- type StackSetStatus
- type StackSetSummary
- type StackStatus
- type StackSummary
- type StopStackSetOperationInput
- type StopStackSetOperationOutput
- type StopStackSetOperationRequest
- type StopStackSetOperationResponse
- type Tag
- type TemplateParameter
- type TemplateStage
- type UpdateStackInput
- type UpdateStackInstancesInput
- type UpdateStackInstancesOutput
- type UpdateStackInstancesRequest
- type UpdateStackInstancesResponse
- type UpdateStackOutput
- type UpdateStackRequest
- type UpdateStackResponse
- type UpdateStackSetInput
- type UpdateStackSetOutput
- type UpdateStackSetRequest
- type UpdateStackSetResponse
- type UpdateTerminationProtectionInput
- type UpdateTerminationProtectionOutput
- type UpdateTerminationProtectionRequest
- type UpdateTerminationProtectionResponse
- type ValidateTemplateInput
- type ValidateTemplateOutput
- type ValidateTemplateRequest
- type ValidateTemplateResponse
Constants ¶
const ( ServiceName = "AWS CloudFormation" // Service's name ServiceID = "CloudFormation" // Service's identifier EndpointsID = "cloudformation" // Service's Endpoint identifier )
const ( // ErrCodeAlreadyExistsException for service response error code // "AlreadyExistsException". // // The resource with the name requested already exists. ErrCodeAlreadyExistsException = "AlreadyExistsException" // ErrCodeChangeSetNotFoundException for service response error code // "ChangeSetNotFound". // // The specified change set name or ID doesn't exit. To view valid change sets // for a stack, use the ListChangeSets action. ErrCodeChangeSetNotFoundException = "ChangeSetNotFound" // ErrCodeCreatedButModifiedException for service response error code // "CreatedButModifiedException". // // The specified resource exists, but has been changed. ErrCodeCreatedButModifiedException = "CreatedButModifiedException" // ErrCodeInsufficientCapabilitiesException for service response error code // "InsufficientCapabilitiesException". // // The template contains resources with capabilities that weren't specified // in the Capabilities parameter. ErrCodeInsufficientCapabilitiesException = "InsufficientCapabilitiesException" // ErrCodeInvalidChangeSetStatusException for service response error code // "InvalidChangeSetStatus". // // The specified change set can't be used to update the stack. For example, // the change set status might be CREATE_IN_PROGRESS, or the stack status might // be UPDATE_IN_PROGRESS. ErrCodeInvalidChangeSetStatusException = "InvalidChangeSetStatus" // ErrCodeInvalidOperationException for service response error code // "InvalidOperationException". // // The specified operation isn't valid. ErrCodeInvalidOperationException = "InvalidOperationException" // ErrCodeLimitExceededException for service response error code // "LimitExceededException". // // The quota for the resource has already been reached. // // For information on resource and stack limitations, see Limits (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) // in the AWS CloudFormation User Guide. ErrCodeLimitExceededException = "LimitExceededException" // ErrCodeNameAlreadyExistsException for service response error code // "NameAlreadyExistsException". // // The specified name is already in use. ErrCodeNameAlreadyExistsException = "NameAlreadyExistsException" // ErrCodeOperationIdAlreadyExistsException for service response error code // "OperationIdAlreadyExistsException". // // The specified operation ID already exists. ErrCodeOperationIdAlreadyExistsException = "OperationIdAlreadyExistsException" // ErrCodeOperationInProgressException for service response error code // "OperationInProgressException". // // Another operation is currently in progress for this stack set. Only one operation // can be performed for a stack set at a given time. ErrCodeOperationInProgressException = "OperationInProgressException" // ErrCodeOperationNotFoundException for service response error code // "OperationNotFoundException". // // The specified ID refers to an operation that doesn't exist. ErrCodeOperationNotFoundException = "OperationNotFoundException" // ErrCodeStackInstanceNotFoundException for service response error code // "StackInstanceNotFoundException". // // The specified stack instance doesn't exist. ErrCodeStackInstanceNotFoundException = "StackInstanceNotFoundException" // ErrCodeStackSetNotEmptyException for service response error code // "StackSetNotEmptyException". // // You can't yet delete this stack set, because it still contains one or more // stack instances. Delete all stack instances from the stack set before deleting // the stack set. ErrCodeStackSetNotEmptyException = "StackSetNotEmptyException" // ErrCodeStackSetNotFoundException for service response error code // "StackSetNotFoundException". // // The specified stack set doesn't exist. ErrCodeStackSetNotFoundException = "StackSetNotFoundException" // ErrCodeStaleRequestException for service response error code // "StaleRequestException". // // Another operation has been performed on this stack set since the specified // operation was performed. ErrCodeStaleRequestException = "StaleRequestException" // ErrCodeTokenAlreadyExistsException for service response error code // "TokenAlreadyExistsException". // // A client request token already exists. ErrCodeTokenAlreadyExistsException = "TokenAlreadyExistsException" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccountGateResult ¶
type AccountGateResult struct { // The status of the account gate function. // // * SUCCEEDED: The account gate function has determined that the account // and region passes any requirements for a stack set operation to occur. // AWS CloudFormation proceeds with the stack operation in that account and // region. // // * FAILED: The account gate function has determined that the account and // region does not meet the requirements for a stack set operation to occur. // AWS CloudFormation cancels the stack set operation in that account and // region, and sets the stack set operation result status for that account // and region to FAILED. // // * SKIPPED: AWS CloudFormation has skipped calling the account gate function // for this account and region, for one of the following reasons: An account // gate function has not been specified for the account and region. AWS CloudFormation // proceeds with the stack set operation in this account and region. The // AWSCloudFormationStackSetExecutionRole of the stack set adminstration // account lacks permissions to invoke the function. AWS CloudFormation proceeds // with the stack set operation in this account and region. Either no action // is necessary, or no action is possible, on the stack. AWS CloudFormation // skips the stack set operation in this account and region. Status AccountGateStatus `type:"string" enum:"true"` // The reason for the account gate status assigned to this account and region // for the stack set operation. StatusReason *string `type:"string"` // contains filtered or unexported fields }
Structure that contains the results of the account gate function which AWS CloudFormation invokes, if present, before proceeding with a stack set operation in an account and region.
For each account and region, AWS CloudFormation lets you specify a Lamdba function that encapsulates any requirements that must be met before CloudFormation can proceed with a stack set operation in that account and region. CloudFormation invokes the function each time a stack set operation is requested for that account and region; if the function returns FAILED, CloudFormation cancels the operation in that account and region, and sets the stack set operation result status for that account and region to FAILED.
For more information, see Configuring a target account gate (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-account-gating.html).
func (AccountGateResult) String ¶
func (s AccountGateResult) String() string
String returns the string representation
type AccountGateStatus ¶
type AccountGateStatus string
const ( AccountGateStatusSucceeded AccountGateStatus = "SUCCEEDED" AccountGateStatusFailed AccountGateStatus = "FAILED" AccountGateStatusSkipped AccountGateStatus = "SKIPPED" )
Enum values for AccountGateStatus
func (AccountGateStatus) MarshalValue ¶ added in v0.3.0
func (enum AccountGateStatus) MarshalValue() (string, error)
func (AccountGateStatus) MarshalValueBuf ¶ added in v0.3.0
func (enum AccountGateStatus) MarshalValueBuf(b []byte) ([]byte, error)
type AccountLimit ¶
type AccountLimit struct { // The name of the account limit. // // Values: ConcurrentResourcesLimit | StackLimit | StackOutputsLimit Name *string `type:"string"` // The value that is associated with the account limit name. Value *int64 `type:"integer"` // contains filtered or unexported fields }
The AccountLimit data type.
CloudFormation has the following limits per account:
Number of concurrent resources
Number of stacks
Number of stack outputs
For more information about these account limits, and other CloudFormation limits, see AWS CloudFormation Limits (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) in the AWS CloudFormation User Guide.
func (AccountLimit) String ¶
func (s AccountLimit) String() string
String returns the string representation
type CancelUpdateStackInput ¶
type CancelUpdateStackInput struct { // A unique identifier for this CancelUpdateStack request. Specify this token // if you plan to retry requests so that AWS CloudFormation knows that you're // not attempting to cancel an update on a stack with the same name. You might // retry CancelUpdateStack requests to ensure that AWS CloudFormation successfully // received them. ClientRequestToken *string `min:"1" type:"string"` // The name or the unique stack ID that is associated with the stack. // // StackName is a required field StackName *string `type:"string" required:"true"` // contains filtered or unexported fields }
The input for the CancelUpdateStack action.
func (CancelUpdateStackInput) String ¶
func (s CancelUpdateStackInput) String() string
String returns the string representation
func (*CancelUpdateStackInput) Validate ¶
func (s *CancelUpdateStackInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CancelUpdateStackOutput ¶
type CancelUpdateStackOutput struct {
// contains filtered or unexported fields
}
func (CancelUpdateStackOutput) String ¶
func (s CancelUpdateStackOutput) String() string
String returns the string representation
type CancelUpdateStackRequest ¶
type CancelUpdateStackRequest struct { *aws.Request Input *CancelUpdateStackInput Copy func(*CancelUpdateStackInput) CancelUpdateStackRequest }
CancelUpdateStackRequest is the request type for the CancelUpdateStack API operation.
func (CancelUpdateStackRequest) Send ¶
func (r CancelUpdateStackRequest) Send(ctx context.Context) (*CancelUpdateStackResponse, error)
Send marshals and sends the CancelUpdateStack API request.
type CancelUpdateStackResponse ¶ added in v0.9.0
type CancelUpdateStackResponse struct { *CancelUpdateStackOutput // contains filtered or unexported fields }
CancelUpdateStackResponse is the response type for the CancelUpdateStack API operation.
func (*CancelUpdateStackResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CancelUpdateStackResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CancelUpdateStack request.
type Capability ¶
type Capability string
const ( CapabilityCapabilityIam Capability = "CAPABILITY_IAM" CapabilityCapabilityNamedIam Capability = "CAPABILITY_NAMED_IAM" CapabilityCapabilityAutoExpand Capability = "CAPABILITY_AUTO_EXPAND" )
Enum values for Capability
func (Capability) MarshalValue ¶ added in v0.3.0
func (enum Capability) MarshalValue() (string, error)
func (Capability) MarshalValueBuf ¶ added in v0.3.0
func (enum Capability) MarshalValueBuf(b []byte) ([]byte, error)
type Change ¶
type Change struct { // A ResourceChange structure that describes the resource and action that AWS // CloudFormation will perform. ResourceChange *ResourceChange `type:"structure"` // The type of entity that AWS CloudFormation changes. Currently, the only entity // type is Resource. Type ChangeType `type:"string" enum:"true"` // contains filtered or unexported fields }
The Change structure describes the changes AWS CloudFormation will perform if you execute the change set.
type ChangeAction ¶
type ChangeAction string
const ( ChangeActionAdd ChangeAction = "Add" ChangeActionModify ChangeAction = "Modify" ChangeActionRemove ChangeAction = "Remove" ChangeActionImport ChangeAction = "Import" )
Enum values for ChangeAction
func (ChangeAction) MarshalValue ¶ added in v0.3.0
func (enum ChangeAction) MarshalValue() (string, error)
func (ChangeAction) MarshalValueBuf ¶ added in v0.3.0
func (enum ChangeAction) MarshalValueBuf(b []byte) ([]byte, error)
type ChangeSetStatus ¶
type ChangeSetStatus string
const ( ChangeSetStatusCreatePending ChangeSetStatus = "CREATE_PENDING" ChangeSetStatusCreateInProgress ChangeSetStatus = "CREATE_IN_PROGRESS" ChangeSetStatusCreateComplete ChangeSetStatus = "CREATE_COMPLETE" ChangeSetStatusDeleteComplete ChangeSetStatus = "DELETE_COMPLETE" ChangeSetStatusFailed ChangeSetStatus = "FAILED" )
Enum values for ChangeSetStatus
func (ChangeSetStatus) MarshalValue ¶ added in v0.3.0
func (enum ChangeSetStatus) MarshalValue() (string, error)
func (ChangeSetStatus) MarshalValueBuf ¶ added in v0.3.0
func (enum ChangeSetStatus) MarshalValueBuf(b []byte) ([]byte, error)
type ChangeSetSummary ¶
type ChangeSetSummary struct { // The ID of the change set. ChangeSetId *string `min:"1" type:"string"` // The name of the change set. ChangeSetName *string `min:"1" type:"string"` // The start time when the change set was created, in UTC. CreationTime *time.Time `type:"timestamp"` // Descriptive information about the change set. Description *string `min:"1" type:"string"` // If the change set execution status is AVAILABLE, you can execute the change // set. If you can’t execute the change set, the status indicates why. For // example, a change set might be in an UNAVAILABLE state because AWS CloudFormation // is still creating it or in an OBSOLETE state because the stack was already // updated. ExecutionStatus ExecutionStatus `type:"string" enum:"true"` // The ID of the stack with which the change set is associated. StackId *string `type:"string"` // The name of the stack with which the change set is associated. StackName *string `type:"string"` // The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, // or FAILED. Status ChangeSetStatus `type:"string" enum:"true"` // A description of the change set's status. For example, if your change set // is in the FAILED state, AWS CloudFormation shows the error message. StatusReason *string `type:"string"` // contains filtered or unexported fields }
The ChangeSetSummary structure describes a change set, its status, and the stack with which it's associated.
func (ChangeSetSummary) String ¶
func (s ChangeSetSummary) String() string
String returns the string representation
type ChangeSetType ¶
type ChangeSetType string
const ( ChangeSetTypeCreate ChangeSetType = "CREATE" ChangeSetTypeUpdate ChangeSetType = "UPDATE" ChangeSetTypeImport ChangeSetType = "IMPORT" )
Enum values for ChangeSetType
func (ChangeSetType) MarshalValue ¶ added in v0.3.0
func (enum ChangeSetType) MarshalValue() (string, error)
func (ChangeSetType) MarshalValueBuf ¶ added in v0.3.0
func (enum ChangeSetType) MarshalValueBuf(b []byte) ([]byte, error)
type ChangeSource ¶
type ChangeSource string
const ( ChangeSourceResourceReference ChangeSource = "ResourceReference" ChangeSourceParameterReference ChangeSource = "ParameterReference" ChangeSourceResourceAttribute ChangeSource = "ResourceAttribute" ChangeSourceDirectModification ChangeSource = "DirectModification" ChangeSourceAutomatic ChangeSource = "Automatic" )
Enum values for ChangeSource
func (ChangeSource) MarshalValue ¶ added in v0.3.0
func (enum ChangeSource) MarshalValue() (string, error)
func (ChangeSource) MarshalValueBuf ¶ added in v0.3.0
func (enum ChangeSource) MarshalValueBuf(b []byte) ([]byte, error)
type ChangeType ¶
type ChangeType string
const (
ChangeTypeResource ChangeType = "Resource"
)
Enum values for ChangeType
func (ChangeType) MarshalValue ¶ added in v0.3.0
func (enum ChangeType) MarshalValue() (string, error)
func (ChangeType) MarshalValueBuf ¶ added in v0.3.0
func (enum ChangeType) MarshalValueBuf(b []byte) ([]byte, error)
type Client ¶ added in v0.9.0
Client provides the API operation methods for making requests to AWS CloudFormation. See this package's package overview docs for details on the service.
The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
New creates a new instance of the client from the provided Config.
Example:
// Create a client from just a config. svc := cloudformation.New(myConfig)
func (*Client) CancelUpdateStackRequest ¶ added in v0.9.0
func (c *Client) CancelUpdateStackRequest(input *CancelUpdateStackInput) CancelUpdateStackRequest
CancelUpdateStackRequest returns a request value for making API operation for AWS CloudFormation.
Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.
You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.
// Example sending a request using CancelUpdateStackRequest. req := client.CancelUpdateStackRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CancelUpdateStack
func (*Client) ContinueUpdateRollbackRequest ¶ added in v0.9.0
func (c *Client) ContinueUpdateRollbackRequest(input *ContinueUpdateRollbackInput) ContinueUpdateRollbackRequest
ContinueUpdateRollbackRequest returns a request value for making API operation for AWS CloudFormation.
For a specified stack that is in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the error (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed) and continue the rollback. By continuing the rollback, you can return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again.
A stack goes into the UPDATE_ROLLBACK_FAILED state when AWS CloudFormation cannot roll back all changes after a failed stack update. For example, you might have a stack that is rolling back to an old database instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail.
// Example sending a request using ContinueUpdateRollbackRequest. req := client.ContinueUpdateRollbackRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ContinueUpdateRollback
func (*Client) CreateChangeSetRequest ¶ added in v0.9.0
func (c *Client) CreateChangeSetRequest(input *CreateChangeSetInput) CreateChangeSetRequest
CreateChangeSetRequest returns a request value for making API operation for AWS CloudFormation.
Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that AWS CloudFormation will create. If you create a change set for an existing stack, AWS CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources AWS CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack.
To create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify CREATE. To create a change set for an existing stack, specify UPDATE for the ChangeSetType parameter. To create a change set for an import operation, specify IMPORT for the ChangeSetType parameter. After the CreateChangeSet call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet action.
When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. AWS CloudFormation doesn't make changes until you execute the change set.
// Example sending a request using CreateChangeSetRequest. req := client.CreateChangeSetRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet
func (*Client) CreateStackInstancesRequest ¶ added in v0.9.0
func (c *Client) CreateStackInstancesRequest(input *CreateStackInstancesInput) CreateStackInstancesRequest
CreateStackInstancesRequest returns a request value for making API operation for AWS CloudFormation.
Creates stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region. Accounts and Regions are required parameters—you must specify at least one account and one region.
// Example sending a request using CreateStackInstancesRequest. req := client.CreateStackInstancesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateStackInstances
func (*Client) CreateStackRequest ¶ added in v0.9.0
func (c *Client) CreateStackRequest(input *CreateStackInput) CreateStackRequest
CreateStackRequest returns a request value for making API operation for AWS CloudFormation.
Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the DescribeStacks API.
// Example sending a request using CreateStackRequest. req := client.CreateStackRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateStack
func (*Client) CreateStackSetRequest ¶ added in v0.9.0
func (c *Client) CreateStackSetRequest(input *CreateStackSetInput) CreateStackSetRequest
CreateStackSetRequest returns a request value for making API operation for AWS CloudFormation.
Creates a stack set.
// Example sending a request using CreateStackSetRequest. req := client.CreateStackSetRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateStackSet
func (*Client) DeleteChangeSetRequest ¶ added in v0.9.0
func (c *Client) DeleteChangeSetRequest(input *DeleteChangeSetInput) DeleteChangeSetRequest
DeleteChangeSetRequest returns a request value for making API operation for AWS CloudFormation.
Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.
If the call successfully completes, AWS CloudFormation successfully deleted the change set.
// Example sending a request using DeleteChangeSetRequest. req := client.DeleteChangeSetRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteChangeSet
func (*Client) DeleteStackInstancesRequest ¶ added in v0.9.0
func (c *Client) DeleteStackInstancesRequest(input *DeleteStackInstancesInput) DeleteStackInstancesRequest
DeleteStackInstancesRequest returns a request value for making API operation for AWS CloudFormation.
Deletes stack instances for the specified accounts, in the specified regions.
// Example sending a request using DeleteStackInstancesRequest. req := client.DeleteStackInstancesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteStackInstances
func (*Client) DeleteStackRequest ¶ added in v0.9.0
func (c *Client) DeleteStackRequest(input *DeleteStackInput) DeleteStackRequest
DeleteStackRequest returns a request value for making API operation for AWS CloudFormation.
Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the DescribeStacks API if the deletion has been completed successfully.
// Example sending a request using DeleteStackRequest. req := client.DeleteStackRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteStack
func (*Client) DeleteStackSetRequest ¶ added in v0.9.0
func (c *Client) DeleteStackSetRequest(input *DeleteStackSetInput) DeleteStackSetRequest
DeleteStackSetRequest returns a request value for making API operation for AWS CloudFormation.
Deletes a stack set. Before you can delete a stack set, all of its member stack instances must be deleted. For more information about how to do this, see DeleteStackInstances.
// Example sending a request using DeleteStackSetRequest. req := client.DeleteStackSetRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteStackSet
func (*Client) DescribeAccountLimitsRequest ¶ added in v0.9.0
func (c *Client) DescribeAccountLimitsRequest(input *DescribeAccountLimitsInput) DescribeAccountLimitsRequest
DescribeAccountLimitsRequest returns a request value for making API operation for AWS CloudFormation.
Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see AWS CloudFormation Limits (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) in the AWS CloudFormation User Guide.
// Example sending a request using DescribeAccountLimitsRequest. req := client.DescribeAccountLimitsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeAccountLimits
func (*Client) DescribeChangeSetRequest ¶ added in v0.9.0
func (c *Client) DescribeChangeSetRequest(input *DescribeChangeSetInput) DescribeChangeSetRequest
DescribeChangeSetRequest returns a request value for making API operation for AWS CloudFormation.
Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html) in the AWS CloudFormation User Guide.
// Example sending a request using DescribeChangeSetRequest. req := client.DescribeChangeSetRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeChangeSet
func (*Client) DescribeStackDriftDetectionStatusRequest ¶ added in v0.9.0
func (c *Client) DescribeStackDriftDetectionStatusRequest(input *DescribeStackDriftDetectionStatusInput) DescribeStackDriftDetectionStatusRequest
DescribeStackDriftDetectionStatusRequest returns a request value for making API operation for AWS CloudFormation.
Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information on stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html).
Use DetectStackDrift to initiate a stack drift detection operation. DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of the operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.
// Example sending a request using DescribeStackDriftDetectionStatusRequest. req := client.DescribeStackDriftDetectionStatusRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackDriftDetectionStatus
func (*Client) DescribeStackEventsRequest ¶ added in v0.9.0
func (c *Client) DescribeStackEventsRequest(input *DescribeStackEventsInput) DescribeStackEventsRequest
DescribeStackEventsRequest returns a request value for making API operation for AWS CloudFormation.
Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to Stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html) in the AWS CloudFormation User Guide.
You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).
// Example sending a request using DescribeStackEventsRequest. req := client.DescribeStackEventsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackEvents
func (*Client) DescribeStackInstanceRequest ¶ added in v0.9.0
func (c *Client) DescribeStackInstanceRequest(input *DescribeStackInstanceInput) DescribeStackInstanceRequest
DescribeStackInstanceRequest returns a request value for making API operation for AWS CloudFormation.
Returns the stack instance that's associated with the specified stack set, AWS account, and region.
For a list of stack instances that are associated with a specific stack set, use ListStackInstances.
// Example sending a request using DescribeStackInstanceRequest. req := client.DescribeStackInstanceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackInstance
func (*Client) DescribeStackResourceDriftsRequest ¶ added in v0.9.0
func (c *Client) DescribeStackResourceDriftsRequest(input *DescribeStackResourceDriftsInput) DescribeStackResourceDriftsRequest
DescribeStackResourceDriftsRequest returns a request value for making API operation for AWS CloudFormation.
Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where AWS CloudFormation detects configuration drift.
For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that have not yet been checked for drift are not included. Resources that do not currently support drift detection are not checked, and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html).
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.
// Example sending a request using DescribeStackResourceDriftsRequest. req := client.DescribeStackResourceDriftsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackResourceDrifts
func (*Client) DescribeStackResourceRequest ¶ added in v0.9.0
func (c *Client) DescribeStackResourceRequest(input *DescribeStackResourceInput) DescribeStackResourceRequest
DescribeStackResourceRequest returns a request value for making API operation for AWS CloudFormation.
Returns a description of the specified resource in the specified stack.
For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.
// Example sending a request using DescribeStackResourceRequest. req := client.DescribeStackResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackResource
func (*Client) DescribeStackResourcesRequest ¶ added in v0.9.0
func (c *Client) DescribeStackResourcesRequest(input *DescribeStackResourcesInput) DescribeStackResourcesRequest
DescribeStackResourcesRequest returns a request value for making API operation for AWS CloudFormation.
Returns AWS resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId is specified, the associated resources of the stack that the resource belongs to are returned.
Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources instead.
For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the stack has been deleted.
You must specify either StackName or PhysicalResourceId, but not both. In addition, you can specify LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and PhysicalResourceId, go to the AWS CloudFormation User Guide (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/).
A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.
// Example sending a request using DescribeStackResourcesRequest. req := client.DescribeStackResourcesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackResources
func (*Client) DescribeStackSetOperationRequest ¶ added in v0.9.0
func (c *Client) DescribeStackSetOperationRequest(input *DescribeStackSetOperationInput) DescribeStackSetOperationRequest
DescribeStackSetOperationRequest returns a request value for making API operation for AWS CloudFormation.
Returns the description of the specified stack set operation.
// Example sending a request using DescribeStackSetOperationRequest. req := client.DescribeStackSetOperationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackSetOperation
func (*Client) DescribeStackSetRequest ¶ added in v0.9.0
func (c *Client) DescribeStackSetRequest(input *DescribeStackSetInput) DescribeStackSetRequest
DescribeStackSetRequest returns a request value for making API operation for AWS CloudFormation.
Returns the description of the specified stack set.
// Example sending a request using DescribeStackSetRequest. req := client.DescribeStackSetRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackSet
func (*Client) DescribeStacksRequest ¶ added in v0.9.0
func (c *Client) DescribeStacksRequest(input *DescribeStacksInput) DescribeStacksRequest
DescribeStacksRequest returns a request value for making API operation for AWS CloudFormation.
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
If the stack does not exist, an AmazonCloudFormationException is returned.
// Example sending a request using DescribeStacksRequest. req := client.DescribeStacksRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStacks
func (*Client) DetectStackDriftRequest ¶ added in v0.9.0
func (c *Client) DetectStackDriftRequest(input *DetectStackDriftInput) DetectStackDriftRequest
DetectStackDriftRequest returns a request value for making API operation for AWS CloudFormation.
Detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, AWS CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html).
Use DetectStackDrift to detect drift on all supported resources for a given stack, or DetectStackResourceDrift to detect drift on individual resources.
For a list of stack resources that currently support drift detection, see Resources that Support Drift Detection (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html).
DetectStackDrift can take up to several minutes, depending on the number of resources contained within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.
When detecting drift on a stack, AWS CloudFormation does not detect drift on any nested stacks belonging to that stack. Perform DetectStackDrift directly on the nested stack itself.
// Example sending a request using DetectStackDriftRequest. req := client.DetectStackDriftRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DetectStackDrift
func (*Client) DetectStackResourceDriftRequest ¶ added in v0.9.0
func (c *Client) DetectStackResourceDriftRequest(input *DetectStackResourceDriftInput) DetectStackResourceDriftRequest
DetectStackResourceDriftRequest returns a request value for making API operation for AWS CloudFormation.
Returns information about whether a resource's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which AWS CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html).
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
Resources that do not currently support drift detection cannot be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html).
// Example sending a request using DetectStackResourceDriftRequest. req := client.DetectStackResourceDriftRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DetectStackResourceDrift
func (*Client) EstimateTemplateCostRequest ¶ added in v0.9.0
func (c *Client) EstimateTemplateCostRequest(input *EstimateTemplateCostInput) EstimateTemplateCostRequest
EstimateTemplateCostRequest returns a request value for making API operation for AWS CloudFormation.
Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
// Example sending a request using EstimateTemplateCostRequest. req := client.EstimateTemplateCostRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/EstimateTemplateCost
func (*Client) ExecuteChangeSetRequest ¶ added in v0.9.0
func (c *Client) ExecuteChangeSetRequest(input *ExecuteChangeSetInput) ExecuteChangeSetRequest
ExecuteChangeSetRequest returns a request value for making API operation for AWS CloudFormation.
Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, AWS CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.
When you execute a change set, AWS CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.
If a stack policy is associated with the stack, AWS CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.
// Example sending a request using ExecuteChangeSetRequest. req := client.ExecuteChangeSetRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ExecuteChangeSet
func (*Client) GetStackPolicyRequest ¶ added in v0.9.0
func (c *Client) GetStackPolicyRequest(input *GetStackPolicyInput) GetStackPolicyRequest
GetStackPolicyRequest returns a request value for making API operation for AWS CloudFormation.
Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
// Example sending a request using GetStackPolicyRequest. req := client.GetStackPolicyRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/GetStackPolicy
func (*Client) GetTemplateRequest ¶ added in v0.9.0
func (c *Client) GetTemplateRequest(input *GetTemplateInput) GetTemplateRequest
GetTemplateRequest returns a request value for making API operation for AWS CloudFormation.
Returns the template body for a specified stack. You can get the template for running or deleted stacks.
For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.
If the template does not exist, a ValidationError is returned.
// Example sending a request using GetTemplateRequest. req := client.GetTemplateRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/GetTemplate
func (*Client) GetTemplateSummaryRequest ¶ added in v0.9.0
func (c *Client) GetTemplateSummaryRequest(input *GetTemplateSummaryInput) GetTemplateSummaryRequest
GetTemplateSummaryRequest returns a request value for making API operation for AWS CloudFormation.
Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or stack set.
You can use the GetTemplateSummary action when you submit a template, or you can get template information for a stack set, or a running or deleted stack.
For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a ValidationError is returned.
// Example sending a request using GetTemplateSummaryRequest. req := client.GetTemplateSummaryRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/GetTemplateSummary
func (*Client) ListChangeSetsRequest ¶ added in v0.9.0
func (c *Client) ListChangeSetsRequest(input *ListChangeSetsInput) ListChangeSetsRequest
ListChangeSetsRequest returns a request value for making API operation for AWS CloudFormation.
Returns the ID and status of each active change set for a stack. For example, AWS CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.
// Example sending a request using ListChangeSetsRequest. req := client.ListChangeSetsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListChangeSets
func (*Client) ListExportsRequest ¶ added in v0.9.0
func (c *Client) ListExportsRequest(input *ListExportsInput) ListExportsRequest
ListExportsRequest returns a request value for making API operation for AWS CloudFormation.
Lists all exported output values in the account and region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the Fn::ImportValue (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html) function.
For more information, see AWS CloudFormation Export Stack Output Values (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-exports.html).
// Example sending a request using ListExportsRequest. req := client.ListExportsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListExports
func (*Client) ListImportsRequest ¶ added in v0.9.0
func (c *Client) ListImportsRequest(input *ListImportsInput) ListImportsRequest
ListImportsRequest returns a request value for making API operation for AWS CloudFormation.
Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports.
For more information about importing an exported output value, see the Fn::ImportValue (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html) function.
// Example sending a request using ListImportsRequest. req := client.ListImportsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListImports
func (*Client) ListStackInstancesRequest ¶ added in v0.9.0
func (c *Client) ListStackInstancesRequest(input *ListStackInstancesInput) ListStackInstancesRequest
ListStackInstancesRequest returns a request value for making API operation for AWS CloudFormation.
Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific AWS account name or region.
// Example sending a request using ListStackInstancesRequest. req := client.ListStackInstancesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackInstances
func (*Client) ListStackResourcesRequest ¶ added in v0.9.0
func (c *Client) ListStackResourcesRequest(input *ListStackResourcesInput) ListStackResourcesRequest
ListStackResourcesRequest returns a request value for making API operation for AWS CloudFormation.
Returns descriptions of all resources of the specified stack.
For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.
// Example sending a request using ListStackResourcesRequest. req := client.ListStackResourcesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackResources
func (*Client) ListStackSetOperationResultsRequest ¶ added in v0.9.0
func (c *Client) ListStackSetOperationResultsRequest(input *ListStackSetOperationResultsInput) ListStackSetOperationResultsRequest
ListStackSetOperationResultsRequest returns a request value for making API operation for AWS CloudFormation.
Returns summary information about the results of a stack set operation.
// Example sending a request using ListStackSetOperationResultsRequest. req := client.ListStackSetOperationResultsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackSetOperationResults
func (*Client) ListStackSetOperationsRequest ¶ added in v0.9.0
func (c *Client) ListStackSetOperationsRequest(input *ListStackSetOperationsInput) ListStackSetOperationsRequest
ListStackSetOperationsRequest returns a request value for making API operation for AWS CloudFormation.
Returns summary information about operations performed on a stack set.
// Example sending a request using ListStackSetOperationsRequest. req := client.ListStackSetOperationsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackSetOperations
func (*Client) ListStackSetsRequest ¶ added in v0.9.0
func (c *Client) ListStackSetsRequest(input *ListStackSetsInput) ListStackSetsRequest
ListStackSetsRequest returns a request value for making API operation for AWS CloudFormation.
Returns summary information about stack sets that are associated with the user.
// Example sending a request using ListStackSetsRequest. req := client.ListStackSetsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackSets
func (*Client) ListStacksRequest ¶ added in v0.9.0
func (c *Client) ListStacksRequest(input *ListStacksInput) ListStacksRequest
ListStacksRequest returns a request value for making API operation for AWS CloudFormation.
Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).
// Example sending a request using ListStacksRequest. req := client.ListStacksRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStacks
func (*Client) SetStackPolicyRequest ¶ added in v0.9.0
func (c *Client) SetStackPolicyRequest(input *SetStackPolicyInput) SetStackPolicyRequest
SetStackPolicyRequest returns a request value for making API operation for AWS CloudFormation.
Sets a stack policy for a specified stack.
// Example sending a request using SetStackPolicyRequest. req := client.SetStackPolicyRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SetStackPolicy
func (*Client) SignalResourceRequest ¶ added in v0.9.0
func (c *Client) SignalResourceRequest(input *SignalResourceInput) SignalResourceRequest
SignalResourceRequest returns a request value for making API operation for AWS CloudFormation.
Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.
// Example sending a request using SignalResourceRequest. req := client.SignalResourceRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SignalResource
func (*Client) StopStackSetOperationRequest ¶ added in v0.9.0
func (c *Client) StopStackSetOperationRequest(input *StopStackSetOperationInput) StopStackSetOperationRequest
StopStackSetOperationRequest returns a request value for making API operation for AWS CloudFormation.
Stops an in-progress operation on a stack set and its associated stack instances.
// Example sending a request using StopStackSetOperationRequest. req := client.StopStackSetOperationRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StopStackSetOperation
func (*Client) UpdateStackInstancesRequest ¶ added in v0.9.0
func (c *Client) UpdateStackInstancesRequest(input *UpdateStackInstancesInput) UpdateStackInstancesRequest
UpdateStackInstancesRequest returns a request value for making API operation for AWS CloudFormation.
Updates the parameter values for stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region.
You can only update stack instances in regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStackInstances.html).
During stack set updates, any parameters overridden for a stack instance are not updated, but retain their overridden value.
You can only update the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html) to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html) to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.
// Example sending a request using UpdateStackInstancesRequest. req := client.UpdateStackInstancesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateStackInstances
func (*Client) UpdateStackRequest ¶ added in v0.9.0
func (c *Client) UpdateStackRequest(input *UpdateStackInput) UpdateStackRequest
UpdateStackRequest returns a request value for making API operation for AWS CloudFormation.
Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the DescribeStacks action.
To get a copy of the template for an existing stack, you can use the GetTemplate action.
For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html).
// Example sending a request using UpdateStackRequest. req := client.UpdateStackRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateStack
func (*Client) UpdateStackSetRequest ¶ added in v0.9.0
func (c *Client) UpdateStackSetRequest(input *UpdateStackSetInput) UpdateStackSetRequest
UpdateStackSetRequest returns a request value for making API operation for AWS CloudFormation.
Updates the stack set, and associated stack instances in the specified accounts and regions.
Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.
// Example sending a request using UpdateStackSetRequest. req := client.UpdateStackSetRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateStackSet
func (*Client) UpdateTerminationProtectionRequest ¶ added in v0.9.0
func (c *Client) UpdateTerminationProtectionRequest(input *UpdateTerminationProtectionInput) UpdateTerminationProtectionRequest
UpdateTerminationProtectionRequest returns a request value for making API operation for AWS CloudFormation.
Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) in the AWS CloudFormation User Guide.
For nested stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html), termination protection is set on the root stack and cannot be changed directly on the nested stack.
// Example sending a request using UpdateTerminationProtectionRequest. req := client.UpdateTerminationProtectionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateTerminationProtection
func (*Client) ValidateTemplateRequest ¶ added in v0.9.0
func (c *Client) ValidateTemplateRequest(input *ValidateTemplateInput) ValidateTemplateRequest
ValidateTemplateRequest returns a request value for making API operation for AWS CloudFormation.
Validates a specified template. AWS CloudFormation first checks if the template is valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. If both these checks fail, AWS CloudFormation returns a template validation error.
// Example sending a request using ValidateTemplateRequest. req := client.ValidateTemplateRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ValidateTemplate
func (*Client) WaitUntilChangeSetCreateComplete ¶ added in v0.9.0
func (c *Client) WaitUntilChangeSetCreateComplete(ctx context.Context, input *DescribeChangeSetInput, opts ...aws.WaiterOption) error
WaitUntilChangeSetCreateComplete uses the AWS CloudFormation API operation DescribeChangeSet to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Client) WaitUntilStackCreateComplete ¶ added in v0.9.0
func (c *Client) WaitUntilStackCreateComplete(ctx context.Context, input *DescribeStacksInput, opts ...aws.WaiterOption) error
WaitUntilStackCreateComplete uses the AWS CloudFormation API operation DescribeStacks to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Client) WaitUntilStackDeleteComplete ¶ added in v0.9.0
func (c *Client) WaitUntilStackDeleteComplete(ctx context.Context, input *DescribeStacksInput, opts ...aws.WaiterOption) error
WaitUntilStackDeleteComplete uses the AWS CloudFormation API operation DescribeStacks to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Client) WaitUntilStackExists ¶ added in v0.9.0
func (c *Client) WaitUntilStackExists(ctx context.Context, input *DescribeStacksInput, opts ...aws.WaiterOption) error
WaitUntilStackExists uses the AWS CloudFormation API operation DescribeStacks to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Client) WaitUntilStackImportComplete ¶ added in v0.16.0
func (c *Client) WaitUntilStackImportComplete(ctx context.Context, input *DescribeStacksInput, opts ...aws.WaiterOption) error
WaitUntilStackImportComplete uses the AWS CloudFormation API operation DescribeStacks to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Client) WaitUntilStackUpdateComplete ¶ added in v0.9.0
func (c *Client) WaitUntilStackUpdateComplete(ctx context.Context, input *DescribeStacksInput, opts ...aws.WaiterOption) error
WaitUntilStackUpdateComplete uses the AWS CloudFormation API operation DescribeStacks to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
type ContinueUpdateRollbackInput ¶
type ContinueUpdateRollbackInput struct { // A unique identifier for this ContinueUpdateRollback request. Specify this // token if you plan to retry requests so that AWS CloudFormation knows that // you're not attempting to continue the rollback to a stack with the same name. // You might retry ContinueUpdateRollback requests to ensure that AWS CloudFormation // successfully received them. ClientRequestToken *string `min:"1" type:"string"` // A list of the logical IDs of the resources that AWS CloudFormation skips // during the continue update rollback operation. You can specify only resources // that are in the UPDATE_FAILED state because a rollback failed. You can't // specify resources that are in the UPDATE_FAILED state for other reasons, // for example, because an update was cancelled. To check why a resource update // failed, use the DescribeStackResources action, and view the resource status // reason. // // Specify this property to skip rolling back resources that AWS CloudFormation // can't successfully roll back. We recommend that you troubleshoot (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed) // resources before skipping them. AWS CloudFormation sets the status of the // specified resources to UPDATE_COMPLETE and continues to roll back the stack. // After the rollback is complete, the state of the skipped resources will be // inconsistent with the state of the resources in the stack template. Before // performing another stack update, you must update the stack or resources to // be consistent with each other. If you don't, subsequent stack updates might // fail, and the stack will become unrecoverable. // // Specify the minimum number of resources required to successfully roll back // your stack. For example, a failed resource update might cause dependent resources // to fail. In this case, it might not be necessary to skip the dependent resources. // // To skip resources that are part of nested stacks, use the following format: // NestedStackName.ResourceLogicalID. If you want to specify the logical ID // of a stack resource (Type: AWS::CloudFormation::Stack) in the ResourcesToSkip // list, then its corresponding embedded stack must be in one of the following // states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or DELETE_FAILED. // // Don't confuse a child stack's name with its corresponding logical ID defined // in the parent stack. For an example of a continue update rollback operation // with nested stacks, see Using ResourcesToSkip to recover a nested stacks // hierarchy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html#nested-stacks). ResourcesToSkip []string `type:"list"` // The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) // role that AWS CloudFormation assumes to roll back the stack. AWS CloudFormation // uses the role's credentials to make calls on your behalf. AWS CloudFormation // always uses this role for all future operations on the stack. As long as // users have permission to operate on the stack, AWS CloudFormation uses this // role even if the users don't have permission to pass it. Ensure that the // role grants least privilege. // // If you don't specify a value, AWS CloudFormation uses the role that was previously // associated with the stack. If no role is available, AWS CloudFormation uses // a temporary session that is generated from your user credentials. RoleARN *string `min:"20" type:"string"` // The name or the unique ID of the stack that you want to continue rolling // back. // // Don't specify the name of a nested stack (a stack that was created by using // the AWS::CloudFormation::Stack resource). Instead, use this operation on // the parent stack (the stack that contains the AWS::CloudFormation::Stack // resource). // // StackName is a required field StackName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The input for the ContinueUpdateRollback action.
func (ContinueUpdateRollbackInput) String ¶
func (s ContinueUpdateRollbackInput) String() string
String returns the string representation
func (*ContinueUpdateRollbackInput) Validate ¶
func (s *ContinueUpdateRollbackInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ContinueUpdateRollbackOutput ¶
type ContinueUpdateRollbackOutput struct {
// contains filtered or unexported fields
}
The output for a ContinueUpdateRollback action.
func (ContinueUpdateRollbackOutput) String ¶
func (s ContinueUpdateRollbackOutput) String() string
String returns the string representation
type ContinueUpdateRollbackRequest ¶
type ContinueUpdateRollbackRequest struct { *aws.Request Input *ContinueUpdateRollbackInput Copy func(*ContinueUpdateRollbackInput) ContinueUpdateRollbackRequest }
ContinueUpdateRollbackRequest is the request type for the ContinueUpdateRollback API operation.
func (ContinueUpdateRollbackRequest) Send ¶
func (r ContinueUpdateRollbackRequest) Send(ctx context.Context) (*ContinueUpdateRollbackResponse, error)
Send marshals and sends the ContinueUpdateRollback API request.
type ContinueUpdateRollbackResponse ¶ added in v0.9.0
type ContinueUpdateRollbackResponse struct { *ContinueUpdateRollbackOutput // contains filtered or unexported fields }
ContinueUpdateRollbackResponse is the response type for the ContinueUpdateRollback API operation.
func (*ContinueUpdateRollbackResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ContinueUpdateRollbackResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ContinueUpdateRollback request.
type CreateChangeSetInput ¶
type CreateChangeSetInput struct { // In some cases, you must explicitly acknowledge that your stack template contains // certain capabilities in order for AWS CloudFormation to create the stack. // // * CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include // resources that can affect permissions in your AWS account; for example, // by creating new AWS Identity and Access Management (IAM) users. For those // stacks, you must explicitly acknowledge this by specifying one of these // capabilities. The following IAM resources require you to specify either // the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. If you have IAM // resources, you can specify either capability. If you have IAM resources // with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't // specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities // error. If your stack template contains these resources, we recommend that // you review all permissions associated with them and edit their permissions // if necessary. AWS::IAM::AccessKey (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html) // AWS::IAM::Group (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html) // AWS::IAM::InstanceProfile (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html) // AWS::IAM::Policy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html) // AWS::IAM::Role (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html) // AWS::IAM::User (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html) // AWS::IAM::UserToGroupAddition (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html) // For more information, see Acknowledging IAM Resources in AWS CloudFormation // Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). // // * CAPABILITY_AUTO_EXPAND Some template contain macros. Macros perform // custom processing on templates; this can include simple actions like find-and-replace // operations, all the way to extensive transformations of entire templates. // Because of this, users typically create a change set from the processed // template, so that they can review the changes resulting from the macros // before actually creating the stack. If your stack template contains one // or more macros, and you choose to create a stack directly from the processed // template, without first reviewing the resulting changes in a change set, // you must acknowledge this capability. This includes the AWS::Include (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) // and AWS::Serverless (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) // transforms, which are macros hosted by AWS CloudFormation. This capacity // does not apply to creating change sets, and specifying it when creating // change sets has no effect. Also, change sets do not currently support // nested stacks. If you want to create a stack from a stack template that // contains macros and nested stacks, you must create or update the stack // directly from the template using the CreateStack or UpdateStack action, // and specifying this capability. For more information on macros, see Using // AWS CloudFormation Macros to Perform Custom Processing on Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html). Capabilities []Capability `type:"list"` // The name of the change set. The name must be unique among all change sets // that are associated with the specified stack. // // A change set name can contain only alphanumeric, case sensitive characters // and hyphens. It must start with an alphabetic character and cannot exceed // 128 characters. // // ChangeSetName is a required field ChangeSetName *string `min:"1" type:"string" required:"true"` // The type of change set operation. To create a change set for a new stack, // specify CREATE. To create a change set for an existing stack, specify UPDATE. // To create a change set for an import operation, specify IMPORT. // // If you create a change set for a new stack, AWS Cloudformation creates a // stack with a unique stack ID, but no template or resources. The stack will // be in the REVIEW_IN_PROGRESS (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-describing-stacks.html#d0e11995) // state until you execute the change set. // // By default, AWS CloudFormation specifies UPDATE. You can't use the UPDATE // type to create a change set for a new stack or the CREATE type to create // a change set for an existing stack. ChangeSetType ChangeSetType `type:"string" enum:"true"` // A unique identifier for this CreateChangeSet request. Specify this token // if you plan to retry requests so that AWS CloudFormation knows that you're // not attempting to create another change set with the same name. You might // retry CreateChangeSet requests to ensure that AWS CloudFormation successfully // received them. ClientToken *string `min:"1" type:"string"` // A description to help you identify this change set. Description *string `min:"1" type:"string"` // The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon // SNS) topics that AWS CloudFormation associates with the stack. To remove // all associated notification topics, specify an empty list. NotificationARNs []string `type:"list"` // A list of Parameter structures that specify input parameters for the change // set. For more information, see the Parameter data type. Parameters []Parameter `type:"list"` // The template resource types that you have permissions to work with if you // execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. // // If the list of resource types doesn't include a resource type that you're // updating, the stack update fails. By default, AWS CloudFormation grants permissions // to all resource types. AWS Identity and Access Management (IAM) uses this // parameter for condition keys in IAM policies for AWS CloudFormation. For // more information, see Controlling Access with AWS Identity and Access Management // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html) // in the AWS CloudFormation User Guide. ResourceTypes []string `type:"list"` // The resources to import into your stack. ResourcesToImport []ResourceToImport `type:"list"` // The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) // role that AWS CloudFormation assumes when executing the change set. AWS CloudFormation // uses the role's credentials to make calls on your behalf. AWS CloudFormation // uses this role for all future operations on the stack. As long as users have // permission to operate on the stack, AWS CloudFormation uses this role even // if the users don't have permission to pass it. Ensure that the role grants // least privilege. // // If you don't specify a value, AWS CloudFormation uses the role that was previously // associated with the stack. If no role is available, AWS CloudFormation uses // a temporary session that is generated from your user credentials. RoleARN *string `min:"20" type:"string"` // The rollback triggers for AWS CloudFormation to monitor during stack creation // and updating operations, and for the specified monitoring period afterwards. RollbackConfiguration *RollbackConfiguration `type:"structure"` // The name or the unique ID of the stack for which you are creating a change // set. AWS CloudFormation generates the change set by comparing this stack's // information with the information that you submit, such as a modified template // or different parameter input values. // // StackName is a required field StackName *string `min:"1" type:"string" required:"true"` // Key-value pairs to associate with this stack. AWS CloudFormation also propagates // these tags to resources in the stack. You can specify a maximum of 50 tags. Tags []Tag `type:"list"` // A structure that contains the body of the revised template, with a minimum // length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation // generates the change set by comparing this template with the template of // the stack that you specified. // // Conditional: You must specify only TemplateBody or TemplateURL. TemplateBody *string `min:"1" type:"string"` // The location of the file that contains the revised template. The URL must // point to a template (max size: 460,800 bytes) that is located in an S3 bucket. // AWS CloudFormation generates the change set by comparing this template with // the stack that you specified. // // Conditional: You must specify only TemplateBody or TemplateURL. TemplateURL *string `min:"1" type:"string"` // Whether to reuse the template that is associated with the stack to create // the change set. UsePreviousTemplate *bool `type:"boolean"` // contains filtered or unexported fields }
The input for the CreateChangeSet action.
func (CreateChangeSetInput) String ¶
func (s CreateChangeSetInput) String() string
String returns the string representation
func (*CreateChangeSetInput) Validate ¶
func (s *CreateChangeSetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateChangeSetOutput ¶
type CreateChangeSetOutput struct { // The Amazon Resource Name (ARN) of the change set. Id *string `min:"1" type:"string"` // The unique ID of the stack. StackId *string `type:"string"` // contains filtered or unexported fields }
The output for the CreateChangeSet action.
func (CreateChangeSetOutput) String ¶
func (s CreateChangeSetOutput) String() string
String returns the string representation
type CreateChangeSetRequest ¶
type CreateChangeSetRequest struct { *aws.Request Input *CreateChangeSetInput Copy func(*CreateChangeSetInput) CreateChangeSetRequest }
CreateChangeSetRequest is the request type for the CreateChangeSet API operation.
func (CreateChangeSetRequest) Send ¶
func (r CreateChangeSetRequest) Send(ctx context.Context) (*CreateChangeSetResponse, error)
Send marshals and sends the CreateChangeSet API request.
type CreateChangeSetResponse ¶ added in v0.9.0
type CreateChangeSetResponse struct { *CreateChangeSetOutput // contains filtered or unexported fields }
CreateChangeSetResponse is the response type for the CreateChangeSet API operation.
func (*CreateChangeSetResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateChangeSetResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateChangeSet request.
type CreateStackInput ¶
type CreateStackInput struct { // In some cases, you must explicitly acknowledge that your stack template contains // certain capabilities in order for AWS CloudFormation to create the stack. // // * CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include // resources that can affect permissions in your AWS account; for example, // by creating new AWS Identity and Access Management (IAM) users. For those // stacks, you must explicitly acknowledge this by specifying one of these // capabilities. The following IAM resources require you to specify either // the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. If you have IAM // resources, you can specify either capability. If you have IAM resources // with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't // specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities // error. If your stack template contains these resources, we recommend that // you review all permissions associated with them and edit their permissions // if necessary. AWS::IAM::AccessKey (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html) // AWS::IAM::Group (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html) // AWS::IAM::InstanceProfile (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html) // AWS::IAM::Policy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html) // AWS::IAM::Role (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html) // AWS::IAM::User (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html) // AWS::IAM::UserToGroupAddition (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html) // For more information, see Acknowledging IAM Resources in AWS CloudFormation // Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). // // * CAPABILITY_AUTO_EXPAND Some template contain macros. Macros perform // custom processing on templates; this can include simple actions like find-and-replace // operations, all the way to extensive transformations of entire templates. // Because of this, users typically create a change set from the processed // template, so that they can review the changes resulting from the macros // before actually creating the stack. If your stack template contains one // or more macros, and you choose to create a stack directly from the processed // template, without first reviewing the resulting changes in a change set, // you must acknowledge this capability. This includes the AWS::Include (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) // and AWS::Serverless (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) // transforms, which are macros hosted by AWS CloudFormation. Change sets // do not currently support nested stacks. If you want to create a stack // from a stack template that contains macros and nested stacks, you must // create the stack directly from the template using this capability. You // should only create stacks directly from a stack template that contains // macros if you know what processing the macro performs. Each macro relies // on an underlying Lambda service function for processing stack templates. // Be aware that the Lambda function owner can update the function operation // without AWS CloudFormation being notified. For more information, see Using // AWS CloudFormation Macros to Perform Custom Processing on Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html). Capabilities []Capability `type:"list"` // A unique identifier for this CreateStack request. Specify this token if you // plan to retry requests so that AWS CloudFormation knows that you're not attempting // to create a stack with the same name. You might retry CreateStack requests // to ensure that AWS CloudFormation successfully received them. // // All events triggered by a given stack operation are assigned the same client // request token, which you can use to track operations. For example, if you // execute a CreateStack operation with the token token1, then all the StackEvents // generated by that operation will have ClientRequestToken set as token1. // // In the console, stack operations display the client request token on the // Events tab. Stack operations that are initiated from the console use the // token format Console-StackOperation-ID, which helps you easily identify the // stack operation . For example, if you create a stack using the console, each // stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. ClientRequestToken *string `min:"1" type:"string"` // Set to true to disable rollback of the stack if stack creation failed. You // can specify either DisableRollback or OnFailure, but not both. // // Default: false DisableRollback *bool `type:"boolean"` // Whether to enable termination protection on the specified stack. If a user // attempts to delete a stack with termination protection enabled, the operation // fails and the stack remains unchanged. For more information, see Protecting // a Stack From Being Deleted (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) // in the AWS CloudFormation User Guide. Termination protection is disabled // on stacks by default. // // For nested stacks (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html), // termination protection is set on the root stack and cannot be changed directly // on the nested stack. EnableTerminationProtection *bool `type:"boolean"` // The Simple Notification Service (SNS) topic ARNs to publish stack related // events. You can find your SNS topic ARNs using the SNS console or your Command // Line Interface (CLI). NotificationARNs []string `type:"list"` // Determines what action will be taken if stack creation fails. This must be // one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure // or DisableRollback, but not both. // // Default: ROLLBACK OnFailure OnFailure `type:"string" enum:"true"` // A list of Parameter structures that specify input parameters for the stack. // For more information, see the Parameter (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html) // data type. Parameters []Parameter `type:"list"` // The template resource types that you have permissions to work with for this // create stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. // Use the following syntax to describe template resource types: AWS::* (for // all AWS resource), Custom::* (for all custom resources), Custom::logical_ID // (for a specific custom resource), AWS::service_name::* (for all resources // of a particular AWS service), and AWS::service_name::resource_logical_ID // (for a specific AWS resource). // // If the list of resource types doesn't include a resource that you're creating, // the stack creation fails. By default, AWS CloudFormation grants permissions // to all resource types. AWS Identity and Access Management (IAM) uses this // parameter for AWS CloudFormation-specific condition keys in IAM policies. // For more information, see Controlling Access with AWS Identity and Access // Management (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html). ResourceTypes []string `type:"list"` // The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) // role that AWS CloudFormation assumes to create the stack. AWS CloudFormation // uses the role's credentials to make calls on your behalf. AWS CloudFormation // always uses this role for all future operations on the stack. As long as // users have permission to operate on the stack, AWS CloudFormation uses this // role even if the users don't have permission to pass it. Ensure that the // role grants least privilege. // // If you don't specify a value, AWS CloudFormation uses the role that was previously // associated with the stack. If no role is available, AWS CloudFormation uses // a temporary session that is generated from your user credentials. RoleARN *string `min:"20" type:"string"` // The rollback triggers for AWS CloudFormation to monitor during stack creation // and updating operations, and for the specified monitoring period afterwards. RollbackConfiguration *RollbackConfiguration `type:"structure"` // The name that is associated with the stack. The name must be unique in the // region in which you are creating the stack. // // A stack name can contain only alphanumeric characters (case sensitive) and // hyphens. It must start with an alphabetic character and cannot be longer // than 128 characters. // // StackName is a required field StackName *string `type:"string" required:"true"` // Structure containing the stack policy body. For more information, go to Prevent // Updates to Stack Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html) // in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody // or the StackPolicyURL parameter, but not both. StackPolicyBody *string `min:"1" type:"string"` // Location of a file containing the stack policy. The URL must point to a policy // (maximum size: 16 KB) located in an S3 bucket in the same region as the stack. // You can specify either the StackPolicyBody or the StackPolicyURL parameter, // but not both. StackPolicyURL *string `min:"1" type:"string"` // Key-value pairs to associate with this stack. AWS CloudFormation also propagates // these tags to the resources created in the stack. A maximum number of 50 // tags can be specified. Tags []Tag `type:"list"` // Structure containing the template body with a minimum length of 1 byte and // a maximum length of 51,200 bytes. For more information, go to Template Anatomy // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the AWS CloudFormation User Guide. // // Conditional: You must specify either the TemplateBody or the TemplateURL // parameter, but not both. TemplateBody *string `min:"1" type:"string"` // Location of file containing the template body. The URL must point to a template // (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more // information, go to the Template Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the AWS CloudFormation User Guide. // // Conditional: You must specify either the TemplateBody or the TemplateURL // parameter, but not both. TemplateURL *string `min:"1" type:"string"` // The amount of time that can pass before the stack status becomes CREATE_FAILED; // if DisableRollback is not set or is set to false, the stack will be rolled // back. TimeoutInMinutes *int64 `min:"1" type:"integer"` // contains filtered or unexported fields }
The input for CreateStack action.
func (CreateStackInput) String ¶
func (s CreateStackInput) String() string
String returns the string representation
func (*CreateStackInput) Validate ¶
func (s *CreateStackInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateStackInstancesInput ¶
type CreateStackInstancesInput struct { // The names of one or more AWS accounts that you want to create stack instances // in the specified region(s) for. // // Accounts is a required field Accounts []string `type:"list" required:"true"` // The unique identifier for this stack set operation. // // The operation ID also functions as an idempotency token, to ensure that AWS // CloudFormation performs the stack set operation only once, even if you retry // the request multiple times. You might retry stack set operation requests // to ensure that AWS CloudFormation successfully received them. // // If you don't specify an operation ID, the SDK generates one automatically. // // Repeating this stack set operation with a new operation ID retries all stack // instances whose status is OUTDATED. OperationId *string `min:"1" type:"string" idempotencyToken:"true"` // Preferences for how AWS CloudFormation performs this stack set operation. OperationPreferences *StackSetOperationPreferences `type:"structure"` // A list of stack set parameters whose values you want to override in the selected // stack instances. // // Any overridden parameter values will be applied to all stack instances in // the specified accounts and regions. When specifying parameters and their // values, be aware of how AWS CloudFormation sets parameter values during stack // instance operations: // // * To override the current value for a parameter, include the parameter // and specify its value. // // * To leave a parameter set to its present value, you can do one of the // following: Do not include the parameter in the list. Include the parameter // and specify UsePreviousValue as true. (You cannot specify both a value // and set UsePreviousValue to true.) // // * To set all overridden parameter back to the values specified in the // stack set, specify a parameter list but do not include any parameters. // // * To leave all parameters set to their present values, do not specify // this property at all. // // During stack set updates, any parameter values overridden for a stack instance // are not updated, but retain their overridden value. // // You can only override the parameter values that are specified in the stack // set; to add or delete a parameter itself, use UpdateStackSet (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html) // to update the stack set template. ParameterOverrides []Parameter `type:"list"` // The names of one or more regions where you want to create stack instances // using the specified AWS account(s). // // Regions is a required field Regions []string `type:"list" required:"true"` // The name or unique ID of the stack set that you want to create stack instances // from. // // StackSetName is a required field StackSetName *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (CreateStackInstancesInput) String ¶
func (s CreateStackInstancesInput) String() string
String returns the string representation
func (*CreateStackInstancesInput) Validate ¶
func (s *CreateStackInstancesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateStackInstancesOutput ¶
type CreateStackInstancesOutput struct { // The unique identifier for this stack set operation. OperationId *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (CreateStackInstancesOutput) String ¶
func (s CreateStackInstancesOutput) String() string
String returns the string representation
type CreateStackInstancesRequest ¶
type CreateStackInstancesRequest struct { *aws.Request Input *CreateStackInstancesInput Copy func(*CreateStackInstancesInput) CreateStackInstancesRequest }
CreateStackInstancesRequest is the request type for the CreateStackInstances API operation.
func (CreateStackInstancesRequest) Send ¶
func (r CreateStackInstancesRequest) Send(ctx context.Context) (*CreateStackInstancesResponse, error)
Send marshals and sends the CreateStackInstances API request.
type CreateStackInstancesResponse ¶ added in v0.9.0
type CreateStackInstancesResponse struct { *CreateStackInstancesOutput // contains filtered or unexported fields }
CreateStackInstancesResponse is the response type for the CreateStackInstances API operation.
func (*CreateStackInstancesResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateStackInstancesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateStackInstances request.
type CreateStackOutput ¶
type CreateStackOutput struct { // Unique identifier of the stack. StackId *string `type:"string"` // contains filtered or unexported fields }
The output for a CreateStack action.
func (CreateStackOutput) String ¶
func (s CreateStackOutput) String() string
String returns the string representation
type CreateStackRequest ¶
type CreateStackRequest struct { *aws.Request Input *CreateStackInput Copy func(*CreateStackInput) CreateStackRequest }
CreateStackRequest is the request type for the CreateStack API operation.
func (CreateStackRequest) Send ¶
func (r CreateStackRequest) Send(ctx context.Context) (*CreateStackResponse, error)
Send marshals and sends the CreateStack API request.
type CreateStackResponse ¶ added in v0.9.0
type CreateStackResponse struct { *CreateStackOutput // contains filtered or unexported fields }
CreateStackResponse is the response type for the CreateStack API operation.
func (*CreateStackResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateStackResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateStack request.
type CreateStackSetInput ¶
type CreateStackSetInput struct { // The Amazon Resource Number (ARN) of the IAM role to use to create this stack // set. // // Specify an IAM role only if you are using customized administrator roles // to control which users or groups can manage specific stack sets within the // same administrator account. For more information, see Prerequisites: Granting // Permissions for Stack Set Operations (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) // in the AWS CloudFormation User Guide. AdministrationRoleARN *string `min:"20" type:"string"` // In some cases, you must explicitly acknowledge that your stack set template // contains certain capabilities in order for AWS CloudFormation to create the // stack set and related stack instances. // // * CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include // resources that can affect permissions in your AWS account; for example, // by creating new AWS Identity and Access Management (IAM) users. For those // stack sets, you must explicitly acknowledge this by specifying one of // these capabilities. The following IAM resources require you to specify // either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. If you have // IAM resources, you can specify either capability. If you have IAM resources // with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't // specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities // error. If your stack template contains these resources, we recommend that // you review all permissions associated with them and edit their permissions // if necessary. AWS::IAM::AccessKey (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html) // AWS::IAM::Group (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html) // AWS::IAM::InstanceProfile (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html) // AWS::IAM::Policy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html) // AWS::IAM::Role (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html) // AWS::IAM::User (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html) // AWS::IAM::UserToGroupAddition (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html) // For more information, see Acknowledging IAM Resources in AWS CloudFormation // Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). // // * CAPABILITY_AUTO_EXPAND Some templates contain macros. If your stack // template contains one or more macros, and you choose to create a stack // directly from the processed template, without first reviewing the resulting // changes in a change set, you must acknowledge this capability. For more // information, see Using AWS CloudFormation Macros to Perform Custom Processing // on Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html). // Stack sets do not currently support macros in stack templates. (This includes // the AWS::Include (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) // and AWS::Serverless (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) // transforms, which are macros hosted by AWS CloudFormation.) Even if you // specify this capability, if you include a macro in your template the stack // set operation will fail. Capabilities []Capability `type:"list"` // A unique identifier for this CreateStackSet request. Specify this token if // you plan to retry requests so that AWS CloudFormation knows that you're not // attempting to create another stack set with the same name. You might retry // CreateStackSet requests to ensure that AWS CloudFormation successfully received // them. // // If you don't specify an operation ID, the SDK generates one automatically. ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"` // A description of the stack set. You can use the description to identify the // stack set's purpose or other important information. Description *string `min:"1" type:"string"` // The name of the IAM execution role to use to create the stack set. If you // do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole // role for the stack set operation. // // Specify an IAM role only if you are using customized execution roles to control // which stack resources users and groups can include in their stack sets. ExecutionRoleName *string `min:"1" type:"string"` // The input parameters for the stack set template. Parameters []Parameter `type:"list"` // The name to associate with the stack set. The name must be unique in the // region where you create your stack set. // // A stack name can contain only alphanumeric characters (case-sensitive) and // hyphens. It must start with an alphabetic character and can't be longer than // 128 characters. // // StackSetName is a required field StackSetName *string `type:"string" required:"true"` // The key-value pairs to associate with this stack set and the stacks created // from it. AWS CloudFormation also propagates these tags to supported resources // that are created in the stacks. A maximum number of 50 tags can be specified. // // If you specify tags as part of a CreateStackSet action, AWS CloudFormation // checks to see if you have the required IAM permission to tag resources. If // you don't, the entire CreateStackSet action fails with an access denied error, // and the stack set is not created. Tags []Tag `type:"list"` // The structure that contains the template body, with a minimum length of 1 // byte and a maximum length of 51,200 bytes. For more information, see Template // Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the AWS CloudFormation User Guide. // // Conditional: You must specify either the TemplateBody or the TemplateURL // parameter, but not both. TemplateBody *string `min:"1" type:"string"` // The location of the file that contains the template body. The URL must point // to a template (maximum size: 460,800 bytes) that's located in an Amazon S3 // bucket. For more information, see Template Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the AWS CloudFormation User Guide. // // Conditional: You must specify either the TemplateBody or the TemplateURL // parameter, but not both. TemplateURL *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (CreateStackSetInput) String ¶
func (s CreateStackSetInput) String() string
String returns the string representation
func (*CreateStackSetInput) Validate ¶
func (s *CreateStackSetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateStackSetOutput ¶
type CreateStackSetOutput struct { // The ID of the stack set that you're creating. StackSetId *string `type:"string"` // contains filtered or unexported fields }
func (CreateStackSetOutput) String ¶
func (s CreateStackSetOutput) String() string
String returns the string representation
type CreateStackSetRequest ¶
type CreateStackSetRequest struct { *aws.Request Input *CreateStackSetInput Copy func(*CreateStackSetInput) CreateStackSetRequest }
CreateStackSetRequest is the request type for the CreateStackSet API operation.
func (CreateStackSetRequest) Send ¶
func (r CreateStackSetRequest) Send(ctx context.Context) (*CreateStackSetResponse, error)
Send marshals and sends the CreateStackSet API request.
type CreateStackSetResponse ¶ added in v0.9.0
type CreateStackSetResponse struct { *CreateStackSetOutput // contains filtered or unexported fields }
CreateStackSetResponse is the response type for the CreateStackSet API operation.
func (*CreateStackSetResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateStackSetResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateStackSet request.
type DeleteChangeSetInput ¶
type DeleteChangeSetInput struct { // The name or Amazon Resource Name (ARN) of the change set that you want to // delete. // // ChangeSetName is a required field ChangeSetName *string `min:"1" type:"string" required:"true"` // If you specified the name of a change set to delete, specify the stack name // or ID (ARN) that is associated with it. StackName *string `min:"1" type:"string"` // contains filtered or unexported fields }
The input for the DeleteChangeSet action.
func (DeleteChangeSetInput) String ¶
func (s DeleteChangeSetInput) String() string
String returns the string representation
func (*DeleteChangeSetInput) Validate ¶
func (s *DeleteChangeSetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteChangeSetOutput ¶
type DeleteChangeSetOutput struct {
// contains filtered or unexported fields
}
The output for the DeleteChangeSet action.
func (DeleteChangeSetOutput) String ¶
func (s DeleteChangeSetOutput) String() string
String returns the string representation
type DeleteChangeSetRequest ¶
type DeleteChangeSetRequest struct { *aws.Request Input *DeleteChangeSetInput Copy func(*DeleteChangeSetInput) DeleteChangeSetRequest }
DeleteChangeSetRequest is the request type for the DeleteChangeSet API operation.
func (DeleteChangeSetRequest) Send ¶
func (r DeleteChangeSetRequest) Send(ctx context.Context) (*DeleteChangeSetResponse, error)
Send marshals and sends the DeleteChangeSet API request.
type DeleteChangeSetResponse ¶ added in v0.9.0
type DeleteChangeSetResponse struct { *DeleteChangeSetOutput // contains filtered or unexported fields }
DeleteChangeSetResponse is the response type for the DeleteChangeSet API operation.
func (*DeleteChangeSetResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteChangeSetResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteChangeSet request.
type DeleteStackInput ¶
type DeleteStackInput struct { // A unique identifier for this DeleteStack request. Specify this token if you // plan to retry requests so that AWS CloudFormation knows that you're not attempting // to delete a stack with the same name. You might retry DeleteStack requests // to ensure that AWS CloudFormation successfully received them. // // All events triggered by a given stack operation are assigned the same client // request token, which you can use to track operations. For example, if you // execute a CreateStack operation with the token token1, then all the StackEvents // generated by that operation will have ClientRequestToken set as token1. // // In the console, stack operations display the client request token on the // Events tab. Stack operations that are initiated from the console use the // token format Console-StackOperation-ID, which helps you easily identify the // stack operation . For example, if you create a stack using the console, each // stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. ClientRequestToken *string `min:"1" type:"string"` // For stacks in the DELETE_FAILED state, a list of resource logical IDs that // are associated with the resources you want to retain. During deletion, AWS // CloudFormation deletes the stack but does not delete the retained resources. // // Retaining resources is useful when you cannot delete a resource, such as // a non-empty S3 bucket, but you want to delete the stack. RetainResources []string `type:"list"` // The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) // role that AWS CloudFormation assumes to delete the stack. AWS CloudFormation // uses the role's credentials to make calls on your behalf. // // If you don't specify a value, AWS CloudFormation uses the role that was previously // associated with the stack. If no role is available, AWS CloudFormation uses // a temporary session that is generated from your user credentials. RoleARN *string `min:"20" type:"string"` // The name or the unique stack ID that is associated with the stack. // // StackName is a required field StackName *string `type:"string" required:"true"` // contains filtered or unexported fields }
The input for DeleteStack action.
func (DeleteStackInput) String ¶
func (s DeleteStackInput) String() string
String returns the string representation
func (*DeleteStackInput) Validate ¶
func (s *DeleteStackInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteStackInstancesInput ¶
type DeleteStackInstancesInput struct { // The names of the AWS accounts that you want to delete stack instances for. // // Accounts is a required field Accounts []string `type:"list" required:"true"` // The unique identifier for this stack set operation. // // If you don't specify an operation ID, the SDK generates one automatically. // // The operation ID also functions as an idempotency token, to ensure that AWS // CloudFormation performs the stack set operation only once, even if you retry // the request multiple times. You can retry stack set operation requests to // ensure that AWS CloudFormation successfully received them. // // Repeating this stack set operation with a new operation ID retries all stack // instances whose status is OUTDATED. OperationId *string `min:"1" type:"string" idempotencyToken:"true"` // Preferences for how AWS CloudFormation performs this stack set operation. OperationPreferences *StackSetOperationPreferences `type:"structure"` // The regions where you want to delete stack set instances. // // Regions is a required field Regions []string `type:"list" required:"true"` // Removes the stack instances from the specified stack set, but doesn't delete // the stacks. You can't reassociate a retained stack or add an existing, saved // stack to a new stack set. // // For more information, see Stack set operation options (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options). // // RetainStacks is a required field RetainStacks *bool `type:"boolean" required:"true"` // The name or unique ID of the stack set that you want to delete stack instances // for. // // StackSetName is a required field StackSetName *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteStackInstancesInput) String ¶
func (s DeleteStackInstancesInput) String() string
String returns the string representation
func (*DeleteStackInstancesInput) Validate ¶
func (s *DeleteStackInstancesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteStackInstancesOutput ¶
type DeleteStackInstancesOutput struct { // The unique identifier for this stack set operation. OperationId *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (DeleteStackInstancesOutput) String ¶
func (s DeleteStackInstancesOutput) String() string
String returns the string representation
type DeleteStackInstancesRequest ¶
type DeleteStackInstancesRequest struct { *aws.Request Input *DeleteStackInstancesInput Copy func(*DeleteStackInstancesInput) DeleteStackInstancesRequest }
DeleteStackInstancesRequest is the request type for the DeleteStackInstances API operation.
func (DeleteStackInstancesRequest) Send ¶
func (r DeleteStackInstancesRequest) Send(ctx context.Context) (*DeleteStackInstancesResponse, error)
Send marshals and sends the DeleteStackInstances API request.
type DeleteStackInstancesResponse ¶ added in v0.9.0
type DeleteStackInstancesResponse struct { *DeleteStackInstancesOutput // contains filtered or unexported fields }
DeleteStackInstancesResponse is the response type for the DeleteStackInstances API operation.
func (*DeleteStackInstancesResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteStackInstancesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteStackInstances request.
type DeleteStackOutput ¶
type DeleteStackOutput struct {
// contains filtered or unexported fields
}
func (DeleteStackOutput) String ¶
func (s DeleteStackOutput) String() string
String returns the string representation
type DeleteStackRequest ¶
type DeleteStackRequest struct { *aws.Request Input *DeleteStackInput Copy func(*DeleteStackInput) DeleteStackRequest }
DeleteStackRequest is the request type for the DeleteStack API operation.
func (DeleteStackRequest) Send ¶
func (r DeleteStackRequest) Send(ctx context.Context) (*DeleteStackResponse, error)
Send marshals and sends the DeleteStack API request.
type DeleteStackResponse ¶ added in v0.9.0
type DeleteStackResponse struct { *DeleteStackOutput // contains filtered or unexported fields }
DeleteStackResponse is the response type for the DeleteStack API operation.
func (*DeleteStackResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteStackResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteStack request.
type DeleteStackSetInput ¶
type DeleteStackSetInput struct { // The name or unique ID of the stack set that you're deleting. You can obtain // this value by running ListStackSets. // // StackSetName is a required field StackSetName *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteStackSetInput) String ¶
func (s DeleteStackSetInput) String() string
String returns the string representation
func (*DeleteStackSetInput) Validate ¶
func (s *DeleteStackSetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteStackSetOutput ¶
type DeleteStackSetOutput struct {
// contains filtered or unexported fields
}
func (DeleteStackSetOutput) String ¶
func (s DeleteStackSetOutput) String() string
String returns the string representation
type DeleteStackSetRequest ¶
type DeleteStackSetRequest struct { *aws.Request Input *DeleteStackSetInput Copy func(*DeleteStackSetInput) DeleteStackSetRequest }
DeleteStackSetRequest is the request type for the DeleteStackSet API operation.
func (DeleteStackSetRequest) Send ¶
func (r DeleteStackSetRequest) Send(ctx context.Context) (*DeleteStackSetResponse, error)
Send marshals and sends the DeleteStackSet API request.
type DeleteStackSetResponse ¶ added in v0.9.0
type DeleteStackSetResponse struct { *DeleteStackSetOutput // contains filtered or unexported fields }
DeleteStackSetResponse is the response type for the DeleteStackSet API operation.
func (*DeleteStackSetResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteStackSetResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteStackSet request.
type DescribeAccountLimitsInput ¶
type DescribeAccountLimitsInput struct { // A string that identifies the next page of limits that you want to retrieve. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
The input for the DescribeAccountLimits action.
func (DescribeAccountLimitsInput) String ¶
func (s DescribeAccountLimitsInput) String() string
String returns the string representation
func (*DescribeAccountLimitsInput) Validate ¶
func (s *DescribeAccountLimitsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeAccountLimitsOutput ¶
type DescribeAccountLimitsOutput struct { // An account limit structure that contain a list of AWS CloudFormation account // limits and their values. AccountLimits []AccountLimit `type:"list"` // If the output exceeds 1 MB in size, a string that identifies the next page // of limits. If no additional page exists, this value is null. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
The output for the DescribeAccountLimits action.
func (DescribeAccountLimitsOutput) String ¶
func (s DescribeAccountLimitsOutput) String() string
String returns the string representation
type DescribeAccountLimitsRequest ¶
type DescribeAccountLimitsRequest struct { *aws.Request Input *DescribeAccountLimitsInput Copy func(*DescribeAccountLimitsInput) DescribeAccountLimitsRequest }
DescribeAccountLimitsRequest is the request type for the DescribeAccountLimits API operation.
func (DescribeAccountLimitsRequest) Send ¶
func (r DescribeAccountLimitsRequest) Send(ctx context.Context) (*DescribeAccountLimitsResponse, error)
Send marshals and sends the DescribeAccountLimits API request.
type DescribeAccountLimitsResponse ¶ added in v0.9.0
type DescribeAccountLimitsResponse struct { *DescribeAccountLimitsOutput // contains filtered or unexported fields }
DescribeAccountLimitsResponse is the response type for the DescribeAccountLimits API operation.
func (*DescribeAccountLimitsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeAccountLimitsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeAccountLimits request.
type DescribeChangeSetInput ¶
type DescribeChangeSetInput struct { // The name or Amazon Resource Name (ARN) of the change set that you want to // describe. // // ChangeSetName is a required field ChangeSetName *string `min:"1" type:"string" required:"true"` // A string (provided by the DescribeChangeSet response output) that identifies // the next page of information that you want to retrieve. NextToken *string `min:"1" type:"string"` // If you specified the name of a change set, specify the stack name or ID (ARN) // of the change set you want to describe. StackName *string `min:"1" type:"string"` // contains filtered or unexported fields }
The input for the DescribeChangeSet action.
func (DescribeChangeSetInput) String ¶
func (s DescribeChangeSetInput) String() string
String returns the string representation
func (*DescribeChangeSetInput) Validate ¶
func (s *DescribeChangeSetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeChangeSetOutput ¶
type DescribeChangeSetOutput struct { // If you execute the change set, the list of capabilities that were explicitly // acknowledged when the change set was created. Capabilities []Capability `type:"list"` // The ARN of the change set. ChangeSetId *string `min:"1" type:"string"` // The name of the change set. ChangeSetName *string `min:"1" type:"string"` // A list of Change structures that describes the resources AWS CloudFormation // changes if you execute the change set. Changes []Change `type:"list"` // The start time when the change set was created, in UTC. CreationTime *time.Time `type:"timestamp"` // Information about the change set. Description *string `min:"1" type:"string"` // If the change set execution status is AVAILABLE, you can execute the change // set. If you can’t execute the change set, the status indicates why. For // example, a change set might be in an UNAVAILABLE state because AWS CloudFormation // is still creating it or in an OBSOLETE state because the stack was already // updated. ExecutionStatus ExecutionStatus `type:"string" enum:"true"` // If the output exceeds 1 MB, a string that identifies the next page of changes. // If there is no additional page, this value is null. NextToken *string `min:"1" type:"string"` // The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that // will be associated with the stack if you execute the change set. NotificationARNs []string `type:"list"` // A list of Parameter structures that describes the input parameters and their // values used to create the change set. For more information, see the Parameter // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html) // data type. Parameters []Parameter `type:"list"` // The rollback triggers for AWS CloudFormation to monitor during stack creation // and updating operations, and for the specified monitoring period afterwards. RollbackConfiguration *RollbackConfiguration `type:"structure"` // The ARN of the stack that is associated with the change set. StackId *string `type:"string"` // The name of the stack that is associated with the change set. StackName *string `type:"string"` // The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, // or FAILED. Status ChangeSetStatus `type:"string" enum:"true"` // A description of the change set's status. For example, if your attempt to // create a change set failed, AWS CloudFormation shows the error message. StatusReason *string `type:"string"` // If you execute the change set, the tags that will be associated with the // stack. Tags []Tag `type:"list"` // contains filtered or unexported fields }
The output for the DescribeChangeSet action.
func (DescribeChangeSetOutput) String ¶
func (s DescribeChangeSetOutput) String() string
String returns the string representation
type DescribeChangeSetRequest ¶
type DescribeChangeSetRequest struct { *aws.Request Input *DescribeChangeSetInput Copy func(*DescribeChangeSetInput) DescribeChangeSetRequest }
DescribeChangeSetRequest is the request type for the DescribeChangeSet API operation.
func (DescribeChangeSetRequest) Send ¶
func (r DescribeChangeSetRequest) Send(ctx context.Context) (*DescribeChangeSetResponse, error)
Send marshals and sends the DescribeChangeSet API request.
type DescribeChangeSetResponse ¶ added in v0.9.0
type DescribeChangeSetResponse struct { *DescribeChangeSetOutput // contains filtered or unexported fields }
DescribeChangeSetResponse is the response type for the DescribeChangeSet API operation.
func (*DescribeChangeSetResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeChangeSetResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeChangeSet request.
type DescribeStackDriftDetectionStatusInput ¶ added in v0.6.0
type DescribeStackDriftDetectionStatusInput struct { // The ID of the drift detection results of this operation. // // AWS CloudFormation generates new results, with a new drift detection ID, // each time this operation is run. However, the number of drift results AWS // CloudFormation retains for any given stack, and for how long, may vary. // // StackDriftDetectionId is a required field StackDriftDetectionId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DescribeStackDriftDetectionStatusInput) String ¶ added in v0.6.0
func (s DescribeStackDriftDetectionStatusInput) String() string
String returns the string representation
func (*DescribeStackDriftDetectionStatusInput) Validate ¶ added in v0.6.0
func (s *DescribeStackDriftDetectionStatusInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeStackDriftDetectionStatusOutput ¶ added in v0.6.0
type DescribeStackDriftDetectionStatusOutput struct { // The status of the stack drift detection operation. // // * DETECTION_COMPLETE: The stack drift detection operation has successfully // completed for all resources in the stack that support drift detection. // (Resources that do not currently support stack detection remain unchecked.) // If you specified logical resource IDs for AWS CloudFormation to use as // a filter for the stack drift detection operation, only the resources with // those logical IDs are checked for drift. // // * DETECTION_FAILED: The stack drift detection operation has failed for // at least one resource in the stack. Results will be available for resources // on which AWS CloudFormation successfully completed drift detection. // // * DETECTION_IN_PROGRESS: The stack drift detection operation is currently // in progress. // // DetectionStatus is a required field DetectionStatus StackDriftDetectionStatus `type:"string" required:"true" enum:"true"` // The reason the stack drift detection operation has its current status. DetectionStatusReason *string `type:"string"` // Total number of stack resources that have drifted. This is NULL until the // drift detection operation reaches a status of DETECTION_COMPLETE. This value // will be 0 for stacks whose drift status is IN_SYNC. DriftedStackResourceCount *int64 `type:"integer"` // The ID of the drift detection results of this operation. // // AWS CloudFormation generates new results, with a new drift detection ID, // each time this operation is run. However, the number of reports AWS CloudFormation // retains for any given stack, and for how long, may vary. // // StackDriftDetectionId is a required field StackDriftDetectionId *string `min:"1" type:"string" required:"true"` // Status of the stack's actual configuration compared to its expected configuration. // // * DRIFTED: The stack differs from its expected template configuration. // A stack is considered to have drifted if one or more of its resources // have drifted. // // * NOT_CHECKED: AWS CloudFormation has not checked if the stack differs // from its expected template configuration. // // * IN_SYNC: The stack's actual configuration matches its expected template // configuration. // // * UNKNOWN: This value is reserved for future use. StackDriftStatus StackDriftStatus `type:"string" enum:"true"` // The ID of the stack. // // StackId is a required field StackId *string `type:"string" required:"true"` // Time at which the stack drift detection operation was initiated. // // Timestamp is a required field Timestamp *time.Time `type:"timestamp" required:"true"` // contains filtered or unexported fields }
func (DescribeStackDriftDetectionStatusOutput) String ¶ added in v0.6.0
func (s DescribeStackDriftDetectionStatusOutput) String() string
String returns the string representation
type DescribeStackDriftDetectionStatusRequest ¶ added in v0.6.0
type DescribeStackDriftDetectionStatusRequest struct { *aws.Request Input *DescribeStackDriftDetectionStatusInput Copy func(*DescribeStackDriftDetectionStatusInput) DescribeStackDriftDetectionStatusRequest }
DescribeStackDriftDetectionStatusRequest is the request type for the DescribeStackDriftDetectionStatus API operation.
func (DescribeStackDriftDetectionStatusRequest) Send ¶ added in v0.6.0
func (r DescribeStackDriftDetectionStatusRequest) Send(ctx context.Context) (*DescribeStackDriftDetectionStatusResponse, error)
Send marshals and sends the DescribeStackDriftDetectionStatus API request.
type DescribeStackDriftDetectionStatusResponse ¶ added in v0.9.0
type DescribeStackDriftDetectionStatusResponse struct { *DescribeStackDriftDetectionStatusOutput // contains filtered or unexported fields }
DescribeStackDriftDetectionStatusResponse is the response type for the DescribeStackDriftDetectionStatus API operation.
func (*DescribeStackDriftDetectionStatusResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeStackDriftDetectionStatusResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeStackDriftDetectionStatus request.
type DescribeStackEventsInput ¶
type DescribeStackEventsInput struct { // A string that identifies the next page of events that you want to retrieve. NextToken *string `min:"1" type:"string"` // The name or the unique stack ID that is associated with the stack, which // are not always interchangeable: // // * Running stacks: You can specify either the stack's name or its unique // stack ID. // // * Deleted stacks: You must specify the unique stack ID. // // Default: There is no default value. StackName *string `type:"string"` // contains filtered or unexported fields }
The input for DescribeStackEvents action.
func (DescribeStackEventsInput) String ¶
func (s DescribeStackEventsInput) String() string
String returns the string representation
func (*DescribeStackEventsInput) Validate ¶
func (s *DescribeStackEventsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeStackEventsOutput ¶
type DescribeStackEventsOutput struct { // If the output exceeds 1 MB in size, a string that identifies the next page // of events. If no additional page exists, this value is null. NextToken *string `min:"1" type:"string"` // A list of StackEvents structures. StackEvents []StackEvent `type:"list"` // contains filtered or unexported fields }
The output for a DescribeStackEvents action.
func (DescribeStackEventsOutput) String ¶
func (s DescribeStackEventsOutput) String() string
String returns the string representation
type DescribeStackEventsPaginator ¶ added in v0.9.0
DescribeStackEventsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewDescribeStackEventsPaginator ¶ added in v0.9.0
func NewDescribeStackEventsPaginator(req DescribeStackEventsRequest) DescribeStackEventsPaginator
NewDescribeStackEventsRequestPaginator returns a paginator for DescribeStackEvents. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.DescribeStackEventsRequest(input) p := cloudformation.NewDescribeStackEventsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*DescribeStackEventsPaginator) CurrentPage ¶ added in v0.9.0
func (p *DescribeStackEventsPaginator) CurrentPage() *DescribeStackEventsOutput
type DescribeStackEventsRequest ¶
type DescribeStackEventsRequest struct { *aws.Request Input *DescribeStackEventsInput Copy func(*DescribeStackEventsInput) DescribeStackEventsRequest }
DescribeStackEventsRequest is the request type for the DescribeStackEvents API operation.
func (DescribeStackEventsRequest) Send ¶
func (r DescribeStackEventsRequest) Send(ctx context.Context) (*DescribeStackEventsResponse, error)
Send marshals and sends the DescribeStackEvents API request.
type DescribeStackEventsResponse ¶ added in v0.9.0
type DescribeStackEventsResponse struct { *DescribeStackEventsOutput // contains filtered or unexported fields }
DescribeStackEventsResponse is the response type for the DescribeStackEvents API operation.
func (*DescribeStackEventsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeStackEventsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeStackEvents request.
type DescribeStackInstanceInput ¶
type DescribeStackInstanceInput struct { // The ID of an AWS account that's associated with this stack instance. // // StackInstanceAccount is a required field StackInstanceAccount *string `type:"string" required:"true"` // The name of a region that's associated with this stack instance. // // StackInstanceRegion is a required field StackInstanceRegion *string `type:"string" required:"true"` // The name or the unique stack ID of the stack set that you want to get stack // instance information for. // // StackSetName is a required field StackSetName *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (DescribeStackInstanceInput) String ¶
func (s DescribeStackInstanceInput) String() string
String returns the string representation
func (*DescribeStackInstanceInput) Validate ¶
func (s *DescribeStackInstanceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeStackInstanceOutput ¶
type DescribeStackInstanceOutput struct { // The stack instance that matches the specified request parameters. StackInstance *StackInstance `type:"structure"` // contains filtered or unexported fields }
func (DescribeStackInstanceOutput) String ¶
func (s DescribeStackInstanceOutput) String() string
String returns the string representation
type DescribeStackInstanceRequest ¶
type DescribeStackInstanceRequest struct { *aws.Request Input *DescribeStackInstanceInput Copy func(*DescribeStackInstanceInput) DescribeStackInstanceRequest }
DescribeStackInstanceRequest is the request type for the DescribeStackInstance API operation.
func (DescribeStackInstanceRequest) Send ¶
func (r DescribeStackInstanceRequest) Send(ctx context.Context) (*DescribeStackInstanceResponse, error)
Send marshals and sends the DescribeStackInstance API request.
type DescribeStackInstanceResponse ¶ added in v0.9.0
type DescribeStackInstanceResponse struct { *DescribeStackInstanceOutput // contains filtered or unexported fields }
DescribeStackInstanceResponse is the response type for the DescribeStackInstance API operation.
func (*DescribeStackInstanceResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeStackInstanceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeStackInstance request.
type DescribeStackResourceDriftsInput ¶ added in v0.6.0
type DescribeStackResourceDriftsInput struct { // The maximum number of results to be returned with a single call. If the number // of available results exceeds this maximum, the response includes a NextToken // value that you can assign to the NextToken request parameter to get the next // set of results. MaxResults *int64 `min:"1" type:"integer"` // A string that identifies the next page of stack resource drift results. NextToken *string `min:"1" type:"string"` // The name of the stack for which you want drift information. // // StackName is a required field StackName *string `min:"1" type:"string" required:"true"` // The resource drift status values to use as filters for the resource drift // results returned. // // * DELETED: The resource differs from its expected template configuration // in that the resource has been deleted. // // * MODIFIED: One or more resource properties differ from their expected // template values. // // * IN_SYNC: The resources's actual configuration matches its expected template // configuration. // // * NOT_CHECKED: AWS CloudFormation does not currently return this value. StackResourceDriftStatusFilters []StackResourceDriftStatus `min:"1" type:"list"` // contains filtered or unexported fields }
func (DescribeStackResourceDriftsInput) String ¶ added in v0.6.0
func (s DescribeStackResourceDriftsInput) String() string
String returns the string representation
func (*DescribeStackResourceDriftsInput) Validate ¶ added in v0.6.0
func (s *DescribeStackResourceDriftsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeStackResourceDriftsOutput ¶ added in v0.6.0
type DescribeStackResourceDriftsOutput struct { // If the request doesn't return all of the remaining results, NextToken is // set to a token. To retrieve the next set of results, call DescribeStackResourceDrifts // again and assign that token to the request object's NextToken parameter. // If the request returns all results, NextToken is set to null. NextToken *string `min:"1" type:"string"` // Drift information for the resources that have been checked for drift in the // specified stack. This includes actual and expected configuration values for // resources where AWS CloudFormation detects drift. // // For a given stack, there will be one StackResourceDrift for each stack resource // that has been checked for drift. Resources that have not yet been checked // for drift are not included. Resources that do not currently support drift // detection are not checked, and so not included. For a list of resources that // support drift detection, see Resources that Support Drift Detection (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html). // // StackResourceDrifts is a required field StackResourceDrifts []StackResourceDrift `type:"list" required:"true"` // contains filtered or unexported fields }
func (DescribeStackResourceDriftsOutput) String ¶ added in v0.6.0
func (s DescribeStackResourceDriftsOutput) String() string
String returns the string representation
type DescribeStackResourceDriftsPaginator ¶ added in v0.9.0
DescribeStackResourceDriftsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewDescribeStackResourceDriftsPaginator ¶ added in v0.9.0
func NewDescribeStackResourceDriftsPaginator(req DescribeStackResourceDriftsRequest) DescribeStackResourceDriftsPaginator
NewDescribeStackResourceDriftsRequestPaginator returns a paginator for DescribeStackResourceDrifts. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.DescribeStackResourceDriftsRequest(input) p := cloudformation.NewDescribeStackResourceDriftsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*DescribeStackResourceDriftsPaginator) CurrentPage ¶ added in v0.9.0
func (p *DescribeStackResourceDriftsPaginator) CurrentPage() *DescribeStackResourceDriftsOutput
type DescribeStackResourceDriftsRequest ¶ added in v0.6.0
type DescribeStackResourceDriftsRequest struct { *aws.Request Input *DescribeStackResourceDriftsInput Copy func(*DescribeStackResourceDriftsInput) DescribeStackResourceDriftsRequest }
DescribeStackResourceDriftsRequest is the request type for the DescribeStackResourceDrifts API operation.
func (DescribeStackResourceDriftsRequest) Send ¶ added in v0.6.0
func (r DescribeStackResourceDriftsRequest) Send(ctx context.Context) (*DescribeStackResourceDriftsResponse, error)
Send marshals and sends the DescribeStackResourceDrifts API request.
type DescribeStackResourceDriftsResponse ¶ added in v0.9.0
type DescribeStackResourceDriftsResponse struct { *DescribeStackResourceDriftsOutput // contains filtered or unexported fields }
DescribeStackResourceDriftsResponse is the response type for the DescribeStackResourceDrifts API operation.
func (*DescribeStackResourceDriftsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeStackResourceDriftsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeStackResourceDrifts request.
type DescribeStackResourceInput ¶
type DescribeStackResourceInput struct { // The logical name of the resource as specified in the template. // // Default: There is no default value. // // LogicalResourceId is a required field LogicalResourceId *string `type:"string" required:"true"` // The name or the unique stack ID that is associated with the stack, which // are not always interchangeable: // // * Running stacks: You can specify either the stack's name or its unique // stack ID. // // * Deleted stacks: You must specify the unique stack ID. // // Default: There is no default value. // // StackName is a required field StackName *string `type:"string" required:"true"` // contains filtered or unexported fields }
The input for DescribeStackResource action.
func (DescribeStackResourceInput) String ¶
func (s DescribeStackResourceInput) String() string
String returns the string representation
func (*DescribeStackResourceInput) Validate ¶
func (s *DescribeStackResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeStackResourceOutput ¶
type DescribeStackResourceOutput struct { // A StackResourceDetail structure containing the description of the specified // resource in the specified stack. StackResourceDetail *StackResourceDetail `type:"structure"` // contains filtered or unexported fields }
The output for a DescribeStackResource action.
func (DescribeStackResourceOutput) String ¶
func (s DescribeStackResourceOutput) String() string
String returns the string representation
type DescribeStackResourceRequest ¶
type DescribeStackResourceRequest struct { *aws.Request Input *DescribeStackResourceInput Copy func(*DescribeStackResourceInput) DescribeStackResourceRequest }
DescribeStackResourceRequest is the request type for the DescribeStackResource API operation.
func (DescribeStackResourceRequest) Send ¶
func (r DescribeStackResourceRequest) Send(ctx context.Context) (*DescribeStackResourceResponse, error)
Send marshals and sends the DescribeStackResource API request.
type DescribeStackResourceResponse ¶ added in v0.9.0
type DescribeStackResourceResponse struct { *DescribeStackResourceOutput // contains filtered or unexported fields }
DescribeStackResourceResponse is the response type for the DescribeStackResource API operation.
func (*DescribeStackResourceResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeStackResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeStackResource request.
type DescribeStackResourcesInput ¶
type DescribeStackResourcesInput struct { // The logical name of the resource as specified in the template. // // Default: There is no default value. LogicalResourceId *string `type:"string"` // The name or unique identifier that corresponds to a physical instance ID // of a resource supported by AWS CloudFormation. // // For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId // corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources // to find which stack the instance belongs to and what other resources are // part of the stack. // // Required: Conditional. If you do not specify PhysicalResourceId, you must // specify StackName. // // Default: There is no default value. PhysicalResourceId *string `type:"string"` // The name or the unique stack ID that is associated with the stack, which // are not always interchangeable: // // * Running stacks: You can specify either the stack's name or its unique // stack ID. // // * Deleted stacks: You must specify the unique stack ID. // // Default: There is no default value. // // Required: Conditional. If you do not specify StackName, you must specify // PhysicalResourceId. StackName *string `type:"string"` // contains filtered or unexported fields }
The input for DescribeStackResources action.
func (DescribeStackResourcesInput) String ¶
func (s DescribeStackResourcesInput) String() string
String returns the string representation
type DescribeStackResourcesOutput ¶
type DescribeStackResourcesOutput struct { // A list of StackResource structures. StackResources []StackResource `type:"list"` // contains filtered or unexported fields }
The output for a DescribeStackResources action.
func (DescribeStackResourcesOutput) String ¶
func (s DescribeStackResourcesOutput) String() string
String returns the string representation
type DescribeStackResourcesRequest ¶
type DescribeStackResourcesRequest struct { *aws.Request Input *DescribeStackResourcesInput Copy func(*DescribeStackResourcesInput) DescribeStackResourcesRequest }
DescribeStackResourcesRequest is the request type for the DescribeStackResources API operation.
func (DescribeStackResourcesRequest) Send ¶
func (r DescribeStackResourcesRequest) Send(ctx context.Context) (*DescribeStackResourcesResponse, error)
Send marshals and sends the DescribeStackResources API request.
type DescribeStackResourcesResponse ¶ added in v0.9.0
type DescribeStackResourcesResponse struct { *DescribeStackResourcesOutput // contains filtered or unexported fields }
DescribeStackResourcesResponse is the response type for the DescribeStackResources API operation.
func (*DescribeStackResourcesResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeStackResourcesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeStackResources request.
type DescribeStackSetInput ¶
type DescribeStackSetInput struct { // The name or unique ID of the stack set whose description you want. // // StackSetName is a required field StackSetName *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (DescribeStackSetInput) String ¶
func (s DescribeStackSetInput) String() string
String returns the string representation
func (*DescribeStackSetInput) Validate ¶
func (s *DescribeStackSetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeStackSetOperationInput ¶
type DescribeStackSetOperationInput struct { // The unique ID of the stack set operation. // // OperationId is a required field OperationId *string `min:"1" type:"string" required:"true"` // The name or the unique stack ID of the stack set for the stack operation. // // StackSetName is a required field StackSetName *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (DescribeStackSetOperationInput) String ¶
func (s DescribeStackSetOperationInput) String() string
String returns the string representation
func (*DescribeStackSetOperationInput) Validate ¶
func (s *DescribeStackSetOperationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeStackSetOperationOutput ¶
type DescribeStackSetOperationOutput struct { // The specified stack set operation. StackSetOperation *StackSetOperation `type:"structure"` // contains filtered or unexported fields }
func (DescribeStackSetOperationOutput) String ¶
func (s DescribeStackSetOperationOutput) String() string
String returns the string representation
type DescribeStackSetOperationRequest ¶
type DescribeStackSetOperationRequest struct { *aws.Request Input *DescribeStackSetOperationInput Copy func(*DescribeStackSetOperationInput) DescribeStackSetOperationRequest }
DescribeStackSetOperationRequest is the request type for the DescribeStackSetOperation API operation.
func (DescribeStackSetOperationRequest) Send ¶
func (r DescribeStackSetOperationRequest) Send(ctx context.Context) (*DescribeStackSetOperationResponse, error)
Send marshals and sends the DescribeStackSetOperation API request.
type DescribeStackSetOperationResponse ¶ added in v0.9.0
type DescribeStackSetOperationResponse struct { *DescribeStackSetOperationOutput // contains filtered or unexported fields }
DescribeStackSetOperationResponse is the response type for the DescribeStackSetOperation API operation.
func (*DescribeStackSetOperationResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeStackSetOperationResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeStackSetOperation request.
type DescribeStackSetOutput ¶
type DescribeStackSetOutput struct { // The specified stack set. StackSet *StackSet `type:"structure"` // contains filtered or unexported fields }
func (DescribeStackSetOutput) String ¶
func (s DescribeStackSetOutput) String() string
String returns the string representation
type DescribeStackSetRequest ¶
type DescribeStackSetRequest struct { *aws.Request Input *DescribeStackSetInput Copy func(*DescribeStackSetInput) DescribeStackSetRequest }
DescribeStackSetRequest is the request type for the DescribeStackSet API operation.
func (DescribeStackSetRequest) Send ¶
func (r DescribeStackSetRequest) Send(ctx context.Context) (*DescribeStackSetResponse, error)
Send marshals and sends the DescribeStackSet API request.
type DescribeStackSetResponse ¶ added in v0.9.0
type DescribeStackSetResponse struct { *DescribeStackSetOutput // contains filtered or unexported fields }
DescribeStackSetResponse is the response type for the DescribeStackSet API operation.
func (*DescribeStackSetResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeStackSetResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeStackSet request.
type DescribeStacksInput ¶
type DescribeStacksInput struct { // A string that identifies the next page of stacks that you want to retrieve. NextToken *string `min:"1" type:"string"` // The name or the unique stack ID that is associated with the stack, which // are not always interchangeable: // // * Running stacks: You can specify either the stack's name or its unique // stack ID. // // * Deleted stacks: You must specify the unique stack ID. // // Default: There is no default value. StackName *string `type:"string"` // contains filtered or unexported fields }
The input for DescribeStacks action.
func (DescribeStacksInput) String ¶
func (s DescribeStacksInput) String() string
String returns the string representation
func (*DescribeStacksInput) Validate ¶
func (s *DescribeStacksInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeStacksOutput ¶
type DescribeStacksOutput struct { // If the output exceeds 1 MB in size, a string that identifies the next page // of stacks. If no additional page exists, this value is null. NextToken *string `min:"1" type:"string"` // A list of stack structures. Stacks []Stack `type:"list"` // contains filtered or unexported fields }
The output for a DescribeStacks action.
func (DescribeStacksOutput) String ¶
func (s DescribeStacksOutput) String() string
String returns the string representation
type DescribeStacksPaginator ¶ added in v0.9.0
DescribeStacksPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewDescribeStacksPaginator ¶ added in v0.9.0
func NewDescribeStacksPaginator(req DescribeStacksRequest) DescribeStacksPaginator
NewDescribeStacksRequestPaginator returns a paginator for DescribeStacks. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.DescribeStacksRequest(input) p := cloudformation.NewDescribeStacksRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*DescribeStacksPaginator) CurrentPage ¶ added in v0.9.0
func (p *DescribeStacksPaginator) CurrentPage() *DescribeStacksOutput
type DescribeStacksRequest ¶
type DescribeStacksRequest struct { *aws.Request Input *DescribeStacksInput Copy func(*DescribeStacksInput) DescribeStacksRequest }
DescribeStacksRequest is the request type for the DescribeStacks API operation.
func (DescribeStacksRequest) Send ¶
func (r DescribeStacksRequest) Send(ctx context.Context) (*DescribeStacksResponse, error)
Send marshals and sends the DescribeStacks API request.
type DescribeStacksResponse ¶ added in v0.9.0
type DescribeStacksResponse struct { *DescribeStacksOutput // contains filtered or unexported fields }
DescribeStacksResponse is the response type for the DescribeStacks API operation.
func (*DescribeStacksResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeStacksResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeStacks request.
type DetectStackDriftInput ¶ added in v0.6.0
type DetectStackDriftInput struct { // The logical names of any resources you want to use as filters. LogicalResourceIds []string `min:"1" type:"list"` // The name of the stack for which you want to detect drift. // // StackName is a required field StackName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DetectStackDriftInput) String ¶ added in v0.6.0
func (s DetectStackDriftInput) String() string
String returns the string representation
func (*DetectStackDriftInput) Validate ¶ added in v0.6.0
func (s *DetectStackDriftInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DetectStackDriftOutput ¶ added in v0.6.0
type DetectStackDriftOutput struct { // The ID of the drift detection results of this operation. // // AWS CloudFormation generates new results, with a new drift detection ID, // each time this operation is run. However, the number of drift results AWS // CloudFormation retains for any given stack, and for how long, may vary. // // StackDriftDetectionId is a required field StackDriftDetectionId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DetectStackDriftOutput) String ¶ added in v0.6.0
func (s DetectStackDriftOutput) String() string
String returns the string representation
type DetectStackDriftRequest ¶ added in v0.6.0
type DetectStackDriftRequest struct { *aws.Request Input *DetectStackDriftInput Copy func(*DetectStackDriftInput) DetectStackDriftRequest }
DetectStackDriftRequest is the request type for the DetectStackDrift API operation.
func (DetectStackDriftRequest) Send ¶ added in v0.6.0
func (r DetectStackDriftRequest) Send(ctx context.Context) (*DetectStackDriftResponse, error)
Send marshals and sends the DetectStackDrift API request.
type DetectStackDriftResponse ¶ added in v0.9.0
type DetectStackDriftResponse struct { *DetectStackDriftOutput // contains filtered or unexported fields }
DetectStackDriftResponse is the response type for the DetectStackDrift API operation.
func (*DetectStackDriftResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DetectStackDriftResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DetectStackDrift request.
type DetectStackResourceDriftInput ¶ added in v0.6.0
type DetectStackResourceDriftInput struct { // The logical name of the resource for which to return drift information. // // LogicalResourceId is a required field LogicalResourceId *string `type:"string" required:"true"` // The name of the stack to which the resource belongs. // // StackName is a required field StackName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DetectStackResourceDriftInput) String ¶ added in v0.6.0
func (s DetectStackResourceDriftInput) String() string
String returns the string representation
func (*DetectStackResourceDriftInput) Validate ¶ added in v0.6.0
func (s *DetectStackResourceDriftInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DetectStackResourceDriftOutput ¶ added in v0.6.0
type DetectStackResourceDriftOutput struct { // Information about whether the resource's actual configuration has drifted // from its expected template configuration, including actual and expected property // values and any differences detected. // // StackResourceDrift is a required field StackResourceDrift *StackResourceDrift `type:"structure" required:"true"` // contains filtered or unexported fields }
func (DetectStackResourceDriftOutput) String ¶ added in v0.6.0
func (s DetectStackResourceDriftOutput) String() string
String returns the string representation
type DetectStackResourceDriftRequest ¶ added in v0.6.0
type DetectStackResourceDriftRequest struct { *aws.Request Input *DetectStackResourceDriftInput Copy func(*DetectStackResourceDriftInput) DetectStackResourceDriftRequest }
DetectStackResourceDriftRequest is the request type for the DetectStackResourceDrift API operation.
func (DetectStackResourceDriftRequest) Send ¶ added in v0.6.0
func (r DetectStackResourceDriftRequest) Send(ctx context.Context) (*DetectStackResourceDriftResponse, error)
Send marshals and sends the DetectStackResourceDrift API request.
type DetectStackResourceDriftResponse ¶ added in v0.9.0
type DetectStackResourceDriftResponse struct { *DetectStackResourceDriftOutput // contains filtered or unexported fields }
DetectStackResourceDriftResponse is the response type for the DetectStackResourceDrift API operation.
func (*DetectStackResourceDriftResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DetectStackResourceDriftResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DetectStackResourceDrift request.
type DifferenceType ¶ added in v0.6.0
type DifferenceType string
const ( DifferenceTypeAdd DifferenceType = "ADD" DifferenceTypeRemove DifferenceType = "REMOVE" DifferenceTypeNotEqual DifferenceType = "NOT_EQUAL" )
Enum values for DifferenceType
func (DifferenceType) MarshalValue ¶ added in v0.6.0
func (enum DifferenceType) MarshalValue() (string, error)
func (DifferenceType) MarshalValueBuf ¶ added in v0.6.0
func (enum DifferenceType) MarshalValueBuf(b []byte) ([]byte, error)
type EstimateTemplateCostInput ¶
type EstimateTemplateCostInput struct { // A list of Parameter structures that specify input parameters. Parameters []Parameter `type:"list"` // Structure containing the template body with a minimum length of 1 byte and // a maximum length of 51,200 bytes. (For more information, go to Template Anatomy // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the AWS CloudFormation User Guide.) // // Conditional: You must pass TemplateBody or TemplateURL. If both are passed, // only TemplateBody is used. TemplateBody *string `min:"1" type:"string"` // Location of file containing the template body. The URL must point to a template // that is located in an Amazon S3 bucket. For more information, go to Template // Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the AWS CloudFormation User Guide. // // Conditional: You must pass TemplateURL or TemplateBody. If both are passed, // only TemplateBody is used. TemplateURL *string `min:"1" type:"string"` // contains filtered or unexported fields }
The input for an EstimateTemplateCost action.
func (EstimateTemplateCostInput) String ¶
func (s EstimateTemplateCostInput) String() string
String returns the string representation
func (*EstimateTemplateCostInput) Validate ¶
func (s *EstimateTemplateCostInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type EstimateTemplateCostOutput ¶
type EstimateTemplateCostOutput struct { // An AWS Simple Monthly Calculator URL with a query string that describes the // resources required to run the template. Url *string `type:"string"` // contains filtered or unexported fields }
The output for a EstimateTemplateCost action.
func (EstimateTemplateCostOutput) String ¶
func (s EstimateTemplateCostOutput) String() string
String returns the string representation
type EstimateTemplateCostRequest ¶
type EstimateTemplateCostRequest struct { *aws.Request Input *EstimateTemplateCostInput Copy func(*EstimateTemplateCostInput) EstimateTemplateCostRequest }
EstimateTemplateCostRequest is the request type for the EstimateTemplateCost API operation.
func (EstimateTemplateCostRequest) Send ¶
func (r EstimateTemplateCostRequest) Send(ctx context.Context) (*EstimateTemplateCostResponse, error)
Send marshals and sends the EstimateTemplateCost API request.
type EstimateTemplateCostResponse ¶ added in v0.9.0
type EstimateTemplateCostResponse struct { *EstimateTemplateCostOutput // contains filtered or unexported fields }
EstimateTemplateCostResponse is the response type for the EstimateTemplateCost API operation.
func (*EstimateTemplateCostResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *EstimateTemplateCostResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the EstimateTemplateCost request.
type EvaluationType ¶
type EvaluationType string
const ( EvaluationTypeStatic EvaluationType = "Static" EvaluationTypeDynamic EvaluationType = "Dynamic" )
Enum values for EvaluationType
func (EvaluationType) MarshalValue ¶ added in v0.3.0
func (enum EvaluationType) MarshalValue() (string, error)
func (EvaluationType) MarshalValueBuf ¶ added in v0.3.0
func (enum EvaluationType) MarshalValueBuf(b []byte) ([]byte, error)
type ExecuteChangeSetInput ¶
type ExecuteChangeSetInput struct { // The name or ARN of the change set that you want use to update the specified // stack. // // ChangeSetName is a required field ChangeSetName *string `min:"1" type:"string" required:"true"` // A unique identifier for this ExecuteChangeSet request. Specify this token // if you plan to retry requests so that AWS CloudFormation knows that you're // not attempting to execute a change set to update a stack with the same name. // You might retry ExecuteChangeSet requests to ensure that AWS CloudFormation // successfully received them. ClientRequestToken *string `min:"1" type:"string"` // If you specified the name of a change set, specify the stack name or ID (ARN) // that is associated with the change set you want to execute. StackName *string `min:"1" type:"string"` // contains filtered or unexported fields }
The input for the ExecuteChangeSet action.
func (ExecuteChangeSetInput) String ¶
func (s ExecuteChangeSetInput) String() string
String returns the string representation
func (*ExecuteChangeSetInput) Validate ¶
func (s *ExecuteChangeSetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ExecuteChangeSetOutput ¶
type ExecuteChangeSetOutput struct {
// contains filtered or unexported fields
}
The output for the ExecuteChangeSet action.
func (ExecuteChangeSetOutput) String ¶
func (s ExecuteChangeSetOutput) String() string
String returns the string representation
type ExecuteChangeSetRequest ¶
type ExecuteChangeSetRequest struct { *aws.Request Input *ExecuteChangeSetInput Copy func(*ExecuteChangeSetInput) ExecuteChangeSetRequest }
ExecuteChangeSetRequest is the request type for the ExecuteChangeSet API operation.
func (ExecuteChangeSetRequest) Send ¶
func (r ExecuteChangeSetRequest) Send(ctx context.Context) (*ExecuteChangeSetResponse, error)
Send marshals and sends the ExecuteChangeSet API request.
type ExecuteChangeSetResponse ¶ added in v0.9.0
type ExecuteChangeSetResponse struct { *ExecuteChangeSetOutput // contains filtered or unexported fields }
ExecuteChangeSetResponse is the response type for the ExecuteChangeSet API operation.
func (*ExecuteChangeSetResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ExecuteChangeSetResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ExecuteChangeSet request.
type ExecutionStatus ¶
type ExecutionStatus string
const ( ExecutionStatusAvailable ExecutionStatus = "AVAILABLE" ExecutionStatusExecuteInProgress ExecutionStatus = "EXECUTE_IN_PROGRESS" ExecutionStatusExecuteComplete ExecutionStatus = "EXECUTE_COMPLETE" ExecutionStatusExecuteFailed ExecutionStatus = "EXECUTE_FAILED" ExecutionStatusObsolete ExecutionStatus = "OBSOLETE" )
Enum values for ExecutionStatus
func (ExecutionStatus) MarshalValue ¶ added in v0.3.0
func (enum ExecutionStatus) MarshalValue() (string, error)
func (ExecutionStatus) MarshalValueBuf ¶ added in v0.3.0
func (enum ExecutionStatus) MarshalValueBuf(b []byte) ([]byte, error)
type Export ¶
type Export struct { // The stack that contains the exported output name and value. ExportingStackId *string `type:"string"` // The name of exported output value. Use this name and the Fn::ImportValue // function to import the associated value into other stacks. The name is defined // in the Export field in the associated stack's Outputs section. Name *string `type:"string"` // The value of the exported output, such as a resource physical ID. This value // is defined in the Export field in the associated stack's Outputs section. Value *string `type:"string"` // contains filtered or unexported fields }
The Export structure describes the exported output values for a stack.
type GetStackPolicyInput ¶
type GetStackPolicyInput struct { // The name or unique stack ID that is associated with the stack whose policy // you want to get. // // StackName is a required field StackName *string `type:"string" required:"true"` // contains filtered or unexported fields }
The input for the GetStackPolicy action.
func (GetStackPolicyInput) String ¶
func (s GetStackPolicyInput) String() string
String returns the string representation
func (*GetStackPolicyInput) Validate ¶
func (s *GetStackPolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetStackPolicyOutput ¶
type GetStackPolicyOutput struct { // Structure containing the stack policy body. (For more information, go to // Prevent Updates to Stack Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html) // in the AWS CloudFormation User Guide.) StackPolicyBody *string `min:"1" type:"string"` // contains filtered or unexported fields }
The output for the GetStackPolicy action.
func (GetStackPolicyOutput) String ¶
func (s GetStackPolicyOutput) String() string
String returns the string representation
type GetStackPolicyRequest ¶
type GetStackPolicyRequest struct { *aws.Request Input *GetStackPolicyInput Copy func(*GetStackPolicyInput) GetStackPolicyRequest }
GetStackPolicyRequest is the request type for the GetStackPolicy API operation.
func (GetStackPolicyRequest) Send ¶
func (r GetStackPolicyRequest) Send(ctx context.Context) (*GetStackPolicyResponse, error)
Send marshals and sends the GetStackPolicy API request.
type GetStackPolicyResponse ¶ added in v0.9.0
type GetStackPolicyResponse struct { *GetStackPolicyOutput // contains filtered or unexported fields }
GetStackPolicyResponse is the response type for the GetStackPolicy API operation.
func (*GetStackPolicyResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetStackPolicyResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetStackPolicy request.
type GetTemplateInput ¶
type GetTemplateInput struct { // The name or Amazon Resource Name (ARN) of a change set for which AWS CloudFormation // returns the associated template. If you specify a name, you must also specify // the StackName. ChangeSetName *string `min:"1" type:"string"` // The name or the unique stack ID that is associated with the stack, which // are not always interchangeable: // // * Running stacks: You can specify either the stack's name or its unique // stack ID. // // * Deleted stacks: You must specify the unique stack ID. // // Default: There is no default value. StackName *string `type:"string"` // For templates that include transforms, the stage of the template that AWS // CloudFormation returns. To get the user-submitted template, specify Original. // To get the template after AWS CloudFormation has processed all transforms, // specify Processed. // // If the template doesn't include transforms, Original and Processed return // the same template. By default, AWS CloudFormation specifies Original. TemplateStage TemplateStage `type:"string" enum:"true"` // contains filtered or unexported fields }
The input for a GetTemplate action.
func (GetTemplateInput) String ¶
func (s GetTemplateInput) String() string
String returns the string representation
func (*GetTemplateInput) Validate ¶
func (s *GetTemplateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetTemplateOutput ¶
type GetTemplateOutput struct { // The stage of the template that you can retrieve. For stacks, the Original // and Processed templates are always available. For change sets, the Original // template is always available. After AWS CloudFormation finishes creating // the change set, the Processed template becomes available. StagesAvailable []TemplateStage `type:"list"` // Structure containing the template body. (For more information, go to Template // Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the AWS CloudFormation User Guide.) // // AWS CloudFormation returns the same template that was used when the stack // was created. TemplateBody *string `min:"1" type:"string"` // contains filtered or unexported fields }
The output for GetTemplate action.
func (GetTemplateOutput) String ¶
func (s GetTemplateOutput) String() string
String returns the string representation
type GetTemplateRequest ¶
type GetTemplateRequest struct { *aws.Request Input *GetTemplateInput Copy func(*GetTemplateInput) GetTemplateRequest }
GetTemplateRequest is the request type for the GetTemplate API operation.
func (GetTemplateRequest) Send ¶
func (r GetTemplateRequest) Send(ctx context.Context) (*GetTemplateResponse, error)
Send marshals and sends the GetTemplate API request.
type GetTemplateResponse ¶ added in v0.9.0
type GetTemplateResponse struct { *GetTemplateOutput // contains filtered or unexported fields }
GetTemplateResponse is the response type for the GetTemplate API operation.
func (*GetTemplateResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetTemplateResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetTemplate request.
type GetTemplateSummaryInput ¶
type GetTemplateSummaryInput struct { // The name or the stack ID that is associated with the stack, which are not // always interchangeable. For running stacks, you can specify either the stack's // name or its unique stack ID. For deleted stack, you must specify the unique // stack ID. // // Conditional: You must specify only one of the following parameters: StackName, // StackSetName, TemplateBody, or TemplateURL. StackName *string `min:"1" type:"string"` // The name or unique ID of the stack set from which the stack was created. // // Conditional: You must specify only one of the following parameters: StackName, // StackSetName, TemplateBody, or TemplateURL. StackSetName *string `type:"string"` // Structure containing the template body with a minimum length of 1 byte and // a maximum length of 51,200 bytes. For more information about templates, see // Template Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the AWS CloudFormation User Guide. // // Conditional: You must specify only one of the following parameters: StackName, // StackSetName, TemplateBody, or TemplateURL. TemplateBody *string `min:"1" type:"string"` // Location of file containing the template body. The URL must point to a template // (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more // information about templates, see Template Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the AWS CloudFormation User Guide. // // Conditional: You must specify only one of the following parameters: StackName, // StackSetName, TemplateBody, or TemplateURL. TemplateURL *string `min:"1" type:"string"` // contains filtered or unexported fields }
The input for the GetTemplateSummary action.
func (GetTemplateSummaryInput) String ¶
func (s GetTemplateSummaryInput) String() string
String returns the string representation
func (*GetTemplateSummaryInput) Validate ¶
func (s *GetTemplateSummaryInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetTemplateSummaryOutput ¶
type GetTemplateSummaryOutput struct { // The capabilities found within the template. If your template contains IAM // resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value // for this parameter when you use the CreateStack or UpdateStack actions with // your template; otherwise, those actions return an InsufficientCapabilities // error. // // For more information, see Acknowledging IAM Resources in AWS CloudFormation // Templates (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). Capabilities []Capability `type:"list"` // The list of resources that generated the values in the Capabilities response // element. CapabilitiesReason *string `type:"string"` // A list of the transforms that are declared in the template. DeclaredTransforms []string `type:"list"` // The value that is defined in the Description property of the template. Description *string `min:"1" type:"string"` // The value that is defined for the Metadata property of the template. Metadata *string `type:"string"` // A list of parameter declarations that describe various properties for each // parameter. Parameters []ParameterDeclaration `type:"list"` // A list of resource identifier summaries that describe the target resources // of an import operation and the properties you can provide during the import // to identify the target resources. For example, BucketName is a possible identifier // property for an AWS::S3::Bucket resource. ResourceIdentifierSummaries []ResourceIdentifierSummary `type:"list"` // A list of all the template resource types that are defined in the template, // such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance. ResourceTypes []string `type:"list"` // The AWS template format version, which identifies the capabilities of the // template. Version *string `type:"string"` // contains filtered or unexported fields }
The output for the GetTemplateSummary action.
func (GetTemplateSummaryOutput) String ¶
func (s GetTemplateSummaryOutput) String() string
String returns the string representation
type GetTemplateSummaryRequest ¶
type GetTemplateSummaryRequest struct { *aws.Request Input *GetTemplateSummaryInput Copy func(*GetTemplateSummaryInput) GetTemplateSummaryRequest }
GetTemplateSummaryRequest is the request type for the GetTemplateSummary API operation.
func (GetTemplateSummaryRequest) Send ¶
func (r GetTemplateSummaryRequest) Send(ctx context.Context) (*GetTemplateSummaryResponse, error)
Send marshals and sends the GetTemplateSummary API request.
type GetTemplateSummaryResponse ¶ added in v0.9.0
type GetTemplateSummaryResponse struct { *GetTemplateSummaryOutput // contains filtered or unexported fields }
GetTemplateSummaryResponse is the response type for the GetTemplateSummary API operation.
func (*GetTemplateSummaryResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetTemplateSummaryResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetTemplateSummary request.
type ListChangeSetsInput ¶
type ListChangeSetsInput struct { // A string (provided by the ListChangeSets response output) that identifies // the next page of change sets that you want to retrieve. NextToken *string `min:"1" type:"string"` // The name or the Amazon Resource Name (ARN) of the stack for which you want // to list change sets. // // StackName is a required field StackName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The input for the ListChangeSets action.
func (ListChangeSetsInput) String ¶
func (s ListChangeSetsInput) String() string
String returns the string representation
func (*ListChangeSetsInput) Validate ¶
func (s *ListChangeSetsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListChangeSetsOutput ¶
type ListChangeSetsOutput struct { // If the output exceeds 1 MB, a string that identifies the next page of change // sets. If there is no additional page, this value is null. NextToken *string `min:"1" type:"string"` // A list of ChangeSetSummary structures that provides the ID and status of // each change set for the specified stack. Summaries []ChangeSetSummary `type:"list"` // contains filtered or unexported fields }
The output for the ListChangeSets action.
func (ListChangeSetsOutput) String ¶
func (s ListChangeSetsOutput) String() string
String returns the string representation
type ListChangeSetsRequest ¶
type ListChangeSetsRequest struct { *aws.Request Input *ListChangeSetsInput Copy func(*ListChangeSetsInput) ListChangeSetsRequest }
ListChangeSetsRequest is the request type for the ListChangeSets API operation.
func (ListChangeSetsRequest) Send ¶
func (r ListChangeSetsRequest) Send(ctx context.Context) (*ListChangeSetsResponse, error)
Send marshals and sends the ListChangeSets API request.
type ListChangeSetsResponse ¶ added in v0.9.0
type ListChangeSetsResponse struct { *ListChangeSetsOutput // contains filtered or unexported fields }
ListChangeSetsResponse is the response type for the ListChangeSets API operation.
func (*ListChangeSetsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListChangeSetsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListChangeSets request.
type ListExportsInput ¶
type ListExportsInput struct { // A string (provided by the ListExports response output) that identifies the // next page of exported output values that you asked to retrieve. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (ListExportsInput) String ¶
func (s ListExportsInput) String() string
String returns the string representation
func (*ListExportsInput) Validate ¶
func (s *ListExportsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListExportsOutput ¶
type ListExportsOutput struct { // The output for the ListExports action. Exports []Export `type:"list"` // If the output exceeds 100 exported output values, a string that identifies // the next page of exports. If there is no additional page, this value is null. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (ListExportsOutput) String ¶
func (s ListExportsOutput) String() string
String returns the string representation
type ListExportsPaginator ¶ added in v0.9.0
ListExportsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListExportsPaginator ¶ added in v0.9.0
func NewListExportsPaginator(req ListExportsRequest) ListExportsPaginator
NewListExportsRequestPaginator returns a paginator for ListExports. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListExportsRequest(input) p := cloudformation.NewListExportsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListExportsPaginator) CurrentPage ¶ added in v0.9.0
func (p *ListExportsPaginator) CurrentPage() *ListExportsOutput
type ListExportsRequest ¶
type ListExportsRequest struct { *aws.Request Input *ListExportsInput Copy func(*ListExportsInput) ListExportsRequest }
ListExportsRequest is the request type for the ListExports API operation.
func (ListExportsRequest) Send ¶
func (r ListExportsRequest) Send(ctx context.Context) (*ListExportsResponse, error)
Send marshals and sends the ListExports API request.
type ListExportsResponse ¶ added in v0.9.0
type ListExportsResponse struct { *ListExportsOutput // contains filtered or unexported fields }
ListExportsResponse is the response type for the ListExports API operation.
func (*ListExportsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListExportsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListExports request.
type ListImportsInput ¶
type ListImportsInput struct { // The name of the exported output value. AWS CloudFormation returns the stack // names that are importing this value. // // ExportName is a required field ExportName *string `type:"string" required:"true"` // A string (provided by the ListImports response output) that identifies the // next page of stacks that are importing the specified exported output value. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (ListImportsInput) String ¶
func (s ListImportsInput) String() string
String returns the string representation
func (*ListImportsInput) Validate ¶
func (s *ListImportsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListImportsOutput ¶
type ListImportsOutput struct { // A list of stack names that are importing the specified exported output value. Imports []string `type:"list"` // A string that identifies the next page of exports. If there is no additional // page, this value is null. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (ListImportsOutput) String ¶
func (s ListImportsOutput) String() string
String returns the string representation
type ListImportsPaginator ¶ added in v0.9.0
ListImportsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListImportsPaginator ¶ added in v0.9.0
func NewListImportsPaginator(req ListImportsRequest) ListImportsPaginator
NewListImportsRequestPaginator returns a paginator for ListImports. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListImportsRequest(input) p := cloudformation.NewListImportsRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListImportsPaginator) CurrentPage ¶ added in v0.9.0
func (p *ListImportsPaginator) CurrentPage() *ListImportsOutput
type ListImportsRequest ¶
type ListImportsRequest struct { *aws.Request Input *ListImportsInput Copy func(*ListImportsInput) ListImportsRequest }
ListImportsRequest is the request type for the ListImports API operation.
func (ListImportsRequest) Send ¶
func (r ListImportsRequest) Send(ctx context.Context) (*ListImportsResponse, error)
Send marshals and sends the ListImports API request.
type ListImportsResponse ¶ added in v0.9.0
type ListImportsResponse struct { *ListImportsOutput // contains filtered or unexported fields }
ListImportsResponse is the response type for the ListImports API operation.
func (*ListImportsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListImportsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListImports request.
type ListStackInstancesInput ¶
type ListStackInstancesInput struct { // The maximum number of results to be returned with a single call. If the number // of available results exceeds this maximum, the response includes a NextToken // value that you can assign to the NextToken request parameter to get the next // set of results. MaxResults *int64 `min:"1" type:"integer"` // If the previous request didn't return all of the remaining results, the response's // NextToken parameter value is set to a token. To retrieve the next set of // results, call ListStackInstances again and assign that token to the request // object's NextToken parameter. If there are no remaining results, the previous // response object's NextToken parameter is set to null. NextToken *string `min:"1" type:"string"` // The name of the AWS account that you want to list stack instances for. StackInstanceAccount *string `type:"string"` // The name of the region where you want to list stack instances. StackInstanceRegion *string `type:"string"` // The name or unique ID of the stack set that you want to list stack instances // for. // // StackSetName is a required field StackSetName *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (ListStackInstancesInput) String ¶
func (s ListStackInstancesInput) String() string
String returns the string representation
func (*ListStackInstancesInput) Validate ¶
func (s *ListStackInstancesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListStackInstancesOutput ¶
type ListStackInstancesOutput struct { // If the request doesn't return all of the remaining results, NextToken is // set to a token. To retrieve the next set of results, call ListStackInstances // again and assign that token to the request object's NextToken parameter. // If the request returns all results, NextToken is set to null. NextToken *string `min:"1" type:"string"` // A list of StackInstanceSummary structures that contain information about // the specified stack instances. Summaries []StackInstanceSummary `type:"list"` // contains filtered or unexported fields }
func (ListStackInstancesOutput) String ¶
func (s ListStackInstancesOutput) String() string
String returns the string representation
type ListStackInstancesRequest ¶
type ListStackInstancesRequest struct { *aws.Request Input *ListStackInstancesInput Copy func(*ListStackInstancesInput) ListStackInstancesRequest }
ListStackInstancesRequest is the request type for the ListStackInstances API operation.
func (ListStackInstancesRequest) Send ¶
func (r ListStackInstancesRequest) Send(ctx context.Context) (*ListStackInstancesResponse, error)
Send marshals and sends the ListStackInstances API request.
type ListStackInstancesResponse ¶ added in v0.9.0
type ListStackInstancesResponse struct { *ListStackInstancesOutput // contains filtered or unexported fields }
ListStackInstancesResponse is the response type for the ListStackInstances API operation.
func (*ListStackInstancesResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListStackInstancesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListStackInstances request.
type ListStackResourcesInput ¶
type ListStackResourcesInput struct { // A string that identifies the next page of stack resources that you want to // retrieve. NextToken *string `min:"1" type:"string"` // The name or the unique stack ID that is associated with the stack, which // are not always interchangeable: // // * Running stacks: You can specify either the stack's name or its unique // stack ID. // // * Deleted stacks: You must specify the unique stack ID. // // Default: There is no default value. // // StackName is a required field StackName *string `type:"string" required:"true"` // contains filtered or unexported fields }
The input for the ListStackResource action.
func (ListStackResourcesInput) String ¶
func (s ListStackResourcesInput) String() string
String returns the string representation
func (*ListStackResourcesInput) Validate ¶
func (s *ListStackResourcesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListStackResourcesOutput ¶
type ListStackResourcesOutput struct { // If the output exceeds 1 MB, a string that identifies the next page of stack // resources. If no additional page exists, this value is null. NextToken *string `min:"1" type:"string"` // A list of StackResourceSummary structures. StackResourceSummaries []StackResourceSummary `type:"list"` // contains filtered or unexported fields }
The output for a ListStackResources action.
func (ListStackResourcesOutput) String ¶
func (s ListStackResourcesOutput) String() string
String returns the string representation
type ListStackResourcesPaginator ¶ added in v0.9.0
ListStackResourcesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListStackResourcesPaginator ¶ added in v0.9.0
func NewListStackResourcesPaginator(req ListStackResourcesRequest) ListStackResourcesPaginator
NewListStackResourcesRequestPaginator returns a paginator for ListStackResources. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListStackResourcesRequest(input) p := cloudformation.NewListStackResourcesRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListStackResourcesPaginator) CurrentPage ¶ added in v0.9.0
func (p *ListStackResourcesPaginator) CurrentPage() *ListStackResourcesOutput
type ListStackResourcesRequest ¶
type ListStackResourcesRequest struct { *aws.Request Input *ListStackResourcesInput Copy func(*ListStackResourcesInput) ListStackResourcesRequest }
ListStackResourcesRequest is the request type for the ListStackResources API operation.
func (ListStackResourcesRequest) Send ¶
func (r ListStackResourcesRequest) Send(ctx context.Context) (*ListStackResourcesResponse, error)
Send marshals and sends the ListStackResources API request.
type ListStackResourcesResponse ¶ added in v0.9.0
type ListStackResourcesResponse struct { *ListStackResourcesOutput // contains filtered or unexported fields }
ListStackResourcesResponse is the response type for the ListStackResources API operation.
func (*ListStackResourcesResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListStackResourcesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListStackResources request.
type ListStackSetOperationResultsInput ¶
type ListStackSetOperationResultsInput struct { // The maximum number of results to be returned with a single call. If the number // of available results exceeds this maximum, the response includes a NextToken // value that you can assign to the NextToken request parameter to get the next // set of results. MaxResults *int64 `min:"1" type:"integer"` // If the previous request didn't return all of the remaining results, the response // object's NextToken parameter value is set to a token. To retrieve the next // set of results, call ListStackSetOperationResults again and assign that token // to the request object's NextToken parameter. If there are no remaining results, // the previous response object's NextToken parameter is set to null. NextToken *string `min:"1" type:"string"` // The ID of the stack set operation. // // OperationId is a required field OperationId *string `min:"1" type:"string" required:"true"` // The name or unique ID of the stack set that you want to get operation results // for. // // StackSetName is a required field StackSetName *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (ListStackSetOperationResultsInput) String ¶
func (s ListStackSetOperationResultsInput) String() string
String returns the string representation
func (*ListStackSetOperationResultsInput) Validate ¶
func (s *ListStackSetOperationResultsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListStackSetOperationResultsOutput ¶
type ListStackSetOperationResultsOutput struct { // If the request doesn't return all results, NextToken is set to a token. To // retrieve the next set of results, call ListOperationResults again and assign // that token to the request object's NextToken parameter. If there are no remaining // results, NextToken is set to null. NextToken *string `min:"1" type:"string"` // A list of StackSetOperationResultSummary structures that contain information // about the specified operation results, for accounts and regions that are // included in the operation. Summaries []StackSetOperationResultSummary `type:"list"` // contains filtered or unexported fields }
func (ListStackSetOperationResultsOutput) String ¶
func (s ListStackSetOperationResultsOutput) String() string
String returns the string representation
type ListStackSetOperationResultsRequest ¶
type ListStackSetOperationResultsRequest struct { *aws.Request Input *ListStackSetOperationResultsInput Copy func(*ListStackSetOperationResultsInput) ListStackSetOperationResultsRequest }
ListStackSetOperationResultsRequest is the request type for the ListStackSetOperationResults API operation.
func (ListStackSetOperationResultsRequest) Send ¶
func (r ListStackSetOperationResultsRequest) Send(ctx context.Context) (*ListStackSetOperationResultsResponse, error)
Send marshals and sends the ListStackSetOperationResults API request.
type ListStackSetOperationResultsResponse ¶ added in v0.9.0
type ListStackSetOperationResultsResponse struct { *ListStackSetOperationResultsOutput // contains filtered or unexported fields }
ListStackSetOperationResultsResponse is the response type for the ListStackSetOperationResults API operation.
func (*ListStackSetOperationResultsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListStackSetOperationResultsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListStackSetOperationResults request.
type ListStackSetOperationsInput ¶
type ListStackSetOperationsInput struct { // The maximum number of results to be returned with a single call. If the number // of available results exceeds this maximum, the response includes a NextToken // value that you can assign to the NextToken request parameter to get the next // set of results. MaxResults *int64 `min:"1" type:"integer"` // If the previous paginated request didn't return all of the remaining results, // the response object's NextToken parameter value is set to a token. To retrieve // the next set of results, call ListStackSetOperations again and assign that // token to the request object's NextToken parameter. If there are no remaining // results, the previous response object's NextToken parameter is set to null. NextToken *string `min:"1" type:"string"` // The name or unique ID of the stack set that you want to get operation summaries // for. // // StackSetName is a required field StackSetName *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (ListStackSetOperationsInput) String ¶
func (s ListStackSetOperationsInput) String() string
String returns the string representation
func (*ListStackSetOperationsInput) Validate ¶
func (s *ListStackSetOperationsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListStackSetOperationsOutput ¶
type ListStackSetOperationsOutput struct { // If the request doesn't return all results, NextToken is set to a token. To // retrieve the next set of results, call ListOperationResults again and assign // that token to the request object's NextToken parameter. If there are no remaining // results, NextToken is set to null. NextToken *string `min:"1" type:"string"` // A list of StackSetOperationSummary structures that contain summary information // about operations for the specified stack set. Summaries []StackSetOperationSummary `type:"list"` // contains filtered or unexported fields }
func (ListStackSetOperationsOutput) String ¶
func (s ListStackSetOperationsOutput) String() string
String returns the string representation
type ListStackSetOperationsRequest ¶
type ListStackSetOperationsRequest struct { *aws.Request Input *ListStackSetOperationsInput Copy func(*ListStackSetOperationsInput) ListStackSetOperationsRequest }
ListStackSetOperationsRequest is the request type for the ListStackSetOperations API operation.
func (ListStackSetOperationsRequest) Send ¶
func (r ListStackSetOperationsRequest) Send(ctx context.Context) (*ListStackSetOperationsResponse, error)
Send marshals and sends the ListStackSetOperations API request.
type ListStackSetOperationsResponse ¶ added in v0.9.0
type ListStackSetOperationsResponse struct { *ListStackSetOperationsOutput // contains filtered or unexported fields }
ListStackSetOperationsResponse is the response type for the ListStackSetOperations API operation.
func (*ListStackSetOperationsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListStackSetOperationsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListStackSetOperations request.
type ListStackSetsInput ¶
type ListStackSetsInput struct { // The maximum number of results to be returned with a single call. If the number // of available results exceeds this maximum, the response includes a NextToken // value that you can assign to the NextToken request parameter to get the next // set of results. MaxResults *int64 `min:"1" type:"integer"` // If the previous paginated request didn't return all of the remaining results, // the response object's NextToken parameter value is set to a token. To retrieve // the next set of results, call ListStackSets again and assign that token to // the request object's NextToken parameter. If there are no remaining results, // the previous response object's NextToken parameter is set to null. NextToken *string `min:"1" type:"string"` // The status of the stack sets that you want to get summary information about. Status StackSetStatus `type:"string" enum:"true"` // contains filtered or unexported fields }
func (ListStackSetsInput) String ¶
func (s ListStackSetsInput) String() string
String returns the string representation
func (*ListStackSetsInput) Validate ¶
func (s *ListStackSetsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListStackSetsOutput ¶
type ListStackSetsOutput struct { // If the request doesn't return all of the remaining results, NextToken is // set to a token. To retrieve the next set of results, call ListStackInstances // again and assign that token to the request object's NextToken parameter. // If the request returns all results, NextToken is set to null. NextToken *string `min:"1" type:"string"` // A list of StackSetSummary structures that contain information about the user's // stack sets. Summaries []StackSetSummary `type:"list"` // contains filtered or unexported fields }
func (ListStackSetsOutput) String ¶
func (s ListStackSetsOutput) String() string
String returns the string representation
type ListStackSetsRequest ¶
type ListStackSetsRequest struct { *aws.Request Input *ListStackSetsInput Copy func(*ListStackSetsInput) ListStackSetsRequest }
ListStackSetsRequest is the request type for the ListStackSets API operation.
func (ListStackSetsRequest) Send ¶
func (r ListStackSetsRequest) Send(ctx context.Context) (*ListStackSetsResponse, error)
Send marshals and sends the ListStackSets API request.
type ListStackSetsResponse ¶ added in v0.9.0
type ListStackSetsResponse struct { *ListStackSetsOutput // contains filtered or unexported fields }
ListStackSetsResponse is the response type for the ListStackSets API operation.
func (*ListStackSetsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListStackSetsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListStackSets request.
type ListStacksInput ¶
type ListStacksInput struct { // A string that identifies the next page of stacks that you want to retrieve. NextToken *string `min:"1" type:"string"` // Stack status to use as a filter. Specify one or more stack status codes to // list only stacks with the specified status codes. For a complete list of // stack status codes, see the StackStatus parameter of the Stack data type. StackStatusFilter []StackStatus `type:"list"` // contains filtered or unexported fields }
The input for ListStacks action.
func (ListStacksInput) String ¶
func (s ListStacksInput) String() string
String returns the string representation
func (*ListStacksInput) Validate ¶
func (s *ListStacksInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListStacksOutput ¶
type ListStacksOutput struct { // If the output exceeds 1 MB in size, a string that identifies the next page // of stacks. If no additional page exists, this value is null. NextToken *string `min:"1" type:"string"` // A list of StackSummary structures containing information about the specified // stacks. StackSummaries []StackSummary `type:"list"` // contains filtered or unexported fields }
The output for ListStacks action.
func (ListStacksOutput) String ¶
func (s ListStacksOutput) String() string
String returns the string representation
type ListStacksPaginator ¶ added in v0.9.0
ListStacksPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListStacksPaginator ¶ added in v0.9.0
func NewListStacksPaginator(req ListStacksRequest) ListStacksPaginator
NewListStacksRequestPaginator returns a paginator for ListStacks. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListStacksRequest(input) p := cloudformation.NewListStacksRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListStacksPaginator) CurrentPage ¶ added in v0.9.0
func (p *ListStacksPaginator) CurrentPage() *ListStacksOutput
type ListStacksRequest ¶
type ListStacksRequest struct { *aws.Request Input *ListStacksInput Copy func(*ListStacksInput) ListStacksRequest }
ListStacksRequest is the request type for the ListStacks API operation.
func (ListStacksRequest) Send ¶
func (r ListStacksRequest) Send(ctx context.Context) (*ListStacksResponse, error)
Send marshals and sends the ListStacks API request.
type ListStacksResponse ¶ added in v0.9.0
type ListStacksResponse struct { *ListStacksOutput // contains filtered or unexported fields }
ListStacksResponse is the response type for the ListStacks API operation.
func (*ListStacksResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListStacksResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListStacks request.
type OnFailure ¶
type OnFailure string
const ( OnFailureDoNothing OnFailure = "DO_NOTHING" OnFailureRollback OnFailure = "ROLLBACK" OnFailureDelete OnFailure = "DELETE" )
Enum values for OnFailure
func (OnFailure) MarshalValue ¶ added in v0.3.0
type Output ¶
type Output struct { // User defined description associated with the output. Description *string `min:"1" type:"string"` // The name of the export associated with the output. ExportName *string `type:"string"` // The key associated with the output. OutputKey *string `type:"string"` // The value associated with the output. OutputValue *string `type:"string"` // contains filtered or unexported fields }
The Output data type.
type Parameter ¶
type Parameter struct { // The key associated with the parameter. If you don't specify a key and value // for a particular parameter, AWS CloudFormation uses the default value that // is specified in your template. ParameterKey *string `type:"string"` // The input value associated with the parameter. ParameterValue *string `type:"string"` // Read-only. The value that corresponds to a Systems Manager parameter key. // This field is returned only for SSM parameter types (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types) // in the template. ResolvedValue *string `type:"string"` // During a stack update, use the existing parameter value that the stack is // using for a given parameter key. If you specify true, do not specify a parameter // value. UsePreviousValue *bool `type:"boolean"` // contains filtered or unexported fields }
The Parameter data type.
type ParameterConstraints ¶
type ParameterConstraints struct { // A list of values that are permitted for a parameter. AllowedValues []string `type:"list"` // contains filtered or unexported fields }
A set of criteria that AWS CloudFormation uses to validate parameter values. Although other constraints might be defined in the stack template, AWS CloudFormation returns only the AllowedValues property.
func (ParameterConstraints) String ¶
func (s ParameterConstraints) String() string
String returns the string representation
type ParameterDeclaration ¶
type ParameterDeclaration struct { // The default value of the parameter. DefaultValue *string `type:"string"` // The description that is associate with the parameter. Description *string `min:"1" type:"string"` // Flag that indicates whether the parameter value is shown as plain text in // logs and in the AWS Management Console. NoEcho *bool `type:"boolean"` // The criteria that AWS CloudFormation uses to validate parameter values. ParameterConstraints *ParameterConstraints `type:"structure"` // The name that is associated with the parameter. ParameterKey *string `type:"string"` // The type of parameter. ParameterType *string `type:"string"` // contains filtered or unexported fields }
The ParameterDeclaration data type.
func (ParameterDeclaration) String ¶
func (s ParameterDeclaration) String() string
String returns the string representation
type PhysicalResourceIdContextKeyValuePair ¶ added in v0.6.0
type PhysicalResourceIdContextKeyValuePair struct { // The resource context key. // // Key is a required field Key *string `type:"string" required:"true"` // The resource context value. // // Value is a required field Value *string `type:"string" required:"true"` // contains filtered or unexported fields }
Context information that enables AWS CloudFormation to uniquely identify a resource. AWS CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs are not enough to uniquely identify that resource. Each context key-value pair specifies a resource that contains the targeted resource.
func (PhysicalResourceIdContextKeyValuePair) String ¶ added in v0.6.0
func (s PhysicalResourceIdContextKeyValuePair) String() string
String returns the string representation
type PropertyDifference ¶ added in v0.6.0
type PropertyDifference struct { // The actual property value of the resource property. // // ActualValue is a required field ActualValue *string `type:"string" required:"true"` // The type of property difference. // // * ADD: A value has been added to a resource property that is an array // or list data type. // // * REMOVE: The property has been removed from the current resource configuration. // // * NOT_EQUAL: The current property value differs from its expected value // (as defined in the stack template and any values specified as template // parameters). // // DifferenceType is a required field DifferenceType DifferenceType `type:"string" required:"true" enum:"true"` // The expected property value of the resource property, as defined in the stack // template and any values specified as template parameters. // // ExpectedValue is a required field ExpectedValue *string `type:"string" required:"true"` // The fully-qualified path to the resource property. // // PropertyPath is a required field PropertyPath *string `type:"string" required:"true"` // contains filtered or unexported fields }
Information about a resource property whose actual value differs from its expected value, as defined in the stack template and any values specified as template parameters. These will be present only for resources whose StackResourceDriftStatus is MODIFIED. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html).
func (PropertyDifference) String ¶ added in v0.6.0
func (s PropertyDifference) String() string
String returns the string representation
type Replacement ¶
type Replacement string
const ( ReplacementTrue Replacement = "True" ReplacementFalse Replacement = "False" ReplacementConditional Replacement = "Conditional" )
Enum values for Replacement
func (Replacement) MarshalValue ¶ added in v0.3.0
func (enum Replacement) MarshalValue() (string, error)
func (Replacement) MarshalValueBuf ¶ added in v0.3.0
func (enum Replacement) MarshalValueBuf(b []byte) ([]byte, error)
type RequiresRecreation ¶
type RequiresRecreation string
const ( RequiresRecreationNever RequiresRecreation = "Never" RequiresRecreationConditionally RequiresRecreation = "Conditionally" RequiresRecreationAlways RequiresRecreation = "Always" )
Enum values for RequiresRecreation
func (RequiresRecreation) MarshalValue ¶ added in v0.3.0
func (enum RequiresRecreation) MarshalValue() (string, error)
func (RequiresRecreation) MarshalValueBuf ¶ added in v0.3.0
func (enum RequiresRecreation) MarshalValueBuf(b []byte) ([]byte, error)
type ResourceAttribute ¶
type ResourceAttribute string
const ( ResourceAttributeProperties ResourceAttribute = "Properties" ResourceAttributeMetadata ResourceAttribute = "Metadata" ResourceAttributeCreationPolicy ResourceAttribute = "CreationPolicy" ResourceAttributeUpdatePolicy ResourceAttribute = "UpdatePolicy" ResourceAttributeDeletionPolicy ResourceAttribute = "DeletionPolicy" ResourceAttributeTags ResourceAttribute = "Tags" )
Enum values for ResourceAttribute
func (ResourceAttribute) MarshalValue ¶ added in v0.3.0
func (enum ResourceAttribute) MarshalValue() (string, error)
func (ResourceAttribute) MarshalValueBuf ¶ added in v0.3.0
func (enum ResourceAttribute) MarshalValueBuf(b []byte) ([]byte, error)
type ResourceChange ¶
type ResourceChange struct { // The action that AWS CloudFormation takes on the resource, such as Add (adds // a new resource), Modify (changes a resource), or Remove (deletes a resource). Action ChangeAction `type:"string" enum:"true"` // For the Modify action, a list of ResourceChangeDetail structures that describes // the changes that AWS CloudFormation will make to the resource. Details []ResourceChangeDetail `type:"list"` // The resource's logical ID, which is defined in the stack's template. LogicalResourceId *string `type:"string"` // The resource's physical ID (resource name). Resources that you are adding // don't have physical IDs because they haven't been created. PhysicalResourceId *string `type:"string"` // For the Modify action, indicates whether AWS CloudFormation will replace // the resource by creating a new one and deleting the old one. This value depends // on the value of the RequiresRecreation property in the ResourceTargetDefinition // structure. For example, if the RequiresRecreation field is Always and the // Evaluation field is Static, Replacement is True. If the RequiresRecreation // field is Always and the Evaluation field is Dynamic, Replacement is Conditionally. // // If you have multiple changes with different RequiresRecreation values, the // Replacement value depends on the change with the most impact. A RequiresRecreation // value of Always has the most impact, followed by Conditionally, and then // Never. Replacement Replacement `type:"string" enum:"true"` // The type of AWS CloudFormation resource, such as AWS::S3::Bucket. ResourceType *string `min:"1" type:"string"` // For the Modify action, indicates which resource attribute is triggering this // update, such as a change in the resource attribute's Metadata, Properties, // or Tags. Scope []ResourceAttribute `type:"list"` // contains filtered or unexported fields }
The ResourceChange structure describes the resource and the action that AWS CloudFormation will perform on it if you execute this change set.
func (ResourceChange) String ¶
func (s ResourceChange) String() string
String returns the string representation
type ResourceChangeDetail ¶
type ResourceChangeDetail struct { // The identity of the entity that triggered this change. This entity is a member // of the group that is specified by the ChangeSource field. For example, if // you modified the value of the KeyPairName parameter, the CausingEntity is // the name of the parameter (KeyPairName). // // If the ChangeSource value is DirectModification, no value is given for CausingEntity. CausingEntity *string `type:"string"` // The group to which the CausingEntity value belongs. There are five entity // groups: // // * ResourceReference entities are Ref intrinsic functions that refer to // resources in the template, such as { "Ref" : "MyEC2InstanceResource" }. // // * ParameterReference entities are Ref intrinsic functions that get template // parameter values, such as { "Ref" : "MyPasswordParameter" }. // // * ResourceAttribute entities are Fn::GetAtt intrinsic functions that get // resource attribute values, such as { "Fn::GetAtt" : [ "MyEC2InstanceResource", // "PublicDnsName" ] }. // // * DirectModification entities are changes that are made directly to the // template. // // * Automatic entities are AWS::CloudFormation::Stack resource types, which // are also known as nested stacks. If you made no changes to the AWS::CloudFormation::Stack // resource, AWS CloudFormation sets the ChangeSource to Automatic because // the nested stack's template might have changed. Changes to a nested stack's // template aren't visible to AWS CloudFormation until you run an update // on the parent stack. ChangeSource ChangeSource `type:"string" enum:"true"` // Indicates whether AWS CloudFormation can determine the target value, and // whether the target value will change before you execute a change set. // // For Static evaluations, AWS CloudFormation can determine that the target // value will change, and its value. For example, if you directly modify the // InstanceType property of an EC2 instance, AWS CloudFormation knows that this // property value will change, and its value, so this is a Static evaluation. // // For Dynamic evaluations, cannot determine the target value because it depends // on the result of an intrinsic function, such as a Ref or Fn::GetAtt intrinsic // function, when the stack is updated. For example, if your template includes // a reference to a resource that is conditionally recreated, the value of the // reference (the physical ID of the resource) might change, depending on if // the resource is recreated. If the resource is recreated, it will have a new // physical ID, so all references to that resource will also be updated. Evaluation EvaluationType `type:"string" enum:"true"` // A ResourceTargetDefinition structure that describes the field that AWS CloudFormation // will change and whether the resource will be recreated. Target *ResourceTargetDefinition `type:"structure"` // contains filtered or unexported fields }
For a resource with Modify as the action, the ResourceChange structure describes the changes AWS CloudFormation will make to that resource.
func (ResourceChangeDetail) String ¶
func (s ResourceChangeDetail) String() string
String returns the string representation
type ResourceIdentifierSummary ¶ added in v0.16.0
type ResourceIdentifierSummary struct { // The logical IDs of the target resources of the specified ResourceType, as // defined in the import template. LogicalResourceIds []string `min:"1" type:"list"` // The resource properties you can provide during the import to identify your // target resources. For example, BucketName is a possible identifier property // for AWS::S3::Bucket resources. ResourceIdentifiers []string `type:"list"` // The template resource type of the target resources, such as AWS::S3::Bucket. ResourceType *string `min:"1" type:"string"` // contains filtered or unexported fields }
Describes the target resources of a specific type in your import template (for example, all AWS::S3::Bucket resources) and the properties you can provide during the import to identify resources of that type.
func (ResourceIdentifierSummary) String ¶ added in v0.16.0
func (s ResourceIdentifierSummary) String() string
String returns the string representation
type ResourceSignalStatus ¶
type ResourceSignalStatus string
const ( ResourceSignalStatusSuccess ResourceSignalStatus = "SUCCESS" ResourceSignalStatusFailure ResourceSignalStatus = "FAILURE" )
Enum values for ResourceSignalStatus
func (ResourceSignalStatus) MarshalValue ¶ added in v0.3.0
func (enum ResourceSignalStatus) MarshalValue() (string, error)
func (ResourceSignalStatus) MarshalValueBuf ¶ added in v0.3.0
func (enum ResourceSignalStatus) MarshalValueBuf(b []byte) ([]byte, error)
type ResourceStatus ¶
type ResourceStatus string
const ( ResourceStatusCreateInProgress ResourceStatus = "CREATE_IN_PROGRESS" ResourceStatusCreateFailed ResourceStatus = "CREATE_FAILED" ResourceStatusCreateComplete ResourceStatus = "CREATE_COMPLETE" ResourceStatusDeleteInProgress ResourceStatus = "DELETE_IN_PROGRESS" ResourceStatusDeleteFailed ResourceStatus = "DELETE_FAILED" ResourceStatusDeleteComplete ResourceStatus = "DELETE_COMPLETE" ResourceStatusDeleteSkipped ResourceStatus = "DELETE_SKIPPED" ResourceStatusUpdateInProgress ResourceStatus = "UPDATE_IN_PROGRESS" ResourceStatusUpdateFailed ResourceStatus = "UPDATE_FAILED" ResourceStatusUpdateComplete ResourceStatus = "UPDATE_COMPLETE" ResourceStatusImportFailed ResourceStatus = "IMPORT_FAILED" ResourceStatusImportComplete ResourceStatus = "IMPORT_COMPLETE" ResourceStatusImportInProgress ResourceStatus = "IMPORT_IN_PROGRESS" ResourceStatusImportRollbackInProgress ResourceStatus = "IMPORT_ROLLBACK_IN_PROGRESS" ResourceStatusImportRollbackFailed ResourceStatus = "IMPORT_ROLLBACK_FAILED" ResourceStatusImportRollbackComplete ResourceStatus = "IMPORT_ROLLBACK_COMPLETE" )
Enum values for ResourceStatus
func (ResourceStatus) MarshalValue ¶ added in v0.3.0
func (enum ResourceStatus) MarshalValue() (string, error)
func (ResourceStatus) MarshalValueBuf ¶ added in v0.3.0
func (enum ResourceStatus) MarshalValueBuf(b []byte) ([]byte, error)
type ResourceTargetDefinition ¶
type ResourceTargetDefinition struct { // Indicates which resource attribute is triggering this update, such as a change // in the resource attribute's Metadata, Properties, or Tags. Attribute ResourceAttribute `type:"string" enum:"true"` // If the Attribute value is Properties, the name of the property. For all other // attributes, the value is null. Name *string `type:"string"` // If the Attribute value is Properties, indicates whether a change to this // property causes the resource to be recreated. The value can be Never, Always, // or Conditionally. To determine the conditions for a Conditionally recreation, // see the update behavior for that property (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) // in the AWS CloudFormation User Guide. RequiresRecreation RequiresRecreation `type:"string" enum:"true"` // contains filtered or unexported fields }
The field that AWS CloudFormation will change, such as the name of a resource's property, and whether the resource will be recreated.
func (ResourceTargetDefinition) String ¶
func (s ResourceTargetDefinition) String() string
String returns the string representation
type ResourceToImport ¶ added in v0.16.0
type ResourceToImport struct { // The logical ID of the target resource as specified in the template. // // LogicalResourceId is a required field LogicalResourceId *string `type:"string" required:"true"` // A key-value pair that identifies the target resource. The key is an identifier // property (for example, BucketName for AWS::S3::Bucket resources) and the // value is the actual property value (for example, MyS3Bucket). // // ResourceIdentifier is a required field ResourceIdentifier map[string]string `min:"1" type:"map" required:"true"` // The type of resource to import into your stack, such as AWS::S3::Bucket. // // ResourceType is a required field ResourceType *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Describes the target resource of an import operation.
func (ResourceToImport) String ¶ added in v0.16.0
func (s ResourceToImport) String() string
String returns the string representation
func (*ResourceToImport) Validate ¶ added in v0.16.0
func (s *ResourceToImport) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RollbackConfiguration ¶
type RollbackConfiguration struct { // The amount of time, in minutes, during which CloudFormation should monitor // all the rollback triggers after the stack creation or update operation deploys // all necessary resources. // // The default is 0 minutes. // // If you specify a monitoring period but do not specify any rollback triggers, // CloudFormation still waits the specified period of time before cleaning up // old resources after update operations. You can use this monitoring period // to perform any manual stack validation desired, and manually cancel the stack // creation or update (using CancelUpdateStack (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CancelUpdateStack.html), // for example) as necessary. // // If you specify 0 for this parameter, CloudFormation still monitors the specified // rollback triggers during stack creation and update operations. Then, for // update operations, it begins disposing of old resources immediately once // the operation completes. MonitoringTimeInMinutes *int64 `type:"integer"` // The triggers to monitor during stack creation or update actions. // // By default, AWS CloudFormation saves the rollback triggers specified for // a stack and applies them to any subsequent update operations for the stack, // unless you specify otherwise. If you do specify rollback triggers for this // parameter, those triggers replace any list of triggers previously specified // for the stack. This means: // // * To use the rollback triggers previously specified for this stack, if // any, don't specify this parameter. // // * To specify new or updated rollback triggers, you must specify all the // triggers that you want used for this stack, even triggers you've specifed // before (for example, when creating the stack or during a previous stack // update). Any triggers that you don't include in the updated list of triggers // are no longer applied to the stack. // // * To remove all currently specified triggers, specify an empty list for // this parameter. // // If a specified trigger is missing, the entire stack operation fails and is // rolled back. RollbackTriggers []RollbackTrigger `type:"list"` // contains filtered or unexported fields }
Structure containing the rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
Rollback triggers enable you to have AWS CloudFormation monitor the state of your application during stack creation and updating, and to roll back that operation if the application breaches the threshold of any of the alarms you've specified. For more information, see Monitor and Roll Back Stack Operations (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-rollback-triggers.html).
func (RollbackConfiguration) String ¶
func (s RollbackConfiguration) String() string
String returns the string representation
func (*RollbackConfiguration) Validate ¶
func (s *RollbackConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RollbackTrigger ¶
type RollbackTrigger struct { // The Amazon Resource Name (ARN) of the rollback trigger. // // If a specified trigger is missing, the entire stack operation fails and is // rolled back. // // Arn is a required field Arn *string `type:"string" required:"true"` // The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html) // is the only supported resource type. // // Type is a required field Type *string `type:"string" required:"true"` // contains filtered or unexported fields }
A rollback trigger AWS CloudFormation monitors during creation and updating of stacks. If any of the alarms you specify goes to ALARM state during the stack operation or within the specified monitoring period afterwards, CloudFormation rolls back the entire stack operation.
func (RollbackTrigger) String ¶
func (s RollbackTrigger) String() string
String returns the string representation
func (*RollbackTrigger) Validate ¶
func (s *RollbackTrigger) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SetStackPolicyInput ¶
type SetStackPolicyInput struct { // The name or unique stack ID that you want to associate a policy with. // // StackName is a required field StackName *string `type:"string" required:"true"` // Structure containing the stack policy body. For more information, go to Prevent // Updates to Stack Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html) // in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody // or the StackPolicyURL parameter, but not both. StackPolicyBody *string `min:"1" type:"string"` // Location of a file containing the stack policy. The URL must point to a policy // (maximum size: 16 KB) located in an S3 bucket in the same region as the stack. // You can specify either the StackPolicyBody or the StackPolicyURL parameter, // but not both. StackPolicyURL *string `min:"1" type:"string"` // contains filtered or unexported fields }
The input for the SetStackPolicy action.
func (SetStackPolicyInput) String ¶
func (s SetStackPolicyInput) String() string
String returns the string representation
func (*SetStackPolicyInput) Validate ¶
func (s *SetStackPolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SetStackPolicyOutput ¶
type SetStackPolicyOutput struct {
// contains filtered or unexported fields
}
func (SetStackPolicyOutput) String ¶
func (s SetStackPolicyOutput) String() string
String returns the string representation
type SetStackPolicyRequest ¶
type SetStackPolicyRequest struct { *aws.Request Input *SetStackPolicyInput Copy func(*SetStackPolicyInput) SetStackPolicyRequest }
SetStackPolicyRequest is the request type for the SetStackPolicy API operation.
func (SetStackPolicyRequest) Send ¶
func (r SetStackPolicyRequest) Send(ctx context.Context) (*SetStackPolicyResponse, error)
Send marshals and sends the SetStackPolicy API request.
type SetStackPolicyResponse ¶ added in v0.9.0
type SetStackPolicyResponse struct { *SetStackPolicyOutput // contains filtered or unexported fields }
SetStackPolicyResponse is the response type for the SetStackPolicy API operation.
func (*SetStackPolicyResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *SetStackPolicyResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the SetStackPolicy request.
type SignalResourceInput ¶
type SignalResourceInput struct { // The logical ID of the resource that you want to signal. The logical ID is // the name of the resource that given in the template. // // LogicalResourceId is a required field LogicalResourceId *string `type:"string" required:"true"` // The stack name or unique stack ID that includes the resource that you want // to signal. // // StackName is a required field StackName *string `min:"1" type:"string" required:"true"` // The status of the signal, which is either success or failure. A failure signal // causes AWS CloudFormation to immediately fail the stack creation or update. // // Status is a required field Status ResourceSignalStatus `type:"string" required:"true" enum:"true"` // A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling // groups, specify the instance ID that you are signaling as the unique ID. // If you send multiple signals to a single resource (such as signaling a wait // condition), each signal requires a different unique ID. // // UniqueId is a required field UniqueId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The input for the SignalResource action.
func (SignalResourceInput) String ¶
func (s SignalResourceInput) String() string
String returns the string representation
func (*SignalResourceInput) Validate ¶
func (s *SignalResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SignalResourceOutput ¶
type SignalResourceOutput struct {
// contains filtered or unexported fields
}
func (SignalResourceOutput) String ¶
func (s SignalResourceOutput) String() string
String returns the string representation
type SignalResourceRequest ¶
type SignalResourceRequest struct { *aws.Request Input *SignalResourceInput Copy func(*SignalResourceInput) SignalResourceRequest }
SignalResourceRequest is the request type for the SignalResource API operation.
func (SignalResourceRequest) Send ¶
func (r SignalResourceRequest) Send(ctx context.Context) (*SignalResourceResponse, error)
Send marshals and sends the SignalResource API request.
type SignalResourceResponse ¶ added in v0.9.0
type SignalResourceResponse struct { *SignalResourceOutput // contains filtered or unexported fields }
SignalResourceResponse is the response type for the SignalResource API operation.
func (*SignalResourceResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *SignalResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the SignalResource request.
type Stack ¶
type Stack struct { // The capabilities allowed in the stack. Capabilities []Capability `type:"list"` // The unique ID of the change set. ChangeSetId *string `min:"1" type:"string"` // The time at which the stack was created. // // CreationTime is a required field CreationTime *time.Time `type:"timestamp" required:"true"` // The time the stack was deleted. DeletionTime *time.Time `type:"timestamp"` // A user-defined description associated with the stack. Description *string `min:"1" type:"string"` // Boolean to enable or disable rollback on stack creation failures: // // * true: disable rollback // // * false: enable rollback DisableRollback *bool `type:"boolean"` // Information on whether a stack's actual configuration differs, or has drifted, // from it's expected configuration, as defined in the stack template and any // values specified as template parameters. For more information, see Detecting // Unregulated Configuration Changes to Stacks and Resources (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). DriftInformation *StackDriftInformation `type:"structure"` // Whether termination protection is enabled for the stack. // // For nested stacks (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html), // termination protection is set on the root stack and cannot be changed directly // on the nested stack. For more information, see Protecting a Stack From Being // Deleted (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) // in the AWS CloudFormation User Guide. EnableTerminationProtection *bool `type:"boolean"` // The time the stack was last updated. This field will only be returned if // the stack has been updated at least once. LastUpdatedTime *time.Time `type:"timestamp"` // SNS topic ARNs to which stack related events are published. NotificationARNs []string `type:"list"` // A list of output structures. Outputs []Output `type:"list"` // A list of Parameter structures. Parameters []Parameter `type:"list"` // For nested stacks--stacks created as resources for another stack--the stack // ID of the direct parent of this stack. For the first level of nested stacks, // the root stack is also the parent stack. // // For more information, see Working with Nested Stacks (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) // in the AWS CloudFormation User Guide. ParentId *string `type:"string"` // The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) // role that is associated with the stack. During a stack operation, AWS CloudFormation // uses this role's credentials to make calls on your behalf. RoleARN *string `min:"20" type:"string"` // The rollback triggers for AWS CloudFormation to monitor during stack creation // and updating operations, and for the specified monitoring period afterwards. RollbackConfiguration *RollbackConfiguration `type:"structure"` // For nested stacks--stacks created as resources for another stack--the stack // ID of the top-level stack to which the nested stack ultimately belongs. // // For more information, see Working with Nested Stacks (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) // in the AWS CloudFormation User Guide. RootId *string `type:"string"` // Unique identifier of the stack. StackId *string `type:"string"` // The name associated with the stack. // // StackName is a required field StackName *string `type:"string" required:"true"` // Current status of the stack. // // StackStatus is a required field StackStatus StackStatus `type:"string" required:"true" enum:"true"` // Success/failure message associated with the stack status. StackStatusReason *string `type:"string"` // A list of Tags that specify information about the stack. Tags []Tag `type:"list"` // The amount of time within which stack creation should complete. TimeoutInMinutes *int64 `min:"1" type:"integer"` // contains filtered or unexported fields }
The Stack data type.
type StackDriftDetectionStatus ¶ added in v0.6.0
type StackDriftDetectionStatus string
const ( StackDriftDetectionStatusDetectionInProgress StackDriftDetectionStatus = "DETECTION_IN_PROGRESS" StackDriftDetectionStatusDetectionFailed StackDriftDetectionStatus = "DETECTION_FAILED" StackDriftDetectionStatusDetectionComplete StackDriftDetectionStatus = "DETECTION_COMPLETE" )
Enum values for StackDriftDetectionStatus
func (StackDriftDetectionStatus) MarshalValue ¶ added in v0.6.0
func (enum StackDriftDetectionStatus) MarshalValue() (string, error)
func (StackDriftDetectionStatus) MarshalValueBuf ¶ added in v0.6.0
func (enum StackDriftDetectionStatus) MarshalValueBuf(b []byte) ([]byte, error)
type StackDriftInformation ¶ added in v0.6.0
type StackDriftInformation struct { // Most recent time when a drift detection operation was initiated on the stack, // or any of its individual resources that support drift detection. LastCheckTimestamp *time.Time `type:"timestamp"` // Status of the stack's actual configuration compared to its expected template // configuration. // // * DRIFTED: The stack differs from its expected template configuration. // A stack is considered to have drifted if one or more of its resources // have drifted. // // * NOT_CHECKED: AWS CloudFormation has not checked if the stack differs // from its expected template configuration. // // * IN_SYNC: The stack's actual configuration matches its expected template // configuration. // // * UNKNOWN: This value is reserved for future use. // // StackDriftStatus is a required field StackDriftStatus StackDriftStatus `type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Contains information about whether the stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted.
func (StackDriftInformation) String ¶ added in v0.6.0
func (s StackDriftInformation) String() string
String returns the string representation
type StackDriftInformationSummary ¶ added in v0.6.0
type StackDriftInformationSummary struct { // Most recent time when a drift detection operation was initiated on the stack, // or any of its individual resources that support drift detection. LastCheckTimestamp *time.Time `type:"timestamp"` // Status of the stack's actual configuration compared to its expected template // configuration. // // * DRIFTED: The stack differs from its expected template configuration. // A stack is considered to have drifted if one or more of its resources // have drifted. // // * NOT_CHECKED: AWS CloudFormation has not checked if the stack differs // from its expected template configuration. // // * IN_SYNC: The stack's actual configuration matches its expected template // configuration. // // * UNKNOWN: This value is reserved for future use. // // StackDriftStatus is a required field StackDriftStatus StackDriftStatus `type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Contains information about whether the stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted.
func (StackDriftInformationSummary) String ¶ added in v0.6.0
func (s StackDriftInformationSummary) String() string
String returns the string representation
type StackDriftStatus ¶ added in v0.6.0
type StackDriftStatus string
const ( StackDriftStatusDrifted StackDriftStatus = "DRIFTED" StackDriftStatusInSync StackDriftStatus = "IN_SYNC" StackDriftStatusUnknown StackDriftStatus = "UNKNOWN" StackDriftStatusNotChecked StackDriftStatus = "NOT_CHECKED" )
Enum values for StackDriftStatus
func (StackDriftStatus) MarshalValue ¶ added in v0.6.0
func (enum StackDriftStatus) MarshalValue() (string, error)
func (StackDriftStatus) MarshalValueBuf ¶ added in v0.6.0
func (enum StackDriftStatus) MarshalValueBuf(b []byte) ([]byte, error)
type StackEvent ¶
type StackEvent struct { // The token passed to the operation that generated this event. // // All events triggered by a given stack operation are assigned the same client // request token, which you can use to track operations. For example, if you // execute a CreateStack operation with the token token1, then all the StackEvents // generated by that operation will have ClientRequestToken set as token1. // // In the console, stack operations display the client request token on the // Events tab. Stack operations that are initiated from the console use the // token format Console-StackOperation-ID, which helps you easily identify the // stack operation . For example, if you create a stack using the console, each // stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. ClientRequestToken *string `min:"1" type:"string"` // The unique ID of this event. // // EventId is a required field EventId *string `type:"string" required:"true"` // The logical name of the resource specified in the template. LogicalResourceId *string `type:"string"` // The name or unique identifier associated with the physical instance of the // resource. PhysicalResourceId *string `type:"string"` // BLOB of the properties used to create the resource. ResourceProperties *string `type:"string"` // Current status of the resource. ResourceStatus ResourceStatus `type:"string" enum:"true"` // Success/failure message associated with the resource. ResourceStatusReason *string `type:"string"` // Type of resource. (For more information, go to AWS Resource Types Reference // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) // in the AWS CloudFormation User Guide.) ResourceType *string `min:"1" type:"string"` // The unique ID name of the instance of the stack. // // StackId is a required field StackId *string `type:"string" required:"true"` // The name associated with a stack. // // StackName is a required field StackName *string `type:"string" required:"true"` // Time the status was updated. // // Timestamp is a required field Timestamp *time.Time `type:"timestamp" required:"true"` // contains filtered or unexported fields }
The StackEvent data type.
func (StackEvent) String ¶
func (s StackEvent) String() string
String returns the string representation
type StackInstance ¶
type StackInstance struct { // The name of the AWS account that the stack instance is associated with. Account *string `type:"string"` // A list of parameters from the stack set template whose values have been overridden // in this stack instance. ParameterOverrides []Parameter `type:"list"` // The name of the AWS region that the stack instance is associated with. Region *string `type:"string"` // The ID of the stack instance. StackId *string `type:"string"` // The name or unique ID of the stack set that the stack instance is associated // with. StackSetId *string `type:"string"` // The status of the stack instance, in terms of its synchronization with its // associated stack set. // // * INOPERABLE: A DeleteStackInstances operation has failed and left the // stack in an unstable state. Stacks in this state are excluded from further // UpdateStackSet operations. You might need to perform a DeleteStackInstances // operation, with RetainStacks set to true, to delete the stack instance, // and then delete the stack manually. // // * OUTDATED: The stack isn't currently up to date with the stack set because: // The associated stack failed during a CreateStackSet or UpdateStackSet // operation. The stack was part of a CreateStackSet or UpdateStackSet operation // that failed or was stopped before the stack was created or updated. // // * CURRENT: The stack is currently up to date with the stack set. Status StackInstanceStatus `type:"string" enum:"true"` // The explanation for the specific status code that is assigned to this stack // instance. StatusReason *string `type:"string"` // contains filtered or unexported fields }
An AWS CloudFormation stack, in a specific account and region, that's part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given region. A stack instance can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, as well as the ID of the actual stack and the stack status.
func (StackInstance) String ¶
func (s StackInstance) String() string
String returns the string representation
type StackInstanceStatus ¶
type StackInstanceStatus string
const ( StackInstanceStatusCurrent StackInstanceStatus = "CURRENT" StackInstanceStatusOutdated StackInstanceStatus = "OUTDATED" StackInstanceStatusInoperable StackInstanceStatus = "INOPERABLE" )
Enum values for StackInstanceStatus
func (StackInstanceStatus) MarshalValue ¶ added in v0.3.0
func (enum StackInstanceStatus) MarshalValue() (string, error)
func (StackInstanceStatus) MarshalValueBuf ¶ added in v0.3.0
func (enum StackInstanceStatus) MarshalValueBuf(b []byte) ([]byte, error)
type StackInstanceSummary ¶
type StackInstanceSummary struct { // The name of the AWS account that the stack instance is associated with. Account *string `type:"string"` // The name of the AWS region that the stack instance is associated with. Region *string `type:"string"` // The ID of the stack instance. StackId *string `type:"string"` // The name or unique ID of the stack set that the stack instance is associated // with. StackSetId *string `type:"string"` // The status of the stack instance, in terms of its synchronization with its // associated stack set. // // * INOPERABLE: A DeleteStackInstances operation has failed and left the // stack in an unstable state. Stacks in this state are excluded from further // UpdateStackSet operations. You might need to perform a DeleteStackInstances // operation, with RetainStacks set to true, to delete the stack instance, // and then delete the stack manually. // // * OUTDATED: The stack isn't currently up to date with the stack set because: // The associated stack failed during a CreateStackSet or UpdateStackSet // operation. The stack was part of a CreateStackSet or UpdateStackSet operation // that failed or was stopped before the stack was created or updated. // // * CURRENT: The stack is currently up to date with the stack set. Status StackInstanceStatus `type:"string" enum:"true"` // The explanation for the specific status code assigned to this stack instance. StatusReason *string `type:"string"` // contains filtered or unexported fields }
The structure that contains summary information about a stack instance.
func (StackInstanceSummary) String ¶
func (s StackInstanceSummary) String() string
String returns the string representation
type StackResource ¶
type StackResource struct { // User defined description associated with the resource. Description *string `min:"1" type:"string"` // Information about whether the resource's actual configuration differs, or // has drifted, from its expected configuration, as defined in the stack template // and any values specified as template parameters. For more information, see // Detecting Unregulated Configuration Changes to Stacks and Resources (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). DriftInformation *StackResourceDriftInformation `type:"structure"` // The logical name of the resource specified in the template. // // LogicalResourceId is a required field LogicalResourceId *string `type:"string" required:"true"` // The name or unique identifier that corresponds to a physical instance ID // of a resource supported by AWS CloudFormation. PhysicalResourceId *string `type:"string"` // Current status of the resource. // // ResourceStatus is a required field ResourceStatus ResourceStatus `type:"string" required:"true" enum:"true"` // Success/failure message associated with the resource. ResourceStatusReason *string `type:"string"` // Type of resource. (For more information, go to AWS Resource Types Reference // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) // in the AWS CloudFormation User Guide.) // // ResourceType is a required field ResourceType *string `min:"1" type:"string" required:"true"` // Unique identifier of the stack. StackId *string `type:"string"` // The name associated with the stack. StackName *string `type:"string"` // Time the status was updated. // // Timestamp is a required field Timestamp *time.Time `type:"timestamp" required:"true"` // contains filtered or unexported fields }
The StackResource data type.
func (StackResource) String ¶
func (s StackResource) String() string
String returns the string representation
type StackResourceDetail ¶
type StackResourceDetail struct { // User defined description associated with the resource. Description *string `min:"1" type:"string"` // Information about whether the resource's actual configuration differs, or // has drifted, from its expected configuration, as defined in the stack template // and any values specified as template parameters. For more information, see // Detecting Unregulated Configuration Changes to Stacks and Resources (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). DriftInformation *StackResourceDriftInformation `type:"structure"` // Time the status was updated. // // LastUpdatedTimestamp is a required field LastUpdatedTimestamp *time.Time `type:"timestamp" required:"true"` // The logical name of the resource specified in the template. // // LogicalResourceId is a required field LogicalResourceId *string `type:"string" required:"true"` // The content of the Metadata attribute declared for the resource. For more // information, see Metadata Attribute (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html) // in the AWS CloudFormation User Guide. Metadata *string `type:"string"` // The name or unique identifier that corresponds to a physical instance ID // of a resource supported by AWS CloudFormation. PhysicalResourceId *string `type:"string"` // Current status of the resource. // // ResourceStatus is a required field ResourceStatus ResourceStatus `type:"string" required:"true" enum:"true"` // Success/failure message associated with the resource. ResourceStatusReason *string `type:"string"` // Type of resource. ((For more information, go to AWS Resource Types Reference // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) // in the AWS CloudFormation User Guide.) // // ResourceType is a required field ResourceType *string `min:"1" type:"string" required:"true"` // Unique identifier of the stack. StackId *string `type:"string"` // The name associated with the stack. StackName *string `type:"string"` // contains filtered or unexported fields }
Contains detailed information about the specified stack resource.
func (StackResourceDetail) String ¶
func (s StackResourceDetail) String() string
String returns the string representation
type StackResourceDrift ¶ added in v0.6.0
type StackResourceDrift struct { // A JSON structure containing the actual property values of the stack resource. // // For resources whose StackResourceDriftStatus is DELETED, this structure will // not be present. ActualProperties *string `type:"string"` // A JSON structure containing the expected property values of the stack resource, // as defined in the stack template and any values specified as template parameters. // // For resources whose StackResourceDriftStatus is DELETED, this structure will // not be present. ExpectedProperties *string `type:"string"` // The logical name of the resource specified in the template. // // LogicalResourceId is a required field LogicalResourceId *string `type:"string" required:"true"` // The name or unique identifier that corresponds to a physical instance ID // of a resource supported by AWS CloudFormation. PhysicalResourceId *string `type:"string"` // Context information that enables AWS CloudFormation to uniquely identify // a resource. AWS CloudFormation uses context key-value pairs in cases where // a resource's logical and physical IDs are not enough to uniquely identify // that resource. Each context key-value pair specifies a unique resource that // contains the targeted resource. PhysicalResourceIdContext []PhysicalResourceIdContextKeyValuePair `type:"list"` // A collection of the resource properties whose actual values differ from their // expected values. These will be present only for resources whose StackResourceDriftStatus // is MODIFIED. PropertyDifferences []PropertyDifference `type:"list"` // The type of the resource. // // ResourceType is a required field ResourceType *string `min:"1" type:"string" required:"true"` // The ID of the stack. // // StackId is a required field StackId *string `type:"string" required:"true"` // Status of the resource's actual configuration compared to its expected configuration // // * DELETED: The resource differs from its expected template configuration // because the resource has been deleted. // // * MODIFIED: One or more resource properties differ from their expected // values (as defined in the stack template and any values specified as template // parameters). // // * IN_SYNC: The resources's actual configuration matches its expected template // configuration. // // * NOT_CHECKED: AWS CloudFormation does not currently return this value. // // StackResourceDriftStatus is a required field StackResourceDriftStatus StackResourceDriftStatus `type:"string" required:"true" enum:"true"` // Time at which AWS CloudFormation performed drift detection on the stack resource. // // Timestamp is a required field Timestamp *time.Time `type:"timestamp" required:"true"` // contains filtered or unexported fields }
Contains the drift information for a resource that has been checked for drift. This includes actual and expected property values for resources in which AWS CloudFormation has detected drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html).
Resources that do not currently support drift detection cannot be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html).
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
func (StackResourceDrift) String ¶ added in v0.6.0
func (s StackResourceDrift) String() string
String returns the string representation
type StackResourceDriftInformation ¶ added in v0.6.0
type StackResourceDriftInformation struct { // When AWS CloudFormation last checked if the resource had drifted from its // expected configuration. LastCheckTimestamp *time.Time `type:"timestamp"` // Status of the resource's actual configuration compared to its expected configuration // // * DELETED: The resource differs from its expected configuration in that // it has been deleted. // // * MODIFIED: The resource differs from its expected configuration. // // * NOT_CHECKED: AWS CloudFormation has not checked if the resource differs // from its expected configuration. Any resources that do not currently support // drift detection have a status of NOT_CHECKED. For more information, see // Resources that Support Drift Detection (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html). // // * IN_SYNC: The resources's actual configuration matches its expected configuration. // // StackResourceDriftStatus is a required field StackResourceDriftStatus StackResourceDriftStatus `type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Contains information about whether the resource's actual configuration differs, or has drifted, from its expected configuration.
func (StackResourceDriftInformation) String ¶ added in v0.6.0
func (s StackResourceDriftInformation) String() string
String returns the string representation
type StackResourceDriftInformationSummary ¶ added in v0.6.0
type StackResourceDriftInformationSummary struct { // When AWS CloudFormation last checked if the resource had drifted from its // expected configuration. LastCheckTimestamp *time.Time `type:"timestamp"` // Status of the resource's actual configuration compared to its expected configuration // // * DELETED: The resource differs from its expected configuration in that // it has been deleted. // // * MODIFIED: The resource differs from its expected configuration. // // * NOT_CHECKED: AWS CloudFormation has not checked if the resource differs // from its expected configuration. Any resources that do not currently support // drift detection have a status of NOT_CHECKED. For more information, see // Resources that Support Drift Detection (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html). // If you performed an ContinueUpdateRollback operation on a stack, any resources // included in ResourcesToSkip will also have a status of NOT_CHECKED. For // more information on skipping resources during rollback operations, see // Continue Rolling Back an Update (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html) // in the AWS CloudFormation User Guide. // // * IN_SYNC: The resources's actual configuration matches its expected configuration. // // StackResourceDriftStatus is a required field StackResourceDriftStatus StackResourceDriftStatus `type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Summarizes information about whether the resource's actual configuration differs, or has drifted, from its expected configuration.
func (StackResourceDriftInformationSummary) String ¶ added in v0.6.0
func (s StackResourceDriftInformationSummary) String() string
String returns the string representation
type StackResourceDriftStatus ¶ added in v0.6.0
type StackResourceDriftStatus string
const ( StackResourceDriftStatusInSync StackResourceDriftStatus = "IN_SYNC" StackResourceDriftStatusModified StackResourceDriftStatus = "MODIFIED" StackResourceDriftStatusDeleted StackResourceDriftStatus = "DELETED" StackResourceDriftStatusNotChecked StackResourceDriftStatus = "NOT_CHECKED" )
Enum values for StackResourceDriftStatus
func (StackResourceDriftStatus) MarshalValue ¶ added in v0.6.0
func (enum StackResourceDriftStatus) MarshalValue() (string, error)
func (StackResourceDriftStatus) MarshalValueBuf ¶ added in v0.6.0
func (enum StackResourceDriftStatus) MarshalValueBuf(b []byte) ([]byte, error)
type StackResourceSummary ¶
type StackResourceSummary struct { // Information about whether the resource's actual configuration differs, or // has drifted, from its expected configuration, as defined in the stack template // and any values specified as template parameters. For more information, see // Detecting Unregulated Configuration Changes to Stacks and Resources (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). DriftInformation *StackResourceDriftInformationSummary `type:"structure"` // Time the status was updated. // // LastUpdatedTimestamp is a required field LastUpdatedTimestamp *time.Time `type:"timestamp" required:"true"` // The logical name of the resource specified in the template. // // LogicalResourceId is a required field LogicalResourceId *string `type:"string" required:"true"` // The name or unique identifier that corresponds to a physical instance ID // of the resource. PhysicalResourceId *string `type:"string"` // Current status of the resource. // // ResourceStatus is a required field ResourceStatus ResourceStatus `type:"string" required:"true" enum:"true"` // Success/failure message associated with the resource. ResourceStatusReason *string `type:"string"` // Type of resource. (For more information, go to AWS Resource Types Reference // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) // in the AWS CloudFormation User Guide.) // // ResourceType is a required field ResourceType *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Contains high-level information about the specified stack resource.
func (StackResourceSummary) String ¶
func (s StackResourceSummary) String() string
String returns the string representation
type StackSet ¶
type StackSet struct { // The Amazon Resource Number (ARN) of the IAM role used to create or update // the stack set. // // Use customized administrator roles to control which users or groups can manage // specific stack sets within the same administrator account. For more information, // see Prerequisites: Granting Permissions for Stack Set Operations (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) // in the AWS CloudFormation User Guide. AdministrationRoleARN *string `min:"20" type:"string"` // The capabilities that are allowed in the stack set. Some stack set templates // might include resources that can affect permissions in your AWS account—for // example, by creating new AWS Identity and Access Management (IAM) users. // For more information, see Acknowledging IAM Resources in AWS CloudFormation // Templates. (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities) Capabilities []Capability `type:"list"` // A description of the stack set that you specify when the stack set is created // or updated. Description *string `min:"1" type:"string"` // The name of the IAM execution role used to create or update the stack set. // // Use customized execution roles to control which stack resources users and // groups can include in their stack sets. ExecutionRoleName *string `min:"1" type:"string"` // A list of input parameters for a stack set. Parameters []Parameter `type:"list"` // The Amazon Resource Number (ARN) of the stack set. StackSetARN *string `type:"string"` // The ID of the stack set. StackSetId *string `type:"string"` // The name that's associated with the stack set. StackSetName *string `type:"string"` // The status of the stack set. Status StackSetStatus `type:"string" enum:"true"` // A list of tags that specify information about the stack set. A maximum number // of 50 tags can be specified. Tags []Tag `type:"list"` // The structure that contains the body of the template that was used to create // or update the stack set. TemplateBody *string `min:"1" type:"string"` // contains filtered or unexported fields }
A structure that contains information about a stack set. A stack set enables you to provision stacks into AWS accounts and across regions by using a single CloudFormation template. In the stack set, you specify the template to use, as well as any parameters and capabilities that the template requires.
type StackSetOperation ¶
type StackSetOperation struct { // The type of stack set operation: CREATE, UPDATE, or DELETE. Create and delete // operations affect only the specified stack set instances that are associated // with the specified stack set. Update operations affect both the stack set // itself, as well as all associated stack set instances. Action StackSetOperationAction `type:"string" enum:"true"` // The Amazon Resource Number (ARN) of the IAM role used to perform this stack // set operation. // // Use customized administrator roles to control which users or groups can manage // specific stack sets within the same administrator account. For more information, // see Define Permissions for Multiple Administrators (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) // in the AWS CloudFormation User Guide. AdministrationRoleARN *string `min:"20" type:"string"` // The time at which the operation was initiated. Note that the creation times // for the stack set operation might differ from the creation time of the individual // stacks themselves. This is because AWS CloudFormation needs to perform preparatory // work for the operation, such as dispatching the work to the requested regions, // before actually creating the first stacks. CreationTimestamp *time.Time `type:"timestamp"` // The time at which the stack set operation ended, across all accounts and // regions specified. Note that this doesn't necessarily mean that the stack // set operation was successful, or even attempted, in each account or region. EndTimestamp *time.Time `type:"timestamp"` // The name of the IAM execution role used to create or update the stack set. // // Use customized execution roles to control which stack resources users and // groups can include in their stack sets. ExecutionRoleName *string `min:"1" type:"string"` // The unique ID of a stack set operation. OperationId *string `min:"1" type:"string"` // The preferences for how AWS CloudFormation performs this stack set operation. OperationPreferences *StackSetOperationPreferences `type:"structure"` // For stack set operations of action type DELETE, specifies whether to remove // the stack instances from the specified stack set, but doesn't delete the // stacks. You can't reassociate a retained stack, or add an existing, saved // stack to a new stack set. RetainStacks *bool `type:"boolean"` // The ID of the stack set. StackSetId *string `type:"string"` // The status of the operation. // // * FAILED: The operation exceeded the specified failure tolerance. The // failure tolerance value that you've set for an operation is applied for // each region during stack create and update operations. If the number of // failed stacks within a region exceeds the failure tolerance, the status // of the operation in the region is set to FAILED. This in turn sets the // status of the operation as a whole to FAILED, and AWS CloudFormation cancels // the operation in any remaining regions. // // * RUNNING: The operation is currently being performed. // // * STOPPED: The user has cancelled the operation. // // * STOPPING: The operation is in the process of stopping, at user request. // // * SUCCEEDED: The operation completed creating or updating all the specified // stacks without exceeding the failure tolerance for the operation. Status StackSetOperationStatus `type:"string" enum:"true"` // contains filtered or unexported fields }
The structure that contains information about a stack set operation.
func (StackSetOperation) String ¶
func (s StackSetOperation) String() string
String returns the string representation
type StackSetOperationAction ¶
type StackSetOperationAction string
const ( StackSetOperationActionCreate StackSetOperationAction = "CREATE" StackSetOperationActionUpdate StackSetOperationAction = "UPDATE" StackSetOperationActionDelete StackSetOperationAction = "DELETE" )
Enum values for StackSetOperationAction
func (StackSetOperationAction) MarshalValue ¶ added in v0.3.0
func (enum StackSetOperationAction) MarshalValue() (string, error)
func (StackSetOperationAction) MarshalValueBuf ¶ added in v0.3.0
func (enum StackSetOperationAction) MarshalValueBuf(b []byte) ([]byte, error)
type StackSetOperationPreferences ¶
type StackSetOperationPreferences struct { // The number of accounts, per region, for which this operation can fail before // AWS CloudFormation stops the operation in that region. If the operation is // stopped in a region, AWS CloudFormation doesn't attempt the operation in // any subsequent regions. // // Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage // (but not both). FailureToleranceCount *int64 `type:"integer"` // The percentage of accounts, per region, for which this stack operation can // fail before AWS CloudFormation stops the operation in that region. If the // operation is stopped in a region, AWS CloudFormation doesn't attempt the // operation in any subsequent regions. // // When calculating the number of accounts based on the specified percentage, // AWS CloudFormation rounds down to the next whole number. // // Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, // but not both. FailureTolerancePercentage *int64 `type:"integer"` // The maximum number of accounts in which to perform this operation at one // time. This is dependent on the value of FailureToleranceCount—MaxConcurrentCount // is at most one more than the FailureToleranceCount . // // Note that this setting lets you specify the maximum for operations. For large // deployments, under certain circumstances the actual number of accounts acted // upon concurrently may be lower due to service throttling. // // Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, // but not both. MaxConcurrentCount *int64 `min:"1" type:"integer"` // The maximum percentage of accounts in which to perform this operation at // one time. // // When calculating the number of accounts based on the specified percentage, // AWS CloudFormation rounds down to the next whole number. This is true except // in cases where rounding down would result is zero. In this case, CloudFormation // sets the number as one instead. // // Note that this setting lets you specify the maximum for operations. For large // deployments, under certain circumstances the actual number of accounts acted // upon concurrently may be lower due to service throttling. // // Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, // but not both. MaxConcurrentPercentage *int64 `min:"1" type:"integer"` // The order of the regions in where you want to perform the stack operation. RegionOrder []string `type:"list"` // contains filtered or unexported fields }
The user-specified preferences for how AWS CloudFormation performs a stack set operation.
For more information on maximum concurrent accounts and failure tolerance, see Stack set operation options (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options).
func (StackSetOperationPreferences) String ¶
func (s StackSetOperationPreferences) String() string
String returns the string representation
func (*StackSetOperationPreferences) Validate ¶
func (s *StackSetOperationPreferences) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StackSetOperationResultStatus ¶
type StackSetOperationResultStatus string
const ( StackSetOperationResultStatusPending StackSetOperationResultStatus = "PENDING" StackSetOperationResultStatusRunning StackSetOperationResultStatus = "RUNNING" StackSetOperationResultStatusSucceeded StackSetOperationResultStatus = "SUCCEEDED" StackSetOperationResultStatusFailed StackSetOperationResultStatus = "FAILED" StackSetOperationResultStatusCancelled StackSetOperationResultStatus = "CANCELLED" )
Enum values for StackSetOperationResultStatus
func (StackSetOperationResultStatus) MarshalValue ¶ added in v0.3.0
func (enum StackSetOperationResultStatus) MarshalValue() (string, error)
func (StackSetOperationResultStatus) MarshalValueBuf ¶ added in v0.3.0
func (enum StackSetOperationResultStatus) MarshalValueBuf(b []byte) ([]byte, error)
type StackSetOperationResultSummary ¶
type StackSetOperationResultSummary struct { // The name of the AWS account for this operation result. Account *string `type:"string"` // The results of the account gate function AWS CloudFormation invokes, if present, // before proceeding with stack set operations in an account AccountGateResult *AccountGateResult `type:"structure"` // The name of the AWS region for this operation result. Region *string `type:"string"` // The result status of the stack set operation for the given account in the // given region. // // * CANCELLED: The operation in the specified account and region has been // cancelled. This is either because a user has stopped the stack set operation, // or because the failure tolerance of the stack set operation has been exceeded. // // * FAILED: The operation in the specified account and region failed. If // the stack set operation fails in enough accounts within a region, the // failure tolerance for the stack set operation as a whole might be exceeded. // // * RUNNING: The operation in the specified account and region is currently // in progress. // // * PENDING: The operation in the specified account and region has yet to // start. // // * SUCCEEDED: The operation in the specified account and region completed // successfully. Status StackSetOperationResultStatus `type:"string" enum:"true"` // The reason for the assigned result status. StatusReason *string `type:"string"` // contains filtered or unexported fields }
The structure that contains information about a specified operation's results for a given account in a given region.
func (StackSetOperationResultSummary) String ¶
func (s StackSetOperationResultSummary) String() string
String returns the string representation
type StackSetOperationStatus ¶
type StackSetOperationStatus string
const ( StackSetOperationStatusRunning StackSetOperationStatus = "RUNNING" StackSetOperationStatusSucceeded StackSetOperationStatus = "SUCCEEDED" StackSetOperationStatusFailed StackSetOperationStatus = "FAILED" StackSetOperationStatusStopping StackSetOperationStatus = "STOPPING" StackSetOperationStatusStopped StackSetOperationStatus = "STOPPED" )
Enum values for StackSetOperationStatus
func (StackSetOperationStatus) MarshalValue ¶ added in v0.3.0
func (enum StackSetOperationStatus) MarshalValue() (string, error)
func (StackSetOperationStatus) MarshalValueBuf ¶ added in v0.3.0
func (enum StackSetOperationStatus) MarshalValueBuf(b []byte) ([]byte, error)
type StackSetOperationSummary ¶
type StackSetOperationSummary struct { // The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations // affect only the specified stack instances that are associated with the specified // stack set. Update operations affect both the stack set itself as well as // all associated stack set instances. Action StackSetOperationAction `type:"string" enum:"true"` // The time at which the operation was initiated. Note that the creation times // for the stack set operation might differ from the creation time of the individual // stacks themselves. This is because AWS CloudFormation needs to perform preparatory // work for the operation, such as dispatching the work to the requested regions, // before actually creating the first stacks. CreationTimestamp *time.Time `type:"timestamp"` // The time at which the stack set operation ended, across all accounts and // regions specified. Note that this doesn't necessarily mean that the stack // set operation was successful, or even attempted, in each account or region. EndTimestamp *time.Time `type:"timestamp"` // The unique ID of the stack set operation. OperationId *string `min:"1" type:"string"` // The overall status of the operation. // // * FAILED: The operation exceeded the specified failure tolerance. The // failure tolerance value that you've set for an operation is applied for // each region during stack create and update operations. If the number of // failed stacks within a region exceeds the failure tolerance, the status // of the operation in the region is set to FAILED. This in turn sets the // status of the operation as a whole to FAILED, and AWS CloudFormation cancels // the operation in any remaining regions. // // * RUNNING: The operation is currently being performed. // // * STOPPED: The user has cancelled the operation. // // * STOPPING: The operation is in the process of stopping, at user request. // // * SUCCEEDED: The operation completed creating or updating all the specified // stacks without exceeding the failure tolerance for the operation. Status StackSetOperationStatus `type:"string" enum:"true"` // contains filtered or unexported fields }
The structures that contain summary information about the specified operation.
func (StackSetOperationSummary) String ¶
func (s StackSetOperationSummary) String() string
String returns the string representation
type StackSetStatus ¶
type StackSetStatus string
const ( StackSetStatusActive StackSetStatus = "ACTIVE" StackSetStatusDeleted StackSetStatus = "DELETED" )
Enum values for StackSetStatus
func (StackSetStatus) MarshalValue ¶ added in v0.3.0
func (enum StackSetStatus) MarshalValue() (string, error)
func (StackSetStatus) MarshalValueBuf ¶ added in v0.3.0
func (enum StackSetStatus) MarshalValueBuf(b []byte) ([]byte, error)
type StackSetSummary ¶
type StackSetSummary struct { // A description of the stack set that you specify when the stack set is created // or updated. Description *string `min:"1" type:"string"` // The ID of the stack set. StackSetId *string `type:"string"` // The name of the stack set. StackSetName *string `type:"string"` // The status of the stack set. Status StackSetStatus `type:"string" enum:"true"` // contains filtered or unexported fields }
The structures that contain summary information about the specified stack set.
func (StackSetSummary) String ¶
func (s StackSetSummary) String() string
String returns the string representation
type StackStatus ¶
type StackStatus string
const ( StackStatusCreateInProgress StackStatus = "CREATE_IN_PROGRESS" StackStatusCreateFailed StackStatus = "CREATE_FAILED" StackStatusCreateComplete StackStatus = "CREATE_COMPLETE" StackStatusRollbackInProgress StackStatus = "ROLLBACK_IN_PROGRESS" StackStatusRollbackFailed StackStatus = "ROLLBACK_FAILED" StackStatusRollbackComplete StackStatus = "ROLLBACK_COMPLETE" StackStatusDeleteInProgress StackStatus = "DELETE_IN_PROGRESS" StackStatusDeleteFailed StackStatus = "DELETE_FAILED" StackStatusDeleteComplete StackStatus = "DELETE_COMPLETE" StackStatusUpdateInProgress StackStatus = "UPDATE_IN_PROGRESS" StackStatusUpdateCompleteCleanupInProgress StackStatus = "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS" StackStatusUpdateComplete StackStatus = "UPDATE_COMPLETE" StackStatusUpdateRollbackInProgress StackStatus = "UPDATE_ROLLBACK_IN_PROGRESS" StackStatusUpdateRollbackFailed StackStatus = "UPDATE_ROLLBACK_FAILED" StackStatusUpdateRollbackCompleteCleanupInProgress StackStatus = "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS" StackStatusUpdateRollbackComplete StackStatus = "UPDATE_ROLLBACK_COMPLETE" StackStatusReviewInProgress StackStatus = "REVIEW_IN_PROGRESS" StackStatusImportInProgress StackStatus = "IMPORT_IN_PROGRESS" StackStatusImportComplete StackStatus = "IMPORT_COMPLETE" StackStatusImportRollbackInProgress StackStatus = "IMPORT_ROLLBACK_IN_PROGRESS" StackStatusImportRollbackFailed StackStatus = "IMPORT_ROLLBACK_FAILED" StackStatusImportRollbackComplete StackStatus = "IMPORT_ROLLBACK_COMPLETE" )
Enum values for StackStatus
func (StackStatus) MarshalValue ¶ added in v0.3.0
func (enum StackStatus) MarshalValue() (string, error)
func (StackStatus) MarshalValueBuf ¶ added in v0.3.0
func (enum StackStatus) MarshalValueBuf(b []byte) ([]byte, error)
type StackSummary ¶
type StackSummary struct { // The time the stack was created. // // CreationTime is a required field CreationTime *time.Time `type:"timestamp" required:"true"` // The time the stack was deleted. DeletionTime *time.Time `type:"timestamp"` // Summarizes information on whether a stack's actual configuration differs, // or has drifted, from it's expected configuration, as defined in the stack // template and any values specified as template parameters. For more information, // see Detecting Unregulated Configuration Changes to Stacks and Resources (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). DriftInformation *StackDriftInformationSummary `type:"structure"` // The time the stack was last updated. This field will only be returned if // the stack has been updated at least once. LastUpdatedTime *time.Time `type:"timestamp"` // For nested stacks--stacks created as resources for another stack--the stack // ID of the direct parent of this stack. For the first level of nested stacks, // the root stack is also the parent stack. // // For more information, see Working with Nested Stacks (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) // in the AWS CloudFormation User Guide. ParentId *string `type:"string"` // For nested stacks--stacks created as resources for another stack--the stack // ID of the top-level stack to which the nested stack ultimately belongs. // // For more information, see Working with Nested Stacks (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html) // in the AWS CloudFormation User Guide. RootId *string `type:"string"` // Unique stack identifier. StackId *string `type:"string"` // The name associated with the stack. // // StackName is a required field StackName *string `type:"string" required:"true"` // The current status of the stack. // // StackStatus is a required field StackStatus StackStatus `type:"string" required:"true" enum:"true"` // Success/Failure message associated with the stack status. StackStatusReason *string `type:"string"` // The template description of the template used to create the stack. TemplateDescription *string `type:"string"` // contains filtered or unexported fields }
The StackSummary Data Type
func (StackSummary) String ¶
func (s StackSummary) String() string
String returns the string representation
type StopStackSetOperationInput ¶
type StopStackSetOperationInput struct { // The ID of the stack operation. // // OperationId is a required field OperationId *string `min:"1" type:"string" required:"true"` // The name or unique ID of the stack set that you want to stop the operation // for. // // StackSetName is a required field StackSetName *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (StopStackSetOperationInput) String ¶
func (s StopStackSetOperationInput) String() string
String returns the string representation
func (*StopStackSetOperationInput) Validate ¶
func (s *StopStackSetOperationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StopStackSetOperationOutput ¶
type StopStackSetOperationOutput struct {
// contains filtered or unexported fields
}
func (StopStackSetOperationOutput) String ¶
func (s StopStackSetOperationOutput) String() string
String returns the string representation
type StopStackSetOperationRequest ¶
type StopStackSetOperationRequest struct { *aws.Request Input *StopStackSetOperationInput Copy func(*StopStackSetOperationInput) StopStackSetOperationRequest }
StopStackSetOperationRequest is the request type for the StopStackSetOperation API operation.
func (StopStackSetOperationRequest) Send ¶
func (r StopStackSetOperationRequest) Send(ctx context.Context) (*StopStackSetOperationResponse, error)
Send marshals and sends the StopStackSetOperation API request.
type StopStackSetOperationResponse ¶ added in v0.9.0
type StopStackSetOperationResponse struct { *StopStackSetOperationOutput // contains filtered or unexported fields }
StopStackSetOperationResponse is the response type for the StopStackSetOperation API operation.
func (*StopStackSetOperationResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *StopStackSetOperationResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the StopStackSetOperation request.
type Tag ¶
type Tag struct { // Required. A string used to identify this tag. You can specify a maximum of // 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have // the reserved prefix: aws:. // // Key is a required field Key *string `min:"1" type:"string" required:"true"` // Required. A string containing the value for this tag. You can specify a maximum // of 256 characters for a tag value. // // Value is a required field Value *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The Tag type enables you to specify a key-value pair that can be used to store information about an AWS CloudFormation stack.
type TemplateParameter ¶
type TemplateParameter struct { // The default value associated with the parameter. DefaultValue *string `type:"string"` // User defined description associated with the parameter. Description *string `min:"1" type:"string"` // Flag indicating whether the parameter should be displayed as plain text in // logs and UIs. NoEcho *bool `type:"boolean"` // The name associated with the parameter. ParameterKey *string `type:"string"` // contains filtered or unexported fields }
The TemplateParameter data type.
func (TemplateParameter) String ¶
func (s TemplateParameter) String() string
String returns the string representation
type TemplateStage ¶
type TemplateStage string
const ( TemplateStageOriginal TemplateStage = "Original" TemplateStageProcessed TemplateStage = "Processed" )
Enum values for TemplateStage
func (TemplateStage) MarshalValue ¶ added in v0.3.0
func (enum TemplateStage) MarshalValue() (string, error)
func (TemplateStage) MarshalValueBuf ¶ added in v0.3.0
func (enum TemplateStage) MarshalValueBuf(b []byte) ([]byte, error)
type UpdateStackInput ¶
type UpdateStackInput struct { // In some cases, you must explicitly acknowledge that your stack template contains // certain capabilities in order for AWS CloudFormation to update the stack. // // * CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include // resources that can affect permissions in your AWS account; for example, // by creating new AWS Identity and Access Management (IAM) users. For those // stacks, you must explicitly acknowledge this by specifying one of these // capabilities. The following IAM resources require you to specify either // the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. If you have IAM // resources, you can specify either capability. If you have IAM resources // with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't // specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities // error. If your stack template contains these resources, we recommend that // you review all permissions associated with them and edit their permissions // if necessary. AWS::IAM::AccessKey (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html) // AWS::IAM::Group (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html) // AWS::IAM::InstanceProfile (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html) // AWS::IAM::Policy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html) // AWS::IAM::Role (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html) // AWS::IAM::User (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html) // AWS::IAM::UserToGroupAddition (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html) // For more information, see Acknowledging IAM Resources in AWS CloudFormation // Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). // // * CAPABILITY_AUTO_EXPAND Some template contain macros. Macros perform // custom processing on templates; this can include simple actions like find-and-replace // operations, all the way to extensive transformations of entire templates. // Because of this, users typically create a change set from the processed // template, so that they can review the changes resulting from the macros // before actually updating the stack. If your stack template contains one // or more macros, and you choose to update a stack directly from the processed // template, without first reviewing the resulting changes in a change set, // you must acknowledge this capability. This includes the AWS::Include (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) // and AWS::Serverless (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) // transforms, which are macros hosted by AWS CloudFormation. Change sets // do not currently support nested stacks. If you want to update a stack // from a stack template that contains macros and nested stacks, you must // update the stack directly from the template using this capability. You // should only update stacks directly from a stack template that contains // macros if you know what processing the macro performs. Each macro relies // on an underlying Lambda service function for processing stack templates. // Be aware that the Lambda function owner can update the function operation // without AWS CloudFormation being notified. For more information, see Using // AWS CloudFormation Macros to Perform Custom Processing on Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html). Capabilities []Capability `type:"list"` // A unique identifier for this UpdateStack request. Specify this token if you // plan to retry requests so that AWS CloudFormation knows that you're not attempting // to update a stack with the same name. You might retry UpdateStack requests // to ensure that AWS CloudFormation successfully received them. // // All events triggered by a given stack operation are assigned the same client // request token, which you can use to track operations. For example, if you // execute a CreateStack operation with the token token1, then all the StackEvents // generated by that operation will have ClientRequestToken set as token1. // // In the console, stack operations display the client request token on the // Events tab. Stack operations that are initiated from the console use the // token format Console-StackOperation-ID, which helps you easily identify the // stack operation . For example, if you create a stack using the console, each // stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002. ClientRequestToken *string `min:"1" type:"string"` // Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that // AWS CloudFormation associates with the stack. Specify an empty list to remove // all notification topics. NotificationARNs []string `type:"list"` // A list of Parameter structures that specify input parameters for the stack. // For more information, see the Parameter (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html) // data type. Parameters []Parameter `type:"list"` // The template resource types that you have permissions to work with for this // update stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. // // If the list of resource types doesn't include a resource that you're updating, // the stack update fails. By default, AWS CloudFormation grants permissions // to all resource types. AWS Identity and Access Management (IAM) uses this // parameter for AWS CloudFormation-specific condition keys in IAM policies. // For more information, see Controlling Access with AWS Identity and Access // Management (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html). ResourceTypes []string `type:"list"` // The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) // role that AWS CloudFormation assumes to update the stack. AWS CloudFormation // uses the role's credentials to make calls on your behalf. AWS CloudFormation // always uses this role for all future operations on the stack. As long as // users have permission to operate on the stack, AWS CloudFormation uses this // role even if the users don't have permission to pass it. Ensure that the // role grants least privilege. // // If you don't specify a value, AWS CloudFormation uses the role that was previously // associated with the stack. If no role is available, AWS CloudFormation uses // a temporary session that is generated from your user credentials. RoleARN *string `min:"20" type:"string"` // The rollback triggers for AWS CloudFormation to monitor during stack creation // and updating operations, and for the specified monitoring period afterwards. RollbackConfiguration *RollbackConfiguration `type:"structure"` // The name or unique stack ID of the stack to update. // // StackName is a required field StackName *string `type:"string" required:"true"` // Structure containing a new stack policy body. You can specify either the // StackPolicyBody or the StackPolicyURL parameter, but not both. // // You might update the stack policy, for example, in order to protect a new // resource that you created during a stack update. If you do not specify a // stack policy, the current policy that is associated with the stack is unchanged. StackPolicyBody *string `min:"1" type:"string"` // Structure containing the temporary overriding stack policy body. You can // specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL // parameter, but not both. // // If you want to update protected resources, specify a temporary overriding // stack policy during this update. If you do not specify a stack policy, the // current policy that is associated with the stack will be used. StackPolicyDuringUpdateBody *string `min:"1" type:"string"` // Location of a file containing the temporary overriding stack policy. The // URL must point to a policy (max size: 16KB) located in an S3 bucket in the // same region as the stack. You can specify either the StackPolicyDuringUpdateBody // or the StackPolicyDuringUpdateURL parameter, but not both. // // If you want to update protected resources, specify a temporary overriding // stack policy during this update. If you do not specify a stack policy, the // current policy that is associated with the stack will be used. StackPolicyDuringUpdateURL *string `min:"1" type:"string"` // Location of a file containing the updated stack policy. The URL must point // to a policy (max size: 16KB) located in an S3 bucket in the same region as // the stack. You can specify either the StackPolicyBody or the StackPolicyURL // parameter, but not both. // // You might update the stack policy, for example, in order to protect a new // resource that you created during a stack update. If you do not specify a // stack policy, the current policy that is associated with the stack is unchanged. StackPolicyURL *string `min:"1" type:"string"` // Key-value pairs to associate with this stack. AWS CloudFormation also propagates // these tags to supported resources in the stack. You can specify a maximum // number of 50 tags. // // If you don't specify this parameter, AWS CloudFormation doesn't modify the // stack's tags. If you specify an empty value, AWS CloudFormation removes all // associated tags. Tags []Tag `type:"list"` // Structure containing the template body with a minimum length of 1 byte and // a maximum length of 51,200 bytes. (For more information, go to Template Anatomy // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the AWS CloudFormation User Guide.) // // Conditional: You must specify only one of the following parameters: TemplateBody, // TemplateURL, or set the UsePreviousTemplate to true. TemplateBody *string `min:"1" type:"string"` // Location of file containing the template body. The URL must point to a template // that is located in an Amazon S3 bucket. For more information, go to Template // Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the AWS CloudFormation User Guide. // // Conditional: You must specify only one of the following parameters: TemplateBody, // TemplateURL, or set the UsePreviousTemplate to true. TemplateURL *string `min:"1" type:"string"` // Reuse the existing template that is associated with the stack that you are // updating. // // Conditional: You must specify only one of the following parameters: TemplateBody, // TemplateURL, or set the UsePreviousTemplate to true. UsePreviousTemplate *bool `type:"boolean"` // contains filtered or unexported fields }
The input for an UpdateStack action.
func (UpdateStackInput) String ¶
func (s UpdateStackInput) String() string
String returns the string representation
func (*UpdateStackInput) Validate ¶
func (s *UpdateStackInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateStackInstancesInput ¶ added in v0.2.0
type UpdateStackInstancesInput struct { // The names of one or more AWS accounts for which you want to update parameter // values for stack instances. The overridden parameter values will be applied // to all stack instances in the specified accounts and regions. // // Accounts is a required field Accounts []string `type:"list" required:"true"` // The unique identifier for this stack set operation. // // The operation ID also functions as an idempotency token, to ensure that AWS // CloudFormation performs the stack set operation only once, even if you retry // the request multiple times. You might retry stack set operation requests // to ensure that AWS CloudFormation successfully received them. // // If you don't specify an operation ID, the SDK generates one automatically. OperationId *string `min:"1" type:"string" idempotencyToken:"true"` // Preferences for how AWS CloudFormation performs this stack set operation. OperationPreferences *StackSetOperationPreferences `type:"structure"` // A list of input parameters whose values you want to update for the specified // stack instances. // // Any overridden parameter values will be applied to all stack instances in // the specified accounts and regions. When specifying parameters and their // values, be aware of how AWS CloudFormation sets parameter values during stack // instance update operations: // // * To override the current value for a parameter, include the parameter // and specify its value. // // * To leave a parameter set to its present value, you can do one of the // following: Do not include the parameter in the list. Include the parameter // and specify UsePreviousValue as true. (You cannot specify both a value // and set UsePreviousValue to true.) // // * To set all overridden parameter back to the values specified in the // stack set, specify a parameter list but do not include any parameters. // // * To leave all parameters set to their present values, do not specify // this property at all. // // During stack set updates, any parameter values overridden for a stack instance // are not updated, but retain their overridden value. // // You can only override the parameter values that are specified in the stack // set; to add or delete a parameter itself, use UpdateStackSet to update the // stack set template. If you add a parameter to a template, before you can // override the parameter value specified in the stack set you must first use // UpdateStackSet (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html) // to update all stack instances with the updated template and parameter value // specified in the stack set. Once a stack instance has been updated with the // new parameter, you can then override the parameter value using UpdateStackInstances. ParameterOverrides []Parameter `type:"list"` // The names of one or more regions in which you want to update parameter values // for stack instances. The overridden parameter values will be applied to all // stack instances in the specified accounts and regions. // // Regions is a required field Regions []string `type:"list" required:"true"` // The name or unique ID of the stack set associated with the stack instances. // // StackSetName is a required field StackSetName *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (UpdateStackInstancesInput) String ¶ added in v0.2.0
func (s UpdateStackInstancesInput) String() string
String returns the string representation
func (*UpdateStackInstancesInput) Validate ¶ added in v0.2.0
func (s *UpdateStackInstancesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateStackInstancesOutput ¶ added in v0.2.0
type UpdateStackInstancesOutput struct { // The unique identifier for this stack set operation. OperationId *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (UpdateStackInstancesOutput) String ¶ added in v0.2.0
func (s UpdateStackInstancesOutput) String() string
String returns the string representation
type UpdateStackInstancesRequest ¶ added in v0.2.0
type UpdateStackInstancesRequest struct { *aws.Request Input *UpdateStackInstancesInput Copy func(*UpdateStackInstancesInput) UpdateStackInstancesRequest }
UpdateStackInstancesRequest is the request type for the UpdateStackInstances API operation.
func (UpdateStackInstancesRequest) Send ¶ added in v0.2.0
func (r UpdateStackInstancesRequest) Send(ctx context.Context) (*UpdateStackInstancesResponse, error)
Send marshals and sends the UpdateStackInstances API request.
type UpdateStackInstancesResponse ¶ added in v0.9.0
type UpdateStackInstancesResponse struct { *UpdateStackInstancesOutput // contains filtered or unexported fields }
UpdateStackInstancesResponse is the response type for the UpdateStackInstances API operation.
func (*UpdateStackInstancesResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateStackInstancesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateStackInstances request.
type UpdateStackOutput ¶
type UpdateStackOutput struct { // Unique identifier of the stack. StackId *string `type:"string"` // contains filtered or unexported fields }
The output for an UpdateStack action.
func (UpdateStackOutput) String ¶
func (s UpdateStackOutput) String() string
String returns the string representation
type UpdateStackRequest ¶
type UpdateStackRequest struct { *aws.Request Input *UpdateStackInput Copy func(*UpdateStackInput) UpdateStackRequest }
UpdateStackRequest is the request type for the UpdateStack API operation.
func (UpdateStackRequest) Send ¶
func (r UpdateStackRequest) Send(ctx context.Context) (*UpdateStackResponse, error)
Send marshals and sends the UpdateStack API request.
type UpdateStackResponse ¶ added in v0.9.0
type UpdateStackResponse struct { *UpdateStackOutput // contains filtered or unexported fields }
UpdateStackResponse is the response type for the UpdateStack API operation.
func (*UpdateStackResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateStackResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateStack request.
type UpdateStackSetInput ¶
type UpdateStackSetInput struct { // The accounts in which to update associated stack instances. If you specify // accounts, you must also specify the regions in which to update stack set // instances. // // To update all the stack instances associated with this stack set, do not // specify the Accounts or Regions properties. // // If the stack set update includes changes to the template (that is, if the // TemplateBody or TemplateURL properties are specified), or the Parameters // property, AWS CloudFormation marks all stack instances with a status of OUTDATED // prior to updating the stack instances in the specified accounts and regions. // If the stack set update does not include changes to the template or parameters, // AWS CloudFormation updates the stack instances in the specified accounts // and regions, while leaving all other stack instances with their existing // stack instance status. Accounts []string `type:"list"` // The Amazon Resource Number (ARN) of the IAM role to use to update this stack // set. // // Specify an IAM role only if you are using customized administrator roles // to control which users or groups can manage specific stack sets within the // same administrator account. For more information, see Granting Permissions // for Stack Set Operations (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html) // in the AWS CloudFormation User Guide. // // If you specified a customized administrator role when you created the stack // set, you must specify a customized administrator role, even if it is the // same customized administrator role used with this stack set previously. AdministrationRoleARN *string `min:"20" type:"string"` // In some cases, you must explicitly acknowledge that your stack template contains // certain capabilities in order for AWS CloudFormation to update the stack // set and its associated stack instances. // // * CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include // resources that can affect permissions in your AWS account; for example, // by creating new AWS Identity and Access Management (IAM) users. For those // stacks sets, you must explicitly acknowledge this by specifying one of // these capabilities. The following IAM resources require you to specify // either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. If you have // IAM resources, you can specify either capability. If you have IAM resources // with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't // specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities // error. If your stack template contains these resources, we recommend that // you review all permissions associated with them and edit their permissions // if necessary. AWS::IAM::AccessKey (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html) // AWS::IAM::Group (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html) // AWS::IAM::InstanceProfile (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html) // AWS::IAM::Policy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html) // AWS::IAM::Role (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html) // AWS::IAM::User (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html) // AWS::IAM::UserToGroupAddition (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html) // For more information, see Acknowledging IAM Resources in AWS CloudFormation // Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). // // * CAPABILITY_AUTO_EXPAND Some templates contain macros. If your stack // template contains one or more macros, and you choose to update a stack // directly from the processed template, without first reviewing the resulting // changes in a change set, you must acknowledge this capability. For more // information, see Using AWS CloudFormation Macros to Perform Custom Processing // on Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html). // Stack sets do not currently support macros in stack templates. (This includes // the AWS::Include (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html) // and AWS::Serverless (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html) // transforms, which are macros hosted by AWS CloudFormation.) Even if you // specify this capability, if you include a macro in your template the stack // set operation will fail. Capabilities []Capability `type:"list"` // A brief description of updates that you are making. Description *string `min:"1" type:"string"` // The name of the IAM execution role to use to update the stack set. If you // do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole // role for the stack set operation. // // Specify an IAM role only if you are using customized execution roles to control // which stack resources users and groups can include in their stack sets. // // If you specify a customized execution role, AWS CloudFormation uses that // role to update the stack. If you do not specify a customized execution role, // AWS CloudFormation performs the update using the role previously associated // with the stack set, so long as you have permissions to perform operations // on the stack set. ExecutionRoleName *string `min:"1" type:"string"` // The unique ID for this stack set operation. // // The operation ID also functions as an idempotency token, to ensure that AWS // CloudFormation performs the stack set operation only once, even if you retry // the request multiple times. You might retry stack set operation requests // to ensure that AWS CloudFormation successfully received them. // // If you don't specify an operation ID, AWS CloudFormation generates one automatically. // // Repeating this stack set operation with a new operation ID retries all stack // instances whose status is OUTDATED. OperationId *string `min:"1" type:"string" idempotencyToken:"true"` // Preferences for how AWS CloudFormation performs this stack set operation. OperationPreferences *StackSetOperationPreferences `type:"structure"` // A list of input parameters for the stack set template. Parameters []Parameter `type:"list"` // The regions in which to update associated stack instances. If you specify // regions, you must also specify accounts in which to update stack set instances. // // To update all the stack instances associated with this stack set, do not // specify the Accounts or Regions properties. // // If the stack set update includes changes to the template (that is, if the // TemplateBody or TemplateURL properties are specified), or the Parameters // property, AWS CloudFormation marks all stack instances with a status of OUTDATED // prior to updating the stack instances in the specified accounts and regions. // If the stack set update does not include changes to the template or parameters, // AWS CloudFormation updates the stack instances in the specified accounts // and regions, while leaving all other stack instances with their existing // stack instance status. Regions []string `type:"list"` // The name or unique ID of the stack set that you want to update. // // StackSetName is a required field StackSetName *string `type:"string" required:"true"` // The key-value pairs to associate with this stack set and the stacks created // from it. AWS CloudFormation also propagates these tags to supported resources // that are created in the stacks. You can specify a maximum number of 50 tags. // // If you specify tags for this parameter, those tags replace any list of tags // that are currently associated with this stack set. This means: // // * If you don't specify this parameter, AWS CloudFormation doesn't modify // the stack's tags. // // * If you specify any tags using this parameter, you must specify all the // tags that you want associated with this stack set, even tags you've specifed // before (for example, when creating the stack set or during a previous // update of the stack set.). Any tags that you don't include in the updated // list of tags are removed from the stack set, and therefore from the stacks // and resources as well. // // * If you specify an empty value, AWS CloudFormation removes all currently // associated tags. // // If you specify new tags as part of an UpdateStackSet action, AWS CloudFormation // checks to see if you have the required IAM permission to tag resources. If // you omit tags that are currently associated with the stack set from the list // of tags you specify, AWS CloudFormation assumes that you want to remove those // tags from the stack set, and checks to see if you have permission to untag // resources. If you don't have the necessary permission(s), the entire UpdateStackSet // action fails with an access denied error, and the stack set is not updated. Tags []Tag `type:"list"` // The structure that contains the template body, with a minimum length of 1 // byte and a maximum length of 51,200 bytes. For more information, see Template // Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the AWS CloudFormation User Guide. // // Conditional: You must specify only one of the following parameters: TemplateBody // or TemplateURL—or set UsePreviousTemplate to true. TemplateBody *string `min:"1" type:"string"` // The location of the file that contains the template body. The URL must point // to a template (maximum size: 460,800 bytes) that is located in an Amazon // S3 bucket. For more information, see Template Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the AWS CloudFormation User Guide. // // Conditional: You must specify only one of the following parameters: TemplateBody // or TemplateURL—or set UsePreviousTemplate to true. TemplateURL *string `min:"1" type:"string"` // Use the existing template that's associated with the stack set that you're // updating. // // Conditional: You must specify only one of the following parameters: TemplateBody // or TemplateURL—or set UsePreviousTemplate to true. UsePreviousTemplate *bool `type:"boolean"` // contains filtered or unexported fields }
func (UpdateStackSetInput) String ¶
func (s UpdateStackSetInput) String() string
String returns the string representation
func (*UpdateStackSetInput) Validate ¶
func (s *UpdateStackSetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateStackSetOutput ¶
type UpdateStackSetOutput struct { // The unique ID for this stack set operation. OperationId *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (UpdateStackSetOutput) String ¶
func (s UpdateStackSetOutput) String() string
String returns the string representation
type UpdateStackSetRequest ¶
type UpdateStackSetRequest struct { *aws.Request Input *UpdateStackSetInput Copy func(*UpdateStackSetInput) UpdateStackSetRequest }
UpdateStackSetRequest is the request type for the UpdateStackSet API operation.
func (UpdateStackSetRequest) Send ¶
func (r UpdateStackSetRequest) Send(ctx context.Context) (*UpdateStackSetResponse, error)
Send marshals and sends the UpdateStackSet API request.
type UpdateStackSetResponse ¶ added in v0.9.0
type UpdateStackSetResponse struct { *UpdateStackSetOutput // contains filtered or unexported fields }
UpdateStackSetResponse is the response type for the UpdateStackSet API operation.
func (*UpdateStackSetResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateStackSetResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateStackSet request.
type UpdateTerminationProtectionInput ¶
type UpdateTerminationProtectionInput struct { // Whether to enable termination protection on the specified stack. // // EnableTerminationProtection is a required field EnableTerminationProtection *bool `type:"boolean" required:"true"` // The name or unique ID of the stack for which you want to set termination // protection. // // StackName is a required field StackName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (UpdateTerminationProtectionInput) String ¶
func (s UpdateTerminationProtectionInput) String() string
String returns the string representation
func (*UpdateTerminationProtectionInput) Validate ¶
func (s *UpdateTerminationProtectionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateTerminationProtectionOutput ¶
type UpdateTerminationProtectionOutput struct { // The unique ID of the stack. StackId *string `type:"string"` // contains filtered or unexported fields }
func (UpdateTerminationProtectionOutput) String ¶
func (s UpdateTerminationProtectionOutput) String() string
String returns the string representation
type UpdateTerminationProtectionRequest ¶
type UpdateTerminationProtectionRequest struct { *aws.Request Input *UpdateTerminationProtectionInput Copy func(*UpdateTerminationProtectionInput) UpdateTerminationProtectionRequest }
UpdateTerminationProtectionRequest is the request type for the UpdateTerminationProtection API operation.
func (UpdateTerminationProtectionRequest) Send ¶
func (r UpdateTerminationProtectionRequest) Send(ctx context.Context) (*UpdateTerminationProtectionResponse, error)
Send marshals and sends the UpdateTerminationProtection API request.
type UpdateTerminationProtectionResponse ¶ added in v0.9.0
type UpdateTerminationProtectionResponse struct { *UpdateTerminationProtectionOutput // contains filtered or unexported fields }
UpdateTerminationProtectionResponse is the response type for the UpdateTerminationProtection API operation.
func (*UpdateTerminationProtectionResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateTerminationProtectionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateTerminationProtection request.
type ValidateTemplateInput ¶
type ValidateTemplateInput struct { // Structure containing the template body with a minimum length of 1 byte and // a maximum length of 51,200 bytes. For more information, go to Template Anatomy // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the AWS CloudFormation User Guide. // // Conditional: You must pass TemplateURL or TemplateBody. If both are passed, // only TemplateBody is used. TemplateBody *string `min:"1" type:"string"` // Location of file containing the template body. The URL must point to a template // (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more // information, go to Template Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) // in the AWS CloudFormation User Guide. // // Conditional: You must pass TemplateURL or TemplateBody. If both are passed, // only TemplateBody is used. TemplateURL *string `min:"1" type:"string"` // contains filtered or unexported fields }
The input for ValidateTemplate action.
func (ValidateTemplateInput) String ¶
func (s ValidateTemplateInput) String() string
String returns the string representation
func (*ValidateTemplateInput) Validate ¶
func (s *ValidateTemplateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ValidateTemplateOutput ¶
type ValidateTemplateOutput struct { // The capabilities found within the template. If your template contains IAM // resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value // for this parameter when you use the CreateStack or UpdateStack actions with // your template; otherwise, those actions return an InsufficientCapabilities // error. // // For more information, see Acknowledging IAM Resources in AWS CloudFormation // Templates (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). Capabilities []Capability `type:"list"` // The list of resources that generated the values in the Capabilities response // element. CapabilitiesReason *string `type:"string"` // A list of the transforms that are declared in the template. DeclaredTransforms []string `type:"list"` // The description found within the template. Description *string `min:"1" type:"string"` // A list of TemplateParameter structures. Parameters []TemplateParameter `type:"list"` // contains filtered or unexported fields }
The output for ValidateTemplate action.
func (ValidateTemplateOutput) String ¶
func (s ValidateTemplateOutput) String() string
String returns the string representation
type ValidateTemplateRequest ¶
type ValidateTemplateRequest struct { *aws.Request Input *ValidateTemplateInput Copy func(*ValidateTemplateInput) ValidateTemplateRequest }
ValidateTemplateRequest is the request type for the ValidateTemplate API operation.
func (ValidateTemplateRequest) Send ¶
func (r ValidateTemplateRequest) Send(ctx context.Context) (*ValidateTemplateResponse, error)
Send marshals and sends the ValidateTemplate API request.
type ValidateTemplateResponse ¶ added in v0.9.0
type ValidateTemplateResponse struct { *ValidateTemplateOutput // contains filtered or unexported fields }
ValidateTemplateResponse is the response type for the ValidateTemplate API operation.
func (*ValidateTemplateResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ValidateTemplateResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ValidateTemplate request.
Source Files ¶
- api_client.go
- api_doc.go
- api_enums.go
- api_errors.go
- api_op_CancelUpdateStack.go
- api_op_ContinueUpdateRollback.go
- api_op_CreateChangeSet.go
- api_op_CreateStack.go
- api_op_CreateStackInstances.go
- api_op_CreateStackSet.go
- api_op_DeleteChangeSet.go
- api_op_DeleteStack.go
- api_op_DeleteStackInstances.go
- api_op_DeleteStackSet.go
- api_op_DescribeAccountLimits.go
- api_op_DescribeChangeSet.go
- api_op_DescribeStackDriftDetectionStatus.go
- api_op_DescribeStackEvents.go
- api_op_DescribeStackInstance.go
- api_op_DescribeStackResource.go
- api_op_DescribeStackResourceDrifts.go
- api_op_DescribeStackResources.go
- api_op_DescribeStackSet.go
- api_op_DescribeStackSetOperation.go
- api_op_DescribeStacks.go
- api_op_DetectStackDrift.go
- api_op_DetectStackResourceDrift.go
- api_op_EstimateTemplateCost.go
- api_op_ExecuteChangeSet.go
- api_op_GetStackPolicy.go
- api_op_GetTemplate.go
- api_op_GetTemplateSummary.go
- api_op_ListChangeSets.go
- api_op_ListExports.go
- api_op_ListImports.go
- api_op_ListStackInstances.go
- api_op_ListStackResources.go
- api_op_ListStackSetOperationResults.go
- api_op_ListStackSetOperations.go
- api_op_ListStackSets.go
- api_op_ListStacks.go
- api_op_SetStackPolicy.go
- api_op_SignalResource.go
- api_op_StopStackSetOperation.go
- api_op_UpdateStack.go
- api_op_UpdateStackInstances.go
- api_op_UpdateStackSet.go
- api_op_UpdateTerminationProtection.go
- api_op_ValidateTemplate.go
- api_types.go
- api_waiters.go
Directories ¶
Path | Synopsis |
---|---|
Package cloudformationiface provides an interface to enable mocking the AWS CloudFormation service client for testing your code.
|
Package cloudformationiface provides an interface to enable mocking the AWS CloudFormation service client for testing your code. |