package cloudformation
import "github.com/aws/aws-sdk-go-v2/service/cloudformation"
Package cloudformation provides the API client, operations, and parameter types for AWS CloudFormation.
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/).
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)
- type ActivateTypeInput
- type ActivateTypeOutput
- type BatchDescribeTypeConfigurationsInput
- type BatchDescribeTypeConfigurationsOutput
- type CancelUpdateStackInput
- type CancelUpdateStackOutput
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) ActivateType(ctx context.Context, params *ActivateTypeInput, optFns ...func(*Options)) (*ActivateTypeOutput, error)
- func (c *Client) BatchDescribeTypeConfigurations(ctx context.Context, params *BatchDescribeTypeConfigurationsInput, optFns ...func(*Options)) (*BatchDescribeTypeConfigurationsOutput, error)
- func (c *Client) CancelUpdateStack(ctx context.Context, params *CancelUpdateStackInput, optFns ...func(*Options)) (*CancelUpdateStackOutput, error)
- func (c *Client) ContinueUpdateRollback(ctx context.Context, params *ContinueUpdateRollbackInput, optFns ...func(*Options)) (*ContinueUpdateRollbackOutput, error)
- func (c *Client) CreateChangeSet(ctx context.Context, params *CreateChangeSetInput, optFns ...func(*Options)) (*CreateChangeSetOutput, error)
- func (c *Client) CreateStack(ctx context.Context, params *CreateStackInput, optFns ...func(*Options)) (*CreateStackOutput, error)
- func (c *Client) CreateStackInstances(ctx context.Context, params *CreateStackInstancesInput, optFns ...func(*Options)) (*CreateStackInstancesOutput, error)
- func (c *Client) CreateStackSet(ctx context.Context, params *CreateStackSetInput, optFns ...func(*Options)) (*CreateStackSetOutput, error)
- func (c *Client) DeactivateType(ctx context.Context, params *DeactivateTypeInput, optFns ...func(*Options)) (*DeactivateTypeOutput, error)
- func (c *Client) DeleteChangeSet(ctx context.Context, params *DeleteChangeSetInput, optFns ...func(*Options)) (*DeleteChangeSetOutput, error)
- func (c *Client) DeleteStack(ctx context.Context, params *DeleteStackInput, optFns ...func(*Options)) (*DeleteStackOutput, error)
- func (c *Client) DeleteStackInstances(ctx context.Context, params *DeleteStackInstancesInput, optFns ...func(*Options)) (*DeleteStackInstancesOutput, error)
- func (c *Client) DeleteStackSet(ctx context.Context, params *DeleteStackSetInput, optFns ...func(*Options)) (*DeleteStackSetOutput, error)
- func (c *Client) DeregisterType(ctx context.Context, params *DeregisterTypeInput, optFns ...func(*Options)) (*DeregisterTypeOutput, error)
- func (c *Client) DescribeAccountLimits(ctx context.Context, params *DescribeAccountLimitsInput, optFns ...func(*Options)) (*DescribeAccountLimitsOutput, error)
- func (c *Client) DescribeChangeSet(ctx context.Context, params *DescribeChangeSetInput, optFns ...func(*Options)) (*DescribeChangeSetOutput, error)
- func (c *Client) DescribePublisher(ctx context.Context, params *DescribePublisherInput, optFns ...func(*Options)) (*DescribePublisherOutput, error)
- func (c *Client) DescribeStackDriftDetectionStatus(ctx context.Context, params *DescribeStackDriftDetectionStatusInput, optFns ...func(*Options)) (*DescribeStackDriftDetectionStatusOutput, error)
- func (c *Client) DescribeStackEvents(ctx context.Context, params *DescribeStackEventsInput, optFns ...func(*Options)) (*DescribeStackEventsOutput, error)
- func (c *Client) DescribeStackInstance(ctx context.Context, params *DescribeStackInstanceInput, optFns ...func(*Options)) (*DescribeStackInstanceOutput, error)
- func (c *Client) DescribeStackResource(ctx context.Context, params *DescribeStackResourceInput, optFns ...func(*Options)) (*DescribeStackResourceOutput, error)
- func (c *Client) DescribeStackResourceDrifts(ctx context.Context, params *DescribeStackResourceDriftsInput, optFns ...func(*Options)) (*DescribeStackResourceDriftsOutput, error)
- func (c *Client) DescribeStackResources(ctx context.Context, params *DescribeStackResourcesInput, optFns ...func(*Options)) (*DescribeStackResourcesOutput, error)
- func (c *Client) DescribeStackSet(ctx context.Context, params *DescribeStackSetInput, optFns ...func(*Options)) (*DescribeStackSetOutput, error)
- func (c *Client) DescribeStackSetOperation(ctx context.Context, params *DescribeStackSetOperationInput, optFns ...func(*Options)) (*DescribeStackSetOperationOutput, error)
- func (c *Client) DescribeStacks(ctx context.Context, params *DescribeStacksInput, optFns ...func(*Options)) (*DescribeStacksOutput, error)
- func (c *Client) DescribeType(ctx context.Context, params *DescribeTypeInput, optFns ...func(*Options)) (*DescribeTypeOutput, error)
- func (c *Client) DescribeTypeRegistration(ctx context.Context, params *DescribeTypeRegistrationInput, optFns ...func(*Options)) (*DescribeTypeRegistrationOutput, error)
- func (c *Client) DetectStackDrift(ctx context.Context, params *DetectStackDriftInput, optFns ...func(*Options)) (*DetectStackDriftOutput, error)
- func (c *Client) DetectStackResourceDrift(ctx context.Context, params *DetectStackResourceDriftInput, optFns ...func(*Options)) (*DetectStackResourceDriftOutput, error)
- func (c *Client) DetectStackSetDrift(ctx context.Context, params *DetectStackSetDriftInput, optFns ...func(*Options)) (*DetectStackSetDriftOutput, error)
- func (c *Client) EstimateTemplateCost(ctx context.Context, params *EstimateTemplateCostInput, optFns ...func(*Options)) (*EstimateTemplateCostOutput, error)
- func (c *Client) ExecuteChangeSet(ctx context.Context, params *ExecuteChangeSetInput, optFns ...func(*Options)) (*ExecuteChangeSetOutput, error)
- func (c *Client) GetStackPolicy(ctx context.Context, params *GetStackPolicyInput, optFns ...func(*Options)) (*GetStackPolicyOutput, error)
- func (c *Client) GetTemplate(ctx context.Context, params *GetTemplateInput, optFns ...func(*Options)) (*GetTemplateOutput, error)
- func (c *Client) GetTemplateSummary(ctx context.Context, params *GetTemplateSummaryInput, optFns ...func(*Options)) (*GetTemplateSummaryOutput, error)
- func (c *Client) ListChangeSets(ctx context.Context, params *ListChangeSetsInput, optFns ...func(*Options)) (*ListChangeSetsOutput, error)
- func (c *Client) ListExports(ctx context.Context, params *ListExportsInput, optFns ...func(*Options)) (*ListExportsOutput, error)
- func (c *Client) ListImports(ctx context.Context, params *ListImportsInput, optFns ...func(*Options)) (*ListImportsOutput, error)
- func (c *Client) ListStackInstances(ctx context.Context, params *ListStackInstancesInput, optFns ...func(*Options)) (*ListStackInstancesOutput, error)
- func (c *Client) ListStackResources(ctx context.Context, params *ListStackResourcesInput, optFns ...func(*Options)) (*ListStackResourcesOutput, error)
- func (c *Client) ListStackSetOperationResults(ctx context.Context, params *ListStackSetOperationResultsInput, optFns ...func(*Options)) (*ListStackSetOperationResultsOutput, error)
- func (c *Client) ListStackSetOperations(ctx context.Context, params *ListStackSetOperationsInput, optFns ...func(*Options)) (*ListStackSetOperationsOutput, error)
- func (c *Client) ListStackSets(ctx context.Context, params *ListStackSetsInput, optFns ...func(*Options)) (*ListStackSetsOutput, error)
- func (c *Client) ListStacks(ctx context.Context, params *ListStacksInput, optFns ...func(*Options)) (*ListStacksOutput, error)
- func (c *Client) ListTypeRegistrations(ctx context.Context, params *ListTypeRegistrationsInput, optFns ...func(*Options)) (*ListTypeRegistrationsOutput, error)
- func (c *Client) ListTypeVersions(ctx context.Context, params *ListTypeVersionsInput, optFns ...func(*Options)) (*ListTypeVersionsOutput, error)
- func (c *Client) ListTypes(ctx context.Context, params *ListTypesInput, optFns ...func(*Options)) (*ListTypesOutput, error)
- func (c *Client) PublishType(ctx context.Context, params *PublishTypeInput, optFns ...func(*Options)) (*PublishTypeOutput, error)
- func (c *Client) RecordHandlerProgress(ctx context.Context, params *RecordHandlerProgressInput, optFns ...func(*Options)) (*RecordHandlerProgressOutput, error)
- func (c *Client) RegisterPublisher(ctx context.Context, params *RegisterPublisherInput, optFns ...func(*Options)) (*RegisterPublisherOutput, error)
- func (c *Client) RegisterType(ctx context.Context, params *RegisterTypeInput, optFns ...func(*Options)) (*RegisterTypeOutput, error)
- func (c *Client) SetStackPolicy(ctx context.Context, params *SetStackPolicyInput, optFns ...func(*Options)) (*SetStackPolicyOutput, error)
- func (c *Client) SetTypeConfiguration(ctx context.Context, params *SetTypeConfigurationInput, optFns ...func(*Options)) (*SetTypeConfigurationOutput, error)
- func (c *Client) SetTypeDefaultVersion(ctx context.Context, params *SetTypeDefaultVersionInput, optFns ...func(*Options)) (*SetTypeDefaultVersionOutput, error)
- func (c *Client) SignalResource(ctx context.Context, params *SignalResourceInput, optFns ...func(*Options)) (*SignalResourceOutput, error)
- func (c *Client) StopStackSetOperation(ctx context.Context, params *StopStackSetOperationInput, optFns ...func(*Options)) (*StopStackSetOperationOutput, error)
- func (c *Client) TestType(ctx context.Context, params *TestTypeInput, optFns ...func(*Options)) (*TestTypeOutput, error)
- func (c *Client) UpdateStack(ctx context.Context, params *UpdateStackInput, optFns ...func(*Options)) (*UpdateStackOutput, error)
- func (c *Client) UpdateStackInstances(ctx context.Context, params *UpdateStackInstancesInput, optFns ...func(*Options)) (*UpdateStackInstancesOutput, error)
- func (c *Client) UpdateStackSet(ctx context.Context, params *UpdateStackSetInput, optFns ...func(*Options)) (*UpdateStackSetOutput, error)
- func (c *Client) UpdateTerminationProtection(ctx context.Context, params *UpdateTerminationProtectionInput, optFns ...func(*Options)) (*UpdateTerminationProtectionOutput, error)
- func (c *Client) ValidateTemplate(ctx context.Context, params *ValidateTemplateInput, optFns ...func(*Options)) (*ValidateTemplateOutput, error)
- type ContinueUpdateRollbackInput
- type ContinueUpdateRollbackOutput
- type CreateChangeSetInput
- type CreateChangeSetOutput
- type CreateStackInput
- type CreateStackInstancesInput
- type CreateStackInstancesOutput
- type CreateStackOutput
- type CreateStackSetInput
- type CreateStackSetOutput
- type DeactivateTypeInput
- type DeactivateTypeOutput
- type DeleteChangeSetInput
- type DeleteChangeSetOutput
- type DeleteStackInput
- type DeleteStackInstancesInput
- type DeleteStackInstancesOutput
- type DeleteStackOutput
- type DeleteStackSetInput
- type DeleteStackSetOutput
- type DeregisterTypeInput
- type DeregisterTypeOutput
- type DescribeAccountLimitsAPIClient
- type DescribeAccountLimitsInput
- type DescribeAccountLimitsOutput
- type DescribeAccountLimitsPaginator
- func NewDescribeAccountLimitsPaginator(client DescribeAccountLimitsAPIClient, params *DescribeAccountLimitsInput, optFns ...func(*DescribeAccountLimitsPaginatorOptions)) *DescribeAccountLimitsPaginator
- func (p *DescribeAccountLimitsPaginator) HasMorePages() bool
- func (p *DescribeAccountLimitsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeAccountLimitsOutput, error)
- type DescribeAccountLimitsPaginatorOptions
- type DescribeChangeSetInput
- type DescribeChangeSetOutput
- type DescribePublisherInput
- type DescribePublisherOutput
- type DescribeStackDriftDetectionStatusInput
- type DescribeStackDriftDetectionStatusOutput
- type DescribeStackEventsAPIClient
- type DescribeStackEventsInput
- type DescribeStackEventsOutput
- type DescribeStackEventsPaginator
- func NewDescribeStackEventsPaginator(client DescribeStackEventsAPIClient, params *DescribeStackEventsInput, optFns ...func(*DescribeStackEventsPaginatorOptions)) *DescribeStackEventsPaginator
- func (p *DescribeStackEventsPaginator) HasMorePages() bool
- func (p *DescribeStackEventsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeStackEventsOutput, error)
- type DescribeStackEventsPaginatorOptions
- type DescribeStackInstanceInput
- type DescribeStackInstanceOutput
- type DescribeStackResourceDriftsAPIClient
- type DescribeStackResourceDriftsInput
- type DescribeStackResourceDriftsOutput
- type DescribeStackResourceDriftsPaginator
- func NewDescribeStackResourceDriftsPaginator(client DescribeStackResourceDriftsAPIClient, params *DescribeStackResourceDriftsInput, optFns ...func(*DescribeStackResourceDriftsPaginatorOptions)) *DescribeStackResourceDriftsPaginator
- func (p *DescribeStackResourceDriftsPaginator) HasMorePages() bool
- func (p *DescribeStackResourceDriftsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeStackResourceDriftsOutput, error)
- type DescribeStackResourceDriftsPaginatorOptions
- type DescribeStackResourceInput
- type DescribeStackResourceOutput
- type DescribeStackResourcesInput
- type DescribeStackResourcesOutput
- type DescribeStackSetInput
- type DescribeStackSetOperationInput
- type DescribeStackSetOperationOutput
- type DescribeStackSetOutput
- type DescribeStacksAPIClient
- type DescribeStacksInput
- type DescribeStacksOutput
- type DescribeStacksPaginator
- func NewDescribeStacksPaginator(client DescribeStacksAPIClient, params *DescribeStacksInput, optFns ...func(*DescribeStacksPaginatorOptions)) *DescribeStacksPaginator
- func (p *DescribeStacksPaginator) HasMorePages() bool
- func (p *DescribeStacksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeStacksOutput, error)
- type DescribeStacksPaginatorOptions
- type DescribeTypeInput
- type DescribeTypeOutput
- type DescribeTypeRegistrationAPIClient
- type DescribeTypeRegistrationInput
- type DescribeTypeRegistrationOutput
- type DetectStackDriftInput
- type DetectStackDriftOutput
- type DetectStackResourceDriftInput
- type DetectStackResourceDriftOutput
- type DetectStackSetDriftInput
- type DetectStackSetDriftOutput
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EstimateTemplateCostInput
- type EstimateTemplateCostOutput
- type ExecuteChangeSetInput
- type ExecuteChangeSetOutput
- type GetStackPolicyInput
- type GetStackPolicyOutput
- type GetTemplateInput
- type GetTemplateOutput
- type GetTemplateSummaryInput
- type GetTemplateSummaryOutput
- type HTTPClient
- type HTTPSignerV4
- type IdempotencyTokenProvider
- type ListChangeSetsAPIClient
- type ListChangeSetsInput
- type ListChangeSetsOutput
- type ListChangeSetsPaginator
- func NewListChangeSetsPaginator(client ListChangeSetsAPIClient, params *ListChangeSetsInput, optFns ...func(*ListChangeSetsPaginatorOptions)) *ListChangeSetsPaginator
- func (p *ListChangeSetsPaginator) HasMorePages() bool
- func (p *ListChangeSetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListChangeSetsOutput, error)
- type ListChangeSetsPaginatorOptions
- type ListExportsAPIClient
- type ListExportsInput
- type ListExportsOutput
- type ListExportsPaginator
- func NewListExportsPaginator(client ListExportsAPIClient, params *ListExportsInput, optFns ...func(*ListExportsPaginatorOptions)) *ListExportsPaginator
- func (p *ListExportsPaginator) HasMorePages() bool
- func (p *ListExportsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListExportsOutput, error)
- type ListExportsPaginatorOptions
- type ListImportsAPIClient
- type ListImportsInput
- type ListImportsOutput
- type ListImportsPaginator
- func NewListImportsPaginator(client ListImportsAPIClient, params *ListImportsInput, optFns ...func(*ListImportsPaginatorOptions)) *ListImportsPaginator
- func (p *ListImportsPaginator) HasMorePages() bool
- func (p *ListImportsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListImportsOutput, error)
- type ListImportsPaginatorOptions
- type ListStackInstancesAPIClient
- type ListStackInstancesInput
- type ListStackInstancesOutput
- type ListStackInstancesPaginator
- func NewListStackInstancesPaginator(client ListStackInstancesAPIClient, params *ListStackInstancesInput, optFns ...func(*ListStackInstancesPaginatorOptions)) *ListStackInstancesPaginator
- func (p *ListStackInstancesPaginator) HasMorePages() bool
- func (p *ListStackInstancesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStackInstancesOutput, error)
- type ListStackInstancesPaginatorOptions
- type ListStackResourcesAPIClient
- type ListStackResourcesInput
- type ListStackResourcesOutput
- type ListStackResourcesPaginator
- func NewListStackResourcesPaginator(client ListStackResourcesAPIClient, params *ListStackResourcesInput, optFns ...func(*ListStackResourcesPaginatorOptions)) *ListStackResourcesPaginator
- func (p *ListStackResourcesPaginator) HasMorePages() bool
- func (p *ListStackResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStackResourcesOutput, error)
- type ListStackResourcesPaginatorOptions
- type ListStackSetOperationResultsAPIClient
- type ListStackSetOperationResultsInput
- type ListStackSetOperationResultsOutput
- type ListStackSetOperationResultsPaginator
- func NewListStackSetOperationResultsPaginator(client ListStackSetOperationResultsAPIClient, params *ListStackSetOperationResultsInput, optFns ...func(*ListStackSetOperationResultsPaginatorOptions)) *ListStackSetOperationResultsPaginator
- func (p *ListStackSetOperationResultsPaginator) HasMorePages() bool
- func (p *ListStackSetOperationResultsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStackSetOperationResultsOutput, error)
- type ListStackSetOperationResultsPaginatorOptions
- type ListStackSetOperationsAPIClient
- type ListStackSetOperationsInput
- type ListStackSetOperationsOutput
- type ListStackSetOperationsPaginator
- func NewListStackSetOperationsPaginator(client ListStackSetOperationsAPIClient, params *ListStackSetOperationsInput, optFns ...func(*ListStackSetOperationsPaginatorOptions)) *ListStackSetOperationsPaginator
- func (p *ListStackSetOperationsPaginator) HasMorePages() bool
- func (p *ListStackSetOperationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStackSetOperationsOutput, error)
- type ListStackSetOperationsPaginatorOptions
- type ListStackSetsAPIClient
- type ListStackSetsInput
- type ListStackSetsOutput
- type ListStackSetsPaginator
- func NewListStackSetsPaginator(client ListStackSetsAPIClient, params *ListStackSetsInput, optFns ...func(*ListStackSetsPaginatorOptions)) *ListStackSetsPaginator
- func (p *ListStackSetsPaginator) HasMorePages() bool
- func (p *ListStackSetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStackSetsOutput, error)
- type ListStackSetsPaginatorOptions
- type ListStacksAPIClient
- type ListStacksInput
- type ListStacksOutput
- type ListStacksPaginator
- func NewListStacksPaginator(client ListStacksAPIClient, params *ListStacksInput, optFns ...func(*ListStacksPaginatorOptions)) *ListStacksPaginator
- func (p *ListStacksPaginator) HasMorePages() bool
- func (p *ListStacksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStacksOutput, error)
- type ListStacksPaginatorOptions
- type ListTypeRegistrationsAPIClient
- type ListTypeRegistrationsInput
- type ListTypeRegistrationsOutput
- type ListTypeRegistrationsPaginator
- func NewListTypeRegistrationsPaginator(client ListTypeRegistrationsAPIClient, params *ListTypeRegistrationsInput, optFns ...func(*ListTypeRegistrationsPaginatorOptions)) *ListTypeRegistrationsPaginator
- func (p *ListTypeRegistrationsPaginator) HasMorePages() bool
- func (p *ListTypeRegistrationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTypeRegistrationsOutput, error)
- type ListTypeRegistrationsPaginatorOptions
- type ListTypeVersionsAPIClient
- type ListTypeVersionsInput
- type ListTypeVersionsOutput
- type ListTypeVersionsPaginator
- func NewListTypeVersionsPaginator(client ListTypeVersionsAPIClient, params *ListTypeVersionsInput, optFns ...func(*ListTypeVersionsPaginatorOptions)) *ListTypeVersionsPaginator
- func (p *ListTypeVersionsPaginator) HasMorePages() bool
- func (p *ListTypeVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTypeVersionsOutput, error)
- type ListTypeVersionsPaginatorOptions
- type ListTypesAPIClient
- type ListTypesInput
- type ListTypesOutput
- type ListTypesPaginator
- func NewListTypesPaginator(client ListTypesAPIClient, params *ListTypesInput, optFns ...func(*ListTypesPaginatorOptions)) *ListTypesPaginator
- func (p *ListTypesPaginator) HasMorePages() bool
- func (p *ListTypesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTypesOutput, error)
- type ListTypesPaginatorOptions
- type Options
- type PublishTypeInput
- type PublishTypeOutput
- type RecordHandlerProgressInput
- type RecordHandlerProgressOutput
- type RegisterPublisherInput
- type RegisterPublisherOutput
- type RegisterTypeInput
- type RegisterTypeOutput
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type SetStackPolicyInput
- type SetStackPolicyOutput
- type SetTypeConfigurationInput
- type SetTypeConfigurationOutput
- type SetTypeDefaultVersionInput
- type SetTypeDefaultVersionOutput
- type SignalResourceInput
- type SignalResourceOutput
- type StopStackSetOperationInput
- type StopStackSetOperationOutput
- type TestTypeInput
- type TestTypeOutput
- type TypeRegistrationCompleteWaiter
- func NewTypeRegistrationCompleteWaiter(client DescribeTypeRegistrationAPIClient, optFns ...func(*TypeRegistrationCompleteWaiterOptions)) *TypeRegistrationCompleteWaiter
- func (w *TypeRegistrationCompleteWaiter) Wait(ctx context.Context, params *DescribeTypeRegistrationInput, maxWaitDur time.Duration, optFns ...func(*TypeRegistrationCompleteWaiterOptions)) error
- type TypeRegistrationCompleteWaiterOptions
- type UpdateStackInput
- type UpdateStackInstancesInput
- type UpdateStackInstancesOutput
- type UpdateStackOutput
- type UpdateStackSetInput
- type UpdateStackSetOutput
- type UpdateTerminationProtectionInput
- type UpdateTerminationProtectionOutput
- type ValidateTemplateInput
- type ValidateTemplateOutput
Constants ¶
const ServiceAPIVersion = "2010-05-15"
const ServiceID = "CloudFormation"
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver ¶
func WithEndpointResolver(v EndpointResolver) func(*Options)
WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.
Types ¶
type ActivateTypeInput ¶
type ActivateTypeInput struct { // Whether to automatically update the extension in this account and region when a // new minor version is published by the extension publisher. Major versions // released by the publisher must be manually updated. The default is true. AutoUpdate *bool // The name of the IAM execution role to use to activate the extension. ExecutionRoleArn *string // Contains logging configuration information for an extension. LoggingConfig *types.LoggingConfig // The major version of this extension you want to activate, if multiple major // versions are available. The default is the latest major version. CloudFormation // uses the latest available minor version of the major version selected. You can // specify MajorVersion or VersionBump, but not both. MajorVersion *int64 // The Amazon Resource Number (ARN) of the public extension. Conditional: You must // specify PublicTypeArn, or TypeName, Type, and PublisherId. PublicTypeArn *string // The ID of the extension publisher. Conditional: You must specify PublicTypeArn, // or TypeName, Type, and PublisherId. PublisherId *string // The extension type. Conditional: You must specify PublicTypeArn, or TypeName, // Type, and PublisherId. Type types.ThirdPartyType // The name of the extension. Conditional: You must specify PublicTypeArn, or // TypeName, Type, and PublisherId. TypeName *string // An alias to assign to the public extension, in this account and region. If you // specify an alias for the extension, CloudFormation treats the alias as the // extension type name within this account and region. You must use the alias to // refer to the extension in your templates, API calls, and CloudFormation console. // An extension alias must be unique within a given account and region. You can // activate the same public resource multiple times in the same account and region, // using different type name aliases. TypeNameAlias *string // Manually updates a previously-activated type to a new major or minor version, if // available. You can also use this parameter to update the value of AutoUpdate. // // * // MAJOR: CloudFormation updates the extension to the newest major version, if one // is available. // // * MINOR: CloudFormation updates the extension to the newest minor // version, if one is available. VersionBump types.VersionBump }
type ActivateTypeOutput ¶
type ActivateTypeOutput struct { // The Amazon Resource Number (ARN) of the activated extension, in this account and // region. Arn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type BatchDescribeTypeConfigurationsInput ¶
type BatchDescribeTypeConfigurationsInput struct { // The list of identifiers for the desired extension configurations. // // This member is required. TypeConfigurationIdentifiers []types.TypeConfigurationIdentifier }
type BatchDescribeTypeConfigurationsOutput ¶
type BatchDescribeTypeConfigurationsOutput struct { // A list of information concerning any errors generated during the setting of the // specified configurations. Errors []types.BatchDescribeTypeConfigurationsError // A list of any of the specified extension configurations from the CloudFormation // registry. TypeConfigurations []types.TypeConfigurationDetails // A list of any of the specified extension configurations that CloudFormation // could not process for any reason. UnprocessedTypeConfigurations []types.TypeConfigurationIdentifier // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CancelUpdateStackInput ¶
type CancelUpdateStackInput struct { // The name or the unique stack ID that is associated with the stack. // // This member is required. StackName *string // 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 }
The input for the CancelUpdateStack action.
type CancelUpdateStackOutput ¶
type CancelUpdateStackOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for AWS CloudFormation.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) ActivateType ¶
func (c *Client) ActivateType(ctx context.Context, params *ActivateTypeInput, optFns ...func(*Options)) (*ActivateTypeOutput, error)
Activates a public third-party extension, making it available for use in stack templates. For more information, see Using public extensions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html) in the CloudFormation User Guide. Once you have activated a public third-party extension in your account and region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration) in the CloudFormation User Guide.
func (*Client) BatchDescribeTypeConfigurations ¶
func (c *Client) BatchDescribeTypeConfigurations(ctx context.Context, params *BatchDescribeTypeConfigurationsInput, optFns ...func(*Options)) (*BatchDescribeTypeConfigurationsOutput, error)
Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and region. For more information, see Configuring extensions at the account level (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration) in the CloudFormation User Guide.
func (*Client) CancelUpdateStack ¶
func (c *Client) CancelUpdateStack(ctx context.Context, params *CancelUpdateStackInput, optFns ...func(*Options)) (*CancelUpdateStackOutput, error)
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.
func (*Client) ContinueUpdateRollback ¶
func (c *Client) ContinueUpdateRollback(ctx context.Context, params *ContinueUpdateRollbackInput, optFns ...func(*Options)) (*ContinueUpdateRollbackOutput, error)
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.
func (*Client) CreateChangeSet ¶
func (c *Client) CreateChangeSet(ctx context.Context, params *CreateChangeSetInput, optFns ...func(*Options)) (*CreateChangeSetOutput, error)
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. To create a change set for the entire stack hierachy, set IncludeNestedStacks to True.
func (*Client) CreateStack ¶
func (c *Client) CreateStack(ctx context.Context, params *CreateStackInput, optFns ...func(*Options)) (*CreateStackOutput, error)
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.
func (*Client) CreateStackInstances ¶
func (c *Client) CreateStackInstances(ctx context.Context, params *CreateStackInstancesInput, optFns ...func(*Options)) (*CreateStackInstancesOutput, error)
Creates stack instances for the specified accounts, within the specified Regions. A stack instance refers to a stack in a specific account and Region. You must specify at least one value for either Accounts or DeploymentTargets, and you must specify at least one value for Regions.
func (*Client) CreateStackSet ¶
func (c *Client) CreateStackSet(ctx context.Context, params *CreateStackSetInput, optFns ...func(*Options)) (*CreateStackSetOutput, error)
Creates a stack set.
func (*Client) DeactivateType ¶
func (c *Client) DeactivateType(ctx context.Context, params *DeactivateTypeInput, optFns ...func(*Options)) (*DeactivateTypeOutput, error)
Deactivates a public extension that was previously activated in this account and region. Once deactivated, an extension cannot be used in any CloudFormation operation. This includes stack update operations where the stack template includes the extension, even if no updates are being made to the extension. In addition, deactivated extensions are not automatically updated if a new version of the extension is released.
func (*Client) DeleteChangeSet ¶
func (c *Client) DeleteChangeSet(ctx context.Context, params *DeleteChangeSetInput, optFns ...func(*Options)) (*DeleteChangeSetOutput, error)
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. If IncludeNestedStacks specifies True during the creation of the nested change set, then DeleteChangeSet will delete all change sets that belong to the stacks hierarchy and will also delete all change sets for nested stacks with the status of REVIEW_IN_PROGRESS.
func (*Client) DeleteStack ¶
func (c *Client) DeleteStack(ctx context.Context, params *DeleteStackInput, optFns ...func(*Options)) (*DeleteStackOutput, error)
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.
func (*Client) DeleteStackInstances ¶
func (c *Client) DeleteStackInstances(ctx context.Context, params *DeleteStackInstancesInput, optFns ...func(*Options)) (*DeleteStackInstancesOutput, error)
Deletes stack instances for the specified accounts, in the specified Regions.
func (*Client) DeleteStackSet ¶
func (c *Client) DeleteStackSet(ctx context.Context, params *DeleteStackSetInput, optFns ...func(*Options)) (*DeleteStackSetOutput, error)
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.
func (*Client) DeregisterType ¶
func (c *Client) DeregisterType(ctx context.Context, params *DeregisterTypeInput, optFns ...func(*Options)) (*DeregisterTypeOutput, error)
Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations. To deregister an entire extension, you must individually deregister all active versions of that extension. If an extension has only a single active version, deregistering that version results in the extension itself being deregistered and marked as deprecated in the registry. You cannot deregister the default version of an extension if there are other active version of that extension. If you do deregister the default version of an extension, the textensionype itself is deregistered as well and marked as deprecated. To view the deprecation status of an extension or extension version, use DescribeType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html).
func (*Client) DescribeAccountLimits ¶
func (c *Client) DescribeAccountLimits(ctx context.Context, params *DescribeAccountLimitsInput, optFns ...func(*Options)) (*DescribeAccountLimitsOutput, error)
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.
func (*Client) DescribeChangeSet ¶
func (c *Client) DescribeChangeSet(ctx context.Context, params *DescribeChangeSetInput, optFns ...func(*Options)) (*DescribeChangeSetOutput, error)
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.
func (*Client) DescribePublisher ¶
func (c *Client) DescribePublisher(ctx context.Context, params *DescribePublisherInput, optFns ...func(*Options)) (*DescribePublisherOutput, error)
Returns information about a CloudFormation extension publisher. If you do not supply a PublisherId, and you have registered as an extension publisher, DescribePublisher returns information about your own publisher account. For more information on registering as a publisher, see:
* RegisterPublisher (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html)
* Publishing extensions to make them available for public use (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html) in the CloudFormation CLI User Guide
func (*Client) DescribeStackDriftDetectionStatus ¶
func (c *Client) DescribeStackDriftDetectionStatus(ctx context.Context, params *DescribeStackDriftDetectionStatusInput, optFns ...func(*Options)) (*DescribeStackDriftDetectionStatusOutput, error)
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.
func (*Client) DescribeStackEvents ¶
func (c *Client) DescribeStackEvents(ctx context.Context, params *DescribeStackEventsInput, optFns ...func(*Options)) (*DescribeStackEventsOutput, error)
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).
func (*Client) DescribeStackInstance ¶
func (c *Client) DescribeStackInstance(ctx context.Context, params *DescribeStackInstanceInput, optFns ...func(*Options)) (*DescribeStackInstanceOutput, error)
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.
func (*Client) DescribeStackResource ¶
func (c *Client) DescribeStackResource(ctx context.Context, params *DescribeStackResourceInput, optFns ...func(*Options)) (*DescribeStackResourceOutput, error)
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.
func (*Client) DescribeStackResourceDrifts ¶
func (c *Client) DescribeStackResourceDrifts(ctx context.Context, params *DescribeStackResourceDriftsInput, optFns ...func(*Options)) (*DescribeStackResourceDriftsOutput, error)
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.
func (*Client) DescribeStackResources ¶
func (c *Client) DescribeStackResources(ctx context.Context, params *DescribeStackResourcesInput, optFns ...func(*Options)) (*DescribeStackResourcesOutput, error)
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.
func (*Client) DescribeStackSet ¶
func (c *Client) DescribeStackSet(ctx context.Context, params *DescribeStackSetInput, optFns ...func(*Options)) (*DescribeStackSetOutput, error)
Returns the description of the specified stack set.
func (*Client) DescribeStackSetOperation ¶
func (c *Client) DescribeStackSetOperation(ctx context.Context, params *DescribeStackSetOperationInput, optFns ...func(*Options)) (*DescribeStackSetOperationOutput, error)
Returns the description of the specified stack set operation.
func (*Client) DescribeStacks ¶
func (c *Client) DescribeStacks(ctx context.Context, params *DescribeStacksInput, optFns ...func(*Options)) (*DescribeStacksOutput, error)
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.
func (*Client) DescribeType ¶
func (c *Client) DescribeType(ctx context.Context, params *DescribeTypeInput, optFns ...func(*Options)) (*DescribeTypeOutput, error)
Returns detailed information about an extension that has been registered. If you specify a VersionId, DescribeType returns information about that specific extension version. Otherwise, it returns information about the default extension version.
func (*Client) DescribeTypeRegistration ¶
func (c *Client) DescribeTypeRegistration(ctx context.Context, params *DescribeTypeRegistrationInput, optFns ...func(*Options)) (*DescribeTypeRegistrationOutput, error)
Returns information about an extension's registration, including its current status and type and version identifiers. When you initiate a registration request using RegisterType, you can then use DescribeTypeRegistration to monitor the progress of that registration request. Once the registration request has completed, use DescribeType to return detailed information about an extension.
func (*Client) DetectStackDrift ¶
func (c *Client) DetectStackDrift(ctx context.Context, params *DetectStackDriftInput, optFns ...func(*Options)) (*DetectStackDriftOutput, error)
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.
func (*Client) DetectStackResourceDrift ¶
func (c *Client) DetectStackResourceDrift(ctx context.Context, params *DetectStackResourceDriftInput, optFns ...func(*Options)) (*DetectStackResourceDriftOutput, error)
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).
func (*Client) DetectStackSetDrift ¶
func (c *Client) DetectStackSetDrift(ctx context.Context, params *DetectStackSetDriftInput, optFns ...func(*Options)) (*DetectStackSetDriftOutput, error)
Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation Performs Drift Detection on a Stack Set (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html). DetectStackSetDrift returns the OperationId of the stack set drift detection operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection operation. The drift detection operation may take some time, depending on the number of stack instances included in the stack set, as well as the number of resources included in each stack. Once the operation has completed, use the following actions to return drift information:
* Use DescribeStackSet to return detailed information about the stack set, including detailed information about the last completed drift operation performed on the stack set. (Information about drift operations that are in progress is not included.)
* Use ListStackInstances to return a list of stack instances belonging to the stack set, including the drift status and last drift time checked of each instance.
* Use DescribeStackInstance to return detailed information about a specific stack instance, including its drift status and last drift time checked.
For more information on performing a drift detection operation on a stack set, see Detecting Unmanaged Changes in Stack Sets (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html). You can only run a single drift detection operation on a given stack set at one time. To stop a drift detection stack set operation, use StopStackSetOperation.
func (*Client) EstimateTemplateCost ¶
func (c *Client) EstimateTemplateCost(ctx context.Context, params *EstimateTemplateCostInput, optFns ...func(*Options)) (*EstimateTemplateCostOutput, error)
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.
func (*Client) ExecuteChangeSet ¶
func (c *Client) ExecuteChangeSet(ctx context.Context, params *ExecuteChangeSetInput, optFns ...func(*Options)) (*ExecuteChangeSetOutput, error)
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. To create a change set for the entire stack hierachy, IncludeNestedStacks must have been set to True.
func (*Client) GetStackPolicy ¶
func (c *Client) GetStackPolicy(ctx context.Context, params *GetStackPolicyInput, optFns ...func(*Options)) (*GetStackPolicyOutput, error)
Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
func (*Client) GetTemplate ¶
func (c *Client) GetTemplate(ctx context.Context, params *GetTemplateInput, optFns ...func(*Options)) (*GetTemplateOutput, error)
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.
func (*Client) GetTemplateSummary ¶
func (c *Client) GetTemplateSummary(ctx context.Context, params *GetTemplateSummaryInput, optFns ...func(*Options)) (*GetTemplateSummaryOutput, error)
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.
func (*Client) ListChangeSets ¶
func (c *Client) ListChangeSets(ctx context.Context, params *ListChangeSetsInput, optFns ...func(*Options)) (*ListChangeSetsOutput, error)
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.
func (*Client) ListExports ¶
func (c *Client) ListExports(ctx context.Context, params *ListExportsInput, optFns ...func(*Options)) (*ListExportsOutput, error)
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).
func (*Client) ListImports ¶
func (c *Client) ListImports(ctx context.Context, params *ListImportsInput, optFns ...func(*Options)) (*ListImportsOutput, error)
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.
func (*Client) ListStackInstances ¶
func (c *Client) ListStackInstances(ctx context.Context, params *ListStackInstancesInput, optFns ...func(*Options)) (*ListStackInstancesOutput, error)
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, or that have a specific status.
func (*Client) ListStackResources ¶
func (c *Client) ListStackResources(ctx context.Context, params *ListStackResourcesInput, optFns ...func(*Options)) (*ListStackResourcesOutput, error)
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.
func (*Client) ListStackSetOperationResults ¶
func (c *Client) ListStackSetOperationResults(ctx context.Context, params *ListStackSetOperationResultsInput, optFns ...func(*Options)) (*ListStackSetOperationResultsOutput, error)
Returns summary information about the results of a stack set operation.
func (*Client) ListStackSetOperations ¶
func (c *Client) ListStackSetOperations(ctx context.Context, params *ListStackSetOperationsInput, optFns ...func(*Options)) (*ListStackSetOperationsOutput, error)
Returns summary information about operations performed on a stack set.
func (*Client) ListStackSets ¶
func (c *Client) ListStackSets(ctx context.Context, params *ListStackSetsInput, optFns ...func(*Options)) (*ListStackSetsOutput, error)
Returns summary information about stack sets that are associated with the user.
* [Self-managed permissions] If you set the CallAs parameter to SELF while signed in to your AWS account, ListStackSets returns all self-managed stack sets in your AWS account.
* [Service-managed permissions] If you set the CallAs parameter to SELF while signed in to the organization's management account, ListStackSets returns all stack sets in the management account.
* [Service-managed permissions] If you set the CallAs parameter to DELEGATED_ADMIN while signed in to your member account, ListStackSets returns all stack sets with service-managed permissions in the management account.
func (*Client) ListStacks ¶
func (c *Client) ListStacks(ctx context.Context, params *ListStacksInput, optFns ...func(*Options)) (*ListStacksOutput, error)
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).
func (*Client) ListTypeRegistrations ¶
func (c *Client) ListTypeRegistrations(ctx context.Context, params *ListTypeRegistrationsInput, optFns ...func(*Options)) (*ListTypeRegistrationsOutput, error)
Returns a list of registration tokens for the specified extension(s).
func (*Client) ListTypeVersions ¶
func (c *Client) ListTypeVersions(ctx context.Context, params *ListTypeVersionsInput, optFns ...func(*Options)) (*ListTypeVersionsOutput, error)
Returns summary information about the versions of an extension.
func (*Client) ListTypes ¶
func (c *Client) ListTypes(ctx context.Context, params *ListTypesInput, optFns ...func(*Options)) (*ListTypesOutput, error)
Returns summary information about extension that have been registered with CloudFormation.
func (*Client) PublishType ¶
func (c *Client) PublishType(ctx context.Context, params *PublishTypeInput, optFns ...func(*Options)) (*PublishTypeOutput, error)
Publishes the specified extension to the CloudFormation registry as a public extension in this region. Public extensions are available for use by all CloudFormation users. For more information on publishing extensions, see Publishing extensions to make them available for public use (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html) in the CloudFormation CLI User Guide. To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html).
func (*Client) RecordHandlerProgress ¶
func (c *Client) RecordHandlerProgress(ctx context.Context, params *RecordHandlerProgressInput, optFns ...func(*Options)) (*RecordHandlerProgressOutput, error)
Reports progress of a resource handler to CloudFormation. Reserved for use by the CloudFormation CLI (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html). Do not use this API in your code.
func (*Client) RegisterPublisher ¶
func (c *Client) RegisterPublisher(ctx context.Context, params *RegisterPublisherInput, optFns ...func(*Options)) (*RegisterPublisherOutput, error)
Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users. This publisher ID applies to your account in all AWS regions. For information on requirements for registering as a public extension publisher, see Registering your account to publish CloudFormation extensions (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs) in the CloudFormation CLI User Guide.
func (*Client) RegisterType ¶
func (c *Client) RegisterType(ctx context.Context, params *RegisterTypeInput, optFns ...func(*Options)) (*RegisterTypeOutput, error)
Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your AWS account, and includes:
* Validating the extension schema
* Determining which handlers, if any, have been specified for the extension
* Making the extension available for use in your account
For more information on how to develop extensions and ready them for registeration, see Creating Resource Providers (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html) in the CloudFormation CLI User Guide. You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and per region. Use DeregisterType to deregister specific extension versions if necessary. Once you have initiated a registration request using RegisterType, you can use DescribeTypeRegistration to monitor the progress of the registration request. Once you have registered a private extension in your account and region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration) in the CloudFormation User Guide.
func (*Client) SetStackPolicy ¶
func (c *Client) SetStackPolicy(ctx context.Context, params *SetStackPolicyInput, optFns ...func(*Options)) (*SetStackPolicyOutput, error)
Sets a stack policy for a specified stack.
func (*Client) SetTypeConfiguration ¶
func (c *Client) SetTypeConfiguration(ctx context.Context, params *SetTypeConfigurationInput, optFns ...func(*Options)) (*SetTypeConfigurationOutput, error)
Specifies the configuration data for a registered CloudFormation extension, in the given account and region. To view the current configuration data for an extension, refer to the ConfigurationSchema element of DescribeType. For more information, see Configuring extensions at the account level (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration) in the CloudFormation User Guide. It is strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more details on dynamic references, see Using dynamic references to specify template values (https://docs.aws.amazon.com/) in the AWS CloudFormation User Guide.
func (*Client) SetTypeDefaultVersion ¶
func (c *Client) SetTypeDefaultVersion(ctx context.Context, params *SetTypeDefaultVersionInput, optFns ...func(*Options)) (*SetTypeDefaultVersionOutput, error)
Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.
func (*Client) SignalResource ¶
func (c *Client) SignalResource(ctx context.Context, params *SignalResourceInput, optFns ...func(*Options)) (*SignalResourceOutput, error)
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.
func (*Client) StopStackSetOperation ¶
func (c *Client) StopStackSetOperation(ctx context.Context, params *StopStackSetOperationInput, optFns ...func(*Options)) (*StopStackSetOperationOutput, error)
Stops an in-progress operation on a stack set and its associated stack instances.
func (*Client) TestType ¶
func (c *Client) TestType(ctx context.Context, params *TestTypeInput, optFns ...func(*Options)) (*TestTypeOutput, error)
Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.
* For resource types, this includes passing all contracts tests defined for the type.
* For modules, this includes determining if the module's model meets all necessary requirements.
For more information, see Testing your public extension prior to publishing (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-testing) in the CloudFormation CLI User Guide. If you do not specify a version, CloudFormation uses the default version of the extension in your account and region for testing. To perform testing, CloudFormation assumes the execution role specified when the test was registered. For more information, see RegisterType. Once you've initiated testing on an extension using TestType, you can use DescribeType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html) to monitor the current test status and test status description for the extension. An extension must have a test status of PASSED before it can be published. For more information, see Publishing extensions to make them available for public use (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html) in the CloudFormation CLI User Guide.
func (*Client) UpdateStack ¶
func (c *Client) UpdateStack(ctx context.Context, params *UpdateStackInput, optFns ...func(*Options)) (*UpdateStackOutput, error)
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).
func (*Client) UpdateStackInstances ¶
func (c *Client) UpdateStackInstances(ctx context.Context, params *UpdateStackInstancesInput, optFns ...func(*Options)) (*UpdateStackInstancesOutput, error)
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.
func (*Client) UpdateStackSet ¶
func (c *Client) UpdateStackSet(ctx context.Context, params *UpdateStackSetInput, optFns ...func(*Options)) (*UpdateStackSetOutput, error)
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.
func (*Client) UpdateTerminationProtection ¶
func (c *Client) UpdateTerminationProtection(ctx context.Context, params *UpdateTerminationProtectionInput, optFns ...func(*Options)) (*UpdateTerminationProtectionOutput, error)
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.
func (*Client) ValidateTemplate ¶
func (c *Client) ValidateTemplate(ctx context.Context, params *ValidateTemplateInput, optFns ...func(*Options)) (*ValidateTemplateOutput, error)
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.
type ContinueUpdateRollbackInput ¶
type ContinueUpdateRollbackInput struct { // 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). // // This member is required. StackName *string // 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 // 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 // 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 }
The input for the ContinueUpdateRollback action.
type ContinueUpdateRollbackOutput ¶
type ContinueUpdateRollbackOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
The output for a ContinueUpdateRollback action.
type CreateChangeSetInput ¶
type CreateChangeSetInput struct { // 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. // // This member is required. ChangeSetName *string // 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. // // This member is required. StackName *string // 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. 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 []types.Capability // 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 types.ChangeSetType // 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 // A description to help you identify this change set. Description *string // Creates a change set for the all nested stacks specified in the template. The // default behavior of this action is set to False. To include nested sets in a // change set, specify True. IncludeNestedStacks *bool // 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 // A list of Parameter structures that specify input parameters for the change set. // For more information, see the Parameter data type. Parameters []types.Parameter // 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 // The resources to import into your stack. ResourcesToImport []types.ResourceToImport // 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 // The rollback triggers for AWS CloudFormation to monitor during stack creation // and updating operations, and for the specified monitoring period afterwards. RollbackConfiguration *types.RollbackConfiguration // 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 []types.Tag // 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 // 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 or a // Systems Manager document. 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 // Whether to reuse the template that is associated with the stack to create the // change set. UsePreviousTemplate *bool }
The input for the CreateChangeSet action.
type CreateChangeSetOutput ¶
type CreateChangeSetOutput struct { // The Amazon Resource Name (ARN) of the change set. Id *string // The unique ID of the stack. StackId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
The output for the CreateChangeSet action.
type CreateStackInput ¶
type CreateStackInput struct { // 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. // // This member is required. StackName *string // 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. 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 []types.Capability // 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 // 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 // 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 // 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 // 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 types.OnFailure // 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 []types.Parameter // 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 // 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 // The rollback triggers for AWS CloudFormation to monitor during stack creation // and updating operations, and for the specified monitoring period afterwards. RollbackConfiguration *types.RollbackConfiguration // 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 // 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 // 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 []types.Tag // 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 // 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 or a Systems // Manager document. 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 // 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 *int32 }
The input for CreateStack action.
type CreateStackInstancesInput ¶
type CreateStackInstancesInput struct { // The names of one or more Regions where you want to create stack instances using // the specified AWS account(s). // // This member is required. Regions []string // The name or unique ID of the stack set that you want to create stack instances // from. // // This member is required. StackSetName *string // [Self-managed permissions] The names of one or more AWS accounts that you want // to create stack instances in the specified Region(s) for. You can specify // Accounts or DeploymentTargets, but not both. Accounts []string // [Service-managed permissions] Specifies whether you are acting as an account // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. // // * If you are signed in to the // management account, specify SELF. // // * If you are signed in to a delegated // administrator account, specify DELEGATED_ADMIN. Your AWS account must be // registered as a delegated administrator in the management account. For more // information, see Register a delegated administrator // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) // in the AWS CloudFormation User Guide. CallAs types.CallAs // [Service-managed permissions] The AWS Organizations accounts for which to create // stack instances in the specified Regions. You can specify Accounts or // DeploymentTargets, but not both. DeploymentTargets *types.DeploymentTargets // 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 // Preferences for how AWS CloudFormation performs this stack set operation. OperationPreferences *types.StackSetOperationPreferences // 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 []types.Parameter }
type CreateStackInstancesOutput ¶
type CreateStackInstancesOutput struct { // The unique identifier for this stack set operation. OperationId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateStackOutput ¶
type CreateStackOutput struct { // Unique identifier of the stack. StackId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
The output for a CreateStack action.
type CreateStackSetInput ¶
type CreateStackSetInput struct { // 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. // // This member is required. StackSetName *string // 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 // Describes whether StackSets automatically deploys to AWS Organizations accounts // that are added to the target organization or organizational unit (OU). Specify // only if PermissionModel is SERVICE_MANAGED. AutoDeployment *types.AutoDeployment // [Service-managed permissions] Specifies whether you are acting as an account // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. // // * To create a stack set with // service-managed permissions while signed in to the management account, specify // SELF. // // * To create a stack set with service-managed permissions while signed in // to a delegated administrator account, specify DELEGATED_ADMIN. Your AWS account // must be registered as a delegated admin in the management account. For more // information, see Register a delegated administrator // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) // in the AWS CloudFormation User Guide. // // Stack sets with service-managed // permissions are created in the management account, including stack sets that are // created by delegated administrators. CallAs types.CallAs // 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 reference macros. If your stack set // template references one or more macros, you must create the stack set directly // from the processed template, without first reviewing the resulting changes in a // change set. To create the stack set directly, 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 with service-managed permissions do not currently support the use of // macros in 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 for a stack set with service-managed permissions, if you // reference a macro in your template the stack set operation will fail. Capabilities []types.Capability // 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 // A description of the stack set. You can use the description to identify the // stack set's purpose or other important information. Description *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 // The input parameters for the stack set template. Parameters []types.Parameter // Describes how the IAM roles required for stack set operations are created. By // default, SELF-MANAGED is specified. // // * With self-managed permissions, you must // create the administrator and execution roles required to deploy to target // accounts. For more information, see Grant Self-Managed Stack Set Permissions // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html). // // * // With service-managed permissions, StackSets automatically creates the IAM roles // required to deploy to accounts managed by AWS Organizations. For more // information, see Grant Service-Managed Stack Set Permissions // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html). PermissionModel types.PermissionModels // 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 []types.Tag // 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 // 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 // or a Systems Manager document. 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 }
type CreateStackSetOutput ¶
type CreateStackSetOutput struct { // The ID of the stack set that you're creating. StackSetId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeactivateTypeInput ¶
type DeactivateTypeInput struct { // The Amazon Resource Name (ARN) for the extension, in this account and region. // Conditional: You must specify either Arn, or TypeName and Type. Arn *string // The extension type. Conditional: You must specify either Arn, or TypeName and // Type. Type types.ThirdPartyType // The type name of the extension, in this account and region. If you specified a // type name alias when enabling the extension, use the type name alias. // Conditional: You must specify either Arn, or TypeName and Type. TypeName *string }
type DeactivateTypeOutput ¶
type DeactivateTypeOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteChangeSetInput ¶
type DeleteChangeSetInput struct { // The name or Amazon Resource Name (ARN) of the change set that you want to // delete. // // This member is required. ChangeSetName *string // 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 }
The input for the DeleteChangeSet action.
type DeleteChangeSetOutput ¶
type DeleteChangeSetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
The output for the DeleteChangeSet action.
type DeleteStackInput ¶
type DeleteStackInput struct { // The name or the unique stack ID that is associated with the stack. // // This member is required. StackName *string // 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 // 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 // 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 }
The input for DeleteStack action.
type DeleteStackInstancesInput ¶
type DeleteStackInstancesInput struct { // The Regions where you want to delete stack set instances. // // This member is required. Regions []string // 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). // // This member is required. RetainStacks bool // The name or unique ID of the stack set that you want to delete stack instances // for. // // This member is required. StackSetName *string // [Self-managed permissions] The names of the AWS accounts that you want to delete // stack instances for. You can specify Accounts or DeploymentTargets, but not // both. Accounts []string // [Service-managed permissions] Specifies whether you are acting as an account // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. // // * If you are signed in to the // management account, specify SELF. // // * If you are signed in to a delegated // administrator account, specify DELEGATED_ADMIN. Your AWS account must be // registered as a delegated administrator in the management account. For more // information, see Register a delegated administrator // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) // in the AWS CloudFormation User Guide. CallAs types.CallAs // [Service-managed permissions] The AWS Organizations accounts from which to // delete stack instances. You can specify Accounts or DeploymentTargets, but not // both. DeploymentTargets *types.DeploymentTargets // 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 // Preferences for how AWS CloudFormation performs this stack set operation. OperationPreferences *types.StackSetOperationPreferences }
type DeleteStackInstancesOutput ¶
type DeleteStackInstancesOutput struct { // The unique identifier for this stack set operation. OperationId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteStackOutput ¶
type DeleteStackOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
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. // // This member is required. StackSetName *string // [Service-managed permissions] Specifies whether you are acting as an account // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. // // * If you are signed in to the // management account, specify SELF. // // * If you are signed in to a delegated // administrator account, specify DELEGATED_ADMIN. Your AWS account must be // registered as a delegated administrator in the management account. For more // information, see Register a delegated administrator // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) // in the AWS CloudFormation User Guide. CallAs types.CallAs }
type DeleteStackSetOutput ¶
type DeleteStackSetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeregisterTypeInput ¶
type DeregisterTypeInput struct { // The Amazon Resource Name (ARN) of the extension. Conditional: You must specify // either TypeName and Type, or Arn. Arn *string // The kind of extension. Conditional: You must specify either TypeName and Type, // or Arn. Type types.RegistryType // The name of the extension. Conditional: You must specify either TypeName and // Type, or Arn. TypeName *string // The ID of a specific version of the extension. The version ID is the value at // the end of the Amazon Resource Name (ARN) assigned to the extension version when // it is registered. VersionId *string }
type DeregisterTypeOutput ¶
type DeregisterTypeOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeAccountLimitsAPIClient ¶
type DescribeAccountLimitsAPIClient interface { DescribeAccountLimits(context.Context, *DescribeAccountLimitsInput, ...func(*Options)) (*DescribeAccountLimitsOutput, error) }
DescribeAccountLimitsAPIClient is a client that implements the DescribeAccountLimits operation.
type DescribeAccountLimitsInput ¶
type DescribeAccountLimitsInput struct { // A string that identifies the next page of limits that you want to retrieve. NextToken *string }
The input for the DescribeAccountLimits action.
type DescribeAccountLimitsOutput ¶
type DescribeAccountLimitsOutput struct { // An account limit structure that contain a list of AWS CloudFormation account // limits and their values. AccountLimits []types.AccountLimit // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
The output for the DescribeAccountLimits action.
type DescribeAccountLimitsPaginator ¶
type DescribeAccountLimitsPaginator struct {
// contains filtered or unexported fields
}
DescribeAccountLimitsPaginator is a paginator for DescribeAccountLimits
func NewDescribeAccountLimitsPaginator ¶
func NewDescribeAccountLimitsPaginator(client DescribeAccountLimitsAPIClient, params *DescribeAccountLimitsInput, optFns ...func(*DescribeAccountLimitsPaginatorOptions)) *DescribeAccountLimitsPaginator
NewDescribeAccountLimitsPaginator returns a new DescribeAccountLimitsPaginator
func (*DescribeAccountLimitsPaginator) HasMorePages ¶
func (p *DescribeAccountLimitsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeAccountLimitsPaginator) NextPage ¶
func (p *DescribeAccountLimitsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeAccountLimitsOutput, error)
NextPage retrieves the next DescribeAccountLimits page.
type DescribeAccountLimitsPaginatorOptions ¶
type DescribeAccountLimitsPaginatorOptions struct { // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeAccountLimitsPaginatorOptions is the paginator options for DescribeAccountLimits
type DescribeChangeSetInput ¶
type DescribeChangeSetInput struct { // The name or Amazon Resource Name (ARN) of the change set that you want to // describe. // // This member is required. ChangeSetName *string // A string (provided by the DescribeChangeSet response output) that identifies the // next page of information that you want to retrieve. NextToken *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 }
The input for the DescribeChangeSet action.
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 []types.Capability // The ARN of the change set. ChangeSetId *string // The name of the change set. ChangeSetName *string // A list of Change structures that describes the resources AWS CloudFormation // changes if you execute the change set. Changes []types.Change // The start time when the change set was created, in UTC. CreationTime *time.Time // Information about the change set. Description *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 types.ExecutionStatus // Verifies if IncludeNestedStacks is set to True. IncludeNestedStacks *bool // 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 // 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 // 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 []types.Parameter // Specifies the change set ID of the parent change set in the current nested // change set hierarchy. ParentChangeSetId *string // The rollback triggers for AWS CloudFormation to monitor during stack creation // and updating operations, and for the specified monitoring period afterwards. RollbackConfiguration *types.RollbackConfiguration // Specifies the change set ID of the root change set in the current nested change // set hierarchy. RootChangeSetId *string // The ARN of the stack that is associated with the change set. StackId *string // The name of the stack that is associated with the change set. StackName *string // The current status of the change set, such as CREATE_IN_PROGRESS, // CREATE_COMPLETE, or FAILED. Status types.ChangeSetStatus // 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 // If you execute the change set, the tags that will be associated with the stack. Tags []types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
The output for the DescribeChangeSet action.
type DescribePublisherInput ¶
type DescribePublisherInput struct { // The ID of the extension publisher. If you do not supply a PublisherId, and you // have registered as an extension publisher, DescribePublisher returns information // about your own publisher account. PublisherId *string }
type DescribePublisherOutput ¶
type DescribePublisherOutput struct { // The type of account used as the identity provider when registering this // publisher with CloudFormation. IdentityProvider types.IdentityProvider // The ID of the extension publisher. PublisherId *string // The URL to the publisher's profile with the identity provider. PublisherProfile *string // Whether the publisher is verified. Currently, all registered publishers are // verified. PublisherStatus types.PublisherStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeStackDriftDetectionStatusInput ¶
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. // // This member is required. StackDriftDetectionId *string }
type DescribeStackDriftDetectionStatusOutput ¶
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. // // This member is required. DetectionStatus types.StackDriftDetectionStatus // 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. // // This member is required. StackDriftDetectionId *string // The ID of the stack. // // This member is required. StackId *string // Time at which the stack drift detection operation was initiated. // // This member is required. Timestamp *time.Time // The reason the stack drift detection operation has its current status. DetectionStatusReason *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 *int32 // 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 types.StackDriftStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeStackEventsAPIClient ¶
type DescribeStackEventsAPIClient interface { DescribeStackEvents(context.Context, *DescribeStackEventsInput, ...func(*Options)) (*DescribeStackEventsOutput, error) }
DescribeStackEventsAPIClient is a client that implements the DescribeStackEvents operation.
type DescribeStackEventsInput ¶
type DescribeStackEventsInput struct { // A string that identifies the next page of events that you want to retrieve. NextToken *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 }
The input for DescribeStackEvents action.
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 // A list of StackEvents structures. StackEvents []types.StackEvent // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
The output for a DescribeStackEvents action.
type DescribeStackEventsPaginator ¶
type DescribeStackEventsPaginator struct {
// contains filtered or unexported fields
}
DescribeStackEventsPaginator is a paginator for DescribeStackEvents
func NewDescribeStackEventsPaginator ¶
func NewDescribeStackEventsPaginator(client DescribeStackEventsAPIClient, params *DescribeStackEventsInput, optFns ...func(*DescribeStackEventsPaginatorOptions)) *DescribeStackEventsPaginator
NewDescribeStackEventsPaginator returns a new DescribeStackEventsPaginator
func (*DescribeStackEventsPaginator) HasMorePages ¶
func (p *DescribeStackEventsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeStackEventsPaginator) NextPage ¶
func (p *DescribeStackEventsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeStackEventsOutput, error)
NextPage retrieves the next DescribeStackEvents page.
type DescribeStackEventsPaginatorOptions ¶
type DescribeStackEventsPaginatorOptions struct { // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeStackEventsPaginatorOptions is the paginator options for DescribeStackEvents
type DescribeStackInstanceInput ¶
type DescribeStackInstanceInput struct { // The ID of an AWS account that's associated with this stack instance. // // This member is required. StackInstanceAccount *string // The name of a Region that's associated with this stack instance. // // This member is required. StackInstanceRegion *string // The name or the unique stack ID of the stack set that you want to get stack // instance information for. // // This member is required. StackSetName *string // [Service-managed permissions] Specifies whether you are acting as an account // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. // // * If you are signed in to the // management account, specify SELF. // // * If you are signed in to a delegated // administrator account, specify DELEGATED_ADMIN. Your AWS account must be // registered as a delegated administrator in the management account. For more // information, see Register a delegated administrator // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) // in the AWS CloudFormation User Guide. CallAs types.CallAs }
type DescribeStackInstanceOutput ¶
type DescribeStackInstanceOutput struct { // The stack instance that matches the specified request parameters. StackInstance *types.StackInstance // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeStackResourceDriftsAPIClient ¶
type DescribeStackResourceDriftsAPIClient interface { DescribeStackResourceDrifts(context.Context, *DescribeStackResourceDriftsInput, ...func(*Options)) (*DescribeStackResourceDriftsOutput, error) }
DescribeStackResourceDriftsAPIClient is a client that implements the DescribeStackResourceDrifts operation.
type DescribeStackResourceDriftsInput ¶
type DescribeStackResourceDriftsInput struct { // The name of the stack for which you want drift information. // // This member is required. StackName *string // 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 *int32 // A string that identifies the next page of stack resource drift results. NextToken *string // 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 []types.StackResourceDriftStatus }
type DescribeStackResourceDriftsOutput ¶
type DescribeStackResourceDriftsOutput struct { // 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). // // This member is required. StackResourceDrifts []types.StackResourceDrift // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeStackResourceDriftsPaginator ¶
type DescribeStackResourceDriftsPaginator struct {
// contains filtered or unexported fields
}
DescribeStackResourceDriftsPaginator is a paginator for DescribeStackResourceDrifts
func NewDescribeStackResourceDriftsPaginator ¶
func NewDescribeStackResourceDriftsPaginator(client DescribeStackResourceDriftsAPIClient, params *DescribeStackResourceDriftsInput, optFns ...func(*DescribeStackResourceDriftsPaginatorOptions)) *DescribeStackResourceDriftsPaginator
NewDescribeStackResourceDriftsPaginator returns a new DescribeStackResourceDriftsPaginator
func (*DescribeStackResourceDriftsPaginator) HasMorePages ¶
func (p *DescribeStackResourceDriftsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeStackResourceDriftsPaginator) NextPage ¶
func (p *DescribeStackResourceDriftsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeStackResourceDriftsOutput, error)
NextPage retrieves the next DescribeStackResourceDrifts page.
type DescribeStackResourceDriftsPaginatorOptions ¶
type DescribeStackResourceDriftsPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeStackResourceDriftsPaginatorOptions is the paginator options for DescribeStackResourceDrifts
type DescribeStackResourceInput ¶
type DescribeStackResourceInput struct { // The logical name of the resource as specified in the template. Default: There is // no default value. // // This member is required. LogicalResourceId *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. // // This member is required. StackName *string }
The input for DescribeStackResource action.
type DescribeStackResourceOutput ¶
type DescribeStackResourceOutput struct { // A StackResourceDetail structure containing the description of the specified // resource in the specified stack. StackResourceDetail *types.StackResourceDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
The output for a DescribeStackResource action.
type DescribeStackResourcesInput ¶
type DescribeStackResourcesInput struct { // The logical name of the resource as specified in the template. Default: There is // no default value. LogicalResourceId *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 // 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 }
The input for DescribeStackResources action.
type DescribeStackResourcesOutput ¶
type DescribeStackResourcesOutput struct { // A list of StackResource structures. StackResources []types.StackResource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
The output for a DescribeStackResources action.
type DescribeStackSetInput ¶
type DescribeStackSetInput struct { // The name or unique ID of the stack set whose description you want. // // This member is required. StackSetName *string // [Service-managed permissions] Specifies whether you are acting as an account // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. // // * If you are signed in to the // management account, specify SELF. // // * If you are signed in to a delegated // administrator account, specify DELEGATED_ADMIN. Your AWS account must be // registered as a delegated administrator in the management account. For more // information, see Register a delegated administrator // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) // in the AWS CloudFormation User Guide. CallAs types.CallAs }
type DescribeStackSetOperationInput ¶
type DescribeStackSetOperationInput struct { // The unique ID of the stack set operation. // // This member is required. OperationId *string // The name or the unique stack ID of the stack set for the stack operation. // // This member is required. StackSetName *string // [Service-managed permissions] Specifies whether you are acting as an account // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. // // * If you are signed in to the // management account, specify SELF. // // * If you are signed in to a delegated // administrator account, specify DELEGATED_ADMIN. Your AWS account must be // registered as a delegated administrator in the management account. For more // information, see Register a delegated administrator // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) // in the AWS CloudFormation User Guide. CallAs types.CallAs }
type DescribeStackSetOperationOutput ¶
type DescribeStackSetOperationOutput struct { // The specified stack set operation. StackSetOperation *types.StackSetOperation // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeStackSetOutput ¶
type DescribeStackSetOutput struct { // The specified stack set. StackSet *types.StackSet // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeStacksAPIClient ¶
type DescribeStacksAPIClient interface { DescribeStacks(context.Context, *DescribeStacksInput, ...func(*Options)) (*DescribeStacksOutput, error) }
DescribeStacksAPIClient is a client that implements the DescribeStacks operation.
type DescribeStacksInput ¶
type DescribeStacksInput struct { // A string that identifies the next page of stacks that you want to retrieve. NextToken *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 }
The input for DescribeStacks action.
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 // A list of stack structures. Stacks []types.Stack // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
The output for a DescribeStacks action.
type DescribeStacksPaginator ¶
type DescribeStacksPaginator struct {
// contains filtered or unexported fields
}
DescribeStacksPaginator is a paginator for DescribeStacks
func NewDescribeStacksPaginator ¶
func NewDescribeStacksPaginator(client DescribeStacksAPIClient, params *DescribeStacksInput, optFns ...func(*DescribeStacksPaginatorOptions)) *DescribeStacksPaginator
NewDescribeStacksPaginator returns a new DescribeStacksPaginator
func (*DescribeStacksPaginator) HasMorePages ¶
func (p *DescribeStacksPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeStacksPaginator) NextPage ¶
func (p *DescribeStacksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeStacksOutput, error)
NextPage retrieves the next DescribeStacks page.
type DescribeStacksPaginatorOptions ¶
type DescribeStacksPaginatorOptions struct { // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeStacksPaginatorOptions is the paginator options for DescribeStacks
type DescribeTypeInput ¶
type DescribeTypeInput struct { // The Amazon Resource Name (ARN) of the extension. Conditional: You must specify // either TypeName and Type, or Arn. Arn *string // The version number of a public third-party extension. PublicVersionNumber *string // The publisher ID of the extension publisher. Extensions provided by Amazon are // not assigned a publisher ID. PublisherId *string // The kind of extension. Conditional: You must specify either TypeName and Type, // or Arn. Type types.RegistryType // The name of the extension. Conditional: You must specify either TypeName and // Type, or Arn. TypeName *string // The ID of a specific version of the extension. The version ID is the value at // the end of the Amazon Resource Name (ARN) assigned to the extension version when // it is registered. If you specify a VersionId, DescribeType returns information // about that specific extension version. Otherwise, it returns information about // the default extension version. VersionId *string }
type DescribeTypeOutput ¶
type DescribeTypeOutput struct { // The Amazon Resource Name (ARN) of the extension. Arn *string // Whether CloudFormation automatically updates the extension in this account and // region when a new minor version is published by the extension publisher. Major // versions released by the publisher must be manually updated. For more // information, see Activating public extensions for use in your account in the AWS // CloudFormation User Guide. AutoUpdate *bool // A JSON string that represent the current configuration data for the extension in // this account and region. To set the configuration data for an extension, use // SetTypeConfiguration // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html). // For more information, see Configuring extensions at the account level // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration) // in the CloudFormation User Guide. ConfigurationSchema *string // The ID of the default version of the extension. The default version is used when // the extension version is not specified. This applies only to private extensions // you have registered in your account. For public extensions, both those provided // by Amazon and published by third parties, CloudFormation returns null. For more // information, see RegisterType // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html). // To set the default version of an extension, use SetTypeDefaultVersion. DefaultVersionId *string // The deprecation status of the extension version. Valid values include: // // * LIVE: // The extension is activated or registered and can be used in CloudFormation // operations, dependent on its provisioning behavior and visibility scope. // // * // DEPRECATED: The extension has been deactivated or deregistered and can no longer // be used in CloudFormation operations. // // For public third-party extensions, // CloudFormation returns null. DeprecatedStatus types.DeprecatedStatus // The description of the extension. Description *string // The URL of a page providing detailed documentation for this extension. DocumentationUrl *string // The Amazon Resource Name (ARN) of the IAM execution role used to register the // extension. This applies only to private extensions you have registered in your // account. For more information, see RegisterType // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html). // If the registered extension calls any AWS APIs, you must create an IAM execution // role (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) that // includes the necessary permissions to call those AWS APIs, and provision that // execution role in your account. CloudFormation then assumes that execution role // to provide your extension with the appropriate credentials. ExecutionRoleArn *string // Whether or not the extension is activated in the account and region. This only // applies to public third-party extensions. For all other extensions, // CloudFormation returns null. IsActivated *bool // Whether the specified extension version is set as the default version. This // applies only to private extensions you have registered in your account, and // extensions published by Amazon. For public third-party extensions, whether or // not they are activated in your account, CloudFormation returns null. IsDefaultVersion *bool // When the specified extension version was registered. This applies only to: // // * // Private extensions you have registered in your account. For more information, // see RegisterType // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html). // // * // Public extensions you have activated in your account with auto-update specified. // For more information, see ActivateType // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html). LastUpdated *time.Time // The latest version of a public extension that is available for use. This only // applies if you specify a public extension, and you do not specify a version. For // all other requests, CloudFormation returns null. LatestPublicVersion *string // Contains logging configuration information for private extensions. This applies // only to private extensions you have registered in your account. For public // extensions, both those provided by Amazon and published by third parties, // CloudFormation returns null. For more information, see RegisterType // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html). LoggingConfig *types.LoggingConfig // For public extensions that have been activated for this account and region, the // Amazon Resource Name (ARN) of the public extension. OriginalTypeArn *string // For public extensions that have been activated for this account and region, the // type name of the public extension. If you specified a TypeNameAlias when // enabling the extension in this account and region, CloudFormation treats that // alias as the extension's type name within the account and region, not the type // name of the public extension. For more information, see Specifying aliases to // refer to extensions // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias) // in the CloudFormation User Guide. OriginalTypeName *string // For resource type extensions, the provisioning behavior of the resource type. // AWS CloudFormation determines the provisioning type during registration, based // on the types of handlers in the schema handler package submitted. Valid values // include: // // * FULLY_MUTABLE: The resource type includes an update handler to // process updates to the type during stack update operations. // // * IMMUTABLE: The // resource type does not include an update handler, so the type cannot be updated // and must instead be replaced during stack update operations. // // * // NON_PROVISIONABLE: The resource type does not include all of the following // handlers, and therefore cannot actually be provisioned. // // * create // // * read // // * // delete ProvisioningType types.ProvisioningType // The version number of a public third-party extension. This applies only if you // specify a public extension you have activated in your account, or specify a // public extension without specifying a version. For all other extensions, // CloudFormation returns null. PublicVersionNumber *string // The publisher ID of the extension publisher. This applies only to public // third-party extensions. For private registered extensions, and extensions // provided by Amazon, CloudFormation returns null. PublisherId *string // For extensions that are modules, the public third-party extensions that must be // activated in your account in order for the module itself to be activated. RequiredActivatedTypes []types.RequiredActivatedType // The schema that defines the extension. For more information on extension // schemas, see Resource Provider Schema // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html) // in the CloudFormation CLI User Guide. Schema *string // The URL of the source code for the extension. SourceUrl *string // When the specified private extension version was registered or activated in your // account. TimeCreated *time.Time // The kind of extension. Type types.RegistryType // The name of the extension. If the extension is a public third-party type you // have activated with a type name alias, CloudFormation returns the type name // alias. For more information, see ActivateType // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html). TypeName *string // The contract test status of the registered extension version. To return the // extension test status of a specifc extension version, you must specify // VersionId. This applies only to registered private extension versions. // CloudFormation does not return this information for public extensions, whether // or not they are activated in your account. // // * PASSED: The extension has passed // all its contract tests. An extension must have a test status of PASSED before it // can be published. For more information, see Publishing extensions to make them // available for public use // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html) // in the CloudFormation Command Line Interface User Guide. // // * FAILED: The // extension has failed one or more contract tests. // // * IN_PROGRESS: Contract tests // are currently being performed on the extension. // // * NOT_TESTED: Contract tests // have not been performed on the extension. TypeTestsStatus types.TypeTestsStatus // The description of the test status. To return the extension test status of a // specifc extension version, you must specify VersionId. This applies only to // registered private extension versions. CloudFormation does not return this // information for public extensions, whether or not they are activated in your // account. TypeTestsStatusDescription *string // The scope at which the extension is visible and usable in CloudFormation // operations. Valid values include: // // * PRIVATE: The extension is only visible and // usable within the account in which it is registered. AWS CloudFormation marks // any extensions you register as PRIVATE. // // * PUBLIC: The extension is publically // visible and usable within any Amazon account. Visibility types.Visibility // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeTypeRegistrationAPIClient ¶
type DescribeTypeRegistrationAPIClient interface { DescribeTypeRegistration(context.Context, *DescribeTypeRegistrationInput, ...func(*Options)) (*DescribeTypeRegistrationOutput, error) }
DescribeTypeRegistrationAPIClient is a client that implements the DescribeTypeRegistration operation.
type DescribeTypeRegistrationInput ¶
type DescribeTypeRegistrationInput struct { // The identifier for this registration request. This registration token is // generated by CloudFormation when you initiate a registration request using // RegisterType. // // This member is required. RegistrationToken *string }
type DescribeTypeRegistrationOutput ¶
type DescribeTypeRegistrationOutput struct { // The description of the extension registration request. Description *string // The current status of the extension registration request. ProgressStatus types.RegistrationStatus // The Amazon Resource Name (ARN) of the extension being registered. For // registration requests with a ProgressStatus of other than COMPLETE, this will be // null. TypeArn *string // The Amazon Resource Name (ARN) of this specific version of the extension being // registered. For registration requests with a ProgressStatus of other than // COMPLETE, this will be null. TypeVersionArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DetectStackDriftInput ¶
type DetectStackDriftInput struct { // The name of the stack for which you want to detect drift. // // This member is required. StackName *string // The logical names of any resources you want to use as filters. LogicalResourceIds []string }
type DetectStackDriftOutput ¶
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. // // This member is required. StackDriftDetectionId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DetectStackResourceDriftInput ¶
type DetectStackResourceDriftInput struct { // The logical name of the resource for which to return drift information. // // This member is required. LogicalResourceId *string // The name of the stack to which the resource belongs. // // This member is required. StackName *string }
type DetectStackResourceDriftOutput ¶
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. // // This member is required. StackResourceDrift *types.StackResourceDrift // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DetectStackSetDriftInput ¶
type DetectStackSetDriftInput struct { // The name of the stack set on which to perform the drift detection operation. // // This member is required. StackSetName *string // [Service-managed permissions] Specifies whether you are acting as an account // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. // // * If you are signed in to the // management account, specify SELF. // // * If you are signed in to a delegated // administrator account, specify DELEGATED_ADMIN. Your AWS account must be // registered as a delegated administrator in the management account. For more // information, see Register a delegated administrator // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) // in the AWS CloudFormation User Guide. CallAs types.CallAs // The ID of the stack set operation. OperationId *string // 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). OperationPreferences *types.StackSetOperationPreferences }
type DetectStackSetDriftOutput ¶
type DetectStackSetDriftOutput struct { // The ID of the drift detection stack set operation. you can use this operation id // with DescribeStackSetOperation to monitor the progress of the drift detection // operation. OperationId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type EndpointResolver ¶
type EndpointResolver interface { ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error) }
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type EstimateTemplateCostInput ¶
type EstimateTemplateCostInput struct { // A list of Parameter structures that specify input parameters. Parameters []types.Parameter // 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 // Location of file containing the template body. The URL must point to a template // that is located in an Amazon S3 bucket or a Systems Manager document. 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 }
The input for an EstimateTemplateCost action.
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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
The output for a EstimateTemplateCost action.
type ExecuteChangeSetInput ¶
type ExecuteChangeSetInput struct { // The name or ARN of the change set that you want use to update the specified // stack. // // This member is required. ChangeSetName *string // 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 // 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 }
The input for the ExecuteChangeSet action.
type ExecuteChangeSetOutput ¶
type ExecuteChangeSetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
The output for the ExecuteChangeSet action.
type GetStackPolicyInput ¶
type GetStackPolicyInput struct { // The name or unique stack ID that is associated with the stack whose policy you // want to get. // // This member is required. StackName *string }
The input for the GetStackPolicy action.
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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
The output for the GetStackPolicy action.
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 // 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 // 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 Processed. TemplateStage types.TemplateStage }
The input for a GetTemplate action.
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 []types.TemplateStage // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
The output for GetTemplate action.
type GetTemplateSummaryInput ¶
type GetTemplateSummaryInput struct { // [Service-managed permissions] Specifies whether you are acting as an account // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. // // * If you are signed in to the // management account, specify SELF. // // * If you are signed in to a delegated // administrator account, specify DELEGATED_ADMIN. Your AWS account must be // registered as a delegated administrator in the management account. For more // information, see Register a delegated administrator // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) // in the AWS CloudFormation User Guide. CallAs types.CallAs // 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 // 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 // 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 // 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 or a Systems // Manager document. 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 }
The input for the GetTemplateSummary action.
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 []types.Capability // The list of resources that generated the values in the Capabilities response // element. CapabilitiesReason *string // A list of the transforms that are declared in the template. DeclaredTransforms []string // The value that is defined in the Description property of the template. Description *string // The value that is defined for the Metadata property of the template. Metadata *string // A list of parameter declarations that describe various properties for each // parameter. Parameters []types.ParameterDeclaration // 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 []types.ResourceIdentifierSummary // 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 // The AWS template format version, which identifies the capabilities of the // template. Version *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
The output for the GetTemplateSummary action.
type HTTPClient ¶
type HTTPSignerV4 ¶
type HTTPSignerV4 interface { SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error }
type IdempotencyTokenProvider ¶
IdempotencyTokenProvider interface for providing idempotency token
type ListChangeSetsAPIClient ¶
type ListChangeSetsAPIClient interface { ListChangeSets(context.Context, *ListChangeSetsInput, ...func(*Options)) (*ListChangeSetsOutput, error) }
ListChangeSetsAPIClient is a client that implements the ListChangeSets operation.
type ListChangeSetsInput ¶
type ListChangeSetsInput struct { // The name or the Amazon Resource Name (ARN) of the stack for which you want to // list change sets. // // This member is required. StackName *string // A string (provided by the ListChangeSets response output) that identifies the // next page of change sets that you want to retrieve. NextToken *string }
The input for the ListChangeSets action.
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 // A list of ChangeSetSummary structures that provides the ID and status of each // change set for the specified stack. Summaries []types.ChangeSetSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
The output for the ListChangeSets action.
type ListChangeSetsPaginator ¶
type ListChangeSetsPaginator struct {
// contains filtered or unexported fields
}
ListChangeSetsPaginator is a paginator for ListChangeSets
func NewListChangeSetsPaginator ¶
func NewListChangeSetsPaginator(client ListChangeSetsAPIClient, params *ListChangeSetsInput, optFns ...func(*ListChangeSetsPaginatorOptions)) *ListChangeSetsPaginator
NewListChangeSetsPaginator returns a new ListChangeSetsPaginator
func (*ListChangeSetsPaginator) HasMorePages ¶
func (p *ListChangeSetsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListChangeSetsPaginator) NextPage ¶
func (p *ListChangeSetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListChangeSetsOutput, error)
NextPage retrieves the next ListChangeSets page.
type ListChangeSetsPaginatorOptions ¶
type ListChangeSetsPaginatorOptions struct { // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListChangeSetsPaginatorOptions is the paginator options for ListChangeSets
type ListExportsAPIClient ¶
type ListExportsAPIClient interface { ListExports(context.Context, *ListExportsInput, ...func(*Options)) (*ListExportsOutput, error) }
ListExportsAPIClient is a client that implements the ListExports operation.
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 }
type ListExportsOutput ¶
type ListExportsOutput struct { // The output for the ListExports action. Exports []types.Export // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListExportsPaginator ¶
type ListExportsPaginator struct {
// contains filtered or unexported fields
}
ListExportsPaginator is a paginator for ListExports
func NewListExportsPaginator ¶
func NewListExportsPaginator(client ListExportsAPIClient, params *ListExportsInput, optFns ...func(*ListExportsPaginatorOptions)) *ListExportsPaginator
NewListExportsPaginator returns a new ListExportsPaginator
func (*ListExportsPaginator) HasMorePages ¶
func (p *ListExportsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListExportsPaginator) NextPage ¶
func (p *ListExportsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListExportsOutput, error)
NextPage retrieves the next ListExports page.
type ListExportsPaginatorOptions ¶
type ListExportsPaginatorOptions struct { // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListExportsPaginatorOptions is the paginator options for ListExports
type ListImportsAPIClient ¶
type ListImportsAPIClient interface { ListImports(context.Context, *ListImportsInput, ...func(*Options)) (*ListImportsOutput, error) }
ListImportsAPIClient is a client that implements the ListImports operation.
type ListImportsInput ¶
type ListImportsInput struct { // The name of the exported output value. AWS CloudFormation returns the stack // names that are importing this value. // // This member is required. ExportName *string // 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 }
type ListImportsOutput ¶
type ListImportsOutput struct { // A list of stack names that are importing the specified exported output value. Imports []string // A string that identifies the next page of exports. If there is no additional // page, this value is null. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListImportsPaginator ¶
type ListImportsPaginator struct {
// contains filtered or unexported fields
}
ListImportsPaginator is a paginator for ListImports
func NewListImportsPaginator ¶
func NewListImportsPaginator(client ListImportsAPIClient, params *ListImportsInput, optFns ...func(*ListImportsPaginatorOptions)) *ListImportsPaginator
NewListImportsPaginator returns a new ListImportsPaginator
func (*ListImportsPaginator) HasMorePages ¶
func (p *ListImportsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListImportsPaginator) NextPage ¶
func (p *ListImportsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListImportsOutput, error)
NextPage retrieves the next ListImports page.
type ListImportsPaginatorOptions ¶
type ListImportsPaginatorOptions struct { // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListImportsPaginatorOptions is the paginator options for ListImports
type ListStackInstancesAPIClient ¶
type ListStackInstancesAPIClient interface { ListStackInstances(context.Context, *ListStackInstancesInput, ...func(*Options)) (*ListStackInstancesOutput, error) }
ListStackInstancesAPIClient is a client that implements the ListStackInstances operation.
type ListStackInstancesInput ¶
type ListStackInstancesInput struct { // The name or unique ID of the stack set that you want to list stack instances // for. // // This member is required. StackSetName *string // [Service-managed permissions] Specifies whether you are acting as an account // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. // // * If you are signed in to the // management account, specify SELF. // // * If you are signed in to a delegated // administrator account, specify DELEGATED_ADMIN. Your AWS account must be // registered as a delegated administrator in the management account. For more // information, see Register a delegated administrator // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) // in the AWS CloudFormation User Guide. CallAs types.CallAs // The status that stack instances are filtered by. Filters []types.StackInstanceFilter // 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 *int32 // 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 // The name of the AWS account that you want to list stack instances for. StackInstanceAccount *string // The name of the Region where you want to list stack instances. StackInstanceRegion *string }
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 // A list of StackInstanceSummary structures that contain information about the // specified stack instances. Summaries []types.StackInstanceSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListStackInstancesPaginator ¶
type ListStackInstancesPaginator struct {
// contains filtered or unexported fields
}
ListStackInstancesPaginator is a paginator for ListStackInstances
func NewListStackInstancesPaginator ¶
func NewListStackInstancesPaginator(client ListStackInstancesAPIClient, params *ListStackInstancesInput, optFns ...func(*ListStackInstancesPaginatorOptions)) *ListStackInstancesPaginator
NewListStackInstancesPaginator returns a new ListStackInstancesPaginator
func (*ListStackInstancesPaginator) HasMorePages ¶
func (p *ListStackInstancesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListStackInstancesPaginator) NextPage ¶
func (p *ListStackInstancesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStackInstancesOutput, error)
NextPage retrieves the next ListStackInstances page.
type ListStackInstancesPaginatorOptions ¶
type ListStackInstancesPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListStackInstancesPaginatorOptions is the paginator options for ListStackInstances
type ListStackResourcesAPIClient ¶
type ListStackResourcesAPIClient interface { ListStackResources(context.Context, *ListStackResourcesInput, ...func(*Options)) (*ListStackResourcesOutput, error) }
ListStackResourcesAPIClient is a client that implements the ListStackResources operation.
type ListStackResourcesInput ¶
type ListStackResourcesInput struct { // 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. // // This member is required. StackName *string // A string that identifies the next page of stack resources that you want to // retrieve. NextToken *string }
The input for the ListStackResource action.
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 // A list of StackResourceSummary structures. StackResourceSummaries []types.StackResourceSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
The output for a ListStackResources action.
type ListStackResourcesPaginator ¶
type ListStackResourcesPaginator struct {
// contains filtered or unexported fields
}
ListStackResourcesPaginator is a paginator for ListStackResources
func NewListStackResourcesPaginator ¶
func NewListStackResourcesPaginator(client ListStackResourcesAPIClient, params *ListStackResourcesInput, optFns ...func(*ListStackResourcesPaginatorOptions)) *ListStackResourcesPaginator
NewListStackResourcesPaginator returns a new ListStackResourcesPaginator
func (*ListStackResourcesPaginator) HasMorePages ¶
func (p *ListStackResourcesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListStackResourcesPaginator) NextPage ¶
func (p *ListStackResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStackResourcesOutput, error)
NextPage retrieves the next ListStackResources page.
type ListStackResourcesPaginatorOptions ¶
type ListStackResourcesPaginatorOptions struct { // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListStackResourcesPaginatorOptions is the paginator options for ListStackResources
type ListStackSetOperationResultsAPIClient ¶
type ListStackSetOperationResultsAPIClient interface { ListStackSetOperationResults(context.Context, *ListStackSetOperationResultsInput, ...func(*Options)) (*ListStackSetOperationResultsOutput, error) }
ListStackSetOperationResultsAPIClient is a client that implements the ListStackSetOperationResults operation.
type ListStackSetOperationResultsInput ¶
type ListStackSetOperationResultsInput struct { // The ID of the stack set operation. // // This member is required. OperationId *string // The name or unique ID of the stack set that you want to get operation results // for. // // This member is required. StackSetName *string // [Service-managed permissions] Specifies whether you are acting as an account // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. // // * If you are signed in to the // management account, specify SELF. // // * If you are signed in to a delegated // administrator account, specify DELEGATED_ADMIN. Your AWS account must be // registered as a delegated administrator in the management account. For more // information, see Register a delegated administrator // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) // in the AWS CloudFormation User Guide. CallAs types.CallAs // 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 *int32 // 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 }
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 // A list of StackSetOperationResultSummary structures that contain information // about the specified operation results, for accounts and Regions that are // included in the operation. Summaries []types.StackSetOperationResultSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListStackSetOperationResultsPaginator ¶
type ListStackSetOperationResultsPaginator struct {
// contains filtered or unexported fields
}
ListStackSetOperationResultsPaginator is a paginator for ListStackSetOperationResults
func NewListStackSetOperationResultsPaginator ¶
func NewListStackSetOperationResultsPaginator(client ListStackSetOperationResultsAPIClient, params *ListStackSetOperationResultsInput, optFns ...func(*ListStackSetOperationResultsPaginatorOptions)) *ListStackSetOperationResultsPaginator
NewListStackSetOperationResultsPaginator returns a new ListStackSetOperationResultsPaginator
func (*ListStackSetOperationResultsPaginator) HasMorePages ¶
func (p *ListStackSetOperationResultsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListStackSetOperationResultsPaginator) NextPage ¶
func (p *ListStackSetOperationResultsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStackSetOperationResultsOutput, error)
NextPage retrieves the next ListStackSetOperationResults page.
type ListStackSetOperationResultsPaginatorOptions ¶
type ListStackSetOperationResultsPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListStackSetOperationResultsPaginatorOptions is the paginator options for ListStackSetOperationResults
type ListStackSetOperationsAPIClient ¶
type ListStackSetOperationsAPIClient interface { ListStackSetOperations(context.Context, *ListStackSetOperationsInput, ...func(*Options)) (*ListStackSetOperationsOutput, error) }
ListStackSetOperationsAPIClient is a client that implements the ListStackSetOperations operation.
type ListStackSetOperationsInput ¶
type ListStackSetOperationsInput struct { // The name or unique ID of the stack set that you want to get operation summaries // for. // // This member is required. StackSetName *string // [Service-managed permissions] Specifies whether you are acting as an account // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. // // * If you are signed in to the // management account, specify SELF. // // * If you are signed in to a delegated // administrator account, specify DELEGATED_ADMIN. Your AWS account must be // registered as a delegated administrator in the management account. For more // information, see Register a delegated administrator // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) // in the AWS CloudFormation User Guide. CallAs types.CallAs // 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 *int32 // 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 }
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 // A list of StackSetOperationSummary structures that contain summary information // about operations for the specified stack set. Summaries []types.StackSetOperationSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListStackSetOperationsPaginator ¶
type ListStackSetOperationsPaginator struct {
// contains filtered or unexported fields
}
ListStackSetOperationsPaginator is a paginator for ListStackSetOperations
func NewListStackSetOperationsPaginator ¶
func NewListStackSetOperationsPaginator(client ListStackSetOperationsAPIClient, params *ListStackSetOperationsInput, optFns ...func(*ListStackSetOperationsPaginatorOptions)) *ListStackSetOperationsPaginator
NewListStackSetOperationsPaginator returns a new ListStackSetOperationsPaginator
func (*ListStackSetOperationsPaginator) HasMorePages ¶
func (p *ListStackSetOperationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListStackSetOperationsPaginator) NextPage ¶
func (p *ListStackSetOperationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStackSetOperationsOutput, error)
NextPage retrieves the next ListStackSetOperations page.
type ListStackSetOperationsPaginatorOptions ¶
type ListStackSetOperationsPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListStackSetOperationsPaginatorOptions is the paginator options for ListStackSetOperations
type ListStackSetsAPIClient ¶
type ListStackSetsAPIClient interface { ListStackSets(context.Context, *ListStackSetsInput, ...func(*Options)) (*ListStackSetsOutput, error) }
ListStackSetsAPIClient is a client that implements the ListStackSets operation.
type ListStackSetsInput ¶
type ListStackSetsInput struct { // [Service-managed permissions] Specifies whether you are acting as an account // administrator in the management account or as a delegated administrator in a // member account. By default, SELF is specified. Use SELF for stack sets with // self-managed permissions. // // * If you are signed in to the management account, // specify SELF. // // * If you are signed in to a delegated administrator account, // specify DELEGATED_ADMIN. Your AWS account must be registered as a delegated // administrator in the management account. For more information, see Register a // delegated administrator // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) // in the AWS CloudFormation User Guide. CallAs types.CallAs // 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 *int32 // 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 // The status of the stack sets that you want to get summary information about. Status types.StackSetStatus }
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 // A list of StackSetSummary structures that contain information about the user's // stack sets. Summaries []types.StackSetSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListStackSetsPaginator ¶
type ListStackSetsPaginator struct {
// contains filtered or unexported fields
}
ListStackSetsPaginator is a paginator for ListStackSets
func NewListStackSetsPaginator ¶
func NewListStackSetsPaginator(client ListStackSetsAPIClient, params *ListStackSetsInput, optFns ...func(*ListStackSetsPaginatorOptions)) *ListStackSetsPaginator
NewListStackSetsPaginator returns a new ListStackSetsPaginator
func (*ListStackSetsPaginator) HasMorePages ¶
func (p *ListStackSetsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListStackSetsPaginator) NextPage ¶
func (p *ListStackSetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStackSetsOutput, error)
NextPage retrieves the next ListStackSets page.
type ListStackSetsPaginatorOptions ¶
type ListStackSetsPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListStackSetsPaginatorOptions is the paginator options for ListStackSets
type ListStacksAPIClient ¶
type ListStacksAPIClient interface { ListStacks(context.Context, *ListStacksInput, ...func(*Options)) (*ListStacksOutput, error) }
ListStacksAPIClient is a client that implements the ListStacks operation.
type ListStacksInput ¶
type ListStacksInput struct { // A string that identifies the next page of stacks that you want to retrieve. NextToken *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 []types.StackStatus }
The input for ListStacks action.
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 // A list of StackSummary structures containing information about the specified // stacks. StackSummaries []types.StackSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
The output for ListStacks action.
type ListStacksPaginator ¶
type ListStacksPaginator struct {
// contains filtered or unexported fields
}
ListStacksPaginator is a paginator for ListStacks
func NewListStacksPaginator ¶
func NewListStacksPaginator(client ListStacksAPIClient, params *ListStacksInput, optFns ...func(*ListStacksPaginatorOptions)) *ListStacksPaginator
NewListStacksPaginator returns a new ListStacksPaginator
func (*ListStacksPaginator) HasMorePages ¶
func (p *ListStacksPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListStacksPaginator) NextPage ¶
func (p *ListStacksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStacksOutput, error)
NextPage retrieves the next ListStacks page.
type ListStacksPaginatorOptions ¶
type ListStacksPaginatorOptions struct { // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListStacksPaginatorOptions is the paginator options for ListStacks
type ListTypeRegistrationsAPIClient ¶
type ListTypeRegistrationsAPIClient interface { ListTypeRegistrations(context.Context, *ListTypeRegistrationsInput, ...func(*Options)) (*ListTypeRegistrationsOutput, error) }
ListTypeRegistrationsAPIClient is a client that implements the ListTypeRegistrations operation.
type ListTypeRegistrationsInput ¶
type ListTypeRegistrationsInput 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 *int32 // 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 this action 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 // The current status of the extension registration request. The default is // IN_PROGRESS. RegistrationStatusFilter types.RegistrationStatus // The kind of extension. Conditional: You must specify either TypeName and Type, // or Arn. Type types.RegistryType // The Amazon Resource Name (ARN) of the extension. Conditional: You must specify // either TypeName and Type, or Arn. TypeArn *string // The name of the extension. Conditional: You must specify either TypeName and // Type, or Arn. TypeName *string }
type ListTypeRegistrationsOutput ¶
type ListTypeRegistrationsOutput 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 this action 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 // A list of extension registration tokens. Use DescribeTypeRegistration to return // detailed information about a type registration request. RegistrationTokenList []string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListTypeRegistrationsPaginator ¶
type ListTypeRegistrationsPaginator struct {
// contains filtered or unexported fields
}
ListTypeRegistrationsPaginator is a paginator for ListTypeRegistrations
func NewListTypeRegistrationsPaginator ¶
func NewListTypeRegistrationsPaginator(client ListTypeRegistrationsAPIClient, params *ListTypeRegistrationsInput, optFns ...func(*ListTypeRegistrationsPaginatorOptions)) *ListTypeRegistrationsPaginator
NewListTypeRegistrationsPaginator returns a new ListTypeRegistrationsPaginator
func (*ListTypeRegistrationsPaginator) HasMorePages ¶
func (p *ListTypeRegistrationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListTypeRegistrationsPaginator) NextPage ¶
func (p *ListTypeRegistrationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTypeRegistrationsOutput, error)
NextPage retrieves the next ListTypeRegistrations page.
type ListTypeRegistrationsPaginatorOptions ¶
type ListTypeRegistrationsPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListTypeRegistrationsPaginatorOptions is the paginator options for ListTypeRegistrations
type ListTypeVersionsAPIClient ¶
type ListTypeVersionsAPIClient interface { ListTypeVersions(context.Context, *ListTypeVersionsInput, ...func(*Options)) (*ListTypeVersionsOutput, error) }
ListTypeVersionsAPIClient is a client that implements the ListTypeVersions operation.
type ListTypeVersionsInput ¶
type ListTypeVersionsInput struct { // The Amazon Resource Name (ARN) of the extension for which you want version // summary information. Conditional: You must specify either TypeName and Type, or // Arn. Arn *string // The deprecation status of the extension versions that you want to get summary // information about. Valid values include: // // * LIVE: The extension version is // registered and can be used in CloudFormation operations, dependent on its // provisioning behavior and visibility scope. // // * DEPRECATED: The extension version // has been deregistered and can no longer be used in CloudFormation // operations. // // The default is LIVE. DeprecatedStatus types.DeprecatedStatus // 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 *int32 // 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 this action 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 // The publisher ID of the extension publisher. Extensions published by Amazon are // not assigned a publisher ID. PublisherId *string // The kind of the extension. Conditional: You must specify either TypeName and // Type, or Arn. Type types.RegistryType // The name of the extension for which you want version summary information. // Conditional: You must specify either TypeName and Type, or Arn. TypeName *string }
type ListTypeVersionsOutput ¶
type ListTypeVersionsOutput 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 this action 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 // A list of TypeVersionSummary structures that contain information about the // specified extension's versions. TypeVersionSummaries []types.TypeVersionSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListTypeVersionsPaginator ¶
type ListTypeVersionsPaginator struct {
// contains filtered or unexported fields
}
ListTypeVersionsPaginator is a paginator for ListTypeVersions
func NewListTypeVersionsPaginator ¶
func NewListTypeVersionsPaginator(client ListTypeVersionsAPIClient, params *ListTypeVersionsInput, optFns ...func(*ListTypeVersionsPaginatorOptions)) *ListTypeVersionsPaginator
NewListTypeVersionsPaginator returns a new ListTypeVersionsPaginator
func (*ListTypeVersionsPaginator) HasMorePages ¶
func (p *ListTypeVersionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListTypeVersionsPaginator) NextPage ¶
func (p *ListTypeVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTypeVersionsOutput, error)
NextPage retrieves the next ListTypeVersions page.
type ListTypeVersionsPaginatorOptions ¶
type ListTypeVersionsPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListTypeVersionsPaginatorOptions is the paginator options for ListTypeVersions
type ListTypesAPIClient ¶
type ListTypesAPIClient interface { ListTypes(context.Context, *ListTypesInput, ...func(*Options)) (*ListTypesOutput, error) }
ListTypesAPIClient is a client that implements the ListTypes operation.
type ListTypesInput ¶
type ListTypesInput struct { // The deprecation status of the extension that you want to get summary information // about. Valid values include: // // * LIVE: The extension is registered for use in // CloudFormation operations. // // * DEPRECATED: The extension has been deregistered // and can no longer be used in CloudFormation operations. DeprecatedStatus types.DeprecatedStatus // Filter criteria to use in determining which extensions to return. If you specify // a filter, CloudFormation ignores any specified Visibility value when returning // the list of types. Filters *types.TypeFilters // 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 *int32 // 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 this action 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 // For resource types, the provisioning behavior of the resource type. AWS // CloudFormation determines the provisioning type during registration, based on // the types of handlers in the schema handler package submitted. Valid values // include: // // * FULLY_MUTABLE: The resource type includes an update handler to // process updates to the type during stack update operations. // // * IMMUTABLE: The // resource type does not include an update handler, so the type cannot be updated // and must instead be replaced during stack update operations. // // * // NON_PROVISIONABLE: The resource type does not include create, read, and delete // handlers, and therefore cannot actually be provisioned. // // The default is // FULLY_MUTABLE. ProvisioningType types.ProvisioningType // The type of extension. Type types.RegistryType // The scope at which the extensions are visible and usable in CloudFormation // operations. Valid values include: // // * PRIVATE: Extensions that are visible and // usable within this account and region. This includes: // // * Private extensions you // have registered in this account and region. // // * Public extensions that you have // activated in this account and region. // // * PUBLIC: Extensions that are publicly // visible and available to be activated within any Amazon account. This includes // extensions from Amazon, as well as third-party publishers. // // The default is // PRIVATE. Visibility types.Visibility }
type ListTypesOutput ¶
type ListTypesOutput 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 this action 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 // A list of TypeSummary structures that contain information about the specified // extensions. TypeSummaries []types.TypeSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListTypesPaginator ¶
type ListTypesPaginator struct {
// contains filtered or unexported fields
}
ListTypesPaginator is a paginator for ListTypes
func NewListTypesPaginator ¶
func NewListTypesPaginator(client ListTypesAPIClient, params *ListTypesInput, optFns ...func(*ListTypesPaginatorOptions)) *ListTypesPaginator
NewListTypesPaginator returns a new ListTypesPaginator
func (*ListTypesPaginator) HasMorePages ¶
func (p *ListTypesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListTypesPaginator) NextPage ¶
func (p *ListTypesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTypesOutput, error)
NextPage retrieves the next ListTypes page.
type ListTypesPaginatorOptions ¶
type ListTypesPaginatorOptions 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListTypesPaginatorOptions is the paginator options for ListTypes
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // Provides idempotency tokens values that will be automatically populated into // idempotent API operations. IdempotencyTokenProvider IdempotencyTokenProvider // The logger writer interface to write logging messages to. Logger logging.Logger // The region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer aws.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
type PublishTypeInput ¶
type PublishTypeInput struct { // The Amazon Resource Number (ARN) of the extension. Conditional: You must specify // Arn, or TypeName and Type. Arn *string // The version number to assign to this version of the extension. Use the following // format, and adhere to semantic versioning when assigning a version number to // your extension: MAJOR.MINOR.PATCH For more information, see Semantic Versioning // 2.0.0 (https://semver.org/). If you do not specify a version number, // CloudFormation increments the version number by one minor version release. PublicVersionNumber *string // The type of the extension. Conditional: You must specify Arn, or TypeName and // Type. Type types.ThirdPartyType // The name of the extension. Conditional: You must specify Arn, or TypeName and // Type. TypeName *string }
type PublishTypeOutput ¶
type PublishTypeOutput struct { // The Amazon Resource Number (ARN) assigned to the public extension upon // publication. PublicTypeArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type RecordHandlerProgressInput ¶
type RecordHandlerProgressInput struct { // Reserved for use by the CloudFormation CLI // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html). // // This member is required. BearerToken *string // Reserved for use by the CloudFormation CLI // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html). // // This member is required. OperationStatus types.OperationStatus // Reserved for use by the CloudFormation CLI // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html). ClientRequestToken *string // Reserved for use by the CloudFormation CLI // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html). CurrentOperationStatus types.OperationStatus // Reserved for use by the CloudFormation CLI // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html). ErrorCode types.HandlerErrorCode // Reserved for use by the CloudFormation CLI // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html). ResourceModel *string // Reserved for use by the CloudFormation CLI // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html). StatusMessage *string }
type RecordHandlerProgressOutput ¶
type RecordHandlerProgressOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type RegisterPublisherInput ¶
type RegisterPublisherInput struct { // Whether you accept the terms and conditions for publishing extensions in the // CloudFormation registry. You must accept the terms and conditions in order to // register to publish public extensions to the CloudFormation registry. The // default is false. AcceptTermsAndConditions *bool // If you are using a Bitbucket or GitHub account for identity verification, the // Amazon Resource Name (ARN) for your connection to that account. For more // information, see Registering your account to publish CloudFormation extensions // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs) // in the CloudFormation CLI User Guide. ConnectionArn *string }
type RegisterPublisherOutput ¶
type RegisterPublisherOutput struct { // The ID assigned this account by CloudFormation for publishing extensions. PublisherId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type RegisterTypeInput ¶
type RegisterTypeInput struct { // A url to the S3 bucket containing the extension project package that contains // the neccessary files for the extension you want to register. For information on // generating a schema handler package for the extension you want to register, see // submit // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html) // in the CloudFormation CLI User Guide. The user registering the extension must be // able to access the package in the S3 bucket. That is, the user needs to have // GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) // permissions for the schema handler package. For more information, see Actions, // Resources, and Condition Keys for Amazon S3 // (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html) in the AWS // Identity and Access Management User Guide. // // This member is required. SchemaHandlerPackage *string // The name of the extension being registered. We recommend that extension names // adhere to the following patterns: // // * For resource types, // company_or_organization::service::type. // // * For modules, // company_or_organization::service::type::MODULE. // // The following organization // namespaces are reserved and cannot be used in your extension names: // // * Alexa // // * // AMZN // // * Amazon // // * AWS // // * Custom // // * Dev // // This member is required. TypeName *string // A unique identifier that acts as an idempotency key for this registration // request. Specifying a client request token prevents CloudFormation from // generating more than one version of an extension from the same registeration // request, even if the request is submitted multiple times. ClientRequestToken *string // The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when // invoking the extension. For CloudFormation to assume the specified execution // role, the role must contain a trust relationship with the CloudFormation service // principle (resources.cloudformation.amazonaws.com). For more information on // adding trust relationships, see Modifying a role trust policy in the AWS // Identity and Access Management User Guide. If your extension calls AWS APIs in // any of its handlers, you must create an IAM execution role // (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) that includes // the necessary permissions to call those AWS APIs, and provision that execution // role in your account. When CloudFormation needs to invoke the resource type // handler, CloudFormation assumes this execution role to create a temporary // session token, which it then passes to the resource type handler, thereby // supplying your resource type with the appropriate credentials. ExecutionRoleArn *string // Specifies logging configuration information for an extension. LoggingConfig *types.LoggingConfig // The kind of extension. Type types.RegistryType }
type RegisterTypeOutput ¶
type RegisterTypeOutput struct { // The identifier for this registration request. Use this registration token when // calling DescribeTypeRegistration, which returns information about the status and // IDs of the extension registration. RegistrationToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type SetStackPolicyInput ¶
type SetStackPolicyInput struct { // The name or unique stack ID that you want to associate a policy with. // // This member is required. StackName *string // 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 // 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 }
The input for the SetStackPolicy action.
type SetStackPolicyOutput ¶
type SetStackPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type SetTypeConfigurationInput ¶
type SetTypeConfigurationInput struct { // The configuration data for the extension, in this account and region. The // configuration data must be formatted as JSON, and validate against the schema // returned in the ConfigurationSchema response element of API_DescribeType. For // more information, see Defining account-level configuration data for an extension // (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-model.html#resource-type-howto-configuration) // in the CloudFormation CLI User Guide. // // This member is required. Configuration *string // An alias by which to refer to this extension configuration data. Conditional: // Specifying a configuration alias is required when setting a configuration for a // resource type extension. ConfigurationAlias *string // The type of extension. Conditional: You must specify ConfigurationArn, or Type // and TypeName. Type types.ThirdPartyType // The Amazon Resource Name (ARN) for the extension, in this account and region. // For public extensions, this will be the ARN assigned when you activate the type // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html) // in this account and region. For private extensions, this will be the ARN // assigned when you register the type // (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html) // in this account and region. Do not include the extension versions suffix at the // end of the ARN. You can set the configuration for an extension, but not for a // specific extension version. TypeArn *string // The name of the extension. Conditional: You must specify ConfigurationArn, or // Type and TypeName. TypeName *string }
type SetTypeConfigurationOutput ¶
type SetTypeConfigurationOutput struct { // The Amazon Resource Name (ARN) for the configuration data, in this account and // region. Conditional: You must specify ConfigurationArn, or Type and TypeName. ConfigurationArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type SetTypeDefaultVersionInput ¶
type SetTypeDefaultVersionInput struct { // The Amazon Resource Name (ARN) of the extension for which you want version // summary information. Conditional: You must specify either TypeName and Type, or // Arn. Arn *string // The kind of extension. Conditional: You must specify either TypeName and Type, // or Arn. Type types.RegistryType // The name of the extension. Conditional: You must specify either TypeName and // Type, or Arn. TypeName *string // The ID of a specific version of the extension. The version ID is the value at // the end of the Amazon Resource Name (ARN) assigned to the extension version when // it is registered. VersionId *string }
type SetTypeDefaultVersionOutput ¶
type SetTypeDefaultVersionOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
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. // // This member is required. LogicalResourceId *string // The stack name or unique stack ID that includes the resource that you want to // signal. // // This member is required. StackName *string // 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. // // This member is required. Status types.ResourceSignalStatus // 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. // // This member is required. UniqueId *string }
The input for the SignalResource action.
type SignalResourceOutput ¶
type SignalResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type StopStackSetOperationInput ¶
type StopStackSetOperationInput struct { // The ID of the stack operation. // // This member is required. OperationId *string // The name or unique ID of the stack set that you want to stop the operation for. // // This member is required. StackSetName *string // [Service-managed permissions] Specifies whether you are acting as an account // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. // // * If you are signed in to the // management account, specify SELF. // // * If you are signed in to a delegated // administrator account, specify DELEGATED_ADMIN. Your AWS account must be // registered as a delegated administrator in the management account. For more // information, see Register a delegated administrator // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) // in the AWS CloudFormation User Guide. CallAs types.CallAs }
type StopStackSetOperationOutput ¶
type StopStackSetOperationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type TestTypeInput ¶
type TestTypeInput struct { // The Amazon Resource Number (ARN) of the extension. Conditional: You must specify // Arn, or TypeName and Type. Arn *string // The S3 bucket to which CloudFormation delivers the contract test execution logs. // CloudFormation delivers the logs by the time contract testing has completed and // the extension has been assigned a test type status of PASSED or FAILED. The user // calling TestType must be able to access items in the specified S3 bucket. // Specifically, the user needs the following permissions: // // * GetObject // // * // PutObject // // For more information, see Actions, Resources, and Condition Keys for // Amazon S3 // (https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html) // in the AWS Identity and Access Management User Guide. LogDeliveryBucket *string // The type of the extension to test. Conditional: You must specify Arn, or // TypeName and Type. Type types.ThirdPartyType // The name of the extension to test. Conditional: You must specify Arn, or // TypeName and Type. TypeName *string // The version of the extension to test. You can specify the version id with either // Arn, or with TypeName and Type. If you do not specify a version, CloudFormation // uses the default version of the extension in this account and region for // testing. VersionId *string }
type TestTypeOutput ¶
type TestTypeOutput struct { // The Amazon Resource Number (ARN) of the extension. TypeVersionArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type TypeRegistrationCompleteWaiter ¶
type TypeRegistrationCompleteWaiter struct {
// contains filtered or unexported fields
}
TypeRegistrationCompleteWaiter defines the waiters for TypeRegistrationComplete
func NewTypeRegistrationCompleteWaiter ¶
func NewTypeRegistrationCompleteWaiter(client DescribeTypeRegistrationAPIClient, optFns ...func(*TypeRegistrationCompleteWaiterOptions)) *TypeRegistrationCompleteWaiter
NewTypeRegistrationCompleteWaiter constructs a TypeRegistrationCompleteWaiter.
func (*TypeRegistrationCompleteWaiter) Wait ¶
func (w *TypeRegistrationCompleteWaiter) Wait(ctx context.Context, params *DescribeTypeRegistrationInput, maxWaitDur time.Duration, optFns ...func(*TypeRegistrationCompleteWaiterOptions)) error
Wait calls the waiter function for TypeRegistrationComplete waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.
type TypeRegistrationCompleteWaiterOptions ¶
type TypeRegistrationCompleteWaiterOptions struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // MinDelay is the minimum amount of time to delay between retries. If unset, // TypeRegistrationCompleteWaiter will use default minimum delay of 30 seconds. // Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay. MinDelay time.Duration // MaxDelay is the maximum amount of time to delay between retries. If unset or set // to zero, TypeRegistrationCompleteWaiter will use default max delay of 120 // seconds. Note that MaxDelay must resolve to value greater than or equal to the // MinDelay. MaxDelay time.Duration // LogWaitAttempts is used to enable logging for waiter retry attempts LogWaitAttempts bool // Retryable is function that can be used to override the service defined // waiter-behavior based on operation output, or returned error. This function is // used by the waiter to decide if a state is retryable or a terminal state. By // default service-modeled logic will populate this option. This option can thus be // used to define a custom waiter state with fall-back to service-modeled waiter // state mutators.The function returns an error in case of a failure state. In case // of retry state, this function returns a bool value of true and nil error, while // in case of success it returns a bool value of false and nil error. Retryable func(context.Context, *DescribeTypeRegistrationInput, *DescribeTypeRegistrationOutput, error) (bool, error) }
TypeRegistrationCompleteWaiterOptions are waiter options for TypeRegistrationCompleteWaiter
type UpdateStackInput ¶
type UpdateStackInput struct { // The name or unique stack ID of the stack to update. // // This member is required. StackName *string // 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. 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 []types.Capability // 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 // 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 // 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 []types.Parameter // 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 // 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 // The rollback triggers for AWS CloudFormation to monitor during stack creation // and updating operations, and for the specified monitoring period afterwards. RollbackConfiguration *types.RollbackConfiguration // 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 // 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 // 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 // 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 // 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 []types.Tag // 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 // Location of file containing the template body. The URL must point to a template // that is located in an Amazon S3 bucket or a Systems Manager document. 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 // 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 }
The input for an UpdateStack action.
type UpdateStackInstancesInput ¶
type UpdateStackInstancesInput struct { // 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. // // This member is required. Regions []string // The name or unique ID of the stack set associated with the stack instances. // // This member is required. StackSetName *string // [Self-managed permissions] 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. You can specify Accounts or DeploymentTargets, but not both. Accounts []string // [Service-managed permissions] Specifies whether you are acting as an account // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. // // * If you are signed in to the // management account, specify SELF. // // * If you are signed in to a delegated // administrator account, specify DELEGATED_ADMIN. Your AWS account must be // registered as a delegated administrator in the management account. For more // information, see Register a delegated administrator // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) // in the AWS CloudFormation User Guide. CallAs types.CallAs // [Service-managed permissions] The AWS Organizations accounts for which you want // to update parameter values for stack instances. If your update targets OUs, the // overridden parameter values only apply to the accounts that are currently in the // target OUs and their child OUs. Accounts added to the target OUs and their child // OUs in the future won't use the overridden values. You can specify Accounts or // DeploymentTargets, but not both. DeploymentTargets *types.DeploymentTargets // 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 // Preferences for how AWS CloudFormation performs this stack set operation. OperationPreferences *types.StackSetOperationPreferences // 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 []types.Parameter }
type UpdateStackInstancesOutput ¶
type UpdateStackInstancesOutput struct { // The unique identifier for this stack set operation. OperationId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateStackOutput ¶
type UpdateStackOutput struct { // Unique identifier of the stack. StackId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
The output for an UpdateStack action.
type UpdateStackSetInput ¶
type UpdateStackSetInput struct { // The name or unique ID of the stack set that you want to update. // // This member is required. StackSetName *string // [Self-managed permissions] 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 // 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 // [Service-managed permissions] Describes whether StackSets automatically deploys // to AWS Organizations accounts that are added to a target organization or // organizational unit (OU). If you specify AutoDeployment, do not specify // DeploymentTargets or Regions. AutoDeployment *types.AutoDeployment // [Service-managed permissions] Specifies whether you are acting as an account // administrator in the organization's management account or as a delegated // administrator in a member account. By default, SELF is specified. Use SELF for // stack sets with self-managed permissions. // // * If you are signed in to the // management account, specify SELF. // // * If you are signed in to a delegated // administrator account, specify DELEGATED_ADMIN. Your AWS account must be // registered as a delegated administrator in the management account. For more // information, see Register a delegated administrator // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) // in the AWS CloudFormation User Guide. CallAs types.CallAs // 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 reference macros. If your stack set // template references one or more macros, you must update the stack set directly // from the processed template, without first reviewing the resulting changes in a // change set. To update the stack set directly, 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 with service-managed permissions do not currently support the use of // macros in 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 for a stack set with service-managed permissions, if you // reference a macro in your template the stack set operation will fail. Capabilities []types.Capability // [Service-managed permissions] The AWS Organizations accounts in which to update // associated stack instances. To update all the stack instances associated with // this stack set, do not specify DeploymentTargets or Regions. If the stack set // update includes changes to the template (that is, if TemplateBody or TemplateURL // is specified), or the Parameters, 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. DeploymentTargets *types.DeploymentTargets // A brief description of updates that you are making. Description *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 // 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 // Preferences for how AWS CloudFormation performs this stack set operation. OperationPreferences *types.StackSetOperationPreferences // A list of input parameters for the stack set template. Parameters []types.Parameter // Describes how the IAM roles required for stack set operations are created. You // cannot modify PermissionModel if there are stack instances associated with your // stack set. // // * With self-managed permissions, you must create the administrator // and execution roles required to deploy to target accounts. For more information, // see Grant Self-Managed Stack Set Permissions // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html). // // * // With service-managed permissions, StackSets automatically creates the IAM roles // required to deploy to accounts managed by AWS Organizations. For more // information, see Grant Service-Managed Stack Set Permissions // (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html). PermissionModel types.PermissionModels // 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 // 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 []types.Tag // 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 // 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 // or a Systems Manager document. 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 // 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 UpdateStackSetOutput ¶
type UpdateStackSetOutput struct { // The unique ID for this stack set operation. OperationId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateTerminationProtectionInput ¶
type UpdateTerminationProtectionInput struct { // Whether to enable termination protection on the specified stack. // // This member is required. EnableTerminationProtection *bool // The name or unique ID of the stack for which you want to set termination // protection. // // This member is required. StackName *string }
type UpdateTerminationProtectionOutput ¶
type UpdateTerminationProtectionOutput struct { // The unique ID of the stack. StackId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
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 // 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 or a Systems // Manager document. 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 }
The input for ValidateTemplate action.
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 []types.Capability // The list of resources that generated the values in the Capabilities response // element. CapabilitiesReason *string // A list of the transforms that are declared in the template. DeclaredTransforms []string // The description found within the template. Description *string // A list of TemplateParameter structures. Parameters []types.TemplateParameter // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
The output for ValidateTemplate action.
Source Files ¶
api_client.go api_op_ActivateType.go api_op_BatchDescribeTypeConfigurations.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_DeactivateType.go api_op_DeleteChangeSet.go api_op_DeleteStack.go api_op_DeleteStackInstances.go api_op_DeleteStackSet.go api_op_DeregisterType.go api_op_DescribeAccountLimits.go api_op_DescribeChangeSet.go api_op_DescribePublisher.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_DescribeType.go api_op_DescribeTypeRegistration.go api_op_DetectStackDrift.go api_op_DetectStackResourceDrift.go api_op_DetectStackSetDrift.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_ListTypeRegistrations.go api_op_ListTypeVersions.go api_op_ListTypes.go api_op_PublishType.go api_op_RecordHandlerProgress.go api_op_RegisterPublisher.go api_op_RegisterType.go api_op_SetStackPolicy.go api_op_SetTypeConfiguration.go api_op_SetTypeDefaultVersion.go api_op_SignalResource.go api_op_StopStackSetOperation.go api_op_TestType.go api_op_UpdateStack.go api_op_UpdateStackInstances.go api_op_UpdateStackSet.go api_op_UpdateTerminationProtection.go api_op_ValidateTemplate.go deserializers.go doc.go endpoints.go go_module_metadata.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v1.7.0
- Published
- Jul 15, 2021
- Platform
- darwin/amd64
- Imports
- 35 packages
- Last checked
- now –
Tools for package owners.