types

package
v1.56.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 19, 2024 License: Apache-2.0 Imports: 4 Imported by: 187

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccountFilterType added in v1.22.0 

type AccountFilterType string
const (
	AccountFilterTypeNone         AccountFilterType = "NONE"
	AccountFilterTypeIntersection AccountFilterType = "INTERSECTION"
	AccountFilterTypeDifference   AccountFilterType = "DIFFERENCE"
	AccountFilterTypeUnion        AccountFilterType = "UNION"
)

Enum values for AccountFilterType

func (AccountFilterType) Values added in v1.22.0 

func (AccountFilterType) Values() []AccountFilterType

Values returns all known values for AccountFilterType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AccountGateResult 

type AccountGateResult struct {

	// The status of the account gate function.
	//
	//   - SUCCEEDED : The account gate function has determined that the account and
	//   Region passes any requirements for a stack set operation to occur.
	//   CloudFormation proceeds with the stack operation in that account and Region.
	//
	//   - FAILED : The account gate function has determined that the account and
	//   Region doesn't meet the requirements for a stack set operation to occur.
	//   CloudFormation cancels the stack set operation in that account and Region, and
	//   sets the stack set operation result status for that account and Region to
	//   FAILED .
	//
	//   - SKIPPED : CloudFormation has skipped calling the account gate function for
	//   this account and Region, for one of the following reasons:
	//
	//   - An account gate function hasn't been specified for the account and Region.
	//   CloudFormation proceeds with the stack set operation in this account and Region.
	//
	//   - The AWSCloudFormationStackSetExecutionRole of the stack set administration
	//   account lacks permissions to invoke the function. CloudFormation proceeds with
	//   the stack set operation in this account and Region.
	//
	//   - Either no action is necessary, or no action is possible, on the stack.
	//   CloudFormation skips the stack set operation in this account and Region.
	Status AccountGateStatus

	// The reason for the account gate status assigned to this account and Region for
	// the stack set operation.
	StatusReason *string
	// contains filtered or unexported fields
}

Structure that contains the results of the account gate function which CloudFormation invokes, if present, before proceeding with a stack set operation in an account and Region.

For each account and Region, CloudFormation lets you specify a Lambda function that encapsulates any requirements that must be met before CloudFormation can proceed with a stack set operation in that account and Region. CloudFormation invokes the function each time a stack set operation is requested for that account and Region; if the function returns FAILED , CloudFormation cancels the operation in that account and Region, and sets the stack set operation result status for that account and Region to FAILED .

For more information, see Configuring a target account gate.

type AccountGateStatus 

type AccountGateStatus string
const (
	AccountGateStatusSucceeded AccountGateStatus = "SUCCEEDED"
	AccountGateStatusFailed    AccountGateStatus = "FAILED"
	AccountGateStatusSkipped   AccountGateStatus = "SKIPPED"
)

Enum values for AccountGateStatus

func (AccountGateStatus) Values added in v0.29.0 

func (AccountGateStatus) Values() []AccountGateStatus

Values returns all known values for AccountGateStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AccountLimit 

type AccountLimit struct {

	// The name of the account limit.
	//
	// Values: ConcurrentResourcesLimit | StackLimit | StackOutputsLimit
	Name *string

	// The value that's associated with the account limit name.
	Value *int32
	// contains filtered or unexported fields
}

The AccountLimit data type.

CloudFormation has the following limits per account:

  • Number of concurrent resources

  • Number of stacks

  • Number of stack outputs

For more information about these account limits, and other CloudFormation limits, see Understand CloudFormation quotasin the CloudFormation User Guide.

type AlreadyExistsException 

type AlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The resource with the name requested already exists.

func (*AlreadyExistsException) Error 

func (e *AlreadyExistsException) Error() string

func (*AlreadyExistsException) ErrorCode 

func (e *AlreadyExistsException) ErrorCode() string

func (*AlreadyExistsException) ErrorFault 

func (e *AlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*AlreadyExistsException) ErrorMessage 

func (e *AlreadyExistsException) ErrorMessage() string

type AttributeChangeType added in v1.50.0 

type AttributeChangeType string
const (
	AttributeChangeTypeAdd    AttributeChangeType = "Add"
	AttributeChangeTypeRemove AttributeChangeType = "Remove"
	AttributeChangeTypeModify AttributeChangeType = "Modify"
)

Enum values for AttributeChangeType

func (AttributeChangeType) Values added in v1.50.0 

func (AttributeChangeType) Values() []AttributeChangeType

Values returns all known values for AttributeChangeType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AutoDeployment 

type AutoDeployment struct {

	// If set to true , StackSets automatically deploys additional stack instances to
	// Organizations accounts that are added to a target organization or organizational
	// unit (OU) in the specified Regions. If an account is removed from a target
	// organization or OU, StackSets deletes stack instances from the account in the
	// specified Regions.
	Enabled *bool

	// If set to true , stack resources are retained when an account is removed from a
	// target organization or OU. If set to false , stack resources are deleted.
	// Specify only if Enabled is set to True .
	RetainStacksOnAccountRemoval *bool
	// contains filtered or unexported fields
}

[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit (OU).

type BatchDescribeTypeConfigurationsError added in v1.6.0 

type BatchDescribeTypeConfigurationsError struct {

	// The error code.
	ErrorCode *string

	// The error message.
	ErrorMessage *string

	// Identifying information for the configuration of a CloudFormation extension.
	TypeConfigurationIdentifier *TypeConfigurationIdentifier
	// contains filtered or unexported fields
}

Detailed information concerning an error generated during the setting of configuration data for a CloudFormation extension.

type CFNRegistryException 

type CFNRegistryException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An error occurred during a CloudFormation registry operation.

func (*CFNRegistryException) Error 

func (e *CFNRegistryException) Error() string

func (*CFNRegistryException) ErrorCode 

func (e *CFNRegistryException) ErrorCode() string

func (*CFNRegistryException) ErrorFault 

func (e *CFNRegistryException) ErrorFault() smithy.ErrorFault

func (*CFNRegistryException) ErrorMessage 

func (e *CFNRegistryException) ErrorMessage() string

type CallAs added in v1.2.0 

type CallAs string
const (
	CallAsSelf           CallAs = "SELF"
	CallAsDelegatedAdmin CallAs = "DELEGATED_ADMIN"
)

Enum values for CallAs

func (CallAs) Values added in v1.2.0 

func (CallAs) Values() []CallAs

Values returns all known values for CallAs. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Capability 

type Capability string
const (
	CapabilityCapabilityIam        Capability = "CAPABILITY_IAM"
	CapabilityCapabilityNamedIam   Capability = "CAPABILITY_NAMED_IAM"
	CapabilityCapabilityAutoExpand Capability = "CAPABILITY_AUTO_EXPAND"
)

Enum values for Capability

func (Capability) Values added in v0.29.0 

func (Capability) Values() []Capability

Values returns all known values for Capability. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Category added in v1.6.0 

type Category string
const (
	CategoryRegistered Category = "REGISTERED"
	CategoryActivated  Category = "ACTIVATED"
	CategoryThirdParty Category = "THIRD_PARTY"
	CategoryAwsTypes   Category = "AWS_TYPES"
)

Enum values for Category

func (Category) Values added in v1.6.0 

func (Category) Values() []Category

Values returns all known values for Category. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Change 

type Change struct {

	// Is either null , if no hooks invoke for the resource, or contains the number of
	// hooks that will invoke for the resource.
	HookInvocationCount *int32

	// A ResourceChange structure that describes the resource and action that
	// CloudFormation will perform.
	ResourceChange *ResourceChange

	// The type of entity that CloudFormation changes.
	//
	//   - Resource This change is for a resource.
	Type ChangeType
	// contains filtered or unexported fields
}

The Change structure describes the changes CloudFormation will perform if you execute the change set.

type ChangeAction 

type ChangeAction string
const (
	ChangeActionAdd     ChangeAction = "Add"
	ChangeActionModify  ChangeAction = "Modify"
	ChangeActionRemove  ChangeAction = "Remove"
	ChangeActionImport  ChangeAction = "Import"
	ChangeActionDynamic ChangeAction = "Dynamic"
)

Enum values for ChangeAction

func (ChangeAction) Values added in v0.29.0 

func (ChangeAction) Values() []ChangeAction

Values returns all known values for ChangeAction. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ChangeSetHook added in v1.19.0 

type ChangeSetHook struct {

	// Specify the hook failure mode for non-compliant resources in the followings
	// ways.
	//
	//   - FAIL Stops provisioning resources.
	//
	//   - WARN Allows provisioning to continue with a warning message.
	FailureMode HookFailureMode

	// Specifies the points in provisioning logic where a hook is invoked.
	InvocationPoint HookInvocationPoint

	// Specifies details about the target that the hook will run against.
	TargetDetails *ChangeSetHookTargetDetails

	// The version ID of the type configuration.
	TypeConfigurationVersionId *string

	// The unique name for your hook. Specifies a three-part namespace for your hook,
	// with a recommended pattern of Organization::Service::Hook .
	//
	// The following organization namespaces are reserved and can't be used in your
	// hook type names:
	//
	//   - Alexa
	//
	//   - AMZN
	//
	//   - Amazon
	//
	//   - ASK
	//
	//   - AWS
	//
	//   - Custom
	//
	//   - Dev
	TypeName *string

	// The version ID of the type specified.
	TypeVersionId *string
	// contains filtered or unexported fields
}

Specifies the resource, the hook, and the hook version to be invoked.

type ChangeSetHookResourceTargetDetails added in v1.19.0 

type ChangeSetHookResourceTargetDetails struct {

	// The resource's logical ID, which is defined in the stack's template.
	LogicalResourceId *string

	// Specifies the action of the resource.
	ResourceAction ChangeAction

	// The type of CloudFormation resource, such as AWS::S3::Bucket .
	ResourceType *string
	// contains filtered or unexported fields
}

Specifies RESOURCE type target details for activated hooks.

type ChangeSetHookTargetDetails added in v1.19.0 

type ChangeSetHookTargetDetails struct {

	// Required if TargetType is RESOURCE .
	ResourceTargetDetails *ChangeSetHookResourceTargetDetails

	// The name of the type.
	TargetType HookTargetType
	// contains filtered or unexported fields
}

Specifies target details for an activated hook.

type ChangeSetHooksStatus added in v1.19.0 

type ChangeSetHooksStatus string
const (
	ChangeSetHooksStatusPlanning    ChangeSetHooksStatus = "PLANNING"
	ChangeSetHooksStatusPlanned     ChangeSetHooksStatus = "PLANNED"
	ChangeSetHooksStatusUnavailable ChangeSetHooksStatus = "UNAVAILABLE"
)

Enum values for ChangeSetHooksStatus

func (ChangeSetHooksStatus) Values added in v1.19.0 

func (ChangeSetHooksStatus) Values() []ChangeSetHooksStatus

Values returns all known values for ChangeSetHooksStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ChangeSetNotFoundException 

type ChangeSetNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the ListChangeSets operation.

func (*ChangeSetNotFoundException) Error 

func (e *ChangeSetNotFoundException) Error() string

func (*ChangeSetNotFoundException) ErrorCode 

func (e *ChangeSetNotFoundException) ErrorCode() string

func (*ChangeSetNotFoundException) ErrorFault 

func (e *ChangeSetNotFoundException) ErrorFault() smithy.ErrorFault

func (*ChangeSetNotFoundException) ErrorMessage 

func (e *ChangeSetNotFoundException) ErrorMessage() string

type ChangeSetStatus 

type ChangeSetStatus string
const (
	ChangeSetStatusCreatePending    ChangeSetStatus = "CREATE_PENDING"
	ChangeSetStatusCreateInProgress ChangeSetStatus = "CREATE_IN_PROGRESS"
	ChangeSetStatusCreateComplete   ChangeSetStatus = "CREATE_COMPLETE"
	ChangeSetStatusDeletePending    ChangeSetStatus = "DELETE_PENDING"
	ChangeSetStatusDeleteInProgress ChangeSetStatus = "DELETE_IN_PROGRESS"
	ChangeSetStatusDeleteComplete   ChangeSetStatus = "DELETE_COMPLETE"
	ChangeSetStatusDeleteFailed     ChangeSetStatus = "DELETE_FAILED"
	ChangeSetStatusFailed           ChangeSetStatus = "FAILED"
)

Enum values for ChangeSetStatus

func (ChangeSetStatus) Values added in v0.29.0 

func (ChangeSetStatus) Values() []ChangeSetStatus

Values returns all known values for ChangeSetStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ChangeSetSummary 

type ChangeSetSummary struct {

	// The ID of the change set.
	ChangeSetId *string

	// The name of the change set.
	ChangeSetName *string

	// The start time when the change set was created, in UTC.
	CreationTime *time.Time

	// Descriptive 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 CloudFormation is still
	// creating it or in an OBSOLETE state because the stack was already updated.
	ExecutionStatus ExecutionStatus

	// Indicates if the change set imports resources that already exist.
	ImportExistingResources *bool

	// Specifies the current setting of IncludeNestedStacks for the change set.
	IncludeNestedStacks *bool

	// The parent change set ID.
	ParentChangeSetId *string

	// The root change set ID.
	RootChangeSetId *string

	// The ID of the stack with which the change set is associated.
	StackId *string

	// The name of the stack with which the change set is associated.
	StackName *string

	// The state of the change set, such as CREATE_IN_PROGRESS , CREATE_COMPLETE , or
	// FAILED .
	Status ChangeSetStatus

	// A description of the change set's status. For example, if your change set is in
	// the FAILED state, CloudFormation shows the error message.
	StatusReason *string
	// contains filtered or unexported fields
}

The ChangeSetSummary structure describes a change set, its status, and the stack with which it's associated.

type ChangeSetType 

type ChangeSetType string
const (
	ChangeSetTypeCreate ChangeSetType = "CREATE"
	ChangeSetTypeUpdate ChangeSetType = "UPDATE"
	ChangeSetTypeImport ChangeSetType = "IMPORT"
)

Enum values for ChangeSetType

func (ChangeSetType) Values added in v0.29.0 

func (ChangeSetType) Values() []ChangeSetType

Values returns all known values for ChangeSetType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ChangeSource 

type ChangeSource string
const (
	ChangeSourceResourceReference  ChangeSource = "ResourceReference"
	ChangeSourceParameterReference ChangeSource = "ParameterReference"
	ChangeSourceResourceAttribute  ChangeSource = "ResourceAttribute"
	ChangeSourceDirectModification ChangeSource = "DirectModification"
	ChangeSourceAutomatic          ChangeSource = "Automatic"
)

Enum values for ChangeSource

func (ChangeSource) Values added in v0.29.0 

func (ChangeSource) Values() []ChangeSource

Values returns all known values for ChangeSource. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ChangeType 

type ChangeType string
const (
	ChangeTypeResource ChangeType = "Resource"
)

Enum values for ChangeType

func (ChangeType) Values added in v0.29.0 

func (ChangeType) Values() []ChangeType

Values returns all known values for ChangeType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConcurrencyMode added in v1.39.0 

type ConcurrencyMode string
const (
	ConcurrencyModeStrictFailureTolerance ConcurrencyMode = "STRICT_FAILURE_TOLERANCE"
	ConcurrencyModeSoftFailureTolerance   ConcurrencyMode = "SOFT_FAILURE_TOLERANCE"
)

Enum values for ConcurrencyMode

func (ConcurrencyMode) Values added in v1.39.0 

func (ConcurrencyMode) Values() []ConcurrencyMode

Values returns all known values for ConcurrencyMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConcurrentResourcesLimitExceededException added in v1.43.0 

type ConcurrentResourcesLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

No more than 5 generated templates can be in an InProgress or Pending status at one time. This error is also returned if a generated template that is in an InProgress or Pending status is attempted to be updated or deleted.

func (*ConcurrentResourcesLimitExceededException) Error added in v1.43.0 

func (e *ConcurrentResourcesLimitExceededException) Error() string

func (*ConcurrentResourcesLimitExceededException) ErrorCode added in v1.43.0 

func (e *ConcurrentResourcesLimitExceededException) ErrorCode() string

func (*ConcurrentResourcesLimitExceededException) ErrorFault added in v1.43.0 

func (e *ConcurrentResourcesLimitExceededException) ErrorFault() smithy.ErrorFault

func (*ConcurrentResourcesLimitExceededException) ErrorMessage added in v1.43.0 

func (e *ConcurrentResourcesLimitExceededException) ErrorMessage() string

type CreatedButModifiedException 

type CreatedButModifiedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified resource exists, but has been changed.

func (*CreatedButModifiedException) Error 

func (e *CreatedButModifiedException) Error() string

func (*CreatedButModifiedException) ErrorCode 

func (e *CreatedButModifiedException) ErrorCode() string

func (*CreatedButModifiedException) ErrorFault 

func (e *CreatedButModifiedException) ErrorFault() smithy.ErrorFault

func (*CreatedButModifiedException) ErrorMessage 

func (e *CreatedButModifiedException) ErrorMessage() string

type DeletionMode added in v1.51.0 

type DeletionMode string
const (
	DeletionModeStandard         DeletionMode = "STANDARD"
	DeletionModeForceDeleteStack DeletionMode = "FORCE_DELETE_STACK"
)

Enum values for DeletionMode

func (DeletionMode) Values added in v1.51.0 

func (DeletionMode) Values() []DeletionMode

Values returns all known values for DeletionMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DeploymentTargets 

type DeploymentTargets struct {

	// Limit deployment targets to individual accounts or include additional accounts
	// with provided OUs.
	//
	// The following is a list of possible values for the AccountFilterType operation.
	//
	//   - INTERSECTION : StackSets deploys to the accounts specified in Accounts
	//   parameter.
	//
	//   - DIFFERENCE : StackSets excludes the accounts specified in Accounts
	//   parameter. This enables user to avoid certain accounts within an OU such as
	//   suspended accounts.
	//
	//   - UNION : StackSets includes additional accounts deployment targets.
	//
	// This is the default value if AccountFilterType is not provided. This enables
	//   user to update an entire OU and individual accounts from a different OU in one
	//   request, which used to be two separate requests.
	//
	//   - NONE : Deploys to all the accounts in specified organizational units (OU).
	AccountFilterType AccountFilterType

	// The names of one or more Amazon Web Services accounts for which you want to
	// deploy stack set updates.
	Accounts []string

	// Returns the value of the AccountsUrl property.
	AccountsUrl *string

	// The organization root ID or organizational unit (OU) IDs to which StackSets
	// deploys.
	OrganizationalUnitIds []string
	// contains filtered or unexported fields
}

[Service-managed permissions] The Organizations accounts to which StackSets deploys. StackSets doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization.

For update operations, you can specify either Accounts or OrganizationalUnitIds . For create and delete operations, specify OrganizationalUnitIds .

type DeprecatedStatus 

type DeprecatedStatus string
const (
	DeprecatedStatusLive       DeprecatedStatus = "LIVE"
	DeprecatedStatusDeprecated DeprecatedStatus = "DEPRECATED"
)

Enum values for DeprecatedStatus

func (DeprecatedStatus) Values added in v0.29.0 

func (DeprecatedStatus) Values() []DeprecatedStatus

Values returns all known values for DeprecatedStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DetailedStatus added in v1.47.0 

type DetailedStatus string
const (
	DetailedStatusConfigurationComplete DetailedStatus = "CONFIGURATION_COMPLETE"
	DetailedStatusValidationFailed      DetailedStatus = "VALIDATION_FAILED"
)

Enum values for DetailedStatus

func (DetailedStatus) Values added in v1.47.0 

func (DetailedStatus) Values() []DetailedStatus

Values returns all known values for DetailedStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DifferenceType 

type DifferenceType string
const (
	DifferenceTypeAdd      DifferenceType = "ADD"
	DifferenceTypeRemove   DifferenceType = "REMOVE"
	DifferenceTypeNotEqual DifferenceType = "NOT_EQUAL"
)

Enum values for DifferenceType

func (DifferenceType) Values added in v0.29.0 

func (DifferenceType) Values() []DifferenceType

Values returns all known values for DifferenceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type EvaluationType 

type EvaluationType string
const (
	EvaluationTypeStatic  EvaluationType = "Static"
	EvaluationTypeDynamic EvaluationType = "Dynamic"
)

Enum values for EvaluationType

func (EvaluationType) Values added in v0.29.0 

func (EvaluationType) Values() []EvaluationType

Values returns all known values for EvaluationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ExecutionStatus 

type ExecutionStatus string
const (
	ExecutionStatusUnavailable       ExecutionStatus = "UNAVAILABLE"
	ExecutionStatusAvailable         ExecutionStatus = "AVAILABLE"
	ExecutionStatusExecuteInProgress ExecutionStatus = "EXECUTE_IN_PROGRESS"
	ExecutionStatusExecuteComplete   ExecutionStatus = "EXECUTE_COMPLETE"
	ExecutionStatusExecuteFailed     ExecutionStatus = "EXECUTE_FAILED"
	ExecutionStatusObsolete          ExecutionStatus = "OBSOLETE"
)

Enum values for ExecutionStatus

func (ExecutionStatus) Values added in v0.29.0 

func (ExecutionStatus) Values() []ExecutionStatus

Values returns all known values for ExecutionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Export 

type Export struct {

	// The stack that contains the exported output name and value.
	ExportingStackId *string

	// The name of exported output value. Use this name and the Fn::ImportValue
	// function to import the associated value into other stacks. The name is defined
	// in the Export field in the associated stack's Outputs section.
	Name *string

	// The value of the exported output, such as a resource physical ID. This value is
	// defined in the Export field in the associated stack's Outputs section.
	Value *string
	// contains filtered or unexported fields
}

The Export structure describes the exported output values for a stack.

type GeneratedTemplateDeletionPolicy added in v1.43.0 

type GeneratedTemplateDeletionPolicy string
const (
	GeneratedTemplateDeletionPolicyDelete GeneratedTemplateDeletionPolicy = "DELETE"
	GeneratedTemplateDeletionPolicyRetain GeneratedTemplateDeletionPolicy = "RETAIN"
)

Enum values for GeneratedTemplateDeletionPolicy

func (GeneratedTemplateDeletionPolicy) Values added in v1.43.0 

func (GeneratedTemplateDeletionPolicy) Values() []GeneratedTemplateDeletionPolicy

Values returns all known values for GeneratedTemplateDeletionPolicy. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type GeneratedTemplateNotFoundException added in v1.43.0 

type GeneratedTemplateNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The generated template was not found.

func (*GeneratedTemplateNotFoundException) Error added in v1.43.0 

func (e *GeneratedTemplateNotFoundException) Error() string

func (*GeneratedTemplateNotFoundException) ErrorCode added in v1.43.0 

func (e *GeneratedTemplateNotFoundException) ErrorCode() string

func (*GeneratedTemplateNotFoundException) ErrorFault added in v1.43.0 

func (e *GeneratedTemplateNotFoundException) ErrorFault() smithy.ErrorFault

func (*GeneratedTemplateNotFoundException) ErrorMessage added in v1.43.0 

func (e *GeneratedTemplateNotFoundException) ErrorMessage() string

type GeneratedTemplateResourceStatus added in v1.43.0 

type GeneratedTemplateResourceStatus string
const (
	GeneratedTemplateResourceStatusPending    GeneratedTemplateResourceStatus = "PENDING"
	GeneratedTemplateResourceStatusInProgress GeneratedTemplateResourceStatus = "IN_PROGRESS"
	GeneratedTemplateResourceStatusFailed     GeneratedTemplateResourceStatus = "FAILED"
	GeneratedTemplateResourceStatusComplete   GeneratedTemplateResourceStatus = "COMPLETE"
)

Enum values for GeneratedTemplateResourceStatus

func (GeneratedTemplateResourceStatus) Values added in v1.43.0 

func (GeneratedTemplateResourceStatus) Values() []GeneratedTemplateResourceStatus

Values returns all known values for GeneratedTemplateResourceStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type GeneratedTemplateStatus added in v1.43.0 

type GeneratedTemplateStatus string
const (
	GeneratedTemplateStatusCreatePending    GeneratedTemplateStatus = "CREATE_PENDING"
	GeneratedTemplateStatusUpdatePending    GeneratedTemplateStatus = "UPDATE_PENDING"
	GeneratedTemplateStatusDeletePending    GeneratedTemplateStatus = "DELETE_PENDING"
	GeneratedTemplateStatusCreateInProgress GeneratedTemplateStatus = "CREATE_IN_PROGRESS"
	GeneratedTemplateStatusUpdateInProgress GeneratedTemplateStatus = "UPDATE_IN_PROGRESS"
	GeneratedTemplateStatusDeleteInProgress GeneratedTemplateStatus = "DELETE_IN_PROGRESS"
	GeneratedTemplateStatusFailed           GeneratedTemplateStatus = "FAILED"
	GeneratedTemplateStatusComplete         GeneratedTemplateStatus = "COMPLETE"
)

Enum values for GeneratedTemplateStatus

func (GeneratedTemplateStatus) Values added in v1.43.0 

func (GeneratedTemplateStatus) Values() []GeneratedTemplateStatus

Values returns all known values for GeneratedTemplateStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type GeneratedTemplateUpdateReplacePolicy added in v1.43.0 

type GeneratedTemplateUpdateReplacePolicy string
const (
	GeneratedTemplateUpdateReplacePolicyDelete GeneratedTemplateUpdateReplacePolicy = "DELETE"
	GeneratedTemplateUpdateReplacePolicyRetain GeneratedTemplateUpdateReplacePolicy = "RETAIN"
)

Enum values for GeneratedTemplateUpdateReplacePolicy

func (GeneratedTemplateUpdateReplacePolicy) Values added in v1.43.0 

func (GeneratedTemplateUpdateReplacePolicy) Values() []GeneratedTemplateUpdateReplacePolicy

Values returns all known values for GeneratedTemplateUpdateReplacePolicy. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type HandlerErrorCode 

type HandlerErrorCode string
const (
	HandlerErrorCodeNotUpdatable             HandlerErrorCode = "NotUpdatable"
	HandlerErrorCodeInvalidRequest           HandlerErrorCode = "InvalidRequest"
	HandlerErrorCodeAccessDenied             HandlerErrorCode = "AccessDenied"
	HandlerErrorCodeInvalidCredentials       HandlerErrorCode = "InvalidCredentials"
	HandlerErrorCodeAlreadyExists            HandlerErrorCode = "AlreadyExists"
	HandlerErrorCodeNotFound                 HandlerErrorCode = "NotFound"
	HandlerErrorCodeResourceConflict         HandlerErrorCode = "ResourceConflict"
	HandlerErrorCodeThrottling               HandlerErrorCode = "Throttling"
	HandlerErrorCodeServiceLimitExceeded     HandlerErrorCode = "ServiceLimitExceeded"
	HandlerErrorCodeServiceTimeout           HandlerErrorCode = "NotStabilized"
	HandlerErrorCodeGeneralServiceException  HandlerErrorCode = "GeneralServiceException"
	HandlerErrorCodeServiceInternalError     HandlerErrorCode = "ServiceInternalError"
	HandlerErrorCodeNetworkFailure           HandlerErrorCode = "NetworkFailure"
	HandlerErrorCodeInternalFailure          HandlerErrorCode = "InternalFailure"
	HandlerErrorCodeInvalidTypeConfiguration HandlerErrorCode = "InvalidTypeConfiguration"
	HandlerErrorCodeHandlerInternalFailure   HandlerErrorCode = "HandlerInternalFailure"
	HandlerErrorCodeNonCompliant             HandlerErrorCode = "NonCompliant"
	HandlerErrorCodeUnknown                  HandlerErrorCode = "Unknown"
	HandlerErrorCodeUnsupportedTarget        HandlerErrorCode = "UnsupportedTarget"
)

Enum values for HandlerErrorCode

func (HandlerErrorCode) Values added in v0.29.0 

func (HandlerErrorCode) Values() []HandlerErrorCode

Values returns all known values for HandlerErrorCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type HookFailureMode added in v1.19.0 

type HookFailureMode string
const (
	HookFailureModeFail HookFailureMode = "FAIL"
	HookFailureModeWarn HookFailureMode = "WARN"
)

Enum values for HookFailureMode

func (HookFailureMode) Values added in v1.19.0 

func (HookFailureMode) Values() []HookFailureMode

Values returns all known values for HookFailureMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type HookInvocationPoint added in v1.19.0 

type HookInvocationPoint string
const (
	HookInvocationPointPreProvision HookInvocationPoint = "PRE_PROVISION"
)

Enum values for HookInvocationPoint

func (HookInvocationPoint) Values added in v1.19.0 

func (HookInvocationPoint) Values() []HookInvocationPoint

Values returns all known values for HookInvocationPoint. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type HookResultNotFoundException added in v1.56.0 

type HookResultNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified target doesn't have any requested Hook invocations.

func (*HookResultNotFoundException) Error added in v1.56.0 

func (e *HookResultNotFoundException) Error() string

func (*HookResultNotFoundException) ErrorCode added in v1.56.0 

func (e *HookResultNotFoundException) ErrorCode() string

func (*HookResultNotFoundException) ErrorFault added in v1.56.0 

func (e *HookResultNotFoundException) ErrorFault() smithy.ErrorFault

func (*HookResultNotFoundException) ErrorMessage added in v1.56.0 

func (e *HookResultNotFoundException) ErrorMessage() string

type HookResultSummary added in v1.56.0 

type HookResultSummary struct {

	// The failure mode of the invocation. The following are potential modes:
	//
	//   - FAIL : If the hook invocation returns a failure, then the requested target
	//   operation should fail.
	//
	//   - WARN : If the hook invocation returns a failure, then the requested target
	//   operation should warn.
	FailureMode HookFailureMode

	// A description of the Hook results status. For example, if the Hook result is in
	// a FAILED state, this may contain additional information for the FAILED state.
	HookStatusReason *string

	// The exact point in the provisioning logic where the Hook runs.
	InvocationPoint HookInvocationPoint

	// The state of the Hook invocation.
	Status HookStatus

	// The version of the Hook type configuration.
	TypeConfigurationVersionId *string

	// The type name of the Hook being invoked.
	TypeName *string

	// The version of the Hook being invoked.
	TypeVersionId *string
	// contains filtered or unexported fields
}

Describes a Hook invocation, its status, and the reason for its status.

type HookStatus added in v1.19.0 

type HookStatus string
const (
	HookStatusHookInProgress        HookStatus = "HOOK_IN_PROGRESS"
	HookStatusHookCompleteSucceeded HookStatus = "HOOK_COMPLETE_SUCCEEDED"
	HookStatusHookCompleteFailed    HookStatus = "HOOK_COMPLETE_FAILED"
	HookStatusHookFailed            HookStatus = "HOOK_FAILED"
)

Enum values for HookStatus

func (HookStatus) Values added in v1.19.0 

func (HookStatus) Values() []HookStatus

Values returns all known values for HookStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type HookTargetType added in v1.19.0 

type HookTargetType string
const (
	HookTargetTypeResource HookTargetType = "RESOURCE"
)

Enum values for HookTargetType

func (HookTargetType) Values added in v1.19.0 

func (HookTargetType) Values() []HookTargetType

Values returns all known values for HookTargetType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type IdentityProvider added in v1.6.0 

type IdentityProvider string
const (
	IdentityProviderAwsMarketplace IdentityProvider = "AWS_Marketplace"
	IdentityProviderGitHub         IdentityProvider = "GitHub"
	IdentityProviderBitbucket      IdentityProvider = "Bitbucket"
)

Enum values for IdentityProvider

func (IdentityProvider) Values added in v1.6.0 

func (IdentityProvider) Values() []IdentityProvider

Values returns all known values for IdentityProvider. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type InsufficientCapabilitiesException 

type InsufficientCapabilitiesException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The template contains resources with capabilities that weren't specified in the Capabilities parameter.

func (*InsufficientCapabilitiesException) Error 

func (e *InsufficientCapabilitiesException) Error() string

func (*InsufficientCapabilitiesException) ErrorCode 

func (e *InsufficientCapabilitiesException) ErrorCode() string

func (*InsufficientCapabilitiesException) ErrorFault 

func (e *InsufficientCapabilitiesException) ErrorFault() smithy.ErrorFault

func (*InsufficientCapabilitiesException) ErrorMessage 

func (e *InsufficientCapabilitiesException) ErrorMessage() string

type InvalidChangeSetStatusException 

type InvalidChangeSetStatusException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified change set can't be used to update the stack. For example, the change set status might be CREATE_IN_PROGRESS , or the stack status might be UPDATE_IN_PROGRESS .

func (*InvalidChangeSetStatusException) Error 

func (e *InvalidChangeSetStatusException) Error() string

func (*InvalidChangeSetStatusException) ErrorCode 

func (e *InvalidChangeSetStatusException) ErrorCode() string

func (*InvalidChangeSetStatusException) ErrorFault 

func (e *InvalidChangeSetStatusException) ErrorFault() smithy.ErrorFault

func (*InvalidChangeSetStatusException) ErrorMessage 

func (e *InvalidChangeSetStatusException) ErrorMessage() string

type InvalidOperationException 

type InvalidOperationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified operation isn't valid.

func (*InvalidOperationException) Error 

func (e *InvalidOperationException) Error() string

func (*InvalidOperationException) ErrorCode 

func (e *InvalidOperationException) ErrorCode() string

func (*InvalidOperationException) ErrorFault 

func (e *InvalidOperationException) ErrorFault() smithy.ErrorFault

func (*InvalidOperationException) ErrorMessage 

func (e *InvalidOperationException) ErrorMessage() string

type InvalidStateTransitionException 

type InvalidStateTransitionException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Error reserved for use by the CloudFormation CLI. CloudFormation doesn't return this error to users.

func (*InvalidStateTransitionException) Error 

func (e *InvalidStateTransitionException) Error() string

func (*InvalidStateTransitionException) ErrorCode 

func (e *InvalidStateTransitionException) ErrorCode() string

func (*InvalidStateTransitionException) ErrorFault 

func (e *InvalidStateTransitionException) ErrorFault() smithy.ErrorFault

func (*InvalidStateTransitionException) ErrorMessage 

func (e *InvalidStateTransitionException) ErrorMessage() string

type LimitExceededException 

type LimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The quota for the resource has already been reached.

For information about resource and stack limitations, see CloudFormation quotas in the CloudFormation User Guide.

func (*LimitExceededException) Error 

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode 

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault 

func (e *LimitExceededException) ErrorFault() smithy.ErrorFault

func (*LimitExceededException) ErrorMessage 

func (e *LimitExceededException) ErrorMessage() string

type ListHookResultsTargetType added in v1.56.0 

type ListHookResultsTargetType string
const (
	ListHookResultsTargetTypeChangeSet    ListHookResultsTargetType = "CHANGE_SET"
	ListHookResultsTargetTypeStack        ListHookResultsTargetType = "STACK"
	ListHookResultsTargetTypeResource     ListHookResultsTargetType = "RESOURCE"
	ListHookResultsTargetTypeCloudControl ListHookResultsTargetType = "CLOUD_CONTROL"
)

Enum values for ListHookResultsTargetType

func (ListHookResultsTargetType) Values added in v1.56.0 

func (ListHookResultsTargetType) Values() []ListHookResultsTargetType

Values returns all known values for ListHookResultsTargetType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type LoggingConfig 

type LoggingConfig struct {

	// The Amazon CloudWatch Logs group to which CloudFormation sends error logging
	// information when invoking the extension's handlers.
	//
	// This member is required.
	LogGroupName *string

	// The Amazon Resource Name (ARN) of the role that CloudFormation should assume
	// when sending log entries to CloudWatch Logs.
	//
	// This member is required.
	LogRoleArn *string
	// contains filtered or unexported fields
}

Contains logging configuration information for an extension.

type ManagedExecution added in v1.14.0 

type ManagedExecution struct {

	// When true , StackSets performs non-conflicting operations concurrently and
	// queues conflicting operations. After conflicting operations finish, StackSets
	// starts queued operations in request order.
	//
	// If there are already running or queued operations, StackSets queues all
	// incoming operations even if they are non-conflicting.
	//
	// You can't modify your stack set's execution configuration while there are
	// running or queued operations for that stack set.
	//
	// When false (default), StackSets performs one operation at a time in request
	// order.
	Active *bool
	// contains filtered or unexported fields
}

Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

type ModuleInfo added in v0.31.0 

type ModuleInfo struct {

	// A concatenated list of the logical IDs of the module or modules containing the
	// resource. Modules are listed starting with the inner-most nested module, and
	// separated by / .
	//
	// In the following example, the resource was created from a module, moduleA ,
	// that's nested inside a parent module, moduleB .
	//
	//     moduleA/moduleB
	//
	// For more information, see [Reference module resources in CloudFormation templates] in the CloudFormation User Guide.
	//
	// [Reference module resources in CloudFormation templates]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/module-ref-resources.html
	LogicalIdHierarchy *string

	// A concatenated list of the module type or types containing the resource. Module
	// types are listed starting with the inner-most nested module, and separated by / .
	//
	// In the following example, the resource was created from a module of type
	// AWS::First::Example::MODULE , that's nested inside a parent module of type
	// AWS::Second::Example::MODULE .
	//
	//     AWS::First::Example::MODULE/AWS::Second::Example::MODULE
	TypeHierarchy *string
	// contains filtered or unexported fields
}

Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

For more information about modules, see Create reusable resource configurations that can be included across templates with CloudFormation modules in the CloudFormation User Guide.

type NameAlreadyExistsException 

type NameAlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified name is already in use.

func (*NameAlreadyExistsException) Error 

func (e *NameAlreadyExistsException) Error() string

func (*NameAlreadyExistsException) ErrorCode 

func (e *NameAlreadyExistsException) ErrorCode() string

func (*NameAlreadyExistsException) ErrorFault 

func (e *NameAlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*NameAlreadyExistsException) ErrorMessage 

func (e *NameAlreadyExistsException) ErrorMessage() string

type OnFailure 

type OnFailure string
const (
	OnFailureDoNothing OnFailure = "DO_NOTHING"
	OnFailureRollback  OnFailure = "ROLLBACK"
	OnFailureDelete    OnFailure = "DELETE"
)

Enum values for OnFailure

func (OnFailure) Values added in v0.29.0 

func (OnFailure) Values() []OnFailure

Values returns all known values for OnFailure. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type OnStackFailure added in v1.30.0 

type OnStackFailure string
const (
	OnStackFailureDoNothing OnStackFailure = "DO_NOTHING"
	OnStackFailureRollback  OnStackFailure = "ROLLBACK"
	OnStackFailureDelete    OnStackFailure = "DELETE"
)

Enum values for OnStackFailure

func (OnStackFailure) Values added in v1.30.0 

func (OnStackFailure) Values() []OnStackFailure

Values returns all known values for OnStackFailure. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type OperationIdAlreadyExistsException 

type OperationIdAlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified operation ID already exists.

func (*OperationIdAlreadyExistsException) Error 

func (e *OperationIdAlreadyExistsException) Error() string

func (*OperationIdAlreadyExistsException) ErrorCode 

func (e *OperationIdAlreadyExistsException) ErrorCode() string

func (*OperationIdAlreadyExistsException) ErrorFault 

func (e *OperationIdAlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*OperationIdAlreadyExistsException) ErrorMessage 

func (e *OperationIdAlreadyExistsException) ErrorMessage() string

type OperationInProgressException 

type OperationInProgressException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Another operation is currently in progress for this stack set. Only one operation can be performed for a stack set at a given time.

func (*OperationInProgressException) Error 

func (e *OperationInProgressException) Error() string

func (*OperationInProgressException) ErrorCode 

func (e *OperationInProgressException) ErrorCode() string

func (*OperationInProgressException) ErrorFault 

func (e *OperationInProgressException) ErrorFault() smithy.ErrorFault

func (*OperationInProgressException) ErrorMessage 

func (e *OperationInProgressException) ErrorMessage() string

type OperationNotFoundException 

type OperationNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified ID refers to an operation that doesn't exist.

func (*OperationNotFoundException) Error 

func (e *OperationNotFoundException) Error() string

func (*OperationNotFoundException) ErrorCode 

func (e *OperationNotFoundException) ErrorCode() string

func (*OperationNotFoundException) ErrorFault 

func (e *OperationNotFoundException) ErrorFault() smithy.ErrorFault

func (*OperationNotFoundException) ErrorMessage 

func (e *OperationNotFoundException) ErrorMessage() string

type OperationResultFilter added in v1.23.0 

type OperationResultFilter struct {

	// The type of filter to apply.
	Name OperationResultFilterName

	// The value to filter by.
	Values *string
	// contains filtered or unexported fields
}

The status that operation results are filtered by.

type OperationResultFilterName added in v1.23.0 

type OperationResultFilterName string
const (
	OperationResultFilterNameOperationResultStatus OperationResultFilterName = "OPERATION_RESULT_STATUS"
)

Enum values for OperationResultFilterName

func (OperationResultFilterName) Values added in v1.23.0 

func (OperationResultFilterName) Values() []OperationResultFilterName

Values returns all known values for OperationResultFilterName. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type OperationStatus 

type OperationStatus string
const (
	OperationStatusPending    OperationStatus = "PENDING"
	OperationStatusInProgress OperationStatus = "IN_PROGRESS"
	OperationStatusSuccess    OperationStatus = "SUCCESS"
	OperationStatusFailed     OperationStatus = "FAILED"
)

Enum values for OperationStatus

func (OperationStatus) Values added in v0.29.0 

func (OperationStatus) Values() []OperationStatus

Values returns all known values for OperationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type OperationStatusCheckFailedException 

type OperationStatusCheckFailedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Error reserved for use by the CloudFormation CLI. CloudFormation doesn't return this error to users.

func (*OperationStatusCheckFailedException) Error 

func (e *OperationStatusCheckFailedException) Error() string

func (*OperationStatusCheckFailedException) ErrorCode 

func (e *OperationStatusCheckFailedException) ErrorCode() string

func (*OperationStatusCheckFailedException) ErrorFault 

func (e *OperationStatusCheckFailedException) ErrorFault() smithy.ErrorFault

func (*OperationStatusCheckFailedException) ErrorMessage 

func (e *OperationStatusCheckFailedException) ErrorMessage() string

type OrganizationStatus added in v1.28.0 

type OrganizationStatus string
const (
	OrganizationStatusEnabled             OrganizationStatus = "ENABLED"
	OrganizationStatusDisabled            OrganizationStatus = "DISABLED"
	OrganizationStatusDisabledPermanently OrganizationStatus = "DISABLED_PERMANENTLY"
)

Enum values for OrganizationStatus

func (OrganizationStatus) Values added in v1.28.0 

func (OrganizationStatus) Values() []OrganizationStatus

Values returns all known values for OrganizationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Output 

type Output struct {

	// User defined description associated with the output.
	Description *string

	// The name of the export associated with the output.
	ExportName *string

	// The key associated with the output.
	OutputKey *string

	// The value associated with the output.
	OutputValue *string
	// contains filtered or unexported fields
}

The Output data type.

type Parameter 

type Parameter struct {

	// The key associated with the parameter. If you don't specify a key and value for
	// a particular parameter, CloudFormation uses the default value that's specified
	// in your template.
	ParameterKey *string

	// The input value associated with the parameter.
	ParameterValue *string

	// Read-only. The value that corresponds to a Systems Manager parameter key. This
	// field is returned only for Systems Manager parameter types in the template. For
	// more information, see [Use CloudFormation-supplied parameter types]in the CloudFormation User Guide.
	//
	// [Use CloudFormation-supplied parameter types]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-supplied-parameter-types.html
	ResolvedValue *string

	// During a stack update, use the existing parameter value that the stack is using
	// for a given parameter key. If you specify true , do not specify a parameter
	// value.
	UsePreviousValue *bool
	// contains filtered or unexported fields
}

The Parameter data type.

type ParameterConstraints 

type ParameterConstraints struct {

	// A list of values that are permitted for a parameter.
	AllowedValues []string
	// contains filtered or unexported fields
}

A set of criteria that CloudFormation uses to validate parameter values. Although other constraints might be defined in the stack template, CloudFormation returns only the AllowedValues property.

type ParameterDeclaration 

type ParameterDeclaration struct {

	// The default value of the parameter.
	DefaultValue *string

	// The description that's associate with the parameter.
	Description *string

	// Flag that indicates whether the parameter value is shown as plain text in logs
	// and in the Amazon Web Services Management Console.
	NoEcho *bool

	// The criteria that CloudFormation uses to validate parameter values.
	ParameterConstraints *ParameterConstraints

	// The name that's associated with the parameter.
	ParameterKey *string

	// The type of parameter.
	ParameterType *string
	// contains filtered or unexported fields
}

The ParameterDeclaration data type.

type PermissionModels 

type PermissionModels string
const (
	PermissionModelsServiceManaged PermissionModels = "SERVICE_MANAGED"
	PermissionModelsSelfManaged    PermissionModels = "SELF_MANAGED"
)

Enum values for PermissionModels

func (PermissionModels) Values added in v0.29.0 

func (PermissionModels) Values() []PermissionModels

Values returns all known values for PermissionModels. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PhysicalResourceIdContextKeyValuePair 

type PhysicalResourceIdContextKeyValuePair struct {

	// The resource context key.
	//
	// This member is required.
	Key *string

	// The resource context value.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context key-value pair specifies a resource that contains the targeted resource.

type PolicyAction added in v1.49.0 

type PolicyAction string
const (
	PolicyActionDelete             PolicyAction = "Delete"
	PolicyActionRetain             PolicyAction = "Retain"
	PolicyActionSnapshot           PolicyAction = "Snapshot"
	PolicyActionReplaceAndDelete   PolicyAction = "ReplaceAndDelete"
	PolicyActionReplaceAndRetain   PolicyAction = "ReplaceAndRetain"
	PolicyActionReplaceAndSnapshot PolicyAction = "ReplaceAndSnapshot"
)

Enum values for PolicyAction

func (PolicyAction) Values added in v1.49.0 

func (PolicyAction) Values() []PolicyAction

Values returns all known values for PolicyAction. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PropertyDifference 

type PropertyDifference struct {

	// The actual property value of the resource property.
	//
	// This member is required.
	ActualValue *string

	// The type of property difference.
	//
	//   - ADD : A value has been added to a resource property that's an array or list
	//   data type.
	//
	//   - REMOVE : The property has been removed from the current resource
	//   configuration.
	//
	//   - NOT_EQUAL : The current property value differs from its expected value (as
	//   defined in the stack template and any values specified as template parameters).
	//
	// This member is required.
	DifferenceType DifferenceType

	// The expected property value of the resource property, as defined in the stack
	// template and any values specified as template parameters.
	//
	// This member is required.
	ExpectedValue *string

	// The fully-qualified path to the resource property.
	//
	// This member is required.
	PropertyPath *string
	// contains filtered or unexported fields
}

Information about a resource property whose actual value differs from its expected value, as defined in the stack template and any values specified as template parameters. These will be present only for resources whose StackResourceDriftStatus is MODIFIED . For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.

type ProvisioningType 

type ProvisioningType string
const (
	ProvisioningTypeNonProvisionable ProvisioningType = "NON_PROVISIONABLE"
	ProvisioningTypeImmutable        ProvisioningType = "IMMUTABLE"
	ProvisioningTypeFullyMutable     ProvisioningType = "FULLY_MUTABLE"
)

Enum values for ProvisioningType

func (ProvisioningType) Values added in v0.29.0 

func (ProvisioningType) Values() []ProvisioningType

Values returns all known values for ProvisioningType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PublisherStatus added in v1.6.0 

type PublisherStatus string
const (
	PublisherStatusVerified   PublisherStatus = "VERIFIED"
	PublisherStatusUnverified PublisherStatus = "UNVERIFIED"
)

Enum values for PublisherStatus

func (PublisherStatus) Values added in v1.6.0 

func (PublisherStatus) Values() []PublisherStatus

Values returns all known values for PublisherStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RegionConcurrencyType added in v1.3.0 

type RegionConcurrencyType string
const (
	RegionConcurrencyTypeSequential RegionConcurrencyType = "SEQUENTIAL"
	RegionConcurrencyTypeParallel   RegionConcurrencyType = "PARALLEL"
)

Enum values for RegionConcurrencyType

func (RegionConcurrencyType) Values added in v1.3.0 

func (RegionConcurrencyType) Values() []RegionConcurrencyType

Values returns all known values for RegionConcurrencyType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RegistrationStatus 

type RegistrationStatus string
const (
	RegistrationStatusComplete   RegistrationStatus = "COMPLETE"
	RegistrationStatusInProgress RegistrationStatus = "IN_PROGRESS"
	RegistrationStatusFailed     RegistrationStatus = "FAILED"
)

Enum values for RegistrationStatus

func (RegistrationStatus) Values added in v0.29.0 

func (RegistrationStatus) Values() []RegistrationStatus

Values returns all known values for RegistrationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RegistryType 

type RegistryType string
const (
	RegistryTypeResource RegistryType = "RESOURCE"
	RegistryTypeModule   RegistryType = "MODULE"
	RegistryTypeHook     RegistryType = "HOOK"
)

Enum values for RegistryType

func (RegistryType) Values added in v0.29.0 

func (RegistryType) Values() []RegistryType

Values returns all known values for RegistryType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Replacement 

type Replacement string
const (
	ReplacementTrue        Replacement = "True"
	ReplacementFalse       Replacement = "False"
	ReplacementConditional Replacement = "Conditional"
)

Enum values for Replacement

func (Replacement) Values added in v0.29.0 

func (Replacement) Values() []Replacement

Values returns all known values for Replacement. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RequiredActivatedType added in v1.6.0 

type RequiredActivatedType struct {

	// 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 [Use aliases to refer to extensions]in the CloudFormation User Guide.
	//
	// [Use aliases to refer to extensions]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias
	OriginalTypeName *string

	// The publisher ID of the extension publisher.
	PublisherId *string

	// A list of the major versions of the extension type that the macro supports.
	SupportedMajorVersions []int32

	// An alias assigned 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.
	TypeNameAlias *string
	// contains filtered or unexported fields
}

For extensions that are modules, a public third-party extension that must be activated in your account in order for the module itself to be activated.

For more information, see Requirements for activating third-party public modules in the CloudFormation User Guide.

type RequiresRecreation 

type RequiresRecreation string
const (
	RequiresRecreationNever         RequiresRecreation = "Never"
	RequiresRecreationConditionally RequiresRecreation = "Conditionally"
	RequiresRecreationAlways        RequiresRecreation = "Always"
)

Enum values for RequiresRecreation

func (RequiresRecreation) Values added in v0.29.0 

func (RequiresRecreation) Values() []RequiresRecreation

Values returns all known values for RequiresRecreation. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceAttribute 

type ResourceAttribute string
const (
	ResourceAttributeProperties          ResourceAttribute = "Properties"
	ResourceAttributeMetadata            ResourceAttribute = "Metadata"
	ResourceAttributeCreationPolicy      ResourceAttribute = "CreationPolicy"
	ResourceAttributeUpdatePolicy        ResourceAttribute = "UpdatePolicy"
	ResourceAttributeDeletionPolicy      ResourceAttribute = "DeletionPolicy"
	ResourceAttributeUpdateReplacePolicy ResourceAttribute = "UpdateReplacePolicy"
	ResourceAttributeTags                ResourceAttribute = "Tags"
)

Enum values for ResourceAttribute

func (ResourceAttribute) Values added in v0.29.0 

func (ResourceAttribute) Values() []ResourceAttribute

Values returns all known values for ResourceAttribute. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceChange 

type ResourceChange struct {

	// The action that CloudFormation takes on the resource, such as Add (adds a new
	// resource), Modify (changes a resource), Remove (deletes a resource), Import
	// (imports a resource), or Dynamic (exact action for the resource can't be
	// determined).
	Action ChangeAction

	// An encoded JSON string containing the context of the resource after the change
	// is executed.
	AfterContext *string

	// An encoded JSON string containing the context of the resource before the change
	// is executed.
	BeforeContext *string

	// The change set ID of the nested change set.
	ChangeSetId *string

	// For the Modify action, a list of ResourceChangeDetail structures that describes
	// the changes that CloudFormation will make to the resource.
	Details []ResourceChangeDetail

	// The resource's logical ID, which is defined in the stack's template.
	LogicalResourceId *string

	// Contains information about the module from which the resource was created, if
	// the resource was created from a module included in the stack template.
	ModuleInfo *ModuleInfo

	// The resource's physical ID (resource name). Resources that you are adding don't
	// have physical IDs because they haven't been created.
	PhysicalResourceId *string

	// The action that will be taken on the physical resource when the change set is
	// executed.
	//
	//   - Delete The resource will be deleted.
	//
	//   - Retain The resource will be retained.
	//
	//   - Snapshot The resource will have a snapshot taken.
	//
	//   - ReplaceAndDelete The resource will be replaced and then deleted.
	//
	//   - ReplaceAndRetain The resource will be replaced and then retained.
	//
	//   - ReplaceAndSnapshot The resource will be replaced and then have a snapshot
	//   taken.
	PolicyAction PolicyAction

	// For the Modify action, indicates whether CloudFormation will replace the
	// resource by creating a new one and deleting the old one. This value depends on
	// the value of the RequiresRecreation property in the ResourceTargetDefinition
	// structure. For example, if the RequiresRecreation field is Always and the
	// Evaluation field is Static , Replacement is True . If the RequiresRecreation
	// field is Always and the Evaluation field is Dynamic , Replacement is Conditional
	// .
	//
	// If you have multiple changes with different RequiresRecreation values, the
	// Replacement value depends on the change with the most impact. A
	// RequiresRecreation value of Always has the most impact, followed by Conditional
	// , and then Never .
	Replacement Replacement

	// The type of CloudFormation resource, such as AWS::S3::Bucket .
	ResourceType *string

	// For the Modify action, indicates which resource attribute is triggering this
	// update, such as a change in the resource attribute's Metadata , Properties , or
	// Tags .
	Scope []ResourceAttribute
	// contains filtered or unexported fields
}

The ResourceChange structure describes the resource and the action that CloudFormation will perform on it if you execute this change set.

type ResourceChangeDetail 

type ResourceChangeDetail struct {

	// The identity of the entity that triggered this change. This entity is a member
	// of the group that's specified by the ChangeSource field. For example, if you
	// modified the value of the KeyPairName parameter, the CausingEntity is the name
	// of the parameter ( KeyPairName ).
	//
	// If the ChangeSource value is DirectModification , no value is given for
	// CausingEntity .
	CausingEntity *string

	// The group to which the CausingEntity value belongs. There are five entity
	// groups:
	//
	//   - ResourceReference entities are Ref intrinsic functions that refer to
	//   resources in the template, such as { "Ref" : "MyEC2InstanceResource" } .
	//
	//   - ParameterReference entities are Ref intrinsic functions that get template
	//   parameter values, such as { "Ref" : "MyPasswordParameter" } .
	//
	//   - ResourceAttribute entities are Fn::GetAtt intrinsic functions that get
	//   resource attribute values, such as { "Fn::GetAtt" : [
	//   "MyEC2InstanceResource", "PublicDnsName" ] } .
	//
	//   - DirectModification entities are changes that are made directly to the
	//   template.
	//
	//   - Automatic entities are AWS::CloudFormation::Stack resource types, which are
	//   also known as nested stacks. If you made no changes to the
	//   AWS::CloudFormation::Stack resource, CloudFormation sets the ChangeSource to
	//   Automatic because the nested stack's template might have changed. Changes to a
	//   nested stack's template aren't visible to CloudFormation until you run an update
	//   on the parent stack.
	ChangeSource ChangeSource

	// Indicates whether CloudFormation can determine the target value, and whether
	// the target value will change before you execute a change set.
	//
	// For Static evaluations, CloudFormation can determine that the target value will
	// change, and its value. For example, if you directly modify the InstanceType
	// property of an EC2 instance, CloudFormation knows that this property value will
	// change, and its value, so this is a Static evaluation.
	//
	// For Dynamic evaluations, can't determine the target value because it depends on
	// the result of an intrinsic function, such as a Ref or Fn::GetAtt intrinsic
	// function, when the stack is updated. For example, if your template includes a
	// reference to a resource that's conditionally recreated, the value of the
	// reference (the physical ID of the resource) might change, depending on if the
	// resource is recreated. If the resource is recreated, it will have a new physical
	// ID, so all references to that resource will also be updated.
	Evaluation EvaluationType

	// A ResourceTargetDefinition structure that describes the field that
	// CloudFormation will change and whether the resource will be recreated.
	Target *ResourceTargetDefinition
	// contains filtered or unexported fields
}

For a resource with Modify as the action, the ResourceChange structure describes the changes CloudFormation will make to that resource.

type ResourceDefinition added in v1.43.0 

type ResourceDefinition struct {

	// A list of up to 256 key-value pairs that identifies the scanned resource. The
	// key is the name of one of the primary identifiers for the resource. (Primary
	// identifiers are specified in the primaryIdentifier list in the resource
	// schema.) The value is the value of that primary identifier. For example, for a
	// AWS::DynamoDB::Table resource, the primary identifiers is TableName so the
	// key-value pair could be "TableName": "MyDDBTable" . For more information, see [primaryIdentifier]
	// in the CloudFormation Command Line Interface (CLI) User Guide.
	//
	// [primaryIdentifier]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-primaryidentifier
	//
	// This member is required.
	ResourceIdentifier map[string]string

	// The type of the resource, such as AWS::DynamoDB::Table . For the list of
	// supported resources, see [Resource type support for imports and drift detection]in the CloudFormation User Guide
	//
	// [Resource type support for imports and drift detection]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html
	//
	// This member is required.
	ResourceType *string

	// The logical resource id for this resource in the generated template.
	LogicalResourceId *string
	// contains filtered or unexported fields
}

A resource included in a generated template. This data type is used with the CreateGeneratedTemplate and UpdateGeneratedTemplate API actions.

type ResourceDetail added in v1.43.0 

type ResourceDetail struct {

	// The logical id for this resource in the final generated template.
	LogicalResourceId *string

	// A list of up to 256 key-value pairs that identifies the resource in the
	// generated template. The key is the name of one of the primary identifiers for
	// the resource. (Primary identifiers are specified in the primaryIdentifier list
	// in the resource schema.) The value is the value of that primary identifier. For
	// example, for a AWS::DynamoDB::Table resource, the primary identifiers is
	// TableName so the key-value pair could be "TableName": "MyDDBTable" . For more
	// information, see [primaryIdentifier]in the CloudFormation Command Line Interface (CLI) User Guide.
	//
	// [primaryIdentifier]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-primaryidentifier
	ResourceIdentifier map[string]string

	// Status of the processing of a resource in a generated template.
	//
	// InProgress
	//
	// The resource processing is still in progress.
	//
	// Complete
	//
	// The resource processing is complete.
	//
	// Pending
	//
	// The resource processing is pending.
	//
	// Failed
	//
	// The resource processing has failed.
	ResourceStatus GeneratedTemplateResourceStatus

	// The reason for the resource detail, providing more information if a failure
	// happened.
	ResourceStatusReason *string

	// The type of the resource, such as AWS::DynamoDB::Table . For the list of
	// supported resources, see [Resource type support for imports and drift detection]In the CloudFormation User Guide
	//
	// [Resource type support for imports and drift detection]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html
	ResourceType *string

	// The warnings generated for this resource.
	Warnings []WarningDetail
	// contains filtered or unexported fields
}

Details about a resource in a generated template

type ResourceIdentifierSummary 

type ResourceIdentifierSummary struct {

	// The logical IDs of the target resources of the specified ResourceType , as
	// defined in the import template.
	LogicalResourceIds []string

	// The resource properties you can provide during the import to identify your
	// target resources. For example, BucketName is a possible identifier property for
	// AWS::S3::Bucket resources.
	ResourceIdentifiers []string

	// The template resource type of the target resources, such as AWS::S3::Bucket .
	ResourceType *string
	// contains filtered or unexported fields
}

Describes the target resources of a specific type in your import template (for example, all AWS::S3::Bucket resources) and the properties you can provide during the import to identify resources of that type.

type ResourceScanInProgressException added in v1.43.0 

type ResourceScanInProgressException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

A resource scan is currently in progress. Only one can be run at a time for an account in a Region.

func (*ResourceScanInProgressException) Error added in v1.43.0 

func (e *ResourceScanInProgressException) Error() string

func (*ResourceScanInProgressException) ErrorCode added in v1.43.0 

func (e *ResourceScanInProgressException) ErrorCode() string

func (*ResourceScanInProgressException) ErrorFault added in v1.43.0 

func (e *ResourceScanInProgressException) ErrorFault() smithy.ErrorFault

func (*ResourceScanInProgressException) ErrorMessage added in v1.43.0 

func (e *ResourceScanInProgressException) ErrorMessage() string

type ResourceScanLimitExceededException added in v1.43.0 

type ResourceScanLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The limit on resource scans has been exceeded. Reasons include:

  • Exceeded the daily quota for resource scans.

  • A resource scan recently failed. You must wait 10 minutes before starting a new resource scan.

  • The last resource scan failed after exceeding 100,000 resources. When this happens, you must wait 24 hours before starting a new resource scan.

func (*ResourceScanLimitExceededException) Error added in v1.43.0 

func (e *ResourceScanLimitExceededException) Error() string

func (*ResourceScanLimitExceededException) ErrorCode added in v1.43.0 

func (e *ResourceScanLimitExceededException) ErrorCode() string

func (*ResourceScanLimitExceededException) ErrorFault added in v1.43.0 

func (e *ResourceScanLimitExceededException) ErrorFault() smithy.ErrorFault

func (*ResourceScanLimitExceededException) ErrorMessage added in v1.43.0 

func (e *ResourceScanLimitExceededException) ErrorMessage() string

type ResourceScanNotFoundException added in v1.43.0 

type ResourceScanNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The resource scan was not found.

func (*ResourceScanNotFoundException) Error added in v1.43.0 

func (e *ResourceScanNotFoundException) Error() string

func (*ResourceScanNotFoundException) ErrorCode added in v1.43.0 

func (e *ResourceScanNotFoundException) ErrorCode() string

func (*ResourceScanNotFoundException) ErrorFault added in v1.43.0 

func (e *ResourceScanNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceScanNotFoundException) ErrorMessage added in v1.43.0 

func (e *ResourceScanNotFoundException) ErrorMessage() string

type ResourceScanStatus added in v1.43.0 

type ResourceScanStatus string
const (
	ResourceScanStatusInProgress ResourceScanStatus = "IN_PROGRESS"
	ResourceScanStatusFailed     ResourceScanStatus = "FAILED"
	ResourceScanStatusComplete   ResourceScanStatus = "COMPLETE"
	ResourceScanStatusExpired    ResourceScanStatus = "EXPIRED"
)

Enum values for ResourceScanStatus

func (ResourceScanStatus) Values added in v1.43.0 

func (ResourceScanStatus) Values() []ResourceScanStatus

Values returns all known values for ResourceScanStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceScanSummary added in v1.43.0 

type ResourceScanSummary struct {

	// The time that the resource scan was finished.
	EndTime *time.Time

	// The percentage of the resource scan that has been completed.
	PercentageCompleted *float64

	// The Amazon Resource Name (ARN) of the resource scan.
	ResourceScanId *string

	// The time that the resource scan was started.
	StartTime *time.Time

	// Status of the resource scan.
	//
	// INPROGRESS
	//
	// The resource scan is still in progress.
	//
	// COMPLETE
	//
	// The resource scan is complete.
	//
	// EXPIRED
	//
	// The resource scan has expired.
	//
	// FAILED
	//
	// The resource scan has failed.
	Status ResourceScanStatus

	// The reason for the resource scan status, providing more information if a
	// failure happened.
	StatusReason *string
	// contains filtered or unexported fields
}

A summary of the resource scan. This is returned by the ListResourceScan API action.

type ResourceSignalStatus 

type ResourceSignalStatus string
const (
	ResourceSignalStatusSuccess ResourceSignalStatus = "SUCCESS"
	ResourceSignalStatusFailure ResourceSignalStatus = "FAILURE"
)

Enum values for ResourceSignalStatus

func (ResourceSignalStatus) Values added in v0.29.0 

func (ResourceSignalStatus) Values() []ResourceSignalStatus

Values returns all known values for ResourceSignalStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceStatus 

type ResourceStatus string
const (
	ResourceStatusCreateInProgress         ResourceStatus = "CREATE_IN_PROGRESS"
	ResourceStatusCreateFailed             ResourceStatus = "CREATE_FAILED"
	ResourceStatusCreateComplete           ResourceStatus = "CREATE_COMPLETE"
	ResourceStatusDeleteInProgress         ResourceStatus = "DELETE_IN_PROGRESS"
	ResourceStatusDeleteFailed             ResourceStatus = "DELETE_FAILED"
	ResourceStatusDeleteComplete           ResourceStatus = "DELETE_COMPLETE"
	ResourceStatusDeleteSkipped            ResourceStatus = "DELETE_SKIPPED"
	ResourceStatusUpdateInProgress         ResourceStatus = "UPDATE_IN_PROGRESS"
	ResourceStatusUpdateFailed             ResourceStatus = "UPDATE_FAILED"
	ResourceStatusUpdateComplete           ResourceStatus = "UPDATE_COMPLETE"
	ResourceStatusImportFailed             ResourceStatus = "IMPORT_FAILED"
	ResourceStatusImportComplete           ResourceStatus = "IMPORT_COMPLETE"
	ResourceStatusImportInProgress         ResourceStatus = "IMPORT_IN_PROGRESS"
	ResourceStatusImportRollbackInProgress ResourceStatus = "IMPORT_ROLLBACK_IN_PROGRESS"
	ResourceStatusImportRollbackFailed     ResourceStatus = "IMPORT_ROLLBACK_FAILED"
	ResourceStatusImportRollbackComplete   ResourceStatus = "IMPORT_ROLLBACK_COMPLETE"
	ResourceStatusUpdateRollbackInProgress ResourceStatus = "UPDATE_ROLLBACK_IN_PROGRESS"
	ResourceStatusUpdateRollbackComplete   ResourceStatus = "UPDATE_ROLLBACK_COMPLETE"
	ResourceStatusUpdateRollbackFailed     ResourceStatus = "UPDATE_ROLLBACK_FAILED"
	ResourceStatusRollbackInProgress       ResourceStatus = "ROLLBACK_IN_PROGRESS"
	ResourceStatusRollbackComplete         ResourceStatus = "ROLLBACK_COMPLETE"
	ResourceStatusRollbackFailed           ResourceStatus = "ROLLBACK_FAILED"
)

Enum values for ResourceStatus

func (ResourceStatus) Values added in v0.29.0 

func (ResourceStatus) Values() []ResourceStatus

Values returns all known values for ResourceStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceTargetDefinition 

type ResourceTargetDefinition struct {

	// The value of the property after the change is executed. Large values can be
	// truncated.
	AfterValue *string

	// Indicates which resource attribute is triggering this update, such as a change
	// in the resource attribute's Metadata , Properties , or Tags .
	Attribute ResourceAttribute

	// The type of change to be made to the property if the change is executed.
	//
	//   - Add The item will be added.
	//
	//   - Remove The item will be removed.
	//
	//   - Modify The item will be modified.
	AttributeChangeType AttributeChangeType

	// The value of the property before the change is executed. Large values can be
	// truncated.
	BeforeValue *string

	// If the Attribute value is Properties , the name of the property. For all other
	// attributes, the value is null.
	Name *string

	// The property path of the property.
	Path *string

	// If the Attribute value is Properties , indicates whether a change to this
	// property causes the resource to be recreated. The value can be Never , Always ,
	// or Conditionally . To determine the conditions for a Conditionally recreation,
	// see the update behavior for that property in the [Amazon Web Services resource and property types reference]in the CloudFormation User
	// Guide.
	//
	// [Amazon Web Services resource and property types reference]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html
	RequiresRecreation RequiresRecreation
	// contains filtered or unexported fields
}

The field that CloudFormation will change, such as the name of a resource's property, and whether the resource will be recreated.

type ResourceToImport 

type ResourceToImport struct {

	// The logical ID of the target resource as specified in the template.
	//
	// This member is required.
	LogicalResourceId *string

	// A key-value pair that identifies the target resource. The key is an identifier
	// property (for example, BucketName for AWS::S3::Bucket resources) and the value
	// is the actual property value (for example, MyS3Bucket ).
	//
	// This member is required.
	ResourceIdentifier map[string]string

	// The type of resource to import into your stack, such as AWS::S3::Bucket . For a
	// list of supported resource types, see [Resource type support for imports and drift detection]in the CloudFormation User Guide.
	//
	// [Resource type support for imports and drift detection]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html
	//
	// This member is required.
	ResourceType *string
	// contains filtered or unexported fields
}

Describes the target resource of an import operation.

type RollbackConfiguration 

type RollbackConfiguration struct {

	// The amount of time, in minutes, during which CloudFormation should monitor all
	// the rollback triggers after the stack creation or update operation deploys all
	// necessary resources.
	//
	// The default is 0 minutes.
	//
	// If you specify a monitoring period but don't specify any rollback triggers,
	// CloudFormation still waits the specified period of time before cleaning up old
	// resources after update operations. You can use this monitoring period to perform
	// any manual stack validation desired, and manually cancel the stack creation or
	// update (using [CancelUpdateStack], for example) as necessary.
	//
	// If you specify 0 for this parameter, CloudFormation still monitors the
	// specified rollback triggers during stack creation and update operations. Then,
	// for update operations, it begins disposing of old resources immediately once the
	// operation completes.
	//
	// [CancelUpdateStack]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CancelUpdateStack.html
	MonitoringTimeInMinutes *int32

	// The triggers to monitor during stack creation or update actions.
	//
	// By default, CloudFormation saves the rollback triggers specified for a stack
	// and applies them to any subsequent update operations for the stack, unless you
	// specify otherwise. If you do specify rollback triggers for this parameter, those
	// triggers replace any list of triggers previously specified for the stack. This
	// means:
	//
	//   - To use the rollback triggers previously specified for this stack, if any,
	//   don't specify this parameter.
	//
	//   - To specify new or updated rollback triggers, you must specify all the
	//   triggers that you want used for this stack, even triggers you've specified
	//   before (for example, when creating the stack or during a previous stack update).
	//   Any triggers that you don't include in the updated list of triggers are no
	//   longer applied to the stack.
	//
	//   - To remove all currently specified triggers, specify an empty list for this
	//   parameter.
	//
	// If a specified trigger is missing, the entire stack operation fails and is
	// rolled back.
	RollbackTriggers []RollbackTrigger
	// contains filtered or unexported fields
}

Structure containing the rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

Rollback triggers enable you to have CloudFormation monitor the state of your application during stack creation and updating, and to roll back that operation if the application breaches the threshold of any of the alarms you've specified. For more information, see Roll back your CloudFormation stack on alarm breach with rollback triggers.

type RollbackTrigger 

type RollbackTrigger struct {

	// The Amazon Resource Name (ARN) of the rollback trigger.
	//
	// If a specified trigger is missing, the entire stack operation fails and is
	// rolled back.
	//
	// This member is required.
	Arn *string

	// The resource type of the rollback trigger. Specify either [AWS::CloudWatch::Alarm] or [AWS::CloudWatch::CompositeAlarm] resource types.
	//
	// [AWS::CloudWatch::CompositeAlarm]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html
	// [AWS::CloudWatch::Alarm]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html
	//
	// This member is required.
	Type *string
	// contains filtered or unexported fields
}

A rollback trigger CloudFormation monitors during creation and updating of stacks. If any of the alarms you specify goes to ALARM state during the stack operation or within the specified monitoring period afterwards, CloudFormation rolls back the entire stack operation.

type ScannedResource added in v1.43.0 

type ScannedResource struct {

	// If true , the resource is managed by a CloudFormation stack.
	ManagedByStack *bool

	// A list of up to 256 key-value pairs that identifies for the scanned resource.
	// The key is the name of one of the primary identifiers for the resource. (Primary
	// identifiers are specified in the primaryIdentifier list in the resource
	// schema.) The value is the value of that primary identifier. For example, for a
	// AWS::DynamoDB::Table resource, the primary identifiers is TableName so the
	// key-value pair could be "TableName": "MyDDBTable" . For more information, see [primaryIdentifier]
	// in the CloudFormation Command Line Interface (CLI) User Guide.
	//
	// [primaryIdentifier]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-primaryidentifier
	ResourceIdentifier map[string]string

	// The type of the resource, such as AWS::DynamoDB::Table . For the list of
	// supported resources, see [Resource type support for imports and drift detection]In the CloudFormation User Guide
	//
	// [Resource type support for imports and drift detection]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html
	ResourceType *string
	// contains filtered or unexported fields
}

A scanned resource returned by ListResourceScanResources or ListResourceScanRelatedResources .

type ScannedResourceIdentifier added in v1.43.0 

type ScannedResourceIdentifier struct {

	// A list of up to 256 key-value pairs that identifies the scanned resource. The
	// key is the name of one of the primary identifiers for the resource. (Primary
	// identifiers are specified in the primaryIdentifier list in the resource
	// schema.) The value is the value of that primary identifier. For example, for a
	// AWS::DynamoDB::Table resource, the primary identifiers is TableName so the
	// key-value pair could be "TableName": "MyDDBTable" . For more information, see [primaryIdentifier]
	// in the CloudFormation Command Line Interface (CLI) User Guide.
	//
	// [primaryIdentifier]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-primaryidentifier
	//
	// This member is required.
	ResourceIdentifier map[string]string

	// The type of the resource, such as AWS::DynamoDB::Table . For the list of
	// supported resources, see [Resource type support for imports and drift detection]In the CloudFormation User Guide.
	//
	// [Resource type support for imports and drift detection]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html
	//
	// This member is required.
	ResourceType *string
	// contains filtered or unexported fields
}

Identifies a scanned resource. This is used with the ListResourceScanRelatedResources API action.

type Stack 

type Stack struct {

	// The time at which the stack was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The name associated with the stack.
	//
	// This member is required.
	StackName *string

	// Current status of the stack.
	//
	// This member is required.
	StackStatus StackStatus

	// The capabilities allowed in the stack.
	Capabilities []Capability

	// The unique ID of the change set.
	ChangeSetId *string

	// Specifies the deletion mode for the stack. Possible values are:
	//
	//   - STANDARD - Use the standard behavior. Specifying this value is the same as
	//   not specifying this parameter.
	//
	//   - FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state
	//   due to resource deletion failure.
	DeletionMode DeletionMode

	// The time the stack was deleted.
	DeletionTime *time.Time

	// A user-defined description associated with the stack.
	Description *string

	// The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is
	// present, the resource or resource configuration phase has completed and the
	// stabilization of the resources is in progress. The stack sets
	// CONFIGURATION_COMPLETE when all of the resources in the stack have reached that
	// event. For more information, see [Understand CloudFormation stack creation events]in the CloudFormation User Guide.
	//
	// [Understand CloudFormation stack creation events]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html
	DetailedStatus DetailedStatus

	// Boolean to enable or disable rollback on stack creation failures:
	//
	//   - true : disable rollback.
	//
	//   - false : enable rollback.
	DisableRollback *bool

	// Information about whether a stack's actual configuration differs, or has
	// drifted, from its expected configuration, as defined in the stack template and
	// any values specified as template parameters. For more information, see [Detect unmanaged configuration changes to stacks and resources with drift detection].
	//
	// [Detect unmanaged configuration changes to stacks and resources with drift detection]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html
	DriftInformation *StackDriftInformation

	// Whether termination protection is enabled for the stack.
	//
	// For [nested stacks], termination protection is set on the root stack and can't be changed
	// directly on the nested stack. For more information, see [Protect a CloudFormation stack from being deleted]in the CloudFormation
	// User Guide.
	//
	// [nested stacks]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html
	// [Protect a CloudFormation stack from being deleted]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html
	EnableTerminationProtection *bool

	// The time the stack was last updated. This field will only be returned if the
	// stack has been updated at least once.
	LastUpdatedTime *time.Time

	// Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are
	// published.
	NotificationARNs []string

	// A list of output structures.
	Outputs []Output

	// A list of Parameter structures.
	Parameters []Parameter

	// For nested stacks--stacks created as resources for another stack--the stack ID
	// of the direct parent of this stack. For the first level of nested stacks, the
	// root stack is also the parent stack.
	//
	// For more information, see [Embed stacks within other stacks using nested stacks] in the CloudFormation User Guide.
	//
	// [Embed stacks within other stacks using nested stacks]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html
	ParentId *string

	// When set to true , newly created resources are deleted when the operation rolls
	// back. This includes newly created resources marked with a deletion policy of
	// Retain .
	//
	// Default: false
	RetainExceptOnCreate *bool

	// The Amazon Resource Name (ARN) of an IAM role that's associated with the stack.
	// During a stack operation, CloudFormation uses this role's credentials to make
	// calls on your behalf.
	RoleARN *string

	// The rollback triggers for CloudFormation to monitor during stack creation and
	// updating operations, and for the specified monitoring period afterwards.
	RollbackConfiguration *RollbackConfiguration

	// For nested stacks--stacks created as resources for another stack--the stack ID
	// of the top-level stack to which the nested stack ultimately belongs.
	//
	// For more information, see [Embed stacks within other stacks using nested stacks] in the CloudFormation User Guide.
	//
	// [Embed stacks within other stacks using nested stacks]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html
	RootId *string

	// Unique identifier of the stack.
	StackId *string

	// Success/failure message associated with the stack status.
	StackStatusReason *string

	// A list of Tag s that specify information about the stack.
	Tags []Tag

	// The amount of time within which stack creation should complete.
	TimeoutInMinutes *int32
	// contains filtered or unexported fields
}

The Stack data type.

type StackDriftDetectionStatus 

type StackDriftDetectionStatus string
const (
	StackDriftDetectionStatusDetectionInProgress StackDriftDetectionStatus = "DETECTION_IN_PROGRESS"
	StackDriftDetectionStatusDetectionFailed     StackDriftDetectionStatus = "DETECTION_FAILED"
	StackDriftDetectionStatusDetectionComplete   StackDriftDetectionStatus = "DETECTION_COMPLETE"
)

Enum values for StackDriftDetectionStatus

func (StackDriftDetectionStatus) Values added in v0.29.0 

func (StackDriftDetectionStatus) Values() []StackDriftDetectionStatus

Values returns all known values for StackDriftDetectionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StackDriftInformation 

type StackDriftInformation struct {

	// Status of the stack's actual configuration compared to its expected template
	// configuration.
	//
	//   - DRIFTED : The stack differs from its expected template configuration. A
	//   stack is considered to have drifted if one or more of its resources have
	//   drifted.
	//
	//   - NOT_CHECKED : CloudFormation hasn't 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.
	//
	// This member is required.
	StackDriftStatus StackDriftStatus

	// Most recent time when a drift detection operation was initiated on the stack,
	// or any of its individual resources that support drift detection.
	LastCheckTimestamp *time.Time
	// contains filtered or unexported fields
}

Contains information about whether the stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted.

type StackDriftInformationSummary 

type StackDriftInformationSummary struct {

	// Status of the stack's actual configuration compared to its expected template
	// configuration.
	//
	//   - DRIFTED : The stack differs from its expected template configuration. A
	//   stack is considered to have drifted if one or more of its resources have
	//   drifted.
	//
	//   - NOT_CHECKED : CloudFormation hasn't 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.
	//
	// This member is required.
	StackDriftStatus StackDriftStatus

	// Most recent time when a drift detection operation was initiated on the stack,
	// or any of its individual resources that support drift detection.
	LastCheckTimestamp *time.Time
	// contains filtered or unexported fields
}

Contains information about whether the stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted.

type StackDriftStatus 

type StackDriftStatus string
const (
	StackDriftStatusDrifted    StackDriftStatus = "DRIFTED"
	StackDriftStatusInSync     StackDriftStatus = "IN_SYNC"
	StackDriftStatusUnknown    StackDriftStatus = "UNKNOWN"
	StackDriftStatusNotChecked StackDriftStatus = "NOT_CHECKED"
)

Enum values for StackDriftStatus

func (StackDriftStatus) Values added in v0.29.0 

func (StackDriftStatus) Values() []StackDriftStatus

Values returns all known values for StackDriftStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StackEvent 

type StackEvent struct {

	// The unique ID of this event.
	//
	// This member is required.
	EventId *string

	// The unique ID name of the instance of the stack.
	//
	// This member is required.
	StackId *string

	// The name associated with a stack.
	//
	// This member is required.
	StackName *string

	// Time the status was updated.
	//
	// This member is required.
	Timestamp *time.Time

	// The token passed to the operation that generated this event.
	//
	// All events triggered by a given stack operation are assigned the same client
	// request token, which you can use to track operations. For example, if you
	// execute a CreateStack operation with the token token1 , then all the StackEvents
	// generated by that operation will have ClientRequestToken set as token1 .
	//
	// In the console, stack operations display the client request token on the Events
	// tab. Stack operations that are initiated from the console use the token format
	// Console-StackOperation-ID, which helps you easily identify the stack operation .
	// For example, if you create a stack using the console, each stack event would be
	// assigned the same token in the following format:
	// Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002 .
	ClientRequestToken *string

	// An optional field containing information about the detailed status of the stack
	// event.
	//
	//   - CONFIGURATION_COMPLETE - all of the resources in the stack have reached that
	//   event. For more information, see [Understand CloudFormation stack creation events]in the CloudFormation User Guide.
	//
	//   - VALIDATION_FAILED - template validation failed because of invalid properties
	//   in the template. The ResourceStatusReason field shows what properties are
	//   defined incorrectly.
	//
	// [Understand CloudFormation stack creation events]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html
	DetailedStatus DetailedStatus

	// Specify the hook failure mode for non-compliant resources in the followings
	// ways.
	//
	//   - FAIL Stops provisioning resources.
	//
	//   - WARN Allows provisioning to continue with a warning message.
	HookFailureMode HookFailureMode

	// Invocation points are points in provisioning logic where hooks are initiated.
	HookInvocationPoint HookInvocationPoint

	// Provides the status of the change set hook.
	HookStatus HookStatus

	// Provides the reason for the hook status.
	HookStatusReason *string

	// The name of the hook.
	HookType *string

	// The logical name of the resource specified in the template.
	LogicalResourceId *string

	// The name or unique identifier associated with the physical instance of the
	// resource.
	PhysicalResourceId *string

	// BLOB of the properties used to create the resource.
	ResourceProperties *string

	// Current status of the resource.
	ResourceStatus ResourceStatus

	// Success/failure message associated with the resource.
	ResourceStatusReason *string

	// Type of resource. For more information, see [Amazon Web Services resource and property types reference] in the CloudFormation User Guide.
	//
	// [Amazon Web Services resource and property types reference]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html
	ResourceType *string
	// contains filtered or unexported fields
}

The StackEvent data type.

type StackInstance 

type StackInstance struct {

	// [Self-managed permissions] The name of the Amazon Web Services account that the
	// stack instance is associated with.
	Account *string

	// Status of the stack instance's actual configuration compared to the expected
	// template and parameter configuration of the stack set to which it belongs.
	//
	//   - DRIFTED : The stack differs from the expected template and parameter
	//   configuration of the stack set to which it belongs. A stack instance is
	//   considered to have drifted if one or more of the resources in the associated
	//   stack have drifted.
	//
	//   - NOT_CHECKED : CloudFormation hasn't checked if the stack instance differs
	//   from its expected stack set configuration.
	//
	//   - IN_SYNC : The stack instance's actual configuration matches its expected
	//   stack set configuration.
	//
	//   - UNKNOWN : This value is reserved for future use.
	DriftStatus StackDriftStatus

	// Most recent time when CloudFormation performed a drift detection operation on
	// the stack instance. This value will be NULL for any stack instance on which
	// drift detection hasn't yet been performed.
	LastDriftCheckTimestamp *time.Time

	// The last unique ID of a StackSet operation performed on a stack instance.
	LastOperationId *string

	// [Service-managed permissions] The organization root ID or organizational unit
	// (OU) IDs that you specified for [DeploymentTargets].
	//
	// [DeploymentTargets]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html
	OrganizationalUnitId *string

	// A list of parameters from the stack set template whose values have been
	// overridden in this stack instance.
	ParameterOverrides []Parameter

	// The name of the Amazon Web Services Region that the stack instance is
	// associated with.
	Region *string

	// The ID of the stack instance.
	StackId *string

	// The detailed status of the stack instance.
	StackInstanceStatus *StackInstanceComprehensiveStatus

	// The name or unique ID of the stack set that the stack instance is associated
	// with.
	StackSetId *string

	// The status of the stack instance, in terms of its synchronization with its
	// associated stack set.
	//
	//   - INOPERABLE : A DeleteStackInstances operation has failed and left the stack
	//   in an unstable state. Stacks in this state are excluded from further
	//   UpdateStackSet operations. You might need to perform a DeleteStackInstances
	//   operation, with RetainStacks set to true , to delete the stack instance, and
	//   then delete the stack manually. INOPERABLE can be returned here when the cause
	//   is a failed import. If it's due to a failed import, the operation can be retried
	//   once the failures are fixed. To see if this is due to a failed import, look at
	//   the DetailedStatus member in the StackInstanceSummary member that is a peer to
	//   this Status member.
	//
	//   - OUTDATED : The stack isn't currently up to date with the stack set because:
	//
	//   - The associated stack failed during a CreateStackSet or UpdateStackSet
	//   operation.
	//
	//   - The stack was part of a CreateStackSet or UpdateStackSet operation that
	//   failed or was stopped before the stack was created or updated.
	//
	//   - CURRENT : The stack is currently up to date with the stack set.
	Status StackInstanceStatus

	// The explanation for the specific status code that's assigned to this stack
	// instance.
	StatusReason *string
	// contains filtered or unexported fields
}

A CloudFormation stack, in a specific account and Region, that's part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given Region. A stack instance can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, in addition to the ID of the actual stack and the stack status.

type StackInstanceComprehensiveStatus 

type StackInstanceComprehensiveStatus struct {

	//   - CANCELLED : The operation in the specified account and Region has been
	//   canceled. This is either because a user has stopped the stack set operation, or
	//   because the failure tolerance of the stack set operation has been exceeded.
	//
	//   - FAILED : The operation in the specified account and Region failed. If the
	//   stack set operation fails in enough accounts within a Region, the failure
	//   tolerance for the stack set operation as a whole might be exceeded.
	//
	//   - FAILED_IMPORT : The import of the stack instance in the specified account
	//   and Region failed and left the stack in an unstable state. Once the issues
	//   causing the failure are fixed, the import operation can be retried. If enough
	//   stack set operations fail in enough accounts within a Region, the failure
	//   tolerance for the stack set operation as a whole might be exceeded.
	//
	//   - INOPERABLE : A DeleteStackInstances operation has failed and left the stack
	//   in an unstable state. Stacks in this state are excluded from further
	//   UpdateStackSet operations. You might need to perform a DeleteStackInstances
	//   operation, with RetainStacks set to true , to delete the stack instance, and
	//   then delete the stack manually.
	//
	//   - PENDING : The operation in the specified account and Region has yet to start.
	//
	//   - RUNNING : The operation in the specified account and Region is currently in
	//   progress.
	//
	//   - SKIPPED_SUSPENDED_ACCOUNT : The operation in the specified account and
	//   Region has been skipped because the account was suspended at the time of the
	//   operation.
	//
	//   - SUCCEEDED : The operation in the specified account and Region completed
	//   successfully.
	DetailedStatus StackInstanceDetailedStatus
	// contains filtered or unexported fields
}

The detailed status of the stack instance.

type StackInstanceDetailedStatus 

type StackInstanceDetailedStatus string
const (
	StackInstanceDetailedStatusPending                 StackInstanceDetailedStatus = "PENDING"
	StackInstanceDetailedStatusRunning                 StackInstanceDetailedStatus = "RUNNING"
	StackInstanceDetailedStatusSucceeded               StackInstanceDetailedStatus = "SUCCEEDED"
	StackInstanceDetailedStatusFailed                  StackInstanceDetailedStatus = "FAILED"
	StackInstanceDetailedStatusCancelled               StackInstanceDetailedStatus = "CANCELLED"
	StackInstanceDetailedStatusInoperable              StackInstanceDetailedStatus = "INOPERABLE"
	StackInstanceDetailedStatusSkippedSuspendedAccount StackInstanceDetailedStatus = "SKIPPED_SUSPENDED_ACCOUNT"
	StackInstanceDetailedStatusFailedImport            StackInstanceDetailedStatus = "FAILED_IMPORT"
)

Enum values for StackInstanceDetailedStatus

func (StackInstanceDetailedStatus) Values added in v0.29.0 

func (StackInstanceDetailedStatus) Values() []StackInstanceDetailedStatus

Values returns all known values for StackInstanceDetailedStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StackInstanceFilter 

type StackInstanceFilter struct {

	// The type of filter to apply.
	Name StackInstanceFilterName

	// The status to filter by.
	Values *string
	// contains filtered or unexported fields
}

The filter to apply to stack instances

type StackInstanceFilterName 

type StackInstanceFilterName string
const (
	StackInstanceFilterNameDetailedStatus  StackInstanceFilterName = "DETAILED_STATUS"
	StackInstanceFilterNameLastOperationId StackInstanceFilterName = "LAST_OPERATION_ID"
	StackInstanceFilterNameDriftStatus     StackInstanceFilterName = "DRIFT_STATUS"
)

Enum values for StackInstanceFilterName

func (StackInstanceFilterName) Values added in v0.29.0 

func (StackInstanceFilterName) Values() []StackInstanceFilterName

Values returns all known values for StackInstanceFilterName. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StackInstanceNotFoundException 

type StackInstanceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified stack instance doesn't exist.

func (*StackInstanceNotFoundException) Error 

func (e *StackInstanceNotFoundException) Error() string

func (*StackInstanceNotFoundException) ErrorCode 

func (e *StackInstanceNotFoundException) ErrorCode() string

func (*StackInstanceNotFoundException) ErrorFault 

func (e *StackInstanceNotFoundException) ErrorFault() smithy.ErrorFault

func (*StackInstanceNotFoundException) ErrorMessage 

func (e *StackInstanceNotFoundException) ErrorMessage() string

type StackInstanceResourceDriftsSummary added in v1.32.0 

type StackInstanceResourceDriftsSummary struct {

	// The logical name of the resource specified in the template.
	//
	// This member is required.
	LogicalResourceId *string

	// Type of resource. For more information, see [Amazon Web Services resource and property types reference] in the CloudFormation User Guide.
	//
	// [Amazon Web Services resource and property types reference]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html
	//
	// This member is required.
	ResourceType *string

	// The ID of the stack instance.
	//
	// This member is required.
	StackId *string

	// The drift status of the resource in a stack instance.
	//
	//   - 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 resource's actual configuration matches its expected template
	//   configuration.
	//
	//   - NOT_CHECKED : CloudFormation doesn't currently return this value.
	//
	// This member is required.
	StackResourceDriftStatus StackResourceDriftStatus

	// Time at which the stack instance drift detection operation was initiated.
	//
	// This member is required.
	Timestamp *time.Time

	// The name or unique identifier that corresponds to a physical instance ID of a
	// resource supported by CloudFormation.
	PhysicalResourceId *string

	// Context information that enables CloudFormation to uniquely identify a
	// resource. CloudFormation uses context key-value pairs in cases where a
	// resource's logical and physical IDs aren't enough to uniquely identify that
	// resource. Each context key-value pair specifies a unique resource that contains
	// the targeted resource.
	PhysicalResourceIdContext []PhysicalResourceIdContextKeyValuePair

	// Status of the actual configuration of the resource compared to its expected
	// configuration. These will be present only for resources whose
	// StackInstanceResourceDriftStatus is MODIFIED .
	PropertyDifferences []PropertyDifference
	// contains filtered or unexported fields
}

The structure containing summary information about resource drifts for a stack instance.

type StackInstanceStatus 

type StackInstanceStatus string
const (
	StackInstanceStatusCurrent    StackInstanceStatus = "CURRENT"
	StackInstanceStatusOutdated   StackInstanceStatus = "OUTDATED"
	StackInstanceStatusInoperable StackInstanceStatus = "INOPERABLE"
)

Enum values for StackInstanceStatus

func (StackInstanceStatus) Values added in v0.29.0 

func (StackInstanceStatus) Values() []StackInstanceStatus

Values returns all known values for StackInstanceStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StackInstanceSummary 

type StackInstanceSummary struct {

	// [Self-managed permissions] The name of the Amazon Web Services account that the
	// stack instance is associated with.
	Account *string

	// Status of the stack instance's actual configuration compared to the expected
	// template and parameter configuration of the stack set to which it belongs.
	//
	//   - DRIFTED : The stack differs from the expected template and parameter
	//   configuration of the stack set to which it belongs. A stack instance is
	//   considered to have drifted if one or more of the resources in the associated
	//   stack have drifted.
	//
	//   - NOT_CHECKED : CloudFormation hasn't checked if the stack instance differs
	//   from its expected stack set configuration.
	//
	//   - IN_SYNC : The stack instance's actual configuration matches its expected
	//   stack set configuration.
	//
	//   - UNKNOWN : This value is reserved for future use.
	DriftStatus StackDriftStatus

	// Most recent time when CloudFormation performed a drift detection operation on
	// the stack instance. This value will be NULL for any stack instance on which
	// drift detection hasn't yet been performed.
	LastDriftCheckTimestamp *time.Time

	// The last unique ID of a StackSet operation performed on a stack instance.
	LastOperationId *string

	// [Service-managed permissions] The organization root ID or organizational unit
	// (OU) IDs that you specified for [DeploymentTargets].
	//
	// [DeploymentTargets]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html
	OrganizationalUnitId *string

	// The name of the Amazon Web Services Region that the stack instance is
	// associated with.
	Region *string

	// The ID of the stack instance.
	StackId *string

	// The detailed status of the stack instance.
	StackInstanceStatus *StackInstanceComprehensiveStatus

	// The name or unique ID of the stack set that the stack instance is associated
	// with.
	StackSetId *string

	// The status of the stack instance, in terms of its synchronization with its
	// associated stack set.
	//
	//   - INOPERABLE : A DeleteStackInstances operation has failed and left the stack
	//   in an unstable state. Stacks in this state are excluded from further
	//   UpdateStackSet operations. You might need to perform a DeleteStackInstances
	//   operation, with RetainStacks set to true , to delete the stack instance, and
	//   then delete the stack manually. INOPERABLE can be returned here when the cause
	//   is a failed import. If it's due to a failed import, the operation can be retried
	//   once the failures are fixed. To see if this is due to a failed import, call the DescribeStackInstance
	//   API operation, look at the DetailedStatus member returned in the
	//   StackInstanceSummary member.
	//
	//   - OUTDATED : The stack isn't currently up to date with the stack set because:
	//
	//   - The associated stack failed during a CreateStackSet or UpdateStackSet
	//   operation.
	//
	//   - The stack was part of a CreateStackSet or UpdateStackSet operation that
	//   failed or was stopped before the stack was created or updated.
	//
	//   - CURRENT : The stack is currently up to date with the stack set.
	Status StackInstanceStatus

	// The explanation for the specific status code assigned to this stack instance.
	StatusReason *string
	// contains filtered or unexported fields
}

The structure that contains summary information about a stack instance.

type StackNotFoundException added in v1.8.0 

type StackNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified stack ARN doesn't exist or stack doesn't exist corresponding to the ARN in input.

func (*StackNotFoundException) Error added in v1.8.0 

func (e *StackNotFoundException) Error() string

func (*StackNotFoundException) ErrorCode added in v1.8.0 

func (e *StackNotFoundException) ErrorCode() string

func (*StackNotFoundException) ErrorFault added in v1.8.0 

func (e *StackNotFoundException) ErrorFault() smithy.ErrorFault

func (*StackNotFoundException) ErrorMessage added in v1.8.0 

func (e *StackNotFoundException) ErrorMessage() string

type StackResource 

type StackResource struct {

	// The logical name of the resource specified in the template.
	//
	// This member is required.
	LogicalResourceId *string

	// Current status of the resource.
	//
	// This member is required.
	ResourceStatus ResourceStatus

	// Type of resource. For more information, see [Amazon Web Services resource and property types reference] in the CloudFormation User Guide.
	//
	// [Amazon Web Services resource and property types reference]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html
	//
	// This member is required.
	ResourceType *string

	// Time the status was updated.
	//
	// This member is required.
	Timestamp *time.Time

	// User defined description associated with the resource.
	Description *string

	// Information about whether the resource's actual configuration differs, or has
	// drifted, from its expected configuration, as defined in the stack template and
	// any values specified as template parameters. For more information, see [Detect unmanaged configuration changes to stacks and resources with drift detection].
	//
	// [Detect unmanaged configuration changes to stacks and resources with drift detection]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html
	DriftInformation *StackResourceDriftInformation

	// Contains information about the module from which the resource was created, if
	// the resource was created from a module included in the stack template.
	ModuleInfo *ModuleInfo

	// The name or unique identifier that corresponds to a physical instance ID of a
	// resource supported by CloudFormation.
	PhysicalResourceId *string

	// Success/failure message associated with the resource.
	ResourceStatusReason *string

	// Unique identifier of the stack.
	StackId *string

	// The name associated with the stack.
	StackName *string
	// contains filtered or unexported fields
}

The StackResource data type.

type StackResourceDetail 

type StackResourceDetail struct {

	// Time the status was updated.
	//
	// This member is required.
	LastUpdatedTimestamp *time.Time

	// The logical name of the resource specified in the template.
	//
	// This member is required.
	LogicalResourceId *string

	// Current status of the resource.
	//
	// This member is required.
	ResourceStatus ResourceStatus

	// Type of resource. For more information, see [Amazon Web Services resource and property types reference] in the CloudFormation User Guide.
	//
	// [Amazon Web Services resource and property types reference]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html
	//
	// This member is required.
	ResourceType *string

	// User defined description associated with the resource.
	Description *string

	// Information about whether the resource's actual configuration differs, or has
	// drifted, from its expected configuration, as defined in the stack template and
	// any values specified as template parameters. For more information, see [Detect unmanaged configuration changes to stacks and resources with drift detection].
	//
	// [Detect unmanaged configuration changes to stacks and resources with drift detection]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html
	DriftInformation *StackResourceDriftInformation

	// The content of the Metadata attribute declared for the resource. For more
	// information, see [Metadata attribute]in the CloudFormation User Guide.
	//
	// [Metadata attribute]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html
	Metadata *string

	// Contains information about the module from which the resource was created, if
	// the resource was created from a module included in the stack template.
	ModuleInfo *ModuleInfo

	// The name or unique identifier that corresponds to a physical instance ID of a
	// resource supported by CloudFormation.
	PhysicalResourceId *string

	// Success/failure message associated with the resource.
	ResourceStatusReason *string

	// Unique identifier of the stack.
	StackId *string

	// The name associated with the stack.
	StackName *string
	// contains filtered or unexported fields
}

Contains detailed information about the specified stack resource.

type StackResourceDrift 

type StackResourceDrift struct {

	// The logical name of the resource specified in the template.
	//
	// This member is required.
	LogicalResourceId *string

	// The type of the resource.
	//
	// This member is required.
	ResourceType *string

	// The ID of the stack.
	//
	// This member is required.
	StackId *string

	// Status of the resource's actual configuration compared to its expected
	// configuration.
	//
	//   - DELETED : The resource differs from its expected template configuration
	//   because the resource has been deleted.
	//
	//   - MODIFIED : One or more resource properties differ from their expected values
	//   (as defined in the stack template and any values specified as template
	//   parameters).
	//
	//   - IN_SYNC : The resource's actual configuration matches its expected template
	//   configuration.
	//
	//   - NOT_CHECKED : CloudFormation does not currently return this value.
	//
	// This member is required.
	StackResourceDriftStatus StackResourceDriftStatus

	// Time at which CloudFormation performed drift detection on the stack resource.
	//
	// This member is required.
	Timestamp *time.Time

	// A JSON structure containing the actual property values of the stack resource.
	//
	// For resources whose StackResourceDriftStatus is DELETED , this structure will
	// not be present.
	ActualProperties *string

	// A JSON structure containing the expected property values of the stack resource,
	// as defined in the stack template and any values specified as template
	// parameters.
	//
	// For resources whose StackResourceDriftStatus is DELETED , this structure will
	// not be present.
	ExpectedProperties *string

	// Contains information about the module from which the resource was created, if
	// the resource was created from a module included in the stack template.
	ModuleInfo *ModuleInfo

	// The name or unique identifier that corresponds to a physical instance ID of a
	// resource supported by CloudFormation.
	PhysicalResourceId *string

	// Context information that enables CloudFormation to uniquely identify a
	// resource. CloudFormation uses context key-value pairs in cases where a
	// resource's logical and physical IDs aren't enough to uniquely identify that
	// resource. Each context key-value pair specifies a unique resource that contains
	// the targeted resource.
	PhysicalResourceIdContext []PhysicalResourceIdContextKeyValuePair

	// A collection of the resource properties whose actual values differ from their
	// expected values. These will be present only for resources whose
	// StackResourceDriftStatus is MODIFIED .
	PropertyDifferences []PropertyDifference
	// contains filtered or unexported fields
}

Contains the drift information for a resource that has been checked for drift. This includes actual and expected property values for resources in which CloudFormation has detected drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.

Resources that don't currently support drift detection can't be checked. For a list of resources that support drift detection, see Resource type support for imports and drift detection.

Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.

type StackResourceDriftInformation 

type StackResourceDriftInformation struct {

	// Status of the resource's actual configuration compared to its expected
	// configuration
	//
	//   - DELETED : The resource differs from its expected configuration in that it
	//   has been deleted.
	//
	//   - MODIFIED : The resource differs from its expected configuration.
	//
	//   - NOT_CHECKED : CloudFormation has not checked if the resource differs from
	//   its expected configuration.
	//
	// Any resources that do not currently support drift detection have a status of
	//   NOT_CHECKED . For more information, see [Resource type support for imports and drift detection].
	//
	//   - IN_SYNC : The resource's actual configuration matches its expected
	//   configuration.
	//
	// [Resource type support for imports and drift detection]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html
	//
	// This member is required.
	StackResourceDriftStatus StackResourceDriftStatus

	// When CloudFormation last checked if the resource had drifted from its expected
	// configuration.
	LastCheckTimestamp *time.Time
	// contains filtered or unexported fields
}

Contains information about whether the resource's actual configuration differs, or has drifted, from its expected configuration.

type StackResourceDriftInformationSummary 

type StackResourceDriftInformationSummary struct {

	// Status of the resource's actual configuration compared to its expected
	// configuration.
	//
	//   - DELETED : The resource differs from its expected configuration in that it
	//   has been deleted.
	//
	//   - MODIFIED : The resource differs from its expected configuration.
	//
	//   - NOT_CHECKED : CloudFormation hasn't checked if the resource differs from its
	//   expected configuration.
	//
	// Any resources that don't currently support drift detection have a status of
	//   NOT_CHECKED . For more information, see [Resource type support for imports and drift detection]. If you performed an ContinueUpdateRollbackoperation on a
	//   stack, any resources included in ResourcesToSkip will also have a status of
	//   NOT_CHECKED . For more information about skipping resources during rollback
	//   operations, see [Continue rolling back an update]in the CloudFormation User Guide.
	//
	//   - IN_SYNC : The resource's actual configuration matches its expected
	//   configuration.
	//
	// [Resource type support for imports and drift detection]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html
	// [Continue rolling back an update]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html
	//
	// This member is required.
	StackResourceDriftStatus StackResourceDriftStatus

	// When CloudFormation last checked if the resource had drifted from its expected
	// configuration.
	LastCheckTimestamp *time.Time
	// contains filtered or unexported fields
}

Summarizes information about whether the resource's actual configuration differs, or has drifted, from its expected configuration.

type StackResourceDriftStatus 

type StackResourceDriftStatus string
const (
	StackResourceDriftStatusInSync     StackResourceDriftStatus = "IN_SYNC"
	StackResourceDriftStatusModified   StackResourceDriftStatus = "MODIFIED"
	StackResourceDriftStatusDeleted    StackResourceDriftStatus = "DELETED"
	StackResourceDriftStatusNotChecked StackResourceDriftStatus = "NOT_CHECKED"
)

Enum values for StackResourceDriftStatus

func (StackResourceDriftStatus) Values added in v0.29.0 

func (StackResourceDriftStatus) Values() []StackResourceDriftStatus

Values returns all known values for StackResourceDriftStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StackResourceSummary 

type StackResourceSummary struct {

	// Time the status was updated.
	//
	// This member is required.
	LastUpdatedTimestamp *time.Time

	// The logical name of the resource specified in the template.
	//
	// This member is required.
	LogicalResourceId *string

	// Current status of the resource.
	//
	// This member is required.
	ResourceStatus ResourceStatus

	// Type of resource. (For more information, see [Amazon Web Services resource and property types reference] in the CloudFormation User Guide.)
	//
	// [Amazon Web Services resource and property types reference]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html
	//
	// This member is required.
	ResourceType *string

	// Information about whether the resource's actual configuration differs, or has
	// drifted, from its expected configuration, as defined in the stack template and
	// any values specified as template parameters. For more information, see [Detect unmanaged configuration changes to stacks and resources with drift detection].
	//
	// [Detect unmanaged configuration changes to stacks and resources with drift detection]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html
	DriftInformation *StackResourceDriftInformationSummary

	// Contains information about the module from which the resource was created, if
	// the resource was created from a module included in the stack template.
	ModuleInfo *ModuleInfo

	// The name or unique identifier that corresponds to a physical instance ID of the
	// resource.
	PhysicalResourceId *string

	// Success/failure message associated with the resource.
	ResourceStatusReason *string
	// contains filtered or unexported fields
}

Contains high-level information about the specified stack resource.

type StackSet 

type StackSet struct {

	// The Amazon Resource Name (ARN) of the IAM role used to create or update the
	// stack set.
	//
	// Use customized administrator roles to control which users or groups can manage
	// specific stack sets within the same administrator account. For more information,
	// see [Prerequisites: Granting Permissions for Stack Set Operations]in the CloudFormation User Guide.
	//
	// [Prerequisites: Granting Permissions for Stack Set Operations]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html
	AdministrationRoleARN *string

	// [Service-managed permissions] Describes whether StackSets automatically deploys
	// to Organizations accounts that are added to a target organization or
	// organizational unit (OU).
	AutoDeployment *AutoDeployment

	// The capabilities that are allowed in the stack set. Some stack set templates
	// might include resources that can affect permissions in your Amazon Web Services
	// account—for example, by creating new Identity and Access Management (IAM) users.
	// For more information, see [Acknowledging IAM resources in CloudFormation templates].
	//
	// [Acknowledging IAM resources in CloudFormation templates]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities
	Capabilities []Capability

	// A description of the stack set that you specify when the stack set is created
	// or updated.
	Description *string

	// The name of the IAM execution role used to create or update the stack set.
	//
	// Use customized execution roles to control which stack resources users and
	// groups can include in their stack sets.
	ExecutionRoleName *string

	// Describes whether StackSets performs non-conflicting operations concurrently
	// and queues conflicting operations.
	ManagedExecution *ManagedExecution

	// [Service-managed permissions] The organization root ID or organizational unit
	// (OU) IDs that you specified for [DeploymentTargets].
	//
	// [DeploymentTargets]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html
	OrganizationalUnitIds []string

	// A list of input parameters for a stack set.
	Parameters []Parameter

	// Describes how the IAM roles required for stack set operations are created.
	//
	//   - 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].
	//
	//   - With service-managed permissions, StackSets automatically creates the IAM
	//   roles required to deploy to accounts managed by Organizations. For more
	//   information, see [Grant Service-Managed Stack Set Permissions].
	//
	// [Grant Self-Managed Stack Set Permissions]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html
	// [Grant Service-Managed Stack Set Permissions]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html
	PermissionModel PermissionModels

	// Returns a list of all Amazon Web Services Regions the given StackSet has stack
	// instances deployed in. The Amazon Web Services Regions list output is in no
	// particular order.
	Regions []string

	// The Amazon Resource Name (ARN) of the stack set.
	StackSetARN *string

	// Detailed information about the drift status of the stack set.
	//
	// For stack sets, contains information about the last completed drift operation
	// performed on the stack set. Information about drift operations currently in
	// progress isn't included.
	StackSetDriftDetectionDetails *StackSetDriftDetectionDetails

	// The ID of the stack set.
	StackSetId *string

	// The name that's associated with the stack set.
	StackSetName *string

	// The status of the stack set.
	Status StackSetStatus

	// A list of tags that specify information about the stack set. A maximum number
	// of 50 tags can be specified.
	Tags []Tag

	// The structure that contains the body of the template that was used to create or
	// update the stack set.
	TemplateBody *string
	// contains filtered or unexported fields
}

A structure that contains information about a stack set. A stack set enables you to provision stacks into Amazon Web Services accounts and across Regions by using a single CloudFormation template. In the stack set, you specify the template to use, in addition to any parameters and capabilities that the template requires.

type StackSetAutoDeploymentTargetSummary added in v1.48.0 

type StackSetAutoDeploymentTargetSummary struct {

	// The organization root ID or organizational unit (OU) IDs where the stack set is
	// targeted.
	OrganizationalUnitId *string

	// The list of Regions targeted for this organization or OU.
	Regions []string
	// contains filtered or unexported fields
}

One of the targets for the stack set. Returned by the ListStackSetAutoDeploymentTargets API operation.

type StackSetDriftDetectionDetails 

type StackSetDriftDetectionDetails struct {

	// The status of the stack set drift detection operation.
	//
	//   - COMPLETED : The drift detection operation completed without failing on any
	//   stack instances.
	//
	//   - FAILED : The drift detection operation exceeded the specified failure
	//   tolerance.
	//
	//   - PARTIAL_SUCCESS : The drift detection operation completed without exceeding
	//   the failure tolerance for the operation.
	//
	//   - IN_PROGRESS : The drift detection operation is currently being performed.
	//
	//   - STOPPED : The user has canceled the drift detection operation.
	DriftDetectionStatus StackSetDriftDetectionStatus

	// Status of the stack set's actual configuration compared to its expected
	// template and parameter configuration. A stack set is considered to have drifted
	// if one or more of its stack instances have drifted from their expected template
	// and parameter configuration.
	//
	//   - DRIFTED : One or more of the stack instances belonging to the stack set
	//   stack differs from the expected template and parameter configuration. A stack
	//   instance is considered to have drifted if one or more of the resources in the
	//   associated stack have drifted.
	//
	//   - NOT_CHECKED : CloudFormation hasn't checked the stack set for drift.
	//
	//   - IN_SYNC : All of the stack instances belonging to the stack set stack match
	//   from the expected template and parameter configuration.
	DriftStatus StackSetDriftStatus

	// The number of stack instances that have drifted from the expected template and
	// parameter configuration of the stack set. A stack instance is considered to have
	// drifted if one or more of the resources in the associated stack don't match
	// their expected configuration.
	DriftedStackInstancesCount *int32

	// The number of stack instances for which the drift detection operation failed.
	FailedStackInstancesCount *int32

	// The number of stack instances that are currently being checked for drift.
	InProgressStackInstancesCount *int32

	// The number of stack instances which match the expected template and parameter
	// configuration of the stack set.
	InSyncStackInstancesCount *int32

	// Most recent time when CloudFormation performed a drift detection operation on
	// the stack set. This value will be NULL for any stack set on which drift
	// detection hasn't yet been performed.
	LastDriftCheckTimestamp *time.Time

	// The total number of stack instances belonging to this stack set.
	//
	// The total number of stack instances is equal to the total of:
	//
	//   - Stack instances that match the stack set configuration.
	//
	//   - Stack instances that have drifted from the stack set configuration.
	//
	//   - Stack instances where the drift detection operation has failed.
	//
	//   - Stack instances currently being checked for drift.
	TotalStackInstancesCount *int32
	// contains filtered or unexported fields
}

Detailed information about the drift status of the stack set.

For stack sets, contains information about the last completed drift operation performed on the stack set. Information about drift operations in-progress isn't included.

For stack set operations, includes information about drift operations currently being performed on the stack set.

For more information, see Detecting unmanaged changes in stack sets in the CloudFormation User Guide.

type StackSetDriftDetectionStatus 

type StackSetDriftDetectionStatus string
const (
	StackSetDriftDetectionStatusCompleted      StackSetDriftDetectionStatus = "COMPLETED"
	StackSetDriftDetectionStatusFailed         StackSetDriftDetectionStatus = "FAILED"
	StackSetDriftDetectionStatusPartialSuccess StackSetDriftDetectionStatus = "PARTIAL_SUCCESS"
	StackSetDriftDetectionStatusInProgress     StackSetDriftDetectionStatus = "IN_PROGRESS"
	StackSetDriftDetectionStatusStopped        StackSetDriftDetectionStatus = "STOPPED"
)

Enum values for StackSetDriftDetectionStatus

func (StackSetDriftDetectionStatus) Values added in v0.29.0 

func (StackSetDriftDetectionStatus) Values() []StackSetDriftDetectionStatus

Values returns all known values for StackSetDriftDetectionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StackSetDriftStatus 

type StackSetDriftStatus string
const (
	StackSetDriftStatusDrifted    StackSetDriftStatus = "DRIFTED"
	StackSetDriftStatusInSync     StackSetDriftStatus = "IN_SYNC"
	StackSetDriftStatusNotChecked StackSetDriftStatus = "NOT_CHECKED"
)

Enum values for StackSetDriftStatus

func (StackSetDriftStatus) Values added in v0.29.0 

func (StackSetDriftStatus) Values() []StackSetDriftStatus

Values returns all known values for StackSetDriftStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StackSetNotEmptyException 

type StackSetNotEmptyException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You can't yet delete this stack set, because it still contains one or more stack instances. Delete all stack instances from the stack set before deleting the stack set.

func (*StackSetNotEmptyException) Error 

func (e *StackSetNotEmptyException) Error() string

func (*StackSetNotEmptyException) ErrorCode 

func (e *StackSetNotEmptyException) ErrorCode() string

func (*StackSetNotEmptyException) ErrorFault 

func (e *StackSetNotEmptyException) ErrorFault() smithy.ErrorFault

func (*StackSetNotEmptyException) ErrorMessage 

func (e *StackSetNotEmptyException) ErrorMessage() string

type StackSetNotFoundException 

type StackSetNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified stack set doesn't exist.

func (*StackSetNotFoundException) Error 

func (e *StackSetNotFoundException) Error() string

func (*StackSetNotFoundException) ErrorCode 

func (e *StackSetNotFoundException) ErrorCode() string

func (*StackSetNotFoundException) ErrorFault 

func (e *StackSetNotFoundException) ErrorFault() smithy.ErrorFault

func (*StackSetNotFoundException) ErrorMessage 

func (e *StackSetNotFoundException) ErrorMessage() string

type StackSetOperation 

type StackSetOperation struct {

	// The type of stack set operation: CREATE , UPDATE , or DELETE . Create and delete
	// operations affect only the specified stack set instances that are associated
	// with the specified stack set. Update operations affect both the stack set
	// itself, in addition to all associated stack set instances.
	Action StackSetOperationAction

	// The Amazon Resource Name (ARN) of the IAM role used to perform this stack set
	// operation.
	//
	// Use customized administrator roles to control which users or groups can manage
	// specific stack sets within the same administrator account. For more information,
	// see [Define Permissions for Multiple Administrators]in the CloudFormation User Guide.
	//
	// [Define Permissions for Multiple Administrators]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html
	AdministrationRoleARN *string

	// The time at which the operation was initiated. Note that the creation times for
	// the stack set operation might differ from the creation time of the individual
	// stacks themselves. This is because CloudFormation needs to perform preparatory
	// work for the operation, such as dispatching the work to the requested Regions,
	// before actually creating the first stacks.
	CreationTimestamp *time.Time

	// [Service-managed permissions] The Organizations accounts affected by the stack
	// operation.
	DeploymentTargets *DeploymentTargets

	// The time at which the stack set operation ended, across all accounts and
	// Regions specified. Note that this doesn't necessarily mean that the stack set
	// operation was successful, or even attempted, in each account or Region.
	EndTimestamp *time.Time

	// The name of the IAM execution role used to create or update the stack set.
	//
	// Use customized execution roles to control which stack resources users and
	// groups can include in their stack sets.
	ExecutionRoleName *string

	// The unique ID of a stack set operation.
	OperationId *string

	// The preferences for how CloudFormation performs this stack set operation.
	OperationPreferences *StackSetOperationPreferences

	// For stack set operations of action type DELETE , specifies whether to remove the
	// stack instances from the specified stack set, but doesn't delete the stacks. You
	// can't re-associate a retained stack, or add an existing, saved stack to a new
	// stack set.
	RetainStacks *bool

	// Detailed information about the drift status of the stack set. This includes
	// information about drift operations currently being performed on the stack set.
	//
	// This information will only be present for stack set operations whose Action
	// type is DETECT_DRIFT .
	//
	// For more information, see [Detect stack set drift] in the CloudFormation User Guide.
	//
	// [Detect stack set drift]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html
	StackSetDriftDetectionDetails *StackSetDriftDetectionDetails

	// The ID of the stack set.
	StackSetId *string

	// The status of the operation.
	//
	//   - FAILED : The operation exceeded the specified failure tolerance. The failure
	//   tolerance value that you've set for an operation is applied for each Region
	//   during stack create and update operations. If the number of failed stacks within
	//   a Region exceeds the failure tolerance, the status of the operation in the
	//   Region is set to FAILED . This in turn sets the status of the operation as a
	//   whole to FAILED , and CloudFormation cancels the operation in any remaining
	//   Regions.
	//
	//   - QUEUED : [Service-managed permissions] For automatic deployments that
	//   require a sequence of operations, the operation is queued to be performed. For
	//   more information, see the [stack set operation status codes]in the CloudFormation User Guide.
	//
	//   - RUNNING : The operation is currently being performed.
	//
	//   - STOPPED : The user has canceled the operation.
	//
	//   - STOPPING : The operation is in the process of stopping, at user request.
	//
	//   - SUCCEEDED : The operation completed creating or updating all the specified
	//   stacks without exceeding the failure tolerance for the operation.
	//
	// [stack set operation status codes]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/what-is-cfnstacksets.html#stackset-status-codes
	Status StackSetOperationStatus

	// Detailed information about the StackSet operation.
	StatusDetails *StackSetOperationStatusDetails

	// The status of the operation in details.
	StatusReason *string
	// contains filtered or unexported fields
}

The structure that contains information about a stack set operation.

type StackSetOperationAction 

type StackSetOperationAction string
const (
	StackSetOperationActionCreate      StackSetOperationAction = "CREATE"
	StackSetOperationActionUpdate      StackSetOperationAction = "UPDATE"
	StackSetOperationActionDelete      StackSetOperationAction = "DELETE"
	StackSetOperationActionDetectDrift StackSetOperationAction = "DETECT_DRIFT"
)

Enum values for StackSetOperationAction

func (StackSetOperationAction) Values added in v0.29.0 

func (StackSetOperationAction) Values() []StackSetOperationAction

Values returns all known values for StackSetOperationAction. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StackSetOperationPreferences 

type StackSetOperationPreferences struct {

	// Specifies how the concurrency level behaves during the operation execution.
	//
	//   - STRICT_FAILURE_TOLERANCE : This option dynamically lowers the concurrency
	//   level to ensure the number of failed accounts never exceeds the value of
	//   FailureToleranceCount +1. The initial actual concurrency is set to the lower
	//   of either the value of the MaxConcurrentCount , or the value of
	//   FailureToleranceCount +1. The actual concurrency is then reduced
	//   proportionally by the number of failures. This is the default behavior.
	//
	// If failure tolerance or Maximum concurrent accounts are set to percentages, the
	//   behavior is similar.
	//
	//   - SOFT_FAILURE_TOLERANCE : This option decouples FailureToleranceCount from
	//   the actual concurrency. This allows stack set operations to run at the
	//   concurrency level set by the MaxConcurrentCount value, or
	//   MaxConcurrentPercentage , regardless of the number of failures.
	ConcurrencyMode ConcurrencyMode

	// The number of accounts, per Region, for which this operation can fail before
	// CloudFormation stops the operation in that Region. If the operation is stopped
	// in a Region, CloudFormation doesn't attempt the operation in any subsequent
	// Regions.
	//
	// Conditional: You must specify either FailureToleranceCount or
	// FailureTolerancePercentage (but not both).
	//
	// By default, 0 is specified.
	FailureToleranceCount *int32

	// The percentage of accounts, per Region, for which this stack operation can fail
	// before CloudFormation stops the operation in that Region. If the operation is
	// stopped in a Region, CloudFormation doesn't attempt the operation in any
	// subsequent Regions.
	//
	// When calculating the number of accounts based on the specified percentage,
	// CloudFormation rounds down to the next whole number.
	//
	// Conditional: You must specify either FailureToleranceCount or
	// FailureTolerancePercentage , but not both.
	//
	// By default, 0 is specified.
	FailureTolerancePercentage *int32

	// The maximum number of accounts in which to perform this operation at one time.
	// This can depend on the value of FailureToleranceCount depending on your
	// ConcurrencyMode . MaxConcurrentCount is at most one more than the
	// FailureToleranceCount if you're using STRICT_FAILURE_TOLERANCE .
	//
	// Note that this setting lets you specify the maximum for operations. For large
	// deployments, under certain circumstances the actual number of accounts acted
	// upon concurrently may be lower due to service throttling.
	//
	// Conditional: You must specify either MaxConcurrentCount or
	// MaxConcurrentPercentage , but not both.
	//
	// By default, 1 is specified.
	MaxConcurrentCount *int32

	// The maximum percentage of accounts in which to perform this operation at one
	// time.
	//
	// When calculating the number of accounts based on the specified percentage,
	// CloudFormation rounds down to the next whole number. This is true except in
	// cases where rounding down would result is zero. In this case, CloudFormation
	// sets the number as one instead.
	//
	// Note that this setting lets you specify the maximum for operations. For large
	// deployments, under certain circumstances the actual number of accounts acted
	// upon concurrently may be lower due to service throttling.
	//
	// Conditional: You must specify either MaxConcurrentCount or
	// MaxConcurrentPercentage , but not both.
	//
	// By default, 1 is specified.
	MaxConcurrentPercentage *int32

	// The concurrency type of deploying StackSets operations in Regions, could be in
	// parallel or one Region at a time.
	RegionConcurrencyType RegionConcurrencyType

	// The order of the Regions where you want to perform the stack operation.
	//
	// RegionOrder isn't followed if AutoDeployment is enabled.
	RegionOrder []string
	// contains filtered or unexported fields
}

The user-specified preferences for how CloudFormation performs a stack set operation.

For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.

type StackSetOperationResultStatus 

type StackSetOperationResultStatus string
const (
	StackSetOperationResultStatusPending   StackSetOperationResultStatus = "PENDING"
	StackSetOperationResultStatusRunning   StackSetOperationResultStatus = "RUNNING"
	StackSetOperationResultStatusSucceeded StackSetOperationResultStatus = "SUCCEEDED"
	StackSetOperationResultStatusFailed    StackSetOperationResultStatus = "FAILED"
	StackSetOperationResultStatusCancelled StackSetOperationResultStatus = "CANCELLED"
)

Enum values for StackSetOperationResultStatus

func (StackSetOperationResultStatus) Values added in v0.29.0 

func (StackSetOperationResultStatus) Values() []StackSetOperationResultStatus

Values returns all known values for StackSetOperationResultStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StackSetOperationResultSummary 

type StackSetOperationResultSummary struct {

	// [Self-managed permissions] The name of the Amazon Web Services account for this
	// operation result.
	Account *string

	// The results of the account gate function CloudFormation invokes, if present,
	// before proceeding with stack set operations in an account.
	AccountGateResult *AccountGateResult

	// [Service-managed permissions] The organization root ID or organizational unit
	// (OU) IDs that you specified for [DeploymentTargets].
	//
	// [DeploymentTargets]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html
	OrganizationalUnitId *string

	// The name of the Amazon Web Services Region for this operation result.
	Region *string

	// The result status of the stack set operation for the given account in the given
	// Region.
	//
	//   - CANCELLED : The operation in the specified account and Region has been
	//   canceled. This is either because a user has stopped the stack set operation, or
	//   because the failure tolerance of the stack set operation has been exceeded.
	//
	//   - FAILED : The operation in the specified account and Region failed.
	//
	// If the stack set operation fails in enough accounts within a Region, the
	//   failure tolerance for the stack set operation as a whole might be exceeded.
	//
	//   - RUNNING : The operation in the specified account and Region is currently in
	//   progress.
	//
	//   - PENDING : The operation in the specified account and Region has yet to start.
	//
	//   - SUCCEEDED : The operation in the specified account and Region completed
	//   successfully.
	Status StackSetOperationResultStatus

	// The reason for the assigned result status.
	StatusReason *string
	// contains filtered or unexported fields
}

The structure that contains information about a specified operation's results for a given account in a given Region.

type StackSetOperationStatus 

type StackSetOperationStatus string
const (
	StackSetOperationStatusRunning   StackSetOperationStatus = "RUNNING"
	StackSetOperationStatusSucceeded StackSetOperationStatus = "SUCCEEDED"
	StackSetOperationStatusFailed    StackSetOperationStatus = "FAILED"
	StackSetOperationStatusStopping  StackSetOperationStatus = "STOPPING"
	StackSetOperationStatusStopped   StackSetOperationStatus = "STOPPED"
	StackSetOperationStatusQueued    StackSetOperationStatus = "QUEUED"
)

Enum values for StackSetOperationStatus

func (StackSetOperationStatus) Values added in v0.29.0 

func (StackSetOperationStatus) Values() []StackSetOperationStatus

Values returns all known values for StackSetOperationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StackSetOperationStatusDetails added in v1.23.0 

type StackSetOperationStatusDetails struct {

	// The number of stack instances for which the StackSet operation failed.
	FailedStackInstancesCount *int32
	// contains filtered or unexported fields
}

Detailed information about the StackSet operation.

type StackSetOperationSummary 

type StackSetOperationSummary struct {

	// The type of operation: CREATE , UPDATE , or DELETE . Create and delete
	// operations affect only the specified stack instances that are associated with
	// the specified stack set. Update operations affect both the stack set itself and
	// all associated stack set instances.
	Action StackSetOperationAction

	// The time at which the operation was initiated. Note that the creation times for
	// the stack set operation might differ from the creation time of the individual
	// stacks themselves. This is because CloudFormation needs to perform preparatory
	// work for the operation, such as dispatching the work to the requested Regions,
	// before actually creating the first stacks.
	CreationTimestamp *time.Time

	// The time at which the stack set operation ended, across all accounts and
	// Regions specified. Note that this doesn't necessarily mean that the stack set
	// operation was successful, or even attempted, in each account or Region.
	EndTimestamp *time.Time

	// The unique ID of the stack set operation.
	OperationId *string

	// The user-specified preferences for how CloudFormation performs a stack set
	// operation.
	//
	// For more information about maximum concurrent accounts and failure tolerance,
	// see [Stack set operation options].
	//
	// [Stack set operation options]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/what-is-cfnstacksets.html#stackset-ops-options
	OperationPreferences *StackSetOperationPreferences

	// The overall status of the operation.
	//
	//   - FAILED : The operation exceeded the specified failure tolerance. The failure
	//   tolerance value that you've set for an operation is applied for each Region
	//   during stack create and update operations. If the number of failed stacks within
	//   a Region exceeds the failure tolerance, the status of the operation in the
	//   Region is set to FAILED . This in turn sets the status of the operation as a
	//   whole to FAILED , and CloudFormation cancels the operation in any remaining
	//   Regions.
	//
	//   - QUEUED : [Service-managed permissions] For automatic deployments that
	//   require a sequence of operations, the operation is queued to be performed. For
	//   more information, see the [stack set operation status codes]in the CloudFormation User Guide.
	//
	//   - RUNNING : The operation is currently being performed.
	//
	//   - STOPPED : The user has canceled the operation.
	//
	//   - STOPPING : The operation is in the process of stopping, at user request.
	//
	//   - SUCCEEDED : The operation completed creating or updating all the specified
	//   stacks without exceeding the failure tolerance for the operation.
	//
	// [stack set operation status codes]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/what-is-cfnstacksets.html#stackset-status-codes
	Status StackSetOperationStatus

	// Detailed information about the stack set operation.
	StatusDetails *StackSetOperationStatusDetails

	// The status of the operation in details.
	StatusReason *string
	// contains filtered or unexported fields
}

The structures that contain summary information about the specified operation.

type StackSetStatus 

type StackSetStatus string
const (
	StackSetStatusActive  StackSetStatus = "ACTIVE"
	StackSetStatusDeleted StackSetStatus = "DELETED"
)

Enum values for StackSetStatus

func (StackSetStatus) Values added in v0.29.0 

func (StackSetStatus) Values() []StackSetStatus

Values returns all known values for StackSetStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StackSetSummary 

type StackSetSummary struct {

	// [Service-managed permissions] Describes whether StackSets automatically deploys
	// to Organizations accounts that are added to a target organizational unit (OU).
	AutoDeployment *AutoDeployment

	// A description of the stack set that you specify when the stack set is created
	// or updated.
	Description *string

	// Status of the stack set's actual configuration compared to its expected
	// template and parameter configuration. A stack set is considered to have drifted
	// if one or more of its stack instances have drifted from their expected template
	// and parameter configuration.
	//
	//   - DRIFTED : One or more of the stack instances belonging to the stack set
	//   stack differs from the expected template and parameter configuration. A stack
	//   instance is considered to have drifted if one or more of the resources in the
	//   associated stack have drifted.
	//
	//   - NOT_CHECKED : CloudFormation hasn't checked the stack set for drift.
	//
	//   - IN_SYNC : All the stack instances belonging to the stack set stack match
	//   from the expected template and parameter configuration.
	//
	//   - UNKNOWN : This value is reserved for future use.
	DriftStatus StackDriftStatus

	// Most recent time when CloudFormation performed a drift detection operation on
	// the stack set. This value will be NULL for any stack set on which drift
	// detection hasn't yet been performed.
	LastDriftCheckTimestamp *time.Time

	// Describes whether StackSets performs non-conflicting operations concurrently
	// and queues conflicting operations.
	ManagedExecution *ManagedExecution

	// Describes how the IAM roles required for stack set operations are created.
	//
	//   - 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].
	//
	//   - With service-managed permissions, StackSets automatically creates the IAM
	//   roles required to deploy to accounts managed by Organizations. For more
	//   information, see [Grant Service-Managed Stack Set Permissions].
	//
	// [Grant Self-Managed Stack Set Permissions]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html
	// [Grant Service-Managed Stack Set Permissions]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html
	PermissionModel PermissionModels

	// The ID of the stack set.
	StackSetId *string

	// The name of the stack set.
	StackSetName *string

	// The status of the stack set.
	Status StackSetStatus
	// contains filtered or unexported fields
}

The structures that contain summary information about the specified stack set.

type StackStatus 

type StackStatus string
const (
	StackStatusCreateInProgress                        StackStatus = "CREATE_IN_PROGRESS"
	StackStatusCreateFailed                            StackStatus = "CREATE_FAILED"
	StackStatusCreateComplete                          StackStatus = "CREATE_COMPLETE"
	StackStatusRollbackInProgress                      StackStatus = "ROLLBACK_IN_PROGRESS"
	StackStatusRollbackFailed                          StackStatus = "ROLLBACK_FAILED"
	StackStatusRollbackComplete                        StackStatus = "ROLLBACK_COMPLETE"
	StackStatusDeleteInProgress                        StackStatus = "DELETE_IN_PROGRESS"
	StackStatusDeleteFailed                            StackStatus = "DELETE_FAILED"
	StackStatusDeleteComplete                          StackStatus = "DELETE_COMPLETE"
	StackStatusUpdateInProgress                        StackStatus = "UPDATE_IN_PROGRESS"
	StackStatusUpdateCompleteCleanupInProgress         StackStatus = "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS"
	StackStatusUpdateComplete                          StackStatus = "UPDATE_COMPLETE"
	StackStatusUpdateFailed                            StackStatus = "UPDATE_FAILED"
	StackStatusUpdateRollbackInProgress                StackStatus = "UPDATE_ROLLBACK_IN_PROGRESS"
	StackStatusUpdateRollbackFailed                    StackStatus = "UPDATE_ROLLBACK_FAILED"
	StackStatusUpdateRollbackCompleteCleanupInProgress StackStatus = "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS"
	StackStatusUpdateRollbackComplete                  StackStatus = "UPDATE_ROLLBACK_COMPLETE"
	StackStatusReviewInProgress                        StackStatus = "REVIEW_IN_PROGRESS"
	StackStatusImportInProgress                        StackStatus = "IMPORT_IN_PROGRESS"
	StackStatusImportComplete                          StackStatus = "IMPORT_COMPLETE"
	StackStatusImportRollbackInProgress                StackStatus = "IMPORT_ROLLBACK_IN_PROGRESS"
	StackStatusImportRollbackFailed                    StackStatus = "IMPORT_ROLLBACK_FAILED"
	StackStatusImportRollbackComplete                  StackStatus = "IMPORT_ROLLBACK_COMPLETE"
)

Enum values for StackStatus

func (StackStatus) Values added in v0.29.0 

func (StackStatus) Values() []StackStatus

Values returns all known values for StackStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StackSummary 

type StackSummary struct {

	// The time the stack was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The name associated with the stack.
	//
	// This member is required.
	StackName *string

	// The current status of the stack.
	//
	// This member is required.
	StackStatus StackStatus

	// The time the stack was deleted.
	DeletionTime *time.Time

	// Summarizes information about whether a stack's actual configuration differs, or
	// has drifted, from its expected configuration, as defined in the stack template
	// and any values specified as template parameters. For more information, see [Detect unmanaged configuration changes to stacks and resources with drift detection].
	//
	// [Detect unmanaged configuration changes to stacks and resources with drift detection]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html
	DriftInformation *StackDriftInformationSummary

	// The time the stack was last updated. This field will only be returned if the
	// stack has been updated at least once.
	LastUpdatedTime *time.Time

	// For nested stacks--stacks created as resources for another stack--the stack ID
	// of the direct parent of this stack. For the first level of nested stacks, the
	// root stack is also the parent stack.
	//
	// For more information, see [Embed stacks within other stacks using nested stacks] in the CloudFormation User Guide.
	//
	// [Embed stacks within other stacks using nested stacks]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html
	ParentId *string

	// For nested stacks--stacks created as resources for another stack--the stack ID
	// of the top-level stack to which the nested stack ultimately belongs.
	//
	// For more information, see [Embed stacks within other stacks using nested stacks] in the CloudFormation User Guide.
	//
	// [Embed stacks within other stacks using nested stacks]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html
	RootId *string

	// Unique stack identifier.
	StackId *string

	// Success/Failure message associated with the stack status.
	StackStatusReason *string

	// The template description of the template used to create the stack.
	TemplateDescription *string
	// contains filtered or unexported fields
}

The StackSummary Data Type

type StaleRequestException 

type StaleRequestException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Another operation has been performed on this stack set since the specified operation was performed.

func (*StaleRequestException) Error 

func (e *StaleRequestException) Error() string

func (*StaleRequestException) ErrorCode 

func (e *StaleRequestException) ErrorCode() string

func (*StaleRequestException) ErrorFault 

func (e *StaleRequestException) ErrorFault() smithy.ErrorFault

func (*StaleRequestException) ErrorMessage 

func (e *StaleRequestException) ErrorMessage() string

type Tag 

type Tag struct {

	//  Required. A string used to identify this tag. You can specify a maximum of 128
	// characters for a tag key. Tags owned by Amazon Web Services have the reserved
	// prefix: aws: .
	//
	// This member is required.
	Key *string

	//  Required. A string containing the value for this tag. You can specify a
	// maximum of 256 characters for a tag value.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

The Tag type enables you to specify a key-value pair that can be used to store information about an CloudFormation stack.

type TemplateConfiguration added in v1.43.0 

type TemplateConfiguration struct {

	// The DeletionPolicy assigned to resources in the generated template. Supported
	// values are:
	//
	//   - DELETE - delete all resources when the stack is deleted.
	//
	//   - RETAIN - retain all resources when the stack is deleted.
	//
	// For more information, see [DeletionPolicy attribute] in the CloudFormation User Guide.
	//
	// [DeletionPolicy attribute]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html
	DeletionPolicy GeneratedTemplateDeletionPolicy

	// The UpdateReplacePolicy assigned to resources in the generated template.
	// Supported values are:
	//
	//   - DELETE - delete all resources when the resource is replaced during an update
	//   operation.
	//
	//   - RETAIN - retain all resources when the resource is replaced during an update
	//   operation.
	//
	// For more information, see [UpdateReplacePolicy attribute] in the CloudFormation User Guide.
	//
	// [UpdateReplacePolicy attribute]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html
	UpdateReplacePolicy GeneratedTemplateUpdateReplacePolicy
	// contains filtered or unexported fields
}

The configuration details of a generated template.

type TemplateFormat added in v1.43.0 

type TemplateFormat string
const (
	TemplateFormatJson TemplateFormat = "JSON"
	TemplateFormatYaml TemplateFormat = "YAML"
)

Enum values for TemplateFormat

func (TemplateFormat) Values added in v1.43.0 

func (TemplateFormat) Values() []TemplateFormat

Values returns all known values for TemplateFormat. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TemplateParameter 

type TemplateParameter struct {

	// The default value associated with the parameter.
	DefaultValue *string

	// User defined description associated with the parameter.
	Description *string

	// Flag indicating whether the parameter should be displayed as plain text in logs
	// and UIs.
	NoEcho *bool

	// The name associated with the parameter.
	ParameterKey *string
	// contains filtered or unexported fields
}

The TemplateParameter data type.

type TemplateProgress added in v1.43.0 

type TemplateProgress struct {

	// The number of resources that failed the template generation.
	ResourcesFailed *int32

	// The number of resources that are still pending the template generation.
	ResourcesPending *int32

	// The number of resources that are in-process for the template generation.
	ResourcesProcessing *int32

	// The number of resources that succeeded the template generation.
	ResourcesSucceeded *int32
	// contains filtered or unexported fields
}

A summary of the progress of the template generation.

type TemplateStage 

type TemplateStage string
const (
	TemplateStageOriginal  TemplateStage = "Original"
	TemplateStageProcessed TemplateStage = "Processed"
)

Enum values for TemplateStage

func (TemplateStage) Values added in v0.29.0 

func (TemplateStage) Values() []TemplateStage

Values returns all known values for TemplateStage. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TemplateSummary added in v1.43.0 

type TemplateSummary struct {

	// The time the generated template was created.
	CreationTime *time.Time

	// The Amazon Resource Name (ARN) of the generated template. The format is
	// arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id} .
	// For example,
	// arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
	// .
	GeneratedTemplateId *string

	// The name of the generated template.
	GeneratedTemplateName *string

	// The time the generated template was last updated.
	LastUpdatedTime *time.Time

	// The number of resources in the generated template. This is a total of resources
	// in pending, in-progress, completed, and failed states.
	NumberOfResources *int32

	// The status of the template generation. Supported values are:
	//
	//   - CreatePending - the creation of the template is pending.
	//
	//   - CreateInProgress - the creation of the template is in progress.
	//
	//   - DeletePending - the deletion of the template is pending.
	//
	//   - DeleteInProgress - the deletion of the template is in progress.
	//
	//   - UpdatePending - the update of the template is pending.
	//
	//   - UpdateInProgress - the update of the template is in progress.
	//
	//   - Failed - the template operation failed.
	//
	//   - Complete - the template operation is complete.
	Status GeneratedTemplateStatus

	// The reason for the current template generation status. This will provide more
	// details if a failure happened.
	StatusReason *string
	// contains filtered or unexported fields
}

The summary of a generated template.

type TemplateSummaryConfig added in v1.31.0 

type TemplateSummaryConfig struct {

	// If set to True , any unrecognized resource types generate warnings and not an
	// error. Any unrecognized resource types are returned in the Warnings output
	// parameter.
	TreatUnrecognizedResourceTypesAsWarnings *bool
	// contains filtered or unexported fields
}

Options for the GetTemplateSummary API action.

type ThirdPartyType added in v1.6.0 

type ThirdPartyType string
const (
	ThirdPartyTypeResource ThirdPartyType = "RESOURCE"
	ThirdPartyTypeModule   ThirdPartyType = "MODULE"
	ThirdPartyTypeHook     ThirdPartyType = "HOOK"
)

Enum values for ThirdPartyType

func (ThirdPartyType) Values added in v1.6.0 

func (ThirdPartyType) Values() []ThirdPartyType

Values returns all known values for ThirdPartyType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TokenAlreadyExistsException 

type TokenAlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

A client request token already exists.

func (*TokenAlreadyExistsException) Error 

func (e *TokenAlreadyExistsException) Error() string

func (*TokenAlreadyExistsException) ErrorCode 

func (e *TokenAlreadyExistsException) ErrorCode() string

func (*TokenAlreadyExistsException) ErrorFault 

func (e *TokenAlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*TokenAlreadyExistsException) ErrorMessage 

func (e *TokenAlreadyExistsException) ErrorMessage() string

type TypeConfigurationDetails added in v1.6.0 

type TypeConfigurationDetails struct {

	// The alias specified for this configuration, if one was specified when the
	// configuration was set.
	Alias *string

	// The Amazon Resource Name (ARN) for the configuration data, in this account and
	// Region.
	Arn *string

	// A JSON string specifying the configuration data for the extension, in this
	// account and Region.
	//
	// If a configuration hasn't been set for a specified extension, CloudFormation
	// returns {} .
	Configuration *string

	// Whether this configuration data is the default configuration for the extension.
	IsDefaultConfiguration *bool

	// When the configuration data was last updated for this extension.
	//
	// If a configuration hasn't been set for a specified extension, CloudFormation
	// returns null .
	LastUpdated *time.Time

	// The Amazon Resource Name (ARN) for the extension, in this account and Region.
	//
	// For public extensions, this will be the ARN assigned when you call the [ActivateType] API
	// operation in this account and Region. For private extensions, this will be the
	// ARN assigned when you call the [RegisterType]API operation in this account and Region.
	//
	// [ActivateType]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
	// [RegisterType]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
	TypeArn *string

	// The name of the extension.
	TypeName *string
	// contains filtered or unexported fields
}

Detailed information concerning the specification of a CloudFormation extension in a given account and Region.

For more information, see Edit configuration data for extensions in your account in the CloudFormation User Guide.

type TypeConfigurationIdentifier added in v1.6.0 

type TypeConfigurationIdentifier struct {

	// The type of extension.
	Type 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 call the [ActivateType] API
	// operation in this account and Region. For private extensions, this will be the
	// ARN assigned when you call the [RegisterType]API operation in this account and Region.
	//
	// [ActivateType]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
	// [RegisterType]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
	TypeArn *string

	// The alias specified for this configuration, if one was specified when the
	// configuration was set.
	TypeConfigurationAlias *string

	// The Amazon Resource Name (ARN) for the configuration, in this account and
	// Region.
	TypeConfigurationArn *string

	// The name of the extension type to which this configuration applies.
	TypeName *string
	// contains filtered or unexported fields
}

Identifying information for the configuration of a CloudFormation extension.

type TypeConfigurationNotFoundException added in v1.6.0 

type TypeConfigurationNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified extension configuration can't be found.

func (*TypeConfigurationNotFoundException) Error added in v1.6.0 

func (e *TypeConfigurationNotFoundException) Error() string

func (*TypeConfigurationNotFoundException) ErrorCode added in v1.6.0 

func (e *TypeConfigurationNotFoundException) ErrorCode() string

func (*TypeConfigurationNotFoundException) ErrorFault added in v1.6.0 

func (e *TypeConfigurationNotFoundException) ErrorFault() smithy.ErrorFault

func (*TypeConfigurationNotFoundException) ErrorMessage added in v1.6.0 

func (e *TypeConfigurationNotFoundException) ErrorMessage() string

type TypeFilters added in v1.6.0 

type TypeFilters struct {

	// The category of extensions to return.
	//
	//   - REGISTERED : Private extensions that have been registered for this account
	//   and Region.
	//
	//   - ACTIVATED : Public extensions that have been activated for this account and
	//   Region.
	//
	//   - THIRD_PARTY : Extensions available for use from publishers other than
	//   Amazon. This includes:
	//
	//   - Private extensions registered in the account.
	//
	//   - Public extensions from publishers other than Amazon, whether activated or
	//   not.
	//
	//   - AWS_TYPES : Extensions available for use from Amazon.
	Category Category

	// The id of the publisher of the extension.
	//
	// Extensions published by Amazon aren't assigned a publisher ID. Use the AWS_TYPES
	// category to specify a list of types published by Amazon.
	PublisherId *string

	// A prefix to use as a filter for results.
	TypeNamePrefix *string
	// contains filtered or unexported fields
}

Filter criteria to use in determining which extensions to return.

type TypeNotFoundException 

type TypeNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified extension doesn't exist in the CloudFormation registry.

func (*TypeNotFoundException) Error 

func (e *TypeNotFoundException) Error() string

func (*TypeNotFoundException) ErrorCode 

func (e *TypeNotFoundException) ErrorCode() string

func (*TypeNotFoundException) ErrorFault 

func (e *TypeNotFoundException) ErrorFault() smithy.ErrorFault

func (*TypeNotFoundException) ErrorMessage 

func (e *TypeNotFoundException) ErrorMessage() string

type TypeSummary 

type TypeSummary struct {

	// The ID of the default version of the extension. The default version is used
	// when the extension version isn't 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].
	//
	// To set the default version of an extension, use SetTypeDefaultVersion.
	//
	// [RegisterType]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
	DefaultVersionId *string

	// The description of the extension.
	Description *string

	// Whether the extension is activated for this account and Region.
	//
	// This applies only to third-party public extensions. Extensions published by
	// Amazon are activated by default.
	IsActivated *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].
	//
	//   - Public extensions you have activated in your account with auto-update
	//   specified. For more information, see [ActivateType].
	//
	// For all other extension types, CloudFormation returns null .
	//
	// [ActivateType]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
	// [RegisterType]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html
	LastUpdated *time.Time

	// For public extensions that have been activated for this account and Region, the
	// latest version of the public extension that is available. For any extensions
	// other than activated third-party extensions, CloudFormation returns null .
	//
	// How you specified AutoUpdate when enabling the extension affects whether
	// CloudFormation automatically updates the extension in this account and Region
	// when a new version is released. For more information, see [Automatically use new versions of extensions]in the CloudFormation
	// User Guide.
	//
	// [Automatically use new versions of extensions]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto
	LatestPublicVersion *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 [Use aliases to refer to extensions]in the CloudFormation User Guide.
	//
	// [Use aliases to refer to extensions]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias
	OriginalTypeName *string

	// For public extensions that have been activated for this account and Region, the
	// version of the public extension to be used for CloudFormation operations in this
	// account and Region.
	//
	// How you specified AutoUpdate when enabling the extension affects whether
	// CloudFormation automatically updates the extension in this account and Region
	// when a new version is released. For more information, see [Automatically use new versions of extensions]in the CloudFormation
	// User Guide.
	//
	// [Automatically use new versions of extensions]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto
	PublicVersionNumber *string

	// The ID of the extension publisher, if the extension is published by a third
	// party. Extensions published by Amazon don't return a publisher ID.
	PublisherId *string

	// The service used to verify the publisher identity.
	//
	// For more information, see [Publishing extensions to make them available for public use] in the CloudFormation Command Line Interface (CLI)
	// User Guide.
	//
	// [Publishing extensions to make them available for public use]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html
	PublisherIdentity IdentityProvider

	// The publisher name, as defined in the public profile for that publisher in the
	// service used to verify the publisher identity.
	PublisherName *string

	// The kind of extension.
	Type RegistryType

	// The Amazon Resource Name (ARN) of the extension.
	TypeArn *string

	// The name of the extension.
	//
	// If you specified a TypeNameAlias when you call the [ActivateType] API operation in your
	// account and Region, CloudFormation considers that alias as the type name.
	//
	// [ActivateType]: https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html
	TypeName *string
	// contains filtered or unexported fields
}

Contains summary information about the specified CloudFormation extension.

type TypeTestsStatus added in v1.6.0 

type TypeTestsStatus string
const (
	TypeTestsStatusPassed     TypeTestsStatus = "PASSED"
	TypeTestsStatusFailed     TypeTestsStatus = "FAILED"
	TypeTestsStatusInProgress TypeTestsStatus = "IN_PROGRESS"
	TypeTestsStatusNotTested  TypeTestsStatus = "NOT_TESTED"
)

Enum values for TypeTestsStatus

func (TypeTestsStatus) Values added in v1.6.0 

func (TypeTestsStatus) Values() []TypeTestsStatus

Values returns all known values for TypeTestsStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TypeVersionSummary 

type TypeVersionSummary struct {

	// The Amazon Resource Name (ARN) of the extension version.
	Arn *string

	// The description of the extension version.
	Description *string

	// 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,
	// CloudFormation returns null .
	IsDefaultVersion *bool

	// For public extensions that have been activated for this account and Region, the
	// version of the public extension to be used for CloudFormation operations in this
	// account and Region. For any extensions other than activated third-party
	// extensions, CloudFormation returns null .
	//
	// How you specified AutoUpdate when enabling the extension affects whether
	// CloudFormation automatically updates the extension in this account and Region
	// when a new version is released. For more information, see [Automatically use new versions of extensions]in the CloudFormation
	// User Guide.
	//
	// [Automatically use new versions of extensions]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto
	PublicVersionNumber *string

	// When the version was registered.
	TimeCreated *time.Time

	// The kind of extension.
	Type RegistryType

	// The name of the extension.
	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's registered.
	VersionId *string
	// contains filtered or unexported fields
}

Contains summary information about a specific version of a CloudFormation extension.

type VersionBump added in v1.6.0 

type VersionBump string
const (
	VersionBumpMajor VersionBump = "MAJOR"
	VersionBumpMinor VersionBump = "MINOR"
)

Enum values for VersionBump

func (VersionBump) Values added in v1.6.0 

func (VersionBump) Values() []VersionBump

Values returns all known values for VersionBump. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Visibility 

type Visibility string
const (
	VisibilityPublic  Visibility = "PUBLIC"
	VisibilityPrivate Visibility = "PRIVATE"
)

Enum values for Visibility

func (Visibility) Values added in v0.29.0 

func (Visibility) Values() []Visibility

Values returns all known values for Visibility. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type WarningDetail added in v1.43.0 

type WarningDetail struct {

	// The properties of the resource that are impacted by this warning.
	Properties []WarningProperty

	// The type of this warning. For more information, see [Resolve write-only properties] in the CloudFormation User
	// Guide.
	//
	//   - MUTUALLY_EXCLUSIVE_PROPERTIES - The resource requires mutually-exclusive
	//   write-only properties. The IaC generator selects one set of mutually exclusive
	//   properties and converts the included properties into parameters. The parameter
	//   names have a suffix OneOf and the parameter descriptions indicate that the
	//   corresponding property can be replaced with other exclusive properties.
	//
	//   - UNSUPPORTED_PROPERTIES - Unsupported properties are present in the resource.
	//   One example of unsupported properties would be a required write-only property
	//   that is an array, because a parameter cannot be an array. Another example is an
	//   optional write-only property.
	//
	//   - MUTUALLY_EXCLUSIVE_TYPES - One or more required write-only properties are
	//   found in the resource, and the type of that property can be any of several
	//   types.
	//
	// Currently the resource and property reference documentation does not indicate
	// if a property uses a type of oneOf or anyOf . You need to look at the resource
	// provider schema.
	//
	// [Resolve write-only properties]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC-write-only-properties.html
	Type WarningType
	// contains filtered or unexported fields
}

The warnings generated for a specific resource for this generated template.

type WarningProperty added in v1.43.0 

type WarningProperty struct {

	// The description of the property from the resource provider schema.
	Description *string

	// The path of the property. For example, if this is for the S3Bucket member of
	// the Code property, the property path would be Code/S3Bucket .
	PropertyPath *string

	// If true , the specified property is required.
	Required *bool
	// contains filtered or unexported fields
}

A specific property that is impacted by a warning.

type WarningType added in v1.43.0 

type WarningType string
const (
	WarningTypeMutuallyExclusiveProperties WarningType = "MUTUALLY_EXCLUSIVE_PROPERTIES"
	WarningTypeUnsupportedProperties       WarningType = "UNSUPPORTED_PROPERTIES"
	WarningTypeMutuallyExclusiveTypes      WarningType = "MUTUALLY_EXCLUSIVE_TYPES"
)

Enum values for WarningType

func (WarningType) Values added in v1.43.0 

func (WarningType) Values() []WarningType

Values returns all known values for WarningType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Warnings added in v1.31.0 

type Warnings struct {

	// A list of all of the unrecognized resource types. This is only returned if the
	// TemplateSummaryConfig parameter has the TreatUnrecognizedResourceTypesAsWarning
	// configuration set to True .
	UnrecognizedResourceTypes []string
	// contains filtered or unexported fields
}

Contains any warnings returned by the GetTemplateSummary API action.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.