cloudformation

package
v1.45.28 Latest Latest
Warning

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

 Go to latest Published: Oct 18, 2023 License: Apache-2.0 Imports: 10 Imported by: 1,192

Documentation

Overview

Package cloudformation provides the client and types for making API requests to AWS CloudFormation.

CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly reliable, highly scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services infrastructure.

With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.

For more information about CloudFormation, see the CloudFormation product page (http://aws.amazon.com/cloudformation/).

CloudFormation makes use of other Amazon Web Services products. If you need additional technical information about a specific Amazon Web Services product, you can find the product's technical documentation at docs.aws.amazon.com (https://docs.aws.amazon.com/).

See https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15 for more information on this service.

See cloudformation package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/cloudformation/

Using the Client

To contact AWS CloudFormation with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS CloudFormation client CloudFormation for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/cloudformation/#New

Index

Constants

View Source 
const (
	// AccountFilterTypeNone is a AccountFilterType enum value
	AccountFilterTypeNone = "NONE"

	// AccountFilterTypeIntersection is a AccountFilterType enum value
	AccountFilterTypeIntersection = "INTERSECTION"

	// AccountFilterTypeDifference is a AccountFilterType enum value
	AccountFilterTypeDifference = "DIFFERENCE"

	// AccountFilterTypeUnion is a AccountFilterType enum value
	AccountFilterTypeUnion = "UNION"
)
View Source 
const (
	// AccountGateStatusSucceeded is a AccountGateStatus enum value
	AccountGateStatusSucceeded = "SUCCEEDED"

	// AccountGateStatusFailed is a AccountGateStatus enum value
	AccountGateStatusFailed = "FAILED"

	// AccountGateStatusSkipped is a AccountGateStatus enum value
	AccountGateStatusSkipped = "SKIPPED"
)
View Source 
const (
	// CallAsSelf is a CallAs enum value
	CallAsSelf = "SELF"

	// CallAsDelegatedAdmin is a CallAs enum value
	CallAsDelegatedAdmin = "DELEGATED_ADMIN"
)
View Source 
const (
	// CapabilityCapabilityIam is a Capability enum value
	CapabilityCapabilityIam = "CAPABILITY_IAM"

	// CapabilityCapabilityNamedIam is a Capability enum value
	CapabilityCapabilityNamedIam = "CAPABILITY_NAMED_IAM"

	// CapabilityCapabilityAutoExpand is a Capability enum value
	CapabilityCapabilityAutoExpand = "CAPABILITY_AUTO_EXPAND"
)
View Source 
const (
	// CategoryRegistered is a Category enum value
	CategoryRegistered = "REGISTERED"

	// CategoryActivated is a Category enum value
	CategoryActivated = "ACTIVATED"

	// CategoryThirdParty is a Category enum value
	CategoryThirdParty = "THIRD_PARTY"

	// CategoryAwsTypes is a Category enum value
	CategoryAwsTypes = "AWS_TYPES"
)
View Source 
const (
	// ChangeActionAdd is a ChangeAction enum value
	ChangeActionAdd = "Add"

	// ChangeActionModify is a ChangeAction enum value
	ChangeActionModify = "Modify"

	// ChangeActionRemove is a ChangeAction enum value
	ChangeActionRemove = "Remove"

	// ChangeActionImport is a ChangeAction enum value
	ChangeActionImport = "Import"

	// ChangeActionDynamic is a ChangeAction enum value
	ChangeActionDynamic = "Dynamic"
)
View Source 
const (
	// ChangeSetHooksStatusPlanning is a ChangeSetHooksStatus enum value
	ChangeSetHooksStatusPlanning = "PLANNING"

	// ChangeSetHooksStatusPlanned is a ChangeSetHooksStatus enum value
	ChangeSetHooksStatusPlanned = "PLANNED"

	// ChangeSetHooksStatusUnavailable is a ChangeSetHooksStatus enum value
	ChangeSetHooksStatusUnavailable = "UNAVAILABLE"
)
View Source 
const (
	// ChangeSetStatusCreatePending is a ChangeSetStatus enum value
	ChangeSetStatusCreatePending = "CREATE_PENDING"

	// ChangeSetStatusCreateInProgress is a ChangeSetStatus enum value
	ChangeSetStatusCreateInProgress = "CREATE_IN_PROGRESS"

	// ChangeSetStatusCreateComplete is a ChangeSetStatus enum value
	ChangeSetStatusCreateComplete = "CREATE_COMPLETE"

	// ChangeSetStatusDeletePending is a ChangeSetStatus enum value
	ChangeSetStatusDeletePending = "DELETE_PENDING"

	// ChangeSetStatusDeleteInProgress is a ChangeSetStatus enum value
	ChangeSetStatusDeleteInProgress = "DELETE_IN_PROGRESS"

	// ChangeSetStatusDeleteComplete is a ChangeSetStatus enum value
	ChangeSetStatusDeleteComplete = "DELETE_COMPLETE"

	// ChangeSetStatusDeleteFailed is a ChangeSetStatus enum value
	ChangeSetStatusDeleteFailed = "DELETE_FAILED"

	// ChangeSetStatusFailed is a ChangeSetStatus enum value
	ChangeSetStatusFailed = "FAILED"
)
View Source 
const (
	// ChangeSetTypeCreate is a ChangeSetType enum value
	ChangeSetTypeCreate = "CREATE"

	// ChangeSetTypeUpdate is a ChangeSetType enum value
	ChangeSetTypeUpdate = "UPDATE"

	// ChangeSetTypeImport is a ChangeSetType enum value
	ChangeSetTypeImport = "IMPORT"
)
View Source 
const (
	// ChangeSourceResourceReference is a ChangeSource enum value
	ChangeSourceResourceReference = "ResourceReference"

	// ChangeSourceParameterReference is a ChangeSource enum value
	ChangeSourceParameterReference = "ParameterReference"

	// ChangeSourceResourceAttribute is a ChangeSource enum value
	ChangeSourceResourceAttribute = "ResourceAttribute"

	// ChangeSourceDirectModification is a ChangeSource enum value
	ChangeSourceDirectModification = "DirectModification"

	// ChangeSourceAutomatic is a ChangeSource enum value
	ChangeSourceAutomatic = "Automatic"
)
View Source 
const (
	// DeprecatedStatusLive is a DeprecatedStatus enum value
	DeprecatedStatusLive = "LIVE"

	// DeprecatedStatusDeprecated is a DeprecatedStatus enum value
	DeprecatedStatusDeprecated = "DEPRECATED"
)
View Source 
const (
	// DifferenceTypeAdd is a DifferenceType enum value
	DifferenceTypeAdd = "ADD"

	// DifferenceTypeRemove is a DifferenceType enum value
	DifferenceTypeRemove = "REMOVE"

	// DifferenceTypeNotEqual is a DifferenceType enum value
	DifferenceTypeNotEqual = "NOT_EQUAL"
)
View Source 
const (
	// EvaluationTypeStatic is a EvaluationType enum value
	EvaluationTypeStatic = "Static"

	// EvaluationTypeDynamic is a EvaluationType enum value
	EvaluationTypeDynamic = "Dynamic"
)
View Source 
const (
	// ExecutionStatusUnavailable is a ExecutionStatus enum value
	ExecutionStatusUnavailable = "UNAVAILABLE"

	// ExecutionStatusAvailable is a ExecutionStatus enum value
	ExecutionStatusAvailable = "AVAILABLE"

	// ExecutionStatusExecuteInProgress is a ExecutionStatus enum value
	ExecutionStatusExecuteInProgress = "EXECUTE_IN_PROGRESS"

	// ExecutionStatusExecuteComplete is a ExecutionStatus enum value
	ExecutionStatusExecuteComplete = "EXECUTE_COMPLETE"

	// ExecutionStatusExecuteFailed is a ExecutionStatus enum value
	ExecutionStatusExecuteFailed = "EXECUTE_FAILED"

	// ExecutionStatusObsolete is a ExecutionStatus enum value
	ExecutionStatusObsolete = "OBSOLETE"
)
View Source 
const (
	// HandlerErrorCodeNotUpdatable is a HandlerErrorCode enum value
	HandlerErrorCodeNotUpdatable = "NotUpdatable"

	// HandlerErrorCodeInvalidRequest is a HandlerErrorCode enum value
	HandlerErrorCodeInvalidRequest = "InvalidRequest"

	// HandlerErrorCodeAccessDenied is a HandlerErrorCode enum value
	HandlerErrorCodeAccessDenied = "AccessDenied"

	// HandlerErrorCodeInvalidCredentials is a HandlerErrorCode enum value
	HandlerErrorCodeInvalidCredentials = "InvalidCredentials"

	// HandlerErrorCodeAlreadyExists is a HandlerErrorCode enum value
	HandlerErrorCodeAlreadyExists = "AlreadyExists"

	// HandlerErrorCodeNotFound is a HandlerErrorCode enum value
	HandlerErrorCodeNotFound = "NotFound"

	// HandlerErrorCodeResourceConflict is a HandlerErrorCode enum value
	HandlerErrorCodeResourceConflict = "ResourceConflict"

	// HandlerErrorCodeThrottling is a HandlerErrorCode enum value
	HandlerErrorCodeThrottling = "Throttling"

	// HandlerErrorCodeServiceLimitExceeded is a HandlerErrorCode enum value
	HandlerErrorCodeServiceLimitExceeded = "ServiceLimitExceeded"

	// HandlerErrorCodeNotStabilized is a HandlerErrorCode enum value
	HandlerErrorCodeNotStabilized = "NotStabilized"

	// HandlerErrorCodeGeneralServiceException is a HandlerErrorCode enum value
	HandlerErrorCodeGeneralServiceException = "GeneralServiceException"

	// HandlerErrorCodeServiceInternalError is a HandlerErrorCode enum value
	HandlerErrorCodeServiceInternalError = "ServiceInternalError"

	// HandlerErrorCodeNetworkFailure is a HandlerErrorCode enum value
	HandlerErrorCodeNetworkFailure = "NetworkFailure"

	// HandlerErrorCodeInternalFailure is a HandlerErrorCode enum value
	HandlerErrorCodeInternalFailure = "InternalFailure"

	// HandlerErrorCodeInvalidTypeConfiguration is a HandlerErrorCode enum value
	HandlerErrorCodeInvalidTypeConfiguration = "InvalidTypeConfiguration"

	// HandlerErrorCodeHandlerInternalFailure is a HandlerErrorCode enum value
	HandlerErrorCodeHandlerInternalFailure = "HandlerInternalFailure"

	// HandlerErrorCodeNonCompliant is a HandlerErrorCode enum value
	HandlerErrorCodeNonCompliant = "NonCompliant"

	// HandlerErrorCodeUnknown is a HandlerErrorCode enum value
	HandlerErrorCodeUnknown = "Unknown"

	// HandlerErrorCodeUnsupportedTarget is a HandlerErrorCode enum value
	HandlerErrorCodeUnsupportedTarget = "UnsupportedTarget"
)
View Source 
const (
	// HookFailureModeFail is a HookFailureMode enum value
	HookFailureModeFail = "FAIL"

	// HookFailureModeWarn is a HookFailureMode enum value
	HookFailureModeWarn = "WARN"
)
View Source 
const (
	// HookStatusHookInProgress is a HookStatus enum value
	HookStatusHookInProgress = "HOOK_IN_PROGRESS"

	// HookStatusHookCompleteSucceeded is a HookStatus enum value
	HookStatusHookCompleteSucceeded = "HOOK_COMPLETE_SUCCEEDED"

	// HookStatusHookCompleteFailed is a HookStatus enum value
	HookStatusHookCompleteFailed = "HOOK_COMPLETE_FAILED"

	// HookStatusHookFailed is a HookStatus enum value
	HookStatusHookFailed = "HOOK_FAILED"
)
View Source 
const (
	// IdentityProviderAwsMarketplace is a IdentityProvider enum value
	IdentityProviderAwsMarketplace = "AWS_Marketplace"

	// IdentityProviderGitHub is a IdentityProvider enum value
	IdentityProviderGitHub = "GitHub"

	// IdentityProviderBitbucket is a IdentityProvider enum value
	IdentityProviderBitbucket = "Bitbucket"
)
View Source 
const (
	// OnFailureDoNothing is a OnFailure enum value
	OnFailureDoNothing = "DO_NOTHING"

	// OnFailureRollback is a OnFailure enum value
	OnFailureRollback = "ROLLBACK"

	// OnFailureDelete is a OnFailure enum value
	OnFailureDelete = "DELETE"
)
View Source 
const (
	// OnStackFailureDoNothing is a OnStackFailure enum value
	OnStackFailureDoNothing = "DO_NOTHING"

	// OnStackFailureRollback is a OnStackFailure enum value
	OnStackFailureRollback = "ROLLBACK"

	// OnStackFailureDelete is a OnStackFailure enum value
	OnStackFailureDelete = "DELETE"
)
View Source 
const (
	// OperationStatusPending is a OperationStatus enum value
	OperationStatusPending = "PENDING"

	// OperationStatusInProgress is a OperationStatus enum value
	OperationStatusInProgress = "IN_PROGRESS"

	// OperationStatusSuccess is a OperationStatus enum value
	OperationStatusSuccess = "SUCCESS"

	// OperationStatusFailed is a OperationStatus enum value
	OperationStatusFailed = "FAILED"
)
View Source 
const (
	// OrganizationStatusEnabled is a OrganizationStatus enum value
	OrganizationStatusEnabled = "ENABLED"

	// OrganizationStatusDisabled is a OrganizationStatus enum value
	OrganizationStatusDisabled = "DISABLED"

	// OrganizationStatusDisabledPermanently is a OrganizationStatus enum value
	OrganizationStatusDisabledPermanently = "DISABLED_PERMANENTLY"
)
View Source 
const (
	// PermissionModelsServiceManaged is a PermissionModels enum value
	PermissionModelsServiceManaged = "SERVICE_MANAGED"

	// PermissionModelsSelfManaged is a PermissionModels enum value
	PermissionModelsSelfManaged = "SELF_MANAGED"
)
View Source 
const (
	// ProvisioningTypeNonProvisionable is a ProvisioningType enum value
	ProvisioningTypeNonProvisionable = "NON_PROVISIONABLE"

	// ProvisioningTypeImmutable is a ProvisioningType enum value
	ProvisioningTypeImmutable = "IMMUTABLE"

	// ProvisioningTypeFullyMutable is a ProvisioningType enum value
	ProvisioningTypeFullyMutable = "FULLY_MUTABLE"
)
View Source 
const (
	// PublisherStatusVerified is a PublisherStatus enum value
	PublisherStatusVerified = "VERIFIED"

	// PublisherStatusUnverified is a PublisherStatus enum value
	PublisherStatusUnverified = "UNVERIFIED"
)
View Source 
const (
	// RegionConcurrencyTypeSequential is a RegionConcurrencyType enum value
	RegionConcurrencyTypeSequential = "SEQUENTIAL"

	// RegionConcurrencyTypeParallel is a RegionConcurrencyType enum value
	RegionConcurrencyTypeParallel = "PARALLEL"
)
View Source 
const (
	// RegistrationStatusComplete is a RegistrationStatus enum value
	RegistrationStatusComplete = "COMPLETE"

	// RegistrationStatusInProgress is a RegistrationStatus enum value
	RegistrationStatusInProgress = "IN_PROGRESS"

	// RegistrationStatusFailed is a RegistrationStatus enum value
	RegistrationStatusFailed = "FAILED"
)
View Source 
const (
	// RegistryTypeResource is a RegistryType enum value
	RegistryTypeResource = "RESOURCE"

	// RegistryTypeModule is a RegistryType enum value
	RegistryTypeModule = "MODULE"

	// RegistryTypeHook is a RegistryType enum value
	RegistryTypeHook = "HOOK"
)
View Source 
const (
	// ReplacementTrue is a Replacement enum value
	ReplacementTrue = "True"

	// ReplacementFalse is a Replacement enum value
	ReplacementFalse = "False"

	// ReplacementConditional is a Replacement enum value
	ReplacementConditional = "Conditional"
)
View Source 
const (
	// RequiresRecreationNever is a RequiresRecreation enum value
	RequiresRecreationNever = "Never"

	// RequiresRecreationConditionally is a RequiresRecreation enum value
	RequiresRecreationConditionally = "Conditionally"

	// RequiresRecreationAlways is a RequiresRecreation enum value
	RequiresRecreationAlways = "Always"
)
View Source 
const (
	// ResourceAttributeProperties is a ResourceAttribute enum value
	ResourceAttributeProperties = "Properties"

	// ResourceAttributeMetadata is a ResourceAttribute enum value
	ResourceAttributeMetadata = "Metadata"

	// ResourceAttributeCreationPolicy is a ResourceAttribute enum value
	ResourceAttributeCreationPolicy = "CreationPolicy"

	// ResourceAttributeUpdatePolicy is a ResourceAttribute enum value
	ResourceAttributeUpdatePolicy = "UpdatePolicy"

	// ResourceAttributeDeletionPolicy is a ResourceAttribute enum value
	ResourceAttributeDeletionPolicy = "DeletionPolicy"

	// ResourceAttributeUpdateReplacePolicy is a ResourceAttribute enum value
	ResourceAttributeUpdateReplacePolicy = "UpdateReplacePolicy"

	// ResourceAttributeTags is a ResourceAttribute enum value
	ResourceAttributeTags = "Tags"
)
View Source 
const (
	// ResourceSignalStatusSuccess is a ResourceSignalStatus enum value
	ResourceSignalStatusSuccess = "SUCCESS"

	// ResourceSignalStatusFailure is a ResourceSignalStatus enum value
	ResourceSignalStatusFailure = "FAILURE"
)
View Source 
const (
	// ResourceStatusCreateInProgress is a ResourceStatus enum value
	ResourceStatusCreateInProgress = "CREATE_IN_PROGRESS"

	// ResourceStatusCreateFailed is a ResourceStatus enum value
	ResourceStatusCreateFailed = "CREATE_FAILED"

	// ResourceStatusCreateComplete is a ResourceStatus enum value
	ResourceStatusCreateComplete = "CREATE_COMPLETE"

	// ResourceStatusDeleteInProgress is a ResourceStatus enum value
	ResourceStatusDeleteInProgress = "DELETE_IN_PROGRESS"

	// ResourceStatusDeleteFailed is a ResourceStatus enum value
	ResourceStatusDeleteFailed = "DELETE_FAILED"

	// ResourceStatusDeleteComplete is a ResourceStatus enum value
	ResourceStatusDeleteComplete = "DELETE_COMPLETE"

	// ResourceStatusDeleteSkipped is a ResourceStatus enum value
	ResourceStatusDeleteSkipped = "DELETE_SKIPPED"

	// ResourceStatusUpdateInProgress is a ResourceStatus enum value
	ResourceStatusUpdateInProgress = "UPDATE_IN_PROGRESS"

	// ResourceStatusUpdateFailed is a ResourceStatus enum value
	ResourceStatusUpdateFailed = "UPDATE_FAILED"

	// ResourceStatusUpdateComplete is a ResourceStatus enum value
	ResourceStatusUpdateComplete = "UPDATE_COMPLETE"

	// ResourceStatusImportFailed is a ResourceStatus enum value
	ResourceStatusImportFailed = "IMPORT_FAILED"

	// ResourceStatusImportComplete is a ResourceStatus enum value
	ResourceStatusImportComplete = "IMPORT_COMPLETE"

	// ResourceStatusImportInProgress is a ResourceStatus enum value
	ResourceStatusImportInProgress = "IMPORT_IN_PROGRESS"

	// ResourceStatusImportRollbackInProgress is a ResourceStatus enum value
	ResourceStatusImportRollbackInProgress = "IMPORT_ROLLBACK_IN_PROGRESS"

	// ResourceStatusImportRollbackFailed is a ResourceStatus enum value
	ResourceStatusImportRollbackFailed = "IMPORT_ROLLBACK_FAILED"

	// ResourceStatusImportRollbackComplete is a ResourceStatus enum value
	ResourceStatusImportRollbackComplete = "IMPORT_ROLLBACK_COMPLETE"

	// ResourceStatusUpdateRollbackInProgress is a ResourceStatus enum value
	ResourceStatusUpdateRollbackInProgress = "UPDATE_ROLLBACK_IN_PROGRESS"

	// ResourceStatusUpdateRollbackComplete is a ResourceStatus enum value
	ResourceStatusUpdateRollbackComplete = "UPDATE_ROLLBACK_COMPLETE"

	// ResourceStatusUpdateRollbackFailed is a ResourceStatus enum value
	ResourceStatusUpdateRollbackFailed = "UPDATE_ROLLBACK_FAILED"

	// ResourceStatusRollbackInProgress is a ResourceStatus enum value
	ResourceStatusRollbackInProgress = "ROLLBACK_IN_PROGRESS"

	// ResourceStatusRollbackComplete is a ResourceStatus enum value
	ResourceStatusRollbackComplete = "ROLLBACK_COMPLETE"

	// ResourceStatusRollbackFailed is a ResourceStatus enum value
	ResourceStatusRollbackFailed = "ROLLBACK_FAILED"
)
View Source 
const (
	// StackDriftDetectionStatusDetectionInProgress is a StackDriftDetectionStatus enum value
	StackDriftDetectionStatusDetectionInProgress = "DETECTION_IN_PROGRESS"

	// StackDriftDetectionStatusDetectionFailed is a StackDriftDetectionStatus enum value
	StackDriftDetectionStatusDetectionFailed = "DETECTION_FAILED"

	// StackDriftDetectionStatusDetectionComplete is a StackDriftDetectionStatus enum value
	StackDriftDetectionStatusDetectionComplete = "DETECTION_COMPLETE"
)
View Source 
const (
	// StackDriftStatusDrifted is a StackDriftStatus enum value
	StackDriftStatusDrifted = "DRIFTED"

	// StackDriftStatusInSync is a StackDriftStatus enum value
	StackDriftStatusInSync = "IN_SYNC"

	// StackDriftStatusUnknown is a StackDriftStatus enum value
	StackDriftStatusUnknown = "UNKNOWN"

	// StackDriftStatusNotChecked is a StackDriftStatus enum value
	StackDriftStatusNotChecked = "NOT_CHECKED"
)
View Source 
const (
	// StackInstanceDetailedStatusPending is a StackInstanceDetailedStatus enum value
	StackInstanceDetailedStatusPending = "PENDING"

	// StackInstanceDetailedStatusRunning is a StackInstanceDetailedStatus enum value
	StackInstanceDetailedStatusRunning = "RUNNING"

	// StackInstanceDetailedStatusSucceeded is a StackInstanceDetailedStatus enum value
	StackInstanceDetailedStatusSucceeded = "SUCCEEDED"

	// StackInstanceDetailedStatusFailed is a StackInstanceDetailedStatus enum value
	StackInstanceDetailedStatusFailed = "FAILED"

	// StackInstanceDetailedStatusCancelled is a StackInstanceDetailedStatus enum value
	StackInstanceDetailedStatusCancelled = "CANCELLED"

	// StackInstanceDetailedStatusInoperable is a StackInstanceDetailedStatus enum value
	StackInstanceDetailedStatusInoperable = "INOPERABLE"

	// StackInstanceDetailedStatusSkippedSuspendedAccount is a StackInstanceDetailedStatus enum value
	StackInstanceDetailedStatusSkippedSuspendedAccount = "SKIPPED_SUSPENDED_ACCOUNT"
)
View Source 
const (
	// StackInstanceFilterNameDetailedStatus is a StackInstanceFilterName enum value
	StackInstanceFilterNameDetailedStatus = "DETAILED_STATUS"

	// StackInstanceFilterNameLastOperationId is a StackInstanceFilterName enum value
	StackInstanceFilterNameLastOperationId = "LAST_OPERATION_ID"

	// StackInstanceFilterNameDriftStatus is a StackInstanceFilterName enum value
	StackInstanceFilterNameDriftStatus = "DRIFT_STATUS"
)
View Source 
const (
	// StackInstanceStatusCurrent is a StackInstanceStatus enum value
	StackInstanceStatusCurrent = "CURRENT"

	// StackInstanceStatusOutdated is a StackInstanceStatus enum value
	StackInstanceStatusOutdated = "OUTDATED"

	// StackInstanceStatusInoperable is a StackInstanceStatus enum value
	StackInstanceStatusInoperable = "INOPERABLE"
)
View Source 
const (
	// StackResourceDriftStatusInSync is a StackResourceDriftStatus enum value
	StackResourceDriftStatusInSync = "IN_SYNC"

	// StackResourceDriftStatusModified is a StackResourceDriftStatus enum value
	StackResourceDriftStatusModified = "MODIFIED"

	// StackResourceDriftStatusDeleted is a StackResourceDriftStatus enum value
	StackResourceDriftStatusDeleted = "DELETED"

	// StackResourceDriftStatusNotChecked is a StackResourceDriftStatus enum value
	StackResourceDriftStatusNotChecked = "NOT_CHECKED"
)
View Source 
const (
	// StackSetDriftDetectionStatusCompleted is a StackSetDriftDetectionStatus enum value
	StackSetDriftDetectionStatusCompleted = "COMPLETED"

	// StackSetDriftDetectionStatusFailed is a StackSetDriftDetectionStatus enum value
	StackSetDriftDetectionStatusFailed = "FAILED"

	// StackSetDriftDetectionStatusPartialSuccess is a StackSetDriftDetectionStatus enum value
	StackSetDriftDetectionStatusPartialSuccess = "PARTIAL_SUCCESS"

	// StackSetDriftDetectionStatusInProgress is a StackSetDriftDetectionStatus enum value
	StackSetDriftDetectionStatusInProgress = "IN_PROGRESS"

	// StackSetDriftDetectionStatusStopped is a StackSetDriftDetectionStatus enum value
	StackSetDriftDetectionStatusStopped = "STOPPED"
)
View Source 
const (
	// StackSetDriftStatusDrifted is a StackSetDriftStatus enum value
	StackSetDriftStatusDrifted = "DRIFTED"

	// StackSetDriftStatusInSync is a StackSetDriftStatus enum value
	StackSetDriftStatusInSync = "IN_SYNC"

	// StackSetDriftStatusNotChecked is a StackSetDriftStatus enum value
	StackSetDriftStatusNotChecked = "NOT_CHECKED"
)
View Source 
const (
	// StackSetOperationActionCreate is a StackSetOperationAction enum value
	StackSetOperationActionCreate = "CREATE"

	// StackSetOperationActionUpdate is a StackSetOperationAction enum value
	StackSetOperationActionUpdate = "UPDATE"

	// StackSetOperationActionDelete is a StackSetOperationAction enum value
	StackSetOperationActionDelete = "DELETE"

	// StackSetOperationActionDetectDrift is a StackSetOperationAction enum value
	StackSetOperationActionDetectDrift = "DETECT_DRIFT"
)
View Source 
const (
	// StackSetOperationResultStatusPending is a StackSetOperationResultStatus enum value
	StackSetOperationResultStatusPending = "PENDING"

	// StackSetOperationResultStatusRunning is a StackSetOperationResultStatus enum value
	StackSetOperationResultStatusRunning = "RUNNING"

	// StackSetOperationResultStatusSucceeded is a StackSetOperationResultStatus enum value
	StackSetOperationResultStatusSucceeded = "SUCCEEDED"

	// StackSetOperationResultStatusFailed is a StackSetOperationResultStatus enum value
	StackSetOperationResultStatusFailed = "FAILED"

	// StackSetOperationResultStatusCancelled is a StackSetOperationResultStatus enum value
	StackSetOperationResultStatusCancelled = "CANCELLED"
)
View Source 
const (
	// StackSetOperationStatusRunning is a StackSetOperationStatus enum value
	StackSetOperationStatusRunning = "RUNNING"

	// StackSetOperationStatusSucceeded is a StackSetOperationStatus enum value
	StackSetOperationStatusSucceeded = "SUCCEEDED"

	// StackSetOperationStatusFailed is a StackSetOperationStatus enum value
	StackSetOperationStatusFailed = "FAILED"

	// StackSetOperationStatusStopping is a StackSetOperationStatus enum value
	StackSetOperationStatusStopping = "STOPPING"

	// StackSetOperationStatusStopped is a StackSetOperationStatus enum value
	StackSetOperationStatusStopped = "STOPPED"

	// StackSetOperationStatusQueued is a StackSetOperationStatus enum value
	StackSetOperationStatusQueued = "QUEUED"
)
View Source 
const (
	// StackSetStatusActive is a StackSetStatus enum value
	StackSetStatusActive = "ACTIVE"

	// StackSetStatusDeleted is a StackSetStatus enum value
	StackSetStatusDeleted = "DELETED"
)
View Source 
const (
	// StackStatusCreateInProgress is a StackStatus enum value
	StackStatusCreateInProgress = "CREATE_IN_PROGRESS"

	// StackStatusCreateFailed is a StackStatus enum value
	StackStatusCreateFailed = "CREATE_FAILED"

	// StackStatusCreateComplete is a StackStatus enum value
	StackStatusCreateComplete = "CREATE_COMPLETE"

	// StackStatusRollbackInProgress is a StackStatus enum value
	StackStatusRollbackInProgress = "ROLLBACK_IN_PROGRESS"

	// StackStatusRollbackFailed is a StackStatus enum value
	StackStatusRollbackFailed = "ROLLBACK_FAILED"

	// StackStatusRollbackComplete is a StackStatus enum value
	StackStatusRollbackComplete = "ROLLBACK_COMPLETE"

	// StackStatusDeleteInProgress is a StackStatus enum value
	StackStatusDeleteInProgress = "DELETE_IN_PROGRESS"

	// StackStatusDeleteFailed is a StackStatus enum value
	StackStatusDeleteFailed = "DELETE_FAILED"

	// StackStatusDeleteComplete is a StackStatus enum value
	StackStatusDeleteComplete = "DELETE_COMPLETE"

	// StackStatusUpdateInProgress is a StackStatus enum value
	StackStatusUpdateInProgress = "UPDATE_IN_PROGRESS"

	// StackStatusUpdateCompleteCleanupInProgress is a StackStatus enum value
	StackStatusUpdateCompleteCleanupInProgress = "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS"

	// StackStatusUpdateComplete is a StackStatus enum value
	StackStatusUpdateComplete = "UPDATE_COMPLETE"

	// StackStatusUpdateFailed is a StackStatus enum value
	StackStatusUpdateFailed = "UPDATE_FAILED"

	// StackStatusUpdateRollbackInProgress is a StackStatus enum value
	StackStatusUpdateRollbackInProgress = "UPDATE_ROLLBACK_IN_PROGRESS"

	// StackStatusUpdateRollbackFailed is a StackStatus enum value
	StackStatusUpdateRollbackFailed = "UPDATE_ROLLBACK_FAILED"

	// StackStatusUpdateRollbackCompleteCleanupInProgress is a StackStatus enum value
	StackStatusUpdateRollbackCompleteCleanupInProgress = "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS"

	// StackStatusUpdateRollbackComplete is a StackStatus enum value
	StackStatusUpdateRollbackComplete = "UPDATE_ROLLBACK_COMPLETE"

	// StackStatusReviewInProgress is a StackStatus enum value
	StackStatusReviewInProgress = "REVIEW_IN_PROGRESS"

	// StackStatusImportInProgress is a StackStatus enum value
	StackStatusImportInProgress = "IMPORT_IN_PROGRESS"

	// StackStatusImportComplete is a StackStatus enum value
	StackStatusImportComplete = "IMPORT_COMPLETE"

	// StackStatusImportRollbackInProgress is a StackStatus enum value
	StackStatusImportRollbackInProgress = "IMPORT_ROLLBACK_IN_PROGRESS"

	// StackStatusImportRollbackFailed is a StackStatus enum value
	StackStatusImportRollbackFailed = "IMPORT_ROLLBACK_FAILED"

	// StackStatusImportRollbackComplete is a StackStatus enum value
	StackStatusImportRollbackComplete = "IMPORT_ROLLBACK_COMPLETE"
)
View Source 
const (
	// TemplateStageOriginal is a TemplateStage enum value
	TemplateStageOriginal = "Original"

	// TemplateStageProcessed is a TemplateStage enum value
	TemplateStageProcessed = "Processed"
)
View Source 
const (
	// ThirdPartyTypeResource is a ThirdPartyType enum value
	ThirdPartyTypeResource = "RESOURCE"

	// ThirdPartyTypeModule is a ThirdPartyType enum value
	ThirdPartyTypeModule = "MODULE"

	// ThirdPartyTypeHook is a ThirdPartyType enum value
	ThirdPartyTypeHook = "HOOK"
)
View Source 
const (
	// TypeTestsStatusPassed is a TypeTestsStatus enum value
	TypeTestsStatusPassed = "PASSED"

	// TypeTestsStatusFailed is a TypeTestsStatus enum value
	TypeTestsStatusFailed = "FAILED"

	// TypeTestsStatusInProgress is a TypeTestsStatus enum value
	TypeTestsStatusInProgress = "IN_PROGRESS"

	// TypeTestsStatusNotTested is a TypeTestsStatus enum value
	TypeTestsStatusNotTested = "NOT_TESTED"
)
View Source 
const (
	// VersionBumpMajor is a VersionBump enum value
	VersionBumpMajor = "MAJOR"

	// VersionBumpMinor is a VersionBump enum value
	VersionBumpMinor = "MINOR"
)
View Source 
const (
	// VisibilityPublic is a Visibility enum value
	VisibilityPublic = "PUBLIC"

	// VisibilityPrivate is a Visibility enum value
	VisibilityPrivate = "PRIVATE"
)
View Source 
const (

	// ErrCodeAlreadyExistsException for service response error code
	// "AlreadyExistsException".
	//
	// The resource with the name requested already exists.
	ErrCodeAlreadyExistsException = "AlreadyExistsException"

	// ErrCodeCFNRegistryException for service response error code
	// "CFNRegistryException".
	//
	// An error occurred during a CloudFormation registry operation.
	ErrCodeCFNRegistryException = "CFNRegistryException"

	// ErrCodeChangeSetNotFoundException for service response error code
	// "ChangeSetNotFound".
	//
	// The specified change set name or ID doesn't exit. To view valid change sets
	// for a stack, use the ListChangeSets operation.
	ErrCodeChangeSetNotFoundException = "ChangeSetNotFound"

	// ErrCodeCreatedButModifiedException for service response error code
	// "CreatedButModifiedException".
	//
	// The specified resource exists, but has been changed.
	ErrCodeCreatedButModifiedException = "CreatedButModifiedException"

	// ErrCodeInsufficientCapabilitiesException for service response error code
	// "InsufficientCapabilitiesException".
	//
	// The template contains resources with capabilities that weren't specified
	// in the Capabilities parameter.
	ErrCodeInsufficientCapabilitiesException = "InsufficientCapabilitiesException"

	// ErrCodeInvalidChangeSetStatusException for service response error code
	// "InvalidChangeSetStatus".
	//
	// The specified change set can't be used to update the stack. For example,
	// the change set status might be CREATE_IN_PROGRESS, or the stack status might
	// be UPDATE_IN_PROGRESS.
	ErrCodeInvalidChangeSetStatusException = "InvalidChangeSetStatus"

	// ErrCodeInvalidOperationException for service response error code
	// "InvalidOperationException".
	//
	// The specified operation isn't valid.
	ErrCodeInvalidOperationException = "InvalidOperationException"

	// ErrCodeInvalidStateTransitionException for service response error code
	// "InvalidStateTransition".
	//
	// Error reserved for use by the CloudFormation CLI (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html).
	// CloudFormation doesn't return this error to users.
	ErrCodeInvalidStateTransitionException = "InvalidStateTransition"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// The quota for the resource has already been reached.
	//
	// For information about resource and stack limitations, see CloudFormation
	// quotas (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html)
	// in the CloudFormation User Guide.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeNameAlreadyExistsException for service response error code
	// "NameAlreadyExistsException".
	//
	// The specified name is already in use.
	ErrCodeNameAlreadyExistsException = "NameAlreadyExistsException"

	// ErrCodeOperationIdAlreadyExistsException for service response error code
	// "OperationIdAlreadyExistsException".
	//
	// The specified operation ID already exists.
	ErrCodeOperationIdAlreadyExistsException = "OperationIdAlreadyExistsException"

	// ErrCodeOperationInProgressException for service response error code
	// "OperationInProgressException".
	//
	// Another operation is currently in progress for this stack set. Only one operation
	// can be performed for a stack set at a given time.
	ErrCodeOperationInProgressException = "OperationInProgressException"

	// ErrCodeOperationNotFoundException for service response error code
	// "OperationNotFoundException".
	//
	// The specified ID refers to an operation that doesn't exist.
	ErrCodeOperationNotFoundException = "OperationNotFoundException"

	// ErrCodeOperationStatusCheckFailedException for service response error code
	// "ConditionalCheckFailed".
	//
	// Error reserved for use by the CloudFormation CLI (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html).
	// CloudFormation doesn't return this error to users.
	ErrCodeOperationStatusCheckFailedException = "ConditionalCheckFailed"

	// ErrCodeStackInstanceNotFoundException for service response error code
	// "StackInstanceNotFoundException".
	//
	// The specified stack instance doesn't exist.
	ErrCodeStackInstanceNotFoundException = "StackInstanceNotFoundException"

	// ErrCodeStackNotFoundException for service response error code
	// "StackNotFoundException".
	//
	// The specified stack ARN doesn't exist or stack doesn't exist corresponding
	// to the ARN in input.
	ErrCodeStackNotFoundException = "StackNotFoundException"

	// ErrCodeStackSetNotEmptyException for service response error code
	// "StackSetNotEmptyException".
	//
	// You can't yet delete this stack set, because it still contains one or more
	// stack instances. Delete all stack instances from the stack set before deleting
	// the stack set.
	ErrCodeStackSetNotEmptyException = "StackSetNotEmptyException"

	// ErrCodeStackSetNotFoundException for service response error code
	// "StackSetNotFoundException".
	//
	// The specified stack set doesn't exist.
	ErrCodeStackSetNotFoundException = "StackSetNotFoundException"

	// ErrCodeStaleRequestException for service response error code
	// "StaleRequestException".
	//
	// Another operation has been performed on this stack set since the specified
	// operation was performed.
	ErrCodeStaleRequestException = "StaleRequestException"

	// ErrCodeTokenAlreadyExistsException for service response error code
	// "TokenAlreadyExistsException".
	//
	// A client request token already exists.
	ErrCodeTokenAlreadyExistsException = "TokenAlreadyExistsException"

	// ErrCodeTypeConfigurationNotFoundException for service response error code
	// "TypeConfigurationNotFoundException".
	//
	// The specified extension configuration can't be found.
	ErrCodeTypeConfigurationNotFoundException = "TypeConfigurationNotFoundException"

	// ErrCodeTypeNotFoundException for service response error code
	// "TypeNotFoundException".
	//
	// The specified extension doesn't exist in the CloudFormation registry.
	ErrCodeTypeNotFoundException = "TypeNotFoundException"
)
View Source 
const (
	ServiceName = "cloudformation" // Name of service.
	EndpointsID = ServiceName      // ID to lookup a service endpoint with.
	ServiceID   = "CloudFormation" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// ChangeTypeResource is a ChangeType enum value
	ChangeTypeResource = "Resource"
)
View Source 
const (
	// HookInvocationPointPreProvision is a HookInvocationPoint enum value
	HookInvocationPointPreProvision = "PRE_PROVISION"
)
View Source 
const (
	// HookTargetTypeResource is a HookTargetType enum value
	HookTargetTypeResource = "RESOURCE"
)
View Source 
const (
	// OperationResultFilterNameOperationResultStatus is a OperationResultFilterName enum value
	OperationResultFilterNameOperationResultStatus = "OPERATION_RESULT_STATUS"
)

Variables

This section is empty.

Functions

func AccountFilterType_Values added in v1.44.49 

func AccountFilterType_Values() []string

AccountFilterType_Values returns all elements of the AccountFilterType enum

func AccountGateStatus_Values added in v1.34.3 

func AccountGateStatus_Values() []string

AccountGateStatus_Values returns all elements of the AccountGateStatus enum

func CallAs_Values added in v1.37.14 

func CallAs_Values() []string

CallAs_Values returns all elements of the CallAs enum

func Capability_Values added in v1.34.3 

func Capability_Values() []string

Capability_Values returns all elements of the Capability enum

func Category_Values added in v1.38.65 

func Category_Values() []string

Category_Values returns all elements of the Category enum

func ChangeAction_Values added in v1.34.3 

func ChangeAction_Values() []string

ChangeAction_Values returns all elements of the ChangeAction enum

func ChangeSetHooksStatus_Values added in v1.42.50 

func ChangeSetHooksStatus_Values() []string

ChangeSetHooksStatus_Values returns all elements of the ChangeSetHooksStatus enum

func ChangeSetStatus_Values added in v1.34.3 

func ChangeSetStatus_Values() []string

ChangeSetStatus_Values returns all elements of the ChangeSetStatus enum

func ChangeSetType_Values added in v1.34.3 

func ChangeSetType_Values() []string

ChangeSetType_Values returns all elements of the ChangeSetType enum

func ChangeSource_Values added in v1.34.3 

func ChangeSource_Values() []string

ChangeSource_Values returns all elements of the ChangeSource enum

func ChangeType_Values added in v1.34.3 

func ChangeType_Values() []string

ChangeType_Values returns all elements of the ChangeType enum

func DeprecatedStatus_Values added in v1.34.3 

func DeprecatedStatus_Values() []string

DeprecatedStatus_Values returns all elements of the DeprecatedStatus enum

func DifferenceType_Values added in v1.34.3 

func DifferenceType_Values() []string

DifferenceType_Values returns all elements of the DifferenceType enum

func EvaluationType_Values added in v1.34.3 

func EvaluationType_Values() []string

EvaluationType_Values returns all elements of the EvaluationType enum

func ExecutionStatus_Values added in v1.34.3 

func ExecutionStatus_Values() []string

ExecutionStatus_Values returns all elements of the ExecutionStatus enum

func HandlerErrorCode_Values added in v1.34.3 

func HandlerErrorCode_Values() []string

HandlerErrorCode_Values returns all elements of the HandlerErrorCode enum

func HookFailureMode_Values added in v1.42.50 

func HookFailureMode_Values() []string

HookFailureMode_Values returns all elements of the HookFailureMode enum

func HookInvocationPoint_Values added in v1.42.50 

func HookInvocationPoint_Values() []string

HookInvocationPoint_Values returns all elements of the HookInvocationPoint enum

func HookStatus_Values added in v1.42.50 

func HookStatus_Values() []string

HookStatus_Values returns all elements of the HookStatus enum

func HookTargetType_Values added in v1.42.50 

func HookTargetType_Values() []string

HookTargetType_Values returns all elements of the HookTargetType enum

func IdentityProvider_Values added in v1.38.65 

func IdentityProvider_Values() []string

IdentityProvider_Values returns all elements of the IdentityProvider enum

func OnFailure_Values added in v1.34.3 

func OnFailure_Values() []string

OnFailure_Values returns all elements of the OnFailure enum

func OnStackFailure_Values added in v1.44.285 

func OnStackFailure_Values() []string

OnStackFailure_Values returns all elements of the OnStackFailure enum

func OperationResultFilterName_Values added in v1.44.126 

func OperationResultFilterName_Values() []string

OperationResultFilterName_Values returns all elements of the OperationResultFilterName enum

func OperationStatus_Values added in v1.34.3 

func OperationStatus_Values() []string

OperationStatus_Values returns all elements of the OperationStatus enum

func OrganizationStatus_Values added in v1.44.276 

func OrganizationStatus_Values() []string

OrganizationStatus_Values returns all elements of the OrganizationStatus enum

func PermissionModels_Values added in v1.34.3 

func PermissionModels_Values() []string

PermissionModels_Values returns all elements of the PermissionModels enum

func ProvisioningType_Values added in v1.34.3 

func ProvisioningType_Values() []string

ProvisioningType_Values returns all elements of the ProvisioningType enum

func PublisherStatus_Values added in v1.38.65 

func PublisherStatus_Values() []string

PublisherStatus_Values returns all elements of the PublisherStatus enum

func RegionConcurrencyType_Values added in v1.38.10 

func RegionConcurrencyType_Values() []string

RegionConcurrencyType_Values returns all elements of the RegionConcurrencyType enum

func RegistrationStatus_Values added in v1.34.3 

func RegistrationStatus_Values() []string

RegistrationStatus_Values returns all elements of the RegistrationStatus enum

func RegistryType_Values added in v1.34.3 

func RegistryType_Values() []string

RegistryType_Values returns all elements of the RegistryType enum

func Replacement_Values added in v1.34.3 

func Replacement_Values() []string

Replacement_Values returns all elements of the Replacement enum

func RequiresRecreation_Values added in v1.34.3 

func RequiresRecreation_Values() []string

RequiresRecreation_Values returns all elements of the RequiresRecreation enum

func ResourceAttribute_Values added in v1.34.3 

func ResourceAttribute_Values() []string

ResourceAttribute_Values returns all elements of the ResourceAttribute enum

func ResourceSignalStatus_Values added in v1.34.3 

func ResourceSignalStatus_Values() []string

ResourceSignalStatus_Values returns all elements of the ResourceSignalStatus enum

func ResourceStatus_Values added in v1.34.3 

func ResourceStatus_Values() []string

ResourceStatus_Values returns all elements of the ResourceStatus enum

func StackDriftDetectionStatus_Values added in v1.34.3 

func StackDriftDetectionStatus_Values() []string

StackDriftDetectionStatus_Values returns all elements of the StackDriftDetectionStatus enum

func StackDriftStatus_Values added in v1.34.3 

func StackDriftStatus_Values() []string

StackDriftStatus_Values returns all elements of the StackDriftStatus enum

func StackInstanceDetailedStatus_Values added in v1.34.3 

func StackInstanceDetailedStatus_Values() []string

StackInstanceDetailedStatus_Values returns all elements of the StackInstanceDetailedStatus enum

func StackInstanceFilterName_Values added in v1.34.3 

func StackInstanceFilterName_Values() []string

StackInstanceFilterName_Values returns all elements of the StackInstanceFilterName enum

func StackInstanceStatus_Values added in v1.34.3 

func StackInstanceStatus_Values() []string

StackInstanceStatus_Values returns all elements of the StackInstanceStatus enum

func StackResourceDriftStatus_Values added in v1.34.3 

func StackResourceDriftStatus_Values() []string

StackResourceDriftStatus_Values returns all elements of the StackResourceDriftStatus enum

func StackSetDriftDetectionStatus_Values added in v1.34.3 

func StackSetDriftDetectionStatus_Values() []string

StackSetDriftDetectionStatus_Values returns all elements of the StackSetDriftDetectionStatus enum

func StackSetDriftStatus_Values added in v1.34.3 

func StackSetDriftStatus_Values() []string

StackSetDriftStatus_Values returns all elements of the StackSetDriftStatus enum

func StackSetOperationAction_Values added in v1.34.3 

func StackSetOperationAction_Values() []string

StackSetOperationAction_Values returns all elements of the StackSetOperationAction enum

func StackSetOperationResultStatus_Values added in v1.34.3 

func StackSetOperationResultStatus_Values() []string

StackSetOperationResultStatus_Values returns all elements of the StackSetOperationResultStatus enum

func StackSetOperationStatus_Values added in v1.34.3 

func StackSetOperationStatus_Values() []string

StackSetOperationStatus_Values returns all elements of the StackSetOperationStatus enum

func StackSetStatus_Values added in v1.34.3 

func StackSetStatus_Values() []string

StackSetStatus_Values returns all elements of the StackSetStatus enum

func StackStatus_Values added in v1.34.3 

func StackStatus_Values() []string

StackStatus_Values returns all elements of the StackStatus enum

func TemplateStage_Values added in v1.34.3 

func TemplateStage_Values() []string

TemplateStage_Values returns all elements of the TemplateStage enum

func ThirdPartyType_Values added in v1.38.65 

func ThirdPartyType_Values() []string

ThirdPartyType_Values returns all elements of the ThirdPartyType enum

func TypeTestsStatus_Values added in v1.38.65 

func TypeTestsStatus_Values() []string

TypeTestsStatus_Values returns all elements of the TypeTestsStatus enum

func VersionBump_Values added in v1.38.65 

func VersionBump_Values() []string

VersionBump_Values returns all elements of the VersionBump enum

func Visibility_Values added in v1.34.3 

func Visibility_Values() []string

Visibility_Values returns all elements of the Visibility enum

Types

type AccountGateResult added in v1.10.16 

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 *string `type:"string" enum:"AccountGateStatus"`

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

Structure that contains the results of the account gate function which 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-account-gating.html).

func (AccountGateResult) GoString added in v1.10.16 

func (s AccountGateResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccountGateResult) SetStatus added in v1.10.16 

func (s *AccountGateResult) SetStatus(v string) *AccountGateResult

SetStatus sets the Status field's value.

func (*AccountGateResult) SetStatusReason added in v1.10.16 

func (s *AccountGateResult) SetStatusReason(v string) *AccountGateResult

SetStatusReason sets the StatusReason field's value.

func (AccountGateResult) String added in v1.10.16 

func (s AccountGateResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AccountLimit added in v0.9.10 

type AccountLimit struct {

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

	// The value that's associated with the account limit name.
	Value *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The AccountLimit data type.

CloudFormation has the following limits per account:

  • Number of concurrent resources

  • Number of stacks

  • Number of stack outputs

For more information about these account limits, and other CloudFormation limits, see CloudFormation quotas (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) in the CloudFormation User Guide.

func (AccountLimit) GoString added in v0.9.10 

func (s AccountLimit) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccountLimit) SetName added in v1.5.0 

func (s *AccountLimit) SetName(v string) *AccountLimit

SetName sets the Name field's value.

func (*AccountLimit) SetValue added in v1.5.0 

func (s *AccountLimit) SetValue(v int64) *AccountLimit

SetValue sets the Value field's value.

func (AccountLimit) String added in v0.9.10 

func (s AccountLimit) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ActivateOrganizationsAccessInput added in v1.44.276 

type ActivateOrganizationsAccessInput struct {
	// contains filtered or unexported fields
}

func (ActivateOrganizationsAccessInput) GoString added in v1.44.276 

func (s ActivateOrganizationsAccessInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (ActivateOrganizationsAccessInput) String added in v1.44.276 

func (s ActivateOrganizationsAccessInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ActivateOrganizationsAccessOutput added in v1.44.276 

type ActivateOrganizationsAccessOutput struct {
	// contains filtered or unexported fields
}

func (ActivateOrganizationsAccessOutput) GoString added in v1.44.276 

func (s ActivateOrganizationsAccessOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (ActivateOrganizationsAccessOutput) String added in v1.44.276 

func (s ActivateOrganizationsAccessOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ActivateTypeInput added in v1.38.65 

type ActivateTypeInput struct {

	// Whether to automatically update the extension in this account and Region
	// when a new minor version is published by the extension publisher. Major versions
	// released by the publisher must be manually updated.
	//
	// The default is true.
	AutoUpdate *bool `type:"boolean"`

	// The name of the IAM execution role to use to activate the extension.
	ExecutionRoleArn *string `min:"1" type:"string"`

	// Contains logging configuration information for an extension.
	LoggingConfig *LoggingConfig `type:"structure"`

	// The major version of this extension you want to activate, if multiple major
	// versions are available. The default is the latest major version. CloudFormation
	// uses the latest available minor version of the major version selected.
	//
	// You can specify MajorVersion or VersionBump, but not both.
	MajorVersion *int64 `min:"1" type:"long"`

	// The Amazon Resource Name (ARN) of the public extension.
	//
	// Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.
	PublicTypeArn *string `type:"string"`

	// The ID of the extension publisher.
	//
	// Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.
	PublisherId *string `min:"1" type:"string"`

	// The extension type.
	//
	// Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.
	Type *string `type:"string" enum:"ThirdPartyType"`

	// The name of the extension.
	//
	// Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.
	TypeName *string `min:"10" type:"string"`

	// An alias to assign to the public extension, in this account and Region. If
	// you specify an alias for the extension, CloudFormation treats the alias as
	// the extension type name within this account and Region. You must use the
	// alias to refer to the extension in your templates, API calls, and CloudFormation
	// console.
	//
	// An extension alias must be unique within a given account and Region. You
	// can activate the same public resource multiple times in the same account
	// and Region, using different type name aliases.
	TypeNameAlias *string `min:"10" type:"string"`

	// Manually updates a previously-activated type to a new major or minor version,
	// if available. You can also use this parameter to update the value of AutoUpdate.
	//
	//    * MAJOR: CloudFormation updates the extension to the newest major version,
	//    if one is available.
	//
	//    * MINOR: CloudFormation updates the extension to the newest minor version,
	//    if one is available.
	VersionBump *string `type:"string" enum:"VersionBump"`
	// contains filtered or unexported fields
}

func (ActivateTypeInput) GoString added in v1.38.65 

func (s ActivateTypeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActivateTypeInput) SetAutoUpdate added in v1.38.65 

func (s *ActivateTypeInput) SetAutoUpdate(v bool) *ActivateTypeInput

SetAutoUpdate sets the AutoUpdate field's value.

func (*ActivateTypeInput) SetExecutionRoleArn added in v1.38.65 

func (s *ActivateTypeInput) SetExecutionRoleArn(v string) *ActivateTypeInput

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*ActivateTypeInput) SetLoggingConfig added in v1.38.65 

func (s *ActivateTypeInput) SetLoggingConfig(v *LoggingConfig) *ActivateTypeInput

SetLoggingConfig sets the LoggingConfig field's value.

func (*ActivateTypeInput) SetMajorVersion added in v1.38.65 

func (s *ActivateTypeInput) SetMajorVersion(v int64) *ActivateTypeInput

SetMajorVersion sets the MajorVersion field's value.

func (*ActivateTypeInput) SetPublicTypeArn added in v1.38.65 

func (s *ActivateTypeInput) SetPublicTypeArn(v string) *ActivateTypeInput

SetPublicTypeArn sets the PublicTypeArn field's value.

func (*ActivateTypeInput) SetPublisherId added in v1.38.65 

func (s *ActivateTypeInput) SetPublisherId(v string) *ActivateTypeInput

SetPublisherId sets the PublisherId field's value.

func (*ActivateTypeInput) SetType added in v1.38.65 

func (s *ActivateTypeInput) SetType(v string) *ActivateTypeInput

SetType sets the Type field's value.

func (*ActivateTypeInput) SetTypeName added in v1.38.65 

func (s *ActivateTypeInput) SetTypeName(v string) *ActivateTypeInput

SetTypeName sets the TypeName field's value.

func (*ActivateTypeInput) SetTypeNameAlias added in v1.38.65 

func (s *ActivateTypeInput) SetTypeNameAlias(v string) *ActivateTypeInput

SetTypeNameAlias sets the TypeNameAlias field's value.

func (*ActivateTypeInput) SetVersionBump added in v1.38.65 

func (s *ActivateTypeInput) SetVersionBump(v string) *ActivateTypeInput

SetVersionBump sets the VersionBump field's value.

func (ActivateTypeInput) String added in v1.38.65 

func (s ActivateTypeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActivateTypeInput) Validate added in v1.38.65 

func (s *ActivateTypeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ActivateTypeOutput added in v1.38.65 

type ActivateTypeOutput struct {

	// The Amazon Resource Name (ARN) of the activated extension, in this account
	// and Region.
	Arn *string `type:"string"`
	// contains filtered or unexported fields
}

func (ActivateTypeOutput) GoString added in v1.38.65 

func (s ActivateTypeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActivateTypeOutput) SetArn added in v1.38.65 

func (s *ActivateTypeOutput) SetArn(v string) *ActivateTypeOutput

SetArn sets the Arn field's value.

func (ActivateTypeOutput) String added in v1.38.65 

func (s ActivateTypeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AutoDeployment added in v1.29.0 

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 `type:"boolean"`

	// 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 `type:"boolean"`
	// 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).

func (AutoDeployment) GoString added in v1.29.0 

func (s AutoDeployment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoDeployment) SetEnabled added in v1.29.0 

func (s *AutoDeployment) SetEnabled(v bool) *AutoDeployment

SetEnabled sets the Enabled field's value.

func (*AutoDeployment) SetRetainStacksOnAccountRemoval added in v1.29.0 

func (s *AutoDeployment) SetRetainStacksOnAccountRemoval(v bool) *AutoDeployment

SetRetainStacksOnAccountRemoval sets the RetainStacksOnAccountRemoval field's value.

func (AutoDeployment) String added in v1.29.0 

func (s AutoDeployment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchDescribeTypeConfigurationsError added in v1.38.65 

type BatchDescribeTypeConfigurationsError struct {

	// The error code.
	ErrorCode *string `min:"3" type:"string"`

	// The error message.
	ErrorMessage *string `min:"1" type:"string"`

	// Identifying information for the configuration of a CloudFormation extension.
	TypeConfigurationIdentifier *TypeConfigurationIdentifier `type:"structure"`
	// contains filtered or unexported fields
}

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

func (BatchDescribeTypeConfigurationsError) GoString added in v1.38.65 

func (s BatchDescribeTypeConfigurationsError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDescribeTypeConfigurationsError) SetErrorCode added in v1.38.65 

func (s *BatchDescribeTypeConfigurationsError) SetErrorCode(v string) *BatchDescribeTypeConfigurationsError

SetErrorCode sets the ErrorCode field's value.

func (*BatchDescribeTypeConfigurationsError) SetErrorMessage added in v1.38.65 

func (s *BatchDescribeTypeConfigurationsError) SetErrorMessage(v string) *BatchDescribeTypeConfigurationsError

SetErrorMessage sets the ErrorMessage field's value.

func (*BatchDescribeTypeConfigurationsError) SetTypeConfigurationIdentifier added in v1.38.65 

func (s *BatchDescribeTypeConfigurationsError) SetTypeConfigurationIdentifier(v *TypeConfigurationIdentifier) *BatchDescribeTypeConfigurationsError

SetTypeConfigurationIdentifier sets the TypeConfigurationIdentifier field's value.

func (BatchDescribeTypeConfigurationsError) String added in v1.38.65 

func (s BatchDescribeTypeConfigurationsError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchDescribeTypeConfigurationsInput added in v1.38.65 

type BatchDescribeTypeConfigurationsInput struct {

	// The list of identifiers for the desired extension configurations.
	//
	// TypeConfigurationIdentifiers is a required field
	TypeConfigurationIdentifiers []*TypeConfigurationIdentifier `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchDescribeTypeConfigurationsInput) GoString added in v1.38.65 

func (s BatchDescribeTypeConfigurationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDescribeTypeConfigurationsInput) SetTypeConfigurationIdentifiers added in v1.38.65 

func (s *BatchDescribeTypeConfigurationsInput) SetTypeConfigurationIdentifiers(v []*TypeConfigurationIdentifier) *BatchDescribeTypeConfigurationsInput

SetTypeConfigurationIdentifiers sets the TypeConfigurationIdentifiers field's value.

func (BatchDescribeTypeConfigurationsInput) String added in v1.38.65 

func (s BatchDescribeTypeConfigurationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDescribeTypeConfigurationsInput) Validate added in v1.38.65 

func (s *BatchDescribeTypeConfigurationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchDescribeTypeConfigurationsOutput added in v1.38.65 

type BatchDescribeTypeConfigurationsOutput struct {

	// A list of information concerning any errors generated during the setting
	// of the specified configurations.
	Errors []*BatchDescribeTypeConfigurationsError `type:"list"`

	// A list of any of the specified extension configurations from the CloudFormation
	// registry.
	TypeConfigurations []*TypeConfigurationDetails `type:"list"`

	// A list of any of the specified extension configurations that CloudFormation
	// could not process for any reason.
	UnprocessedTypeConfigurations []*TypeConfigurationIdentifier `type:"list"`
	// contains filtered or unexported fields
}

func (BatchDescribeTypeConfigurationsOutput) GoString added in v1.38.65 

func (s BatchDescribeTypeConfigurationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDescribeTypeConfigurationsOutput) SetErrors added in v1.38.65 

func (s *BatchDescribeTypeConfigurationsOutput) SetErrors(v []*BatchDescribeTypeConfigurationsError) *BatchDescribeTypeConfigurationsOutput

SetErrors sets the Errors field's value.

func (*BatchDescribeTypeConfigurationsOutput) SetTypeConfigurations added in v1.38.65 

func (s *BatchDescribeTypeConfigurationsOutput) SetTypeConfigurations(v []*TypeConfigurationDetails) *BatchDescribeTypeConfigurationsOutput

SetTypeConfigurations sets the TypeConfigurations field's value.

func (*BatchDescribeTypeConfigurationsOutput) SetUnprocessedTypeConfigurations added in v1.38.65 

func (s *BatchDescribeTypeConfigurationsOutput) SetUnprocessedTypeConfigurations(v []*TypeConfigurationIdentifier) *BatchDescribeTypeConfigurationsOutput

SetUnprocessedTypeConfigurations sets the UnprocessedTypeConfigurations field's value.

func (BatchDescribeTypeConfigurationsOutput) String added in v1.38.65 

func (s BatchDescribeTypeConfigurationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CancelUpdateStackInput 

type CancelUpdateStackInput struct {

	// A unique identifier for this CancelUpdateStack request. Specify this token
	// if you plan to retry requests so that CloudFormation knows that you're not
	// attempting to cancel an update on a stack with the same name. You might retry
	// CancelUpdateStack requests to ensure that CloudFormation successfully received
	// them.
	ClientRequestToken *string `min:"1" type:"string"`

	//
	// If you don't pass a parameter to StackName, the API returns a response that
	// describes all resources in the account.
	//
	// The IAM policy below can be added to IAM policies when you want to limit
	// resource-level permissions and avoid returning a response when no parameter
	// is sent in the request:
	//
	// { "Version": "2012-10-17", "Statement": [{ "Effect": "Deny", "Action": "cloudformation:DescribeStacks",
	// "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" }] }
	//
	// The name or the unique stack ID that's associated with the stack.
	//
	// StackName is a required field
	StackName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the CancelUpdateStack action.

func (CancelUpdateStackInput) GoString added in v0.6.5 

func (s CancelUpdateStackInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelUpdateStackInput) SetClientRequestToken added in v1.8.18 

func (s *CancelUpdateStackInput) SetClientRequestToken(v string) *CancelUpdateStackInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CancelUpdateStackInput) SetStackName added in v1.5.0 

func (s *CancelUpdateStackInput) SetStackName(v string) *CancelUpdateStackInput

SetStackName sets the StackName field's value.

func (CancelUpdateStackInput) String added in v0.6.5 

func (s CancelUpdateStackInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelUpdateStackInput) Validate added in v1.1.21 

func (s *CancelUpdateStackInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CancelUpdateStackOutput 

type CancelUpdateStackOutput struct {
	// contains filtered or unexported fields
}

func (CancelUpdateStackOutput) GoString added in v0.6.5 

func (s CancelUpdateStackOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CancelUpdateStackOutput) String added in v0.6.5 

func (s CancelUpdateStackOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Change added in v1.1.15 

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 *int64 `min:"1" type:"integer"`

	// A ResourceChange structure that describes the resource and action that CloudFormation
	// will perform.
	ResourceChange *ResourceChange `type:"structure"`

	// The type of entity that CloudFormation changes. Currently, the only entity
	// type is Resource.
	Type *string `type:"string" enum:"ChangeType"`
	// contains filtered or unexported fields
}

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

func (Change) GoString added in v1.1.15 

func (s Change) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Change) SetHookInvocationCount added in v1.42.50 

func (s *Change) SetHookInvocationCount(v int64) *Change

SetHookInvocationCount sets the HookInvocationCount field's value.

func (*Change) SetResourceChange added in v1.5.0 

func (s *Change) SetResourceChange(v *ResourceChange) *Change

SetResourceChange sets the ResourceChange field's value.

func (*Change) SetType added in v1.5.0 

func (s *Change) SetType(v string) *Change

SetType sets the Type field's value.

func (Change) String added in v1.1.15 

func (s Change) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ChangeSetHook added in v1.42.50 

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 *string `type:"string" enum:"HookFailureMode"`

	// Specifies the points in provisioning logic where a hook is invoked.
	InvocationPoint *string `type:"string" enum:"HookInvocationPoint"`

	// Specifies details about the target that the hook will run against.
	TargetDetails *ChangeSetHookTargetDetails `type:"structure"`

	// The version ID of the type configuration.
	TypeConfigurationVersionId *string `min:"1" type:"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 `min:"10" type:"string"`

	// The version ID of the type specified.
	TypeVersionId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (ChangeSetHook) GoString added in v1.42.50 

func (s ChangeSetHook) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChangeSetHook) SetFailureMode added in v1.42.50 

func (s *ChangeSetHook) SetFailureMode(v string) *ChangeSetHook

SetFailureMode sets the FailureMode field's value.

func (*ChangeSetHook) SetInvocationPoint added in v1.42.50 

func (s *ChangeSetHook) SetInvocationPoint(v string) *ChangeSetHook

SetInvocationPoint sets the InvocationPoint field's value.

func (*ChangeSetHook) SetTargetDetails added in v1.42.50 

func (s *ChangeSetHook) SetTargetDetails(v *ChangeSetHookTargetDetails) *ChangeSetHook

SetTargetDetails sets the TargetDetails field's value.

func (*ChangeSetHook) SetTypeConfigurationVersionId added in v1.42.50 

func (s *ChangeSetHook) SetTypeConfigurationVersionId(v string) *ChangeSetHook

SetTypeConfigurationVersionId sets the TypeConfigurationVersionId field's value.

func (*ChangeSetHook) SetTypeName added in v1.42.50 

func (s *ChangeSetHook) SetTypeName(v string) *ChangeSetHook

SetTypeName sets the TypeName field's value.

func (*ChangeSetHook) SetTypeVersionId added in v1.42.50 

func (s *ChangeSetHook) SetTypeVersionId(v string) *ChangeSetHook

SetTypeVersionId sets the TypeVersionId field's value.

func (ChangeSetHook) String added in v1.42.50 

func (s ChangeSetHook) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ChangeSetHookResourceTargetDetails added in v1.42.50 

type ChangeSetHookResourceTargetDetails struct {

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

	// Specifies the action of the resource.
	ResourceAction *string `type:"string" enum:"ChangeAction"`

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

Specifies RESOURCE type target details for activated hooks.

func (ChangeSetHookResourceTargetDetails) GoString added in v1.42.50 

func (s ChangeSetHookResourceTargetDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChangeSetHookResourceTargetDetails) SetLogicalResourceId added in v1.42.50 

func (s *ChangeSetHookResourceTargetDetails) SetLogicalResourceId(v string) *ChangeSetHookResourceTargetDetails

SetLogicalResourceId sets the LogicalResourceId field's value.

func (*ChangeSetHookResourceTargetDetails) SetResourceAction added in v1.42.50 

func (s *ChangeSetHookResourceTargetDetails) SetResourceAction(v string) *ChangeSetHookResourceTargetDetails

SetResourceAction sets the ResourceAction field's value.

func (*ChangeSetHookResourceTargetDetails) SetResourceType added in v1.42.50 

func (s *ChangeSetHookResourceTargetDetails) SetResourceType(v string) *ChangeSetHookResourceTargetDetails

SetResourceType sets the ResourceType field's value.

func (ChangeSetHookResourceTargetDetails) String added in v1.42.50 

func (s ChangeSetHookResourceTargetDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ChangeSetHookTargetDetails added in v1.42.50 

type ChangeSetHookTargetDetails struct {

	// Required if TargetType is RESOURCE.
	ResourceTargetDetails *ChangeSetHookResourceTargetDetails `type:"structure"`

	// The name of the type.
	TargetType *string `type:"string" enum:"HookTargetType"`
	// contains filtered or unexported fields
}

Specifies target details for an activated hook.

func (ChangeSetHookTargetDetails) GoString added in v1.42.50 

func (s ChangeSetHookTargetDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChangeSetHookTargetDetails) SetResourceTargetDetails added in v1.42.50 

func (s *ChangeSetHookTargetDetails) SetResourceTargetDetails(v *ChangeSetHookResourceTargetDetails) *ChangeSetHookTargetDetails

SetResourceTargetDetails sets the ResourceTargetDetails field's value.

func (*ChangeSetHookTargetDetails) SetTargetType added in v1.42.50 

func (s *ChangeSetHookTargetDetails) SetTargetType(v string) *ChangeSetHookTargetDetails

SetTargetType sets the TargetType field's value.

func (ChangeSetHookTargetDetails) String added in v1.42.50 

func (s ChangeSetHookTargetDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ChangeSetSummary added in v1.1.15 

type ChangeSetSummary struct {

	// The ID of the change set.
	ChangeSetId *string `min:"1" type:"string"`

	// The name of the change set.
	ChangeSetName *string `min:"1" type:"string"`

	// The start time when the change set was created, in UTC.
	CreationTime *time.Time `type:"timestamp"`

	// Descriptive information about the change set.
	Description *string `min:"1" type:"string"`

	// If the change set execution status is AVAILABLE, you can execute the change
	// set. If you can't execute the change set, the status indicates why. For example,
	// a change set might be in an UNAVAILABLE state because CloudFormation is still
	// creating it or in an OBSOLETE state because the stack was already updated.
	ExecutionStatus *string `type:"string" enum:"ExecutionStatus"`

	// Specifies the current setting of IncludeNestedStacks for the change set.
	IncludeNestedStacks *bool `type:"boolean"`

	// The parent change set ID.
	ParentChangeSetId *string `min:"1" type:"string"`

	// The root change set ID.
	RootChangeSetId *string `min:"1" type:"string"`

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

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

	// The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE,
	// or FAILED.
	Status *string `type:"string" enum:"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 `type:"string"`
	// contains filtered or unexported fields
}

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

func (ChangeSetSummary) GoString added in v1.1.15 

func (s ChangeSetSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChangeSetSummary) SetChangeSetId added in v1.5.0 

func (s *ChangeSetSummary) SetChangeSetId(v string) *ChangeSetSummary

SetChangeSetId sets the ChangeSetId field's value.

func (*ChangeSetSummary) SetChangeSetName added in v1.5.0 

func (s *ChangeSetSummary) SetChangeSetName(v string) *ChangeSetSummary

SetChangeSetName sets the ChangeSetName field's value.

func (*ChangeSetSummary) SetCreationTime added in v1.5.0 

func (s *ChangeSetSummary) SetCreationTime(v time.Time) *ChangeSetSummary

SetCreationTime sets the CreationTime field's value.

func (*ChangeSetSummary) SetDescription added in v1.5.0 

func (s *ChangeSetSummary) SetDescription(v string) *ChangeSetSummary

SetDescription sets the Description field's value.

func (*ChangeSetSummary) SetExecutionStatus added in v1.5.0 

func (s *ChangeSetSummary) SetExecutionStatus(v string) *ChangeSetSummary

SetExecutionStatus sets the ExecutionStatus field's value.

func (*ChangeSetSummary) SetIncludeNestedStacks added in v1.35.31 

func (s *ChangeSetSummary) SetIncludeNestedStacks(v bool) *ChangeSetSummary

SetIncludeNestedStacks sets the IncludeNestedStacks field's value.

func (*ChangeSetSummary) SetParentChangeSetId added in v1.35.31 

func (s *ChangeSetSummary) SetParentChangeSetId(v string) *ChangeSetSummary

SetParentChangeSetId sets the ParentChangeSetId field's value.

func (*ChangeSetSummary) SetRootChangeSetId added in v1.35.31 

func (s *ChangeSetSummary) SetRootChangeSetId(v string) *ChangeSetSummary

SetRootChangeSetId sets the RootChangeSetId field's value.

func (*ChangeSetSummary) SetStackId added in v1.5.0 

func (s *ChangeSetSummary) SetStackId(v string) *ChangeSetSummary

SetStackId sets the StackId field's value.

func (*ChangeSetSummary) SetStackName added in v1.5.0 

func (s *ChangeSetSummary) SetStackName(v string) *ChangeSetSummary

SetStackName sets the StackName field's value.

func (*ChangeSetSummary) SetStatus added in v1.5.0 

func (s *ChangeSetSummary) SetStatus(v string) *ChangeSetSummary

SetStatus sets the Status field's value.

func (*ChangeSetSummary) SetStatusReason added in v1.5.0 

func (s *ChangeSetSummary) SetStatusReason(v string) *ChangeSetSummary

SetStatusReason sets the StatusReason field's value.

func (ChangeSetSummary) String added in v1.1.15 

func (s ChangeSetSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CloudFormation 

type CloudFormation struct {
	*client.Client
}

CloudFormation provides the API operation methods for making requests to AWS CloudFormation. See this package's package overview docs for details on the service.

CloudFormation methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *CloudFormation

New creates a new instance of the CloudFormation client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a CloudFormation client from just a session.
svc := cloudformation.New(mySession)

// Create a CloudFormation client with additional configuration
svc := cloudformation.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*CloudFormation) ActivateOrganizationsAccess added in v1.44.276 

func (c *CloudFormation) ActivateOrganizationsAccess(input *ActivateOrganizationsAccessInput) (*ActivateOrganizationsAccessOutput, error)

ActivateOrganizationsAccess API operation for AWS CloudFormation.

Activate trusted access with Organizations. With trusted access between StackSets and Organizations activated, the management account has permissions to create and manage StackSets for your organization.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation ActivateOrganizationsAccess for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidOperationException "InvalidOperationException" The specified operation isn't valid.

  • ErrCodeOperationNotFoundException "OperationNotFoundException" The specified ID refers to an operation that doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ActivateOrganizationsAccess

func (*CloudFormation) ActivateOrganizationsAccessRequest added in v1.44.276 

func (c *CloudFormation) ActivateOrganizationsAccessRequest(input *ActivateOrganizationsAccessInput) (req *request.Request, output *ActivateOrganizationsAccessOutput)

ActivateOrganizationsAccessRequest generates a "aws/request.Request" representing the client's request for the ActivateOrganizationsAccess operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ActivateOrganizationsAccess for more information on using the ActivateOrganizationsAccess API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ActivateOrganizationsAccessRequest method.
req, resp := client.ActivateOrganizationsAccessRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ActivateOrganizationsAccess

func (*CloudFormation) ActivateOrganizationsAccessWithContext added in v1.44.276 

func (c *CloudFormation) ActivateOrganizationsAccessWithContext(ctx aws.Context, input *ActivateOrganizationsAccessInput, opts ...request.Option) (*ActivateOrganizationsAccessOutput, error)

ActivateOrganizationsAccessWithContext is the same as ActivateOrganizationsAccess with the addition of the ability to pass a context and additional request options.

See ActivateOrganizationsAccess for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ActivateType added in v1.38.65 

func (c *CloudFormation) ActivateType(input *ActivateTypeInput) (*ActivateTypeOutput, error)

ActivateType API operation for AWS CloudFormation.

Activates a public third-party extension, making it available for use in stack templates. For more information, see Using public extensions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html) in the CloudFormation User Guide.

Once you have activated a public third-party extension in your account and Region, use SetTypeConfiguration (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html) to specify configuration properties for the extension. For more information, see Configuring extensions at the account level (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration) in the CloudFormation User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation ActivateType for usage and error information.

Returned Error Codes:

  • ErrCodeCFNRegistryException "CFNRegistryException" An error occurred during a CloudFormation registry operation.

  • ErrCodeTypeNotFoundException "TypeNotFoundException" The specified extension doesn't exist in the CloudFormation registry.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ActivateType

func (*CloudFormation) ActivateTypeRequest added in v1.38.65 

func (c *CloudFormation) ActivateTypeRequest(input *ActivateTypeInput) (req *request.Request, output *ActivateTypeOutput)

ActivateTypeRequest generates a "aws/request.Request" representing the client's request for the ActivateType operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ActivateType for more information on using the ActivateType API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ActivateTypeRequest method.
req, resp := client.ActivateTypeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ActivateType

func (*CloudFormation) ActivateTypeWithContext added in v1.38.65 

func (c *CloudFormation) ActivateTypeWithContext(ctx aws.Context, input *ActivateTypeInput, opts ...request.Option) (*ActivateTypeOutput, error)

ActivateTypeWithContext is the same as ActivateType with the addition of the ability to pass a context and additional request options.

See ActivateType for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) BatchDescribeTypeConfigurations added in v1.38.65 

func (c *CloudFormation) BatchDescribeTypeConfigurations(input *BatchDescribeTypeConfigurationsInput) (*BatchDescribeTypeConfigurationsOutput, error)

BatchDescribeTypeConfigurations API operation for AWS CloudFormation.

Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region.

For more information, see Configuring extensions at the account level (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration) in the CloudFormation User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation BatchDescribeTypeConfigurations for usage and error information.

Returned Error Codes:

  • ErrCodeTypeConfigurationNotFoundException "TypeConfigurationNotFoundException" The specified extension configuration can't be found.

  • ErrCodeCFNRegistryException "CFNRegistryException" An error occurred during a CloudFormation registry operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/BatchDescribeTypeConfigurations

func (*CloudFormation) BatchDescribeTypeConfigurationsRequest added in v1.38.65 

func (c *CloudFormation) BatchDescribeTypeConfigurationsRequest(input *BatchDescribeTypeConfigurationsInput) (req *request.Request, output *BatchDescribeTypeConfigurationsOutput)

BatchDescribeTypeConfigurationsRequest generates a "aws/request.Request" representing the client's request for the BatchDescribeTypeConfigurations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchDescribeTypeConfigurations for more information on using the BatchDescribeTypeConfigurations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the BatchDescribeTypeConfigurationsRequest method.
req, resp := client.BatchDescribeTypeConfigurationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/BatchDescribeTypeConfigurations

func (*CloudFormation) BatchDescribeTypeConfigurationsWithContext added in v1.38.65 

func (c *CloudFormation) BatchDescribeTypeConfigurationsWithContext(ctx aws.Context, input *BatchDescribeTypeConfigurationsInput, opts ...request.Option) (*BatchDescribeTypeConfigurationsOutput, error)

BatchDescribeTypeConfigurationsWithContext is the same as BatchDescribeTypeConfigurations with the addition of the ability to pass a context and additional request options.

See BatchDescribeTypeConfigurations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) CancelUpdateStack 

func (c *CloudFormation) CancelUpdateStack(input *CancelUpdateStackInput) (*CancelUpdateStackOutput, error)

CancelUpdateStack API operation for AWS CloudFormation.

Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.

You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation CancelUpdateStack for usage and error information.

Returned Error Codes:

  • ErrCodeTokenAlreadyExistsException "TokenAlreadyExistsException" A client request token already exists.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CancelUpdateStack

func (*CloudFormation) CancelUpdateStackRequest 

func (c *CloudFormation) CancelUpdateStackRequest(input *CancelUpdateStackInput) (req *request.Request, output *CancelUpdateStackOutput)

CancelUpdateStackRequest generates a "aws/request.Request" representing the client's request for the CancelUpdateStack operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CancelUpdateStack for more information on using the CancelUpdateStack API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CancelUpdateStackRequest method.
req, resp := client.CancelUpdateStackRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CancelUpdateStack

func (*CloudFormation) CancelUpdateStackWithContext added in v1.8.0 

func (c *CloudFormation) CancelUpdateStackWithContext(ctx aws.Context, input *CancelUpdateStackInput, opts ...request.Option) (*CancelUpdateStackOutput, error)

CancelUpdateStackWithContext is the same as CancelUpdateStack with the addition of the ability to pass a context and additional request options.

See CancelUpdateStack for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ContinueUpdateRollback added in v1.0.11 

func (c *CloudFormation) ContinueUpdateRollback(input *ContinueUpdateRollbackInput) (*ContinueUpdateRollbackOutput, error)

ContinueUpdateRollback API operation for AWS CloudFormation.

For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the error (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed) and continue the rollback. By continuing the rollback, you can return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again.

A stack goes into the UPDATE_ROLLBACK_FAILED state when CloudFormation can't roll back all changes after a failed stack update. For example, you might have a stack that's rolling back to an old database instance that was deleted outside of CloudFormation. Because CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation ContinueUpdateRollback for usage and error information.

Returned Error Codes:

  • ErrCodeTokenAlreadyExistsException "TokenAlreadyExistsException" A client request token already exists.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ContinueUpdateRollback

func (*CloudFormation) ContinueUpdateRollbackRequest added in v1.0.11 

func (c *CloudFormation) ContinueUpdateRollbackRequest(input *ContinueUpdateRollbackInput) (req *request.Request, output *ContinueUpdateRollbackOutput)

ContinueUpdateRollbackRequest generates a "aws/request.Request" representing the client's request for the ContinueUpdateRollback operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ContinueUpdateRollback for more information on using the ContinueUpdateRollback API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ContinueUpdateRollbackRequest method.
req, resp := client.ContinueUpdateRollbackRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ContinueUpdateRollback

func (*CloudFormation) ContinueUpdateRollbackWithContext added in v1.8.0 

func (c *CloudFormation) ContinueUpdateRollbackWithContext(ctx aws.Context, input *ContinueUpdateRollbackInput, opts ...request.Option) (*ContinueUpdateRollbackOutput, error)

ContinueUpdateRollbackWithContext is the same as ContinueUpdateRollback with the addition of the ability to pass a context and additional request options.

See ContinueUpdateRollback for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) CreateChangeSet added in v1.1.15 

func (c *CloudFormation) CreateChangeSet(input *CreateChangeSetInput) (*CreateChangeSetOutput, error)

CreateChangeSet API operation for AWS CloudFormation.

Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you create a change set for an existing stack, CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack.

To create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify CREATE. To create a change set for an existing stack, specify UPDATE for the ChangeSetType parameter. To create a change set for an import operation, specify IMPORT for the ChangeSetType parameter. After the CreateChangeSet call successfully completes, CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet action.

When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. CloudFormation doesn't make changes until you execute the change set.

To create a change set for the entire stack hierarchy, set IncludeNestedStacks to True.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation CreateChangeSet for usage and error information.

Returned Error Codes:

  • ErrCodeAlreadyExistsException "AlreadyExistsException" The resource with the name requested already exists.

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

  • ErrCodeLimitExceededException "LimitExceededException" The quota for the resource has already been reached.

    For information about resource and stack limitations, see CloudFormation quotas (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) in the CloudFormation User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet

func (*CloudFormation) CreateChangeSetRequest added in v1.1.15 

func (c *CloudFormation) CreateChangeSetRequest(input *CreateChangeSetInput) (req *request.Request, output *CreateChangeSetOutput)

CreateChangeSetRequest generates a "aws/request.Request" representing the client's request for the CreateChangeSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateChangeSet for more information on using the CreateChangeSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateChangeSetRequest method.
req, resp := client.CreateChangeSetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet

func (*CloudFormation) CreateChangeSetWithContext added in v1.8.0 

func (c *CloudFormation) CreateChangeSetWithContext(ctx aws.Context, input *CreateChangeSetInput, opts ...request.Option) (*CreateChangeSetOutput, error)

CreateChangeSetWithContext is the same as CreateChangeSet with the addition of the ability to pass a context and additional request options.

See CreateChangeSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) CreateStack 

func (c *CloudFormation) CreateStack(input *CreateStackInput) (*CreateStackOutput, error)

CreateStack API operation for AWS CloudFormation.

Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack through the DescribeStacks operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation CreateStack for usage and error information.

Returned Error Codes:

  • ErrCodeLimitExceededException "LimitExceededException" The quota for the resource has already been reached.

    For information about resource and stack limitations, see CloudFormation quotas (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) in the CloudFormation User Guide.

  • ErrCodeAlreadyExistsException "AlreadyExistsException" The resource with the name requested already exists.

  • ErrCodeTokenAlreadyExistsException "TokenAlreadyExistsException" A client request token already exists.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateStack

func (*CloudFormation) CreateStackInstances added in v1.10.16 

func (c *CloudFormation) CreateStackInstances(input *CreateStackInstancesInput) (*CreateStackInstancesOutput, error)

CreateStackInstances API operation for AWS CloudFormation.

Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region. You must specify at least one value for either Accounts or DeploymentTargets, and you must specify at least one value for Regions.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation CreateStackInstances for usage and error information.

Returned Error Codes:

  • ErrCodeStackSetNotFoundException "StackSetNotFoundException" The specified stack set doesn't exist.

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

  • ErrCodeOperationIdAlreadyExistsException "OperationIdAlreadyExistsException" The specified operation ID already exists.

  • ErrCodeStaleRequestException "StaleRequestException" Another operation has been performed on this stack set since the specified operation was performed.

  • ErrCodeInvalidOperationException "InvalidOperationException" The specified operation isn't valid.

  • ErrCodeLimitExceededException "LimitExceededException" The quota for the resource has already been reached.

    For information about resource and stack limitations, see CloudFormation quotas (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) in the CloudFormation User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateStackInstances

func (*CloudFormation) CreateStackInstancesRequest added in v1.10.16 

func (c *CloudFormation) CreateStackInstancesRequest(input *CreateStackInstancesInput) (req *request.Request, output *CreateStackInstancesOutput)

CreateStackInstancesRequest generates a "aws/request.Request" representing the client's request for the CreateStackInstances operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateStackInstances for more information on using the CreateStackInstances API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateStackInstancesRequest method.
req, resp := client.CreateStackInstancesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateStackInstances

func (*CloudFormation) CreateStackInstancesWithContext added in v1.10.16 

func (c *CloudFormation) CreateStackInstancesWithContext(ctx aws.Context, input *CreateStackInstancesInput, opts ...request.Option) (*CreateStackInstancesOutput, error)

CreateStackInstancesWithContext is the same as CreateStackInstances with the addition of the ability to pass a context and additional request options.

See CreateStackInstances for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) CreateStackRequest 

func (c *CloudFormation) CreateStackRequest(input *CreateStackInput) (req *request.Request, output *CreateStackOutput)

CreateStackRequest generates a "aws/request.Request" representing the client's request for the CreateStack operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateStack for more information on using the CreateStack API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateStackRequest method.
req, resp := client.CreateStackRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateStack

func (*CloudFormation) CreateStackSet added in v1.10.16 

func (c *CloudFormation) CreateStackSet(input *CreateStackSetInput) (*CreateStackSetOutput, error)

CreateStackSet API operation for AWS CloudFormation.

Creates a stack set.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation CreateStackSet for usage and error information.

Returned Error Codes:

  • ErrCodeNameAlreadyExistsException "NameAlreadyExistsException" The specified name is already in use.

  • ErrCodeCreatedButModifiedException "CreatedButModifiedException" The specified resource exists, but has been changed.

  • ErrCodeLimitExceededException "LimitExceededException" The quota for the resource has already been reached.

    For information about resource and stack limitations, see CloudFormation quotas (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) in the CloudFormation User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateStackSet

func (*CloudFormation) CreateStackSetRequest added in v1.10.16 

func (c *CloudFormation) CreateStackSetRequest(input *CreateStackSetInput) (req *request.Request, output *CreateStackSetOutput)

CreateStackSetRequest generates a "aws/request.Request" representing the client's request for the CreateStackSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateStackSet for more information on using the CreateStackSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateStackSetRequest method.
req, resp := client.CreateStackSetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateStackSet

func (*CloudFormation) CreateStackSetWithContext added in v1.10.16 

func (c *CloudFormation) CreateStackSetWithContext(ctx aws.Context, input *CreateStackSetInput, opts ...request.Option) (*CreateStackSetOutput, error)

CreateStackSetWithContext is the same as CreateStackSet with the addition of the ability to pass a context and additional request options.

See CreateStackSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) CreateStackWithContext added in v1.8.0 

func (c *CloudFormation) CreateStackWithContext(ctx aws.Context, input *CreateStackInput, opts ...request.Option) (*CreateStackOutput, error)

CreateStackWithContext is the same as CreateStack with the addition of the ability to pass a context and additional request options.

See CreateStack for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DeactivateOrganizationsAccess added in v1.44.276 

func (c *CloudFormation) DeactivateOrganizationsAccess(input *DeactivateOrganizationsAccessInput) (*DeactivateOrganizationsAccessOutput, error)

DeactivateOrganizationsAccess API operation for AWS CloudFormation.

Deactivates trusted access with Organizations. If trusted access is deactivated, the management account does not have permissions to create and manage service-managed StackSets for your organization.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation DeactivateOrganizationsAccess for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidOperationException "InvalidOperationException" The specified operation isn't valid.

  • ErrCodeOperationNotFoundException "OperationNotFoundException" The specified ID refers to an operation that doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeactivateOrganizationsAccess

func (*CloudFormation) DeactivateOrganizationsAccessRequest added in v1.44.276 

func (c *CloudFormation) DeactivateOrganizationsAccessRequest(input *DeactivateOrganizationsAccessInput) (req *request.Request, output *DeactivateOrganizationsAccessOutput)

DeactivateOrganizationsAccessRequest generates a "aws/request.Request" representing the client's request for the DeactivateOrganizationsAccess operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeactivateOrganizationsAccess for more information on using the DeactivateOrganizationsAccess API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeactivateOrganizationsAccessRequest method.
req, resp := client.DeactivateOrganizationsAccessRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeactivateOrganizationsAccess

func (*CloudFormation) DeactivateOrganizationsAccessWithContext added in v1.44.276 

func (c *CloudFormation) DeactivateOrganizationsAccessWithContext(ctx aws.Context, input *DeactivateOrganizationsAccessInput, opts ...request.Option) (*DeactivateOrganizationsAccessOutput, error)

DeactivateOrganizationsAccessWithContext is the same as DeactivateOrganizationsAccess with the addition of the ability to pass a context and additional request options.

See DeactivateOrganizationsAccess for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DeactivateType added in v1.38.65 

func (c *CloudFormation) DeactivateType(input *DeactivateTypeInput) (*DeactivateTypeOutput, error)

DeactivateType API operation for AWS CloudFormation.

Deactivates a public extension that was previously activated in this account and Region.

Once deactivated, an extension can't be used in any CloudFormation operation. This includes stack update operations where the stack template includes the extension, even if no updates are being made to the extension. In addition, deactivated extensions aren't automatically updated if a new version of the extension is released.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation DeactivateType for usage and error information.

Returned Error Codes:

  • ErrCodeCFNRegistryException "CFNRegistryException" An error occurred during a CloudFormation registry operation.

  • ErrCodeTypeNotFoundException "TypeNotFoundException" The specified extension doesn't exist in the CloudFormation registry.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeactivateType

func (*CloudFormation) DeactivateTypeRequest added in v1.38.65 

func (c *CloudFormation) DeactivateTypeRequest(input *DeactivateTypeInput) (req *request.Request, output *DeactivateTypeOutput)

DeactivateTypeRequest generates a "aws/request.Request" representing the client's request for the DeactivateType operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeactivateType for more information on using the DeactivateType API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeactivateTypeRequest method.
req, resp := client.DeactivateTypeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeactivateType

func (*CloudFormation) DeactivateTypeWithContext added in v1.38.65 

func (c *CloudFormation) DeactivateTypeWithContext(ctx aws.Context, input *DeactivateTypeInput, opts ...request.Option) (*DeactivateTypeOutput, error)

DeactivateTypeWithContext is the same as DeactivateType with the addition of the ability to pass a context and additional request options.

See DeactivateType for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DeleteChangeSet added in v1.1.15 

func (c *CloudFormation) DeleteChangeSet(input *DeleteChangeSetInput) (*DeleteChangeSetOutput, error)

DeleteChangeSet API operation for AWS CloudFormation.

Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.

If the call successfully completes, CloudFormation successfully deleted the change set.

If IncludeNestedStacks specifies True during the creation of the nested change set, then DeleteChangeSet will delete all change sets that belong to the stacks hierarchy and will also delete all change sets for nested stacks with the status of REVIEW_IN_PROGRESS.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation DeleteChangeSet for usage and error information.

Returned Error Codes:

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteChangeSet

func (*CloudFormation) DeleteChangeSetRequest added in v1.1.15 

func (c *CloudFormation) DeleteChangeSetRequest(input *DeleteChangeSetInput) (req *request.Request, output *DeleteChangeSetOutput)

DeleteChangeSetRequest generates a "aws/request.Request" representing the client's request for the DeleteChangeSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteChangeSet for more information on using the DeleteChangeSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteChangeSetRequest method.
req, resp := client.DeleteChangeSetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteChangeSet

func (*CloudFormation) DeleteChangeSetWithContext added in v1.8.0 

func (c *CloudFormation) DeleteChangeSetWithContext(ctx aws.Context, input *DeleteChangeSetInput, opts ...request.Option) (*DeleteChangeSetOutput, error)

DeleteChangeSetWithContext is the same as DeleteChangeSet with the addition of the ability to pass a context and additional request options.

See DeleteChangeSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DeleteStack 

func (c *CloudFormation) DeleteStack(input *DeleteStackInput) (*DeleteStackOutput, error)

DeleteStack API operation for AWS CloudFormation.

Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't show up in the DescribeStacks operation if the deletion has been completed successfully.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation DeleteStack for usage and error information.

Returned Error Codes:

  • ErrCodeTokenAlreadyExistsException "TokenAlreadyExistsException" A client request token already exists.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteStack

func (*CloudFormation) DeleteStackInstances added in v1.10.16 

func (c *CloudFormation) DeleteStackInstances(input *DeleteStackInstancesInput) (*DeleteStackInstancesOutput, error)

DeleteStackInstances API operation for AWS CloudFormation.

Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation DeleteStackInstances for usage and error information.

Returned Error Codes:

  • ErrCodeStackSetNotFoundException "StackSetNotFoundException" The specified stack set doesn't exist.

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

  • ErrCodeOperationIdAlreadyExistsException "OperationIdAlreadyExistsException" The specified operation ID already exists.

  • ErrCodeStaleRequestException "StaleRequestException" Another operation has been performed on this stack set since the specified operation was performed.

  • ErrCodeInvalidOperationException "InvalidOperationException" The specified operation isn't valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteStackInstances

func (*CloudFormation) DeleteStackInstancesRequest added in v1.10.16 

func (c *CloudFormation) DeleteStackInstancesRequest(input *DeleteStackInstancesInput) (req *request.Request, output *DeleteStackInstancesOutput)

DeleteStackInstancesRequest generates a "aws/request.Request" representing the client's request for the DeleteStackInstances operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteStackInstances for more information on using the DeleteStackInstances API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteStackInstancesRequest method.
req, resp := client.DeleteStackInstancesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteStackInstances

func (*CloudFormation) DeleteStackInstancesWithContext added in v1.10.16 

func (c *CloudFormation) DeleteStackInstancesWithContext(ctx aws.Context, input *DeleteStackInstancesInput, opts ...request.Option) (*DeleteStackInstancesOutput, error)

DeleteStackInstancesWithContext is the same as DeleteStackInstances with the addition of the ability to pass a context and additional request options.

See DeleteStackInstances for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DeleteStackRequest 

func (c *CloudFormation) DeleteStackRequest(input *DeleteStackInput) (req *request.Request, output *DeleteStackOutput)

DeleteStackRequest generates a "aws/request.Request" representing the client's request for the DeleteStack operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteStack for more information on using the DeleteStack API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteStackRequest method.
req, resp := client.DeleteStackRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteStack

func (*CloudFormation) DeleteStackSet added in v1.10.16 

func (c *CloudFormation) DeleteStackSet(input *DeleteStackSetInput) (*DeleteStackSetOutput, error)

DeleteStackSet API operation for AWS CloudFormation.

Deletes a stack set. Before you can delete a stack set, all its member stack instances must be deleted. For more information about how to complete this, see DeleteStackInstances.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation DeleteStackSet for usage and error information.

Returned Error Codes:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteStackSet

func (*CloudFormation) DeleteStackSetRequest added in v1.10.16 

func (c *CloudFormation) DeleteStackSetRequest(input *DeleteStackSetInput) (req *request.Request, output *DeleteStackSetOutput)

DeleteStackSetRequest generates a "aws/request.Request" representing the client's request for the DeleteStackSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteStackSet for more information on using the DeleteStackSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteStackSetRequest method.
req, resp := client.DeleteStackSetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeleteStackSet

func (*CloudFormation) DeleteStackSetWithContext added in v1.10.16 

func (c *CloudFormation) DeleteStackSetWithContext(ctx aws.Context, input *DeleteStackSetInput, opts ...request.Option) (*DeleteStackSetOutput, error)

DeleteStackSetWithContext is the same as DeleteStackSet with the addition of the ability to pass a context and additional request options.

See DeleteStackSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DeleteStackWithContext added in v1.8.0 

func (c *CloudFormation) DeleteStackWithContext(ctx aws.Context, input *DeleteStackInput, opts ...request.Option) (*DeleteStackOutput, error)

DeleteStackWithContext is the same as DeleteStack with the addition of the ability to pass a context and additional request options.

See DeleteStack for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DeregisterType added in v1.25.37 

func (c *CloudFormation) DeregisterType(input *DeregisterTypeInput) (*DeregisterTypeOutput, error)

DeregisterType API operation for AWS CloudFormation.

Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations.

To deregister an entire extension, you must individually deregister all active versions of that extension. If an extension has only a single active version, deregistering that version results in the extension itself being deregistered and marked as deprecated in the registry.

You can't deregister the default version of an extension if there are other active version of that extension. If you do deregister the default version of an extension, the extension type itself is deregistered as well and marked as deprecated.

To view the deprecation status of an extension or extension version, use DescribeType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation DeregisterType for usage and error information.

Returned Error Codes:

  • ErrCodeCFNRegistryException "CFNRegistryException" An error occurred during a CloudFormation registry operation.

  • ErrCodeTypeNotFoundException "TypeNotFoundException" The specified extension doesn't exist in the CloudFormation registry.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeregisterType

func (*CloudFormation) DeregisterTypeRequest added in v1.25.37 

func (c *CloudFormation) DeregisterTypeRequest(input *DeregisterTypeInput) (req *request.Request, output *DeregisterTypeOutput)

DeregisterTypeRequest generates a "aws/request.Request" representing the client's request for the DeregisterType operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeregisterType for more information on using the DeregisterType API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeregisterTypeRequest method.
req, resp := client.DeregisterTypeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DeregisterType

func (*CloudFormation) DeregisterTypeWithContext added in v1.25.37 

func (c *CloudFormation) DeregisterTypeWithContext(ctx aws.Context, input *DeregisterTypeInput, opts ...request.Option) (*DeregisterTypeOutput, error)

DeregisterTypeWithContext is the same as DeregisterType with the addition of the ability to pass a context and additional request options.

See DeregisterType for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DescribeAccountLimits added in v0.9.10 

func (c *CloudFormation) DescribeAccountLimits(input *DescribeAccountLimitsInput) (*DescribeAccountLimitsOutput, error)

DescribeAccountLimits API operation for AWS CloudFormation.

Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see CloudFormation Quotas (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) in the CloudFormation User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation DescribeAccountLimits for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeAccountLimits

func (*CloudFormation) DescribeAccountLimitsPages added in v1.30.29 

func (c *CloudFormation) DescribeAccountLimitsPages(input *DescribeAccountLimitsInput, fn func(*DescribeAccountLimitsOutput, bool) bool) error

DescribeAccountLimitsPages iterates over the pages of a DescribeAccountLimits operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeAccountLimits method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeAccountLimits operation.
pageNum := 0
err := client.DescribeAccountLimitsPages(params,
    func(page *cloudformation.DescribeAccountLimitsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudFormation) DescribeAccountLimitsPagesWithContext added in v1.30.29 

func (c *CloudFormation) DescribeAccountLimitsPagesWithContext(ctx aws.Context, input *DescribeAccountLimitsInput, fn func(*DescribeAccountLimitsOutput, bool) bool, opts ...request.Option) error

DescribeAccountLimitsPagesWithContext same as DescribeAccountLimitsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DescribeAccountLimitsRequest added in v0.9.10 

func (c *CloudFormation) DescribeAccountLimitsRequest(input *DescribeAccountLimitsInput) (req *request.Request, output *DescribeAccountLimitsOutput)

DescribeAccountLimitsRequest generates a "aws/request.Request" representing the client's request for the DescribeAccountLimits operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAccountLimits for more information on using the DescribeAccountLimits API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeAccountLimitsRequest method.
req, resp := client.DescribeAccountLimitsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeAccountLimits

func (*CloudFormation) DescribeAccountLimitsWithContext added in v1.8.0 

func (c *CloudFormation) DescribeAccountLimitsWithContext(ctx aws.Context, input *DescribeAccountLimitsInput, opts ...request.Option) (*DescribeAccountLimitsOutput, error)

DescribeAccountLimitsWithContext is the same as DescribeAccountLimits with the addition of the ability to pass a context and additional request options.

See DescribeAccountLimits for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DescribeChangeSet added in v1.1.15 

func (c *CloudFormation) DescribeChangeSet(input *DescribeChangeSetInput) (*DescribeChangeSetOutput, error)

DescribeChangeSet API operation for AWS CloudFormation.

Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html) in the CloudFormation User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation DescribeChangeSet for usage and error information.

Returned Error Codes:

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeChangeSet

func (*CloudFormation) DescribeChangeSetHooks added in v1.42.50 

func (c *CloudFormation) DescribeChangeSetHooks(input *DescribeChangeSetHooksInput) (*DescribeChangeSetHooksOutput, error)

DescribeChangeSetHooks API operation for AWS CloudFormation.

Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation DescribeChangeSetHooks for usage and error information.

Returned Error Codes:

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeChangeSetHooks

func (*CloudFormation) DescribeChangeSetHooksRequest added in v1.42.50 

func (c *CloudFormation) DescribeChangeSetHooksRequest(input *DescribeChangeSetHooksInput) (req *request.Request, output *DescribeChangeSetHooksOutput)

DescribeChangeSetHooksRequest generates a "aws/request.Request" representing the client's request for the DescribeChangeSetHooks operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeChangeSetHooks for more information on using the DescribeChangeSetHooks API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeChangeSetHooksRequest method.
req, resp := client.DescribeChangeSetHooksRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeChangeSetHooks

func (*CloudFormation) DescribeChangeSetHooksWithContext added in v1.42.50 

func (c *CloudFormation) DescribeChangeSetHooksWithContext(ctx aws.Context, input *DescribeChangeSetHooksInput, opts ...request.Option) (*DescribeChangeSetHooksOutput, error)

DescribeChangeSetHooksWithContext is the same as DescribeChangeSetHooks with the addition of the ability to pass a context and additional request options.

See DescribeChangeSetHooks for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DescribeChangeSetRequest added in v1.1.15 

func (c *CloudFormation) DescribeChangeSetRequest(input *DescribeChangeSetInput) (req *request.Request, output *DescribeChangeSetOutput)

DescribeChangeSetRequest generates a "aws/request.Request" representing the client's request for the DescribeChangeSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeChangeSet for more information on using the DescribeChangeSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeChangeSetRequest method.
req, resp := client.DescribeChangeSetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeChangeSet

func (*CloudFormation) DescribeChangeSetWithContext added in v1.8.0 

func (c *CloudFormation) DescribeChangeSetWithContext(ctx aws.Context, input *DescribeChangeSetInput, opts ...request.Option) (*DescribeChangeSetOutput, error)

DescribeChangeSetWithContext is the same as DescribeChangeSet with the addition of the ability to pass a context and additional request options.

See DescribeChangeSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DescribeOrganizationsAccess added in v1.44.276 

func (c *CloudFormation) DescribeOrganizationsAccess(input *DescribeOrganizationsAccessInput) (*DescribeOrganizationsAccessOutput, error)

DescribeOrganizationsAccess API operation for AWS CloudFormation.

Retrieves information about the account's OrganizationAccess status. This API can be called either by the management account or the delegated administrator by using the CallAs parameter. This API can also be called without the CallAs parameter by the management account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation DescribeOrganizationsAccess for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidOperationException "InvalidOperationException" The specified operation isn't valid.

  • ErrCodeOperationNotFoundException "OperationNotFoundException" The specified ID refers to an operation that doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeOrganizationsAccess

func (*CloudFormation) DescribeOrganizationsAccessRequest added in v1.44.276 

func (c *CloudFormation) DescribeOrganizationsAccessRequest(input *DescribeOrganizationsAccessInput) (req *request.Request, output *DescribeOrganizationsAccessOutput)

DescribeOrganizationsAccessRequest generates a "aws/request.Request" representing the client's request for the DescribeOrganizationsAccess operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeOrganizationsAccess for more information on using the DescribeOrganizationsAccess API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeOrganizationsAccessRequest method.
req, resp := client.DescribeOrganizationsAccessRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeOrganizationsAccess

func (*CloudFormation) DescribeOrganizationsAccessWithContext added in v1.44.276 

func (c *CloudFormation) DescribeOrganizationsAccessWithContext(ctx aws.Context, input *DescribeOrganizationsAccessInput, opts ...request.Option) (*DescribeOrganizationsAccessOutput, error)

DescribeOrganizationsAccessWithContext is the same as DescribeOrganizationsAccess with the addition of the ability to pass a context and additional request options.

See DescribeOrganizationsAccess for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DescribePublisher added in v1.38.65 

func (c *CloudFormation) DescribePublisher(input *DescribePublisherInput) (*DescribePublisherOutput, error)

DescribePublisher API operation for AWS CloudFormation.

Returns information about a CloudFormation extension publisher.

If you don't supply a PublisherId, and you have registered as an extension publisher, DescribePublisher returns information about your own publisher account.

For more information about registering as a publisher, see:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation DescribePublisher for usage and error information.

Returned Error Codes:

  • ErrCodeCFNRegistryException "CFNRegistryException" An error occurred during a CloudFormation registry operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribePublisher

func (*CloudFormation) DescribePublisherRequest added in v1.38.65 

func (c *CloudFormation) DescribePublisherRequest(input *DescribePublisherInput) (req *request.Request, output *DescribePublisherOutput)

DescribePublisherRequest generates a "aws/request.Request" representing the client's request for the DescribePublisher operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribePublisher for more information on using the DescribePublisher API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribePublisherRequest method.
req, resp := client.DescribePublisherRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribePublisher

func (*CloudFormation) DescribePublisherWithContext added in v1.38.65 

func (c *CloudFormation) DescribePublisherWithContext(ctx aws.Context, input *DescribePublisherInput, opts ...request.Option) (*DescribePublisherOutput, error)

DescribePublisherWithContext is the same as DescribePublisher with the addition of the ability to pass a context and additional request options.

See DescribePublisher for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DescribeStackDriftDetectionStatus added in v1.15.74 

func (c *CloudFormation) DescribeStackDriftDetectionStatus(input *DescribeStackDriftDetectionStatusInput) (*DescribeStackDriftDetectionStatusOutput, error)

DescribeStackDriftDetectionStatus API operation for AWS CloudFormation.

Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from 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. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html).

Use DetectStackDrift to initiate a stack drift detection operation. DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of the operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation DescribeStackDriftDetectionStatus for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackDriftDetectionStatus

func (*CloudFormation) DescribeStackDriftDetectionStatusRequest added in v1.15.74 

func (c *CloudFormation) DescribeStackDriftDetectionStatusRequest(input *DescribeStackDriftDetectionStatusInput) (req *request.Request, output *DescribeStackDriftDetectionStatusOutput)

DescribeStackDriftDetectionStatusRequest generates a "aws/request.Request" representing the client's request for the DescribeStackDriftDetectionStatus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeStackDriftDetectionStatus for more information on using the DescribeStackDriftDetectionStatus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeStackDriftDetectionStatusRequest method.
req, resp := client.DescribeStackDriftDetectionStatusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackDriftDetectionStatus

func (*CloudFormation) DescribeStackDriftDetectionStatusWithContext added in v1.15.74 

func (c *CloudFormation) DescribeStackDriftDetectionStatusWithContext(ctx aws.Context, input *DescribeStackDriftDetectionStatusInput, opts ...request.Option) (*DescribeStackDriftDetectionStatusOutput, error)

DescribeStackDriftDetectionStatusWithContext is the same as DescribeStackDriftDetectionStatus with the addition of the ability to pass a context and additional request options.

See DescribeStackDriftDetectionStatus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DescribeStackEvents 

func (c *CloudFormation) DescribeStackEvents(input *DescribeStackEventsInput) (*DescribeStackEventsOutput, error)

DescribeStackEvents API operation for AWS CloudFormation.

Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to Stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html) in the CloudFormation User Guide.

You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation DescribeStackEvents for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackEvents

func (*CloudFormation) DescribeStackEventsPages 

func (c *CloudFormation) DescribeStackEventsPages(input *DescribeStackEventsInput, fn func(*DescribeStackEventsOutput, bool) bool) error

DescribeStackEventsPages iterates over the pages of a DescribeStackEvents operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeStackEvents method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeStackEvents operation.
pageNum := 0
err := client.DescribeStackEventsPages(params,
    func(page *cloudformation.DescribeStackEventsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudFormation) DescribeStackEventsPagesWithContext added in v1.8.0 

func (c *CloudFormation) DescribeStackEventsPagesWithContext(ctx aws.Context, input *DescribeStackEventsInput, fn func(*DescribeStackEventsOutput, bool) bool, opts ...request.Option) error

DescribeStackEventsPagesWithContext same as DescribeStackEventsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DescribeStackEventsRequest 

func (c *CloudFormation) DescribeStackEventsRequest(input *DescribeStackEventsInput) (req *request.Request, output *DescribeStackEventsOutput)

DescribeStackEventsRequest generates a "aws/request.Request" representing the client's request for the DescribeStackEvents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeStackEvents for more information on using the DescribeStackEvents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeStackEventsRequest method.
req, resp := client.DescribeStackEventsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackEvents

func (*CloudFormation) DescribeStackEventsWithContext added in v1.8.0 

func (c *CloudFormation) DescribeStackEventsWithContext(ctx aws.Context, input *DescribeStackEventsInput, opts ...request.Option) (*DescribeStackEventsOutput, error)

DescribeStackEventsWithContext is the same as DescribeStackEvents with the addition of the ability to pass a context and additional request options.

See DescribeStackEvents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DescribeStackInstance added in v1.10.16 

func (c *CloudFormation) DescribeStackInstance(input *DescribeStackInstanceInput) (*DescribeStackInstanceOutput, error)

DescribeStackInstance API operation for AWS CloudFormation.

Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region.

For a list of stack instances that are associated with a specific StackSet, use ListStackInstances.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation DescribeStackInstance for usage and error information.

Returned Error Codes:

  • ErrCodeStackSetNotFoundException "StackSetNotFoundException" The specified stack set doesn't exist.

  • ErrCodeStackInstanceNotFoundException "StackInstanceNotFoundException" The specified stack instance doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackInstance

func (*CloudFormation) DescribeStackInstanceRequest added in v1.10.16 

func (c *CloudFormation) DescribeStackInstanceRequest(input *DescribeStackInstanceInput) (req *request.Request, output *DescribeStackInstanceOutput)

DescribeStackInstanceRequest generates a "aws/request.Request" representing the client's request for the DescribeStackInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeStackInstance for more information on using the DescribeStackInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeStackInstanceRequest method.
req, resp := client.DescribeStackInstanceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackInstance

func (*CloudFormation) DescribeStackInstanceWithContext added in v1.10.16 

func (c *CloudFormation) DescribeStackInstanceWithContext(ctx aws.Context, input *DescribeStackInstanceInput, opts ...request.Option) (*DescribeStackInstanceOutput, error)

DescribeStackInstanceWithContext is the same as DescribeStackInstance with the addition of the ability to pass a context and additional request options.

See DescribeStackInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DescribeStackResource 

func (c *CloudFormation) DescribeStackResource(input *DescribeStackResourceInput) (*DescribeStackResourceOutput, error)

DescribeStackResource API operation for AWS CloudFormation.

Returns a description of the specified resource in the specified stack.

For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation DescribeStackResource for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackResource

func (*CloudFormation) DescribeStackResourceDrifts added in v1.15.74 

func (c *CloudFormation) DescribeStackResourceDrifts(input *DescribeStackResourceDriftsInput) (*DescribeStackResourceDriftsOutput, error)

DescribeStackResourceDrifts API operation for AWS CloudFormation.

Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects configuration drift.

For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that don't currently support drift detection aren't checked, and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html).

Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation DescribeStackResourceDrifts for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackResourceDrifts

func (*CloudFormation) DescribeStackResourceDriftsPages added in v1.15.74 

func (c *CloudFormation) DescribeStackResourceDriftsPages(input *DescribeStackResourceDriftsInput, fn func(*DescribeStackResourceDriftsOutput, bool) bool) error

DescribeStackResourceDriftsPages iterates over the pages of a DescribeStackResourceDrifts operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeStackResourceDrifts method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeStackResourceDrifts operation.
pageNum := 0
err := client.DescribeStackResourceDriftsPages(params,
    func(page *cloudformation.DescribeStackResourceDriftsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudFormation) DescribeStackResourceDriftsPagesWithContext added in v1.15.74 

func (c *CloudFormation) DescribeStackResourceDriftsPagesWithContext(ctx aws.Context, input *DescribeStackResourceDriftsInput, fn func(*DescribeStackResourceDriftsOutput, bool) bool, opts ...request.Option) error

DescribeStackResourceDriftsPagesWithContext same as DescribeStackResourceDriftsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DescribeStackResourceDriftsRequest added in v1.15.74 

func (c *CloudFormation) DescribeStackResourceDriftsRequest(input *DescribeStackResourceDriftsInput) (req *request.Request, output *DescribeStackResourceDriftsOutput)

DescribeStackResourceDriftsRequest generates a "aws/request.Request" representing the client's request for the DescribeStackResourceDrifts operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeStackResourceDrifts for more information on using the DescribeStackResourceDrifts API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeStackResourceDriftsRequest method.
req, resp := client.DescribeStackResourceDriftsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackResourceDrifts

func (*CloudFormation) DescribeStackResourceDriftsWithContext added in v1.15.74 

func (c *CloudFormation) DescribeStackResourceDriftsWithContext(ctx aws.Context, input *DescribeStackResourceDriftsInput, opts ...request.Option) (*DescribeStackResourceDriftsOutput, error)

DescribeStackResourceDriftsWithContext is the same as DescribeStackResourceDrifts with the addition of the ability to pass a context and additional request options.

See DescribeStackResourceDrifts for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DescribeStackResourceRequest 

func (c *CloudFormation) DescribeStackResourceRequest(input *DescribeStackResourceInput) (req *request.Request, output *DescribeStackResourceOutput)

DescribeStackResourceRequest generates a "aws/request.Request" representing the client's request for the DescribeStackResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeStackResource for more information on using the DescribeStackResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeStackResourceRequest method.
req, resp := client.DescribeStackResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackResource

func (*CloudFormation) DescribeStackResourceWithContext added in v1.8.0 

func (c *CloudFormation) DescribeStackResourceWithContext(ctx aws.Context, input *DescribeStackResourceInput, opts ...request.Option) (*DescribeStackResourceOutput, error)

DescribeStackResourceWithContext is the same as DescribeStackResource with the addition of the ability to pass a context and additional request options.

See DescribeStackResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DescribeStackResources 

func (c *CloudFormation) DescribeStackResources(input *DescribeStackResourcesInput) (*DescribeStackResourcesOutput, error)

DescribeStackResources API operation for AWS CloudFormation.

Returns Amazon Web Services resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId is specified, the associated resources of the stack that the resource belongs to are returned.

Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources instead.

For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the stack has been deleted.

You must specify either StackName or PhysicalResourceId, but not both. In addition, you can specify LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and PhysicalResourceId, go to the CloudFormation User Guide (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/).

A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation DescribeStackResources for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackResources

func (*CloudFormation) DescribeStackResourcesRequest 

func (c *CloudFormation) DescribeStackResourcesRequest(input *DescribeStackResourcesInput) (req *request.Request, output *DescribeStackResourcesOutput)

DescribeStackResourcesRequest generates a "aws/request.Request" representing the client's request for the DescribeStackResources operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeStackResources for more information on using the DescribeStackResources API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeStackResourcesRequest method.
req, resp := client.DescribeStackResourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackResources

func (*CloudFormation) DescribeStackResourcesWithContext added in v1.8.0 

func (c *CloudFormation) DescribeStackResourcesWithContext(ctx aws.Context, input *DescribeStackResourcesInput, opts ...request.Option) (*DescribeStackResourcesOutput, error)

DescribeStackResourcesWithContext is the same as DescribeStackResources with the addition of the ability to pass a context and additional request options.

See DescribeStackResources for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DescribeStackSet added in v1.10.16 

func (c *CloudFormation) DescribeStackSet(input *DescribeStackSetInput) (*DescribeStackSetOutput, error)

DescribeStackSet API operation for AWS CloudFormation.

Returns the description of the specified StackSet.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation DescribeStackSet for usage and error information.

Returned Error Codes:

  • ErrCodeStackSetNotFoundException "StackSetNotFoundException" The specified stack set doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackSet

func (*CloudFormation) DescribeStackSetOperation added in v1.10.16 

func (c *CloudFormation) DescribeStackSetOperation(input *DescribeStackSetOperationInput) (*DescribeStackSetOperationOutput, error)

DescribeStackSetOperation API operation for AWS CloudFormation.

Returns the description of the specified StackSet operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation DescribeStackSetOperation for usage and error information.

Returned Error Codes:

  • ErrCodeStackSetNotFoundException "StackSetNotFoundException" The specified stack set doesn't exist.

  • ErrCodeOperationNotFoundException "OperationNotFoundException" The specified ID refers to an operation that doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackSetOperation

func (*CloudFormation) DescribeStackSetOperationRequest added in v1.10.16 

func (c *CloudFormation) DescribeStackSetOperationRequest(input *DescribeStackSetOperationInput) (req *request.Request, output *DescribeStackSetOperationOutput)

DescribeStackSetOperationRequest generates a "aws/request.Request" representing the client's request for the DescribeStackSetOperation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeStackSetOperation for more information on using the DescribeStackSetOperation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeStackSetOperationRequest method.
req, resp := client.DescribeStackSetOperationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackSetOperation

func (*CloudFormation) DescribeStackSetOperationWithContext added in v1.10.16 

func (c *CloudFormation) DescribeStackSetOperationWithContext(ctx aws.Context, input *DescribeStackSetOperationInput, opts ...request.Option) (*DescribeStackSetOperationOutput, error)

DescribeStackSetOperationWithContext is the same as DescribeStackSetOperation with the addition of the ability to pass a context and additional request options.

See DescribeStackSetOperation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DescribeStackSetRequest added in v1.10.16 

func (c *CloudFormation) DescribeStackSetRequest(input *DescribeStackSetInput) (req *request.Request, output *DescribeStackSetOutput)

DescribeStackSetRequest generates a "aws/request.Request" representing the client's request for the DescribeStackSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeStackSet for more information on using the DescribeStackSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeStackSetRequest method.
req, resp := client.DescribeStackSetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStackSet

func (*CloudFormation) DescribeStackSetWithContext added in v1.10.16 

func (c *CloudFormation) DescribeStackSetWithContext(ctx aws.Context, input *DescribeStackSetInput, opts ...request.Option) (*DescribeStackSetOutput, error)

DescribeStackSetWithContext is the same as DescribeStackSet with the addition of the ability to pass a context and additional request options.

See DescribeStackSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DescribeStacks 

func (c *CloudFormation) DescribeStacks(input *DescribeStacksInput) (*DescribeStacksOutput, error)

DescribeStacks API operation for AWS CloudFormation.

Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.

If the stack doesn't exist, an ValidationError is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation DescribeStacks for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStacks

func (*CloudFormation) DescribeStacksPages 

func (c *CloudFormation) DescribeStacksPages(input *DescribeStacksInput, fn func(*DescribeStacksOutput, bool) bool) error

DescribeStacksPages iterates over the pages of a DescribeStacks operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeStacks method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeStacks operation.
pageNum := 0
err := client.DescribeStacksPages(params,
    func(page *cloudformation.DescribeStacksOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudFormation) DescribeStacksPagesWithContext added in v1.8.0 

func (c *CloudFormation) DescribeStacksPagesWithContext(ctx aws.Context, input *DescribeStacksInput, fn func(*DescribeStacksOutput, bool) bool, opts ...request.Option) error

DescribeStacksPagesWithContext same as DescribeStacksPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DescribeStacksRequest 

func (c *CloudFormation) DescribeStacksRequest(input *DescribeStacksInput) (req *request.Request, output *DescribeStacksOutput)

DescribeStacksRequest generates a "aws/request.Request" representing the client's request for the DescribeStacks operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeStacks for more information on using the DescribeStacks API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeStacksRequest method.
req, resp := client.DescribeStacksRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeStacks

func (*CloudFormation) DescribeStacksWithContext added in v1.8.0 

func (c *CloudFormation) DescribeStacksWithContext(ctx aws.Context, input *DescribeStacksInput, opts ...request.Option) (*DescribeStacksOutput, error)

DescribeStacksWithContext is the same as DescribeStacks with the addition of the ability to pass a context and additional request options.

See DescribeStacks for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DescribeType added in v1.25.37 

func (c *CloudFormation) DescribeType(input *DescribeTypeInput) (*DescribeTypeOutput, error)

DescribeType API operation for AWS CloudFormation.

Returns detailed information about an extension that has been registered.

If you specify a VersionId, DescribeType returns information about that specific extension version. Otherwise, it returns information about the default extension version.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation DescribeType for usage and error information.

Returned Error Codes:

  • ErrCodeCFNRegistryException "CFNRegistryException" An error occurred during a CloudFormation registry operation.

  • ErrCodeTypeNotFoundException "TypeNotFoundException" The specified extension doesn't exist in the CloudFormation registry.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeType

func (*CloudFormation) DescribeTypeRegistration added in v1.25.37 

func (c *CloudFormation) DescribeTypeRegistration(input *DescribeTypeRegistrationInput) (*DescribeTypeRegistrationOutput, error)

DescribeTypeRegistration API operation for AWS CloudFormation.

Returns information about an extension's registration, including its current status and type and version identifiers.

When you initiate a registration request using RegisterType, you can then use DescribeTypeRegistration to monitor the progress of that registration request.

Once the registration request has completed, use DescribeType to return detailed information about an extension.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation DescribeTypeRegistration for usage and error information.

Returned Error Codes:

  • ErrCodeCFNRegistryException "CFNRegistryException" An error occurred during a CloudFormation registry operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeTypeRegistration

func (*CloudFormation) DescribeTypeRegistrationRequest added in v1.25.37 

func (c *CloudFormation) DescribeTypeRegistrationRequest(input *DescribeTypeRegistrationInput) (req *request.Request, output *DescribeTypeRegistrationOutput)

DescribeTypeRegistrationRequest generates a "aws/request.Request" representing the client's request for the DescribeTypeRegistration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeTypeRegistration for more information on using the DescribeTypeRegistration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeTypeRegistrationRequest method.
req, resp := client.DescribeTypeRegistrationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeTypeRegistration

func (*CloudFormation) DescribeTypeRegistrationWithContext added in v1.25.37 

func (c *CloudFormation) DescribeTypeRegistrationWithContext(ctx aws.Context, input *DescribeTypeRegistrationInput, opts ...request.Option) (*DescribeTypeRegistrationOutput, error)

DescribeTypeRegistrationWithContext is the same as DescribeTypeRegistration with the addition of the ability to pass a context and additional request options.

See DescribeTypeRegistration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DescribeTypeRequest added in v1.25.37 

func (c *CloudFormation) DescribeTypeRequest(input *DescribeTypeInput) (req *request.Request, output *DescribeTypeOutput)

DescribeTypeRequest generates a "aws/request.Request" representing the client's request for the DescribeType operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeType for more information on using the DescribeType API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeTypeRequest method.
req, resp := client.DescribeTypeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DescribeType

func (*CloudFormation) DescribeTypeWithContext added in v1.25.37 

func (c *CloudFormation) DescribeTypeWithContext(ctx aws.Context, input *DescribeTypeInput, opts ...request.Option) (*DescribeTypeOutput, error)

DescribeTypeWithContext is the same as DescribeType with the addition of the ability to pass a context and additional request options.

See DescribeType for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DetectStackDrift added in v1.15.74 

func (c *CloudFormation) DetectStackDrift(input *DetectStackDriftInput) (*DetectStackDriftOutput, error)

DetectStackDrift API operation for AWS CloudFormation.

Detects 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 each resource in the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html).

Use DetectStackDrift to detect drift on all supported resources for a given stack, or DetectStackResourceDrift to detect drift on individual resources.

For a list of stack resources that currently support drift detection, see Resources that Support Drift Detection (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html).

DetectStackDrift can take up to several minutes, depending on the number of resources contained within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.

When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks belonging to that stack. Perform DetectStackDrift directly on the nested stack itself.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation DetectStackDrift for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DetectStackDrift

func (*CloudFormation) DetectStackDriftRequest added in v1.15.74 

func (c *CloudFormation) DetectStackDriftRequest(input *DetectStackDriftInput) (req *request.Request, output *DetectStackDriftOutput)

DetectStackDriftRequest generates a "aws/request.Request" representing the client's request for the DetectStackDrift operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetectStackDrift for more information on using the DetectStackDrift API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DetectStackDriftRequest method.
req, resp := client.DetectStackDriftRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DetectStackDrift

func (*CloudFormation) DetectStackDriftWithContext added in v1.15.74 

func (c *CloudFormation) DetectStackDriftWithContext(ctx aws.Context, input *DetectStackDriftInput, opts ...request.Option) (*DetectStackDriftOutput, error)

DetectStackDriftWithContext is the same as DetectStackDrift with the addition of the ability to pass a context and additional request options.

See DetectStackDrift for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DetectStackResourceDrift added in v1.15.74 

func (c *CloudFormation) DetectStackResourceDrift(input *DetectStackResourceDriftInput) (*DetectStackResourceDriftOutput, error)

DetectStackResourceDrift API operation for AWS CloudFormation.

Returns information about whether a 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. This information includes actual and expected property values for resources in which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html).

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

Resources that don't currently support drift detection can't be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation DetectStackResourceDrift for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DetectStackResourceDrift

func (*CloudFormation) DetectStackResourceDriftRequest added in v1.15.74 

func (c *CloudFormation) DetectStackResourceDriftRequest(input *DetectStackResourceDriftInput) (req *request.Request, output *DetectStackResourceDriftOutput)

DetectStackResourceDriftRequest generates a "aws/request.Request" representing the client's request for the DetectStackResourceDrift operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetectStackResourceDrift for more information on using the DetectStackResourceDrift API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DetectStackResourceDriftRequest method.
req, resp := client.DetectStackResourceDriftRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DetectStackResourceDrift

func (*CloudFormation) DetectStackResourceDriftWithContext added in v1.15.74 

func (c *CloudFormation) DetectStackResourceDriftWithContext(ctx aws.Context, input *DetectStackResourceDriftInput, opts ...request.Option) (*DetectStackResourceDriftOutput, error)

DetectStackResourceDriftWithContext is the same as DetectStackResourceDrift with the addition of the ability to pass a context and additional request options.

See DetectStackResourceDrift for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) DetectStackSetDrift added in v1.25.38 

func (c *CloudFormation) DetectStackSetDrift(input *DetectStackSetDriftInput) (*DetectStackSetDriftOutput, error)

DetectStackSetDrift API operation for AWS CloudFormation.

Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation performs drift detection on a stack set (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html).

DetectStackSetDrift returns the OperationId of the stack set drift detection operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection operation. The drift detection operation may take some time, depending on the number of stack instances included in the stack set, in addition to the number of resources included in each stack.

Once the operation has completed, use the following actions to return drift information:

  • Use DescribeStackSet to return detailed information about the stack set, including detailed information about the last completed drift operation performed on the stack set. (Information about drift operations that are in progress isn't included.)

  • Use ListStackInstances to return a list of stack instances belonging to the stack set, including the drift status and last drift time checked of each instance.

  • Use DescribeStackInstance to return detailed information about a specific stack instance, including its drift status and last drift time checked.

For more information about performing a drift detection operation on a stack set, see Detecting unmanaged changes in stack sets (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html).

You can only run a single drift detection operation on a given stack set at one time.

To stop a drift detection stack set operation, use StopStackSetOperation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation DetectStackSetDrift for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidOperationException "InvalidOperationException" The specified operation isn't valid.

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

  • ErrCodeStackSetNotFoundException "StackSetNotFoundException" The specified stack set doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DetectStackSetDrift

func (*CloudFormation) DetectStackSetDriftRequest added in v1.25.38 

func (c *CloudFormation) DetectStackSetDriftRequest(input *DetectStackSetDriftInput) (req *request.Request, output *DetectStackSetDriftOutput)

DetectStackSetDriftRequest generates a "aws/request.Request" representing the client's request for the DetectStackSetDrift operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetectStackSetDrift for more information on using the DetectStackSetDrift API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DetectStackSetDriftRequest method.
req, resp := client.DetectStackSetDriftRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/DetectStackSetDrift

func (*CloudFormation) DetectStackSetDriftWithContext added in v1.25.38 

func (c *CloudFormation) DetectStackSetDriftWithContext(ctx aws.Context, input *DetectStackSetDriftInput, opts ...request.Option) (*DetectStackSetDriftOutput, error)

DetectStackSetDriftWithContext is the same as DetectStackSetDrift with the addition of the ability to pass a context and additional request options.

See DetectStackSetDrift for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) EstimateTemplateCost 

func (c *CloudFormation) EstimateTemplateCost(input *EstimateTemplateCostInput) (*EstimateTemplateCostOutput, error)

EstimateTemplateCost API operation for AWS CloudFormation.

Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to run the template.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation EstimateTemplateCost for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/EstimateTemplateCost

func (*CloudFormation) EstimateTemplateCostRequest 

func (c *CloudFormation) EstimateTemplateCostRequest(input *EstimateTemplateCostInput) (req *request.Request, output *EstimateTemplateCostOutput)

EstimateTemplateCostRequest generates a "aws/request.Request" representing the client's request for the EstimateTemplateCost operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See EstimateTemplateCost for more information on using the EstimateTemplateCost API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the EstimateTemplateCostRequest method.
req, resp := client.EstimateTemplateCostRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/EstimateTemplateCost

func (*CloudFormation) EstimateTemplateCostWithContext added in v1.8.0 

func (c *CloudFormation) EstimateTemplateCostWithContext(ctx aws.Context, input *EstimateTemplateCostInput, opts ...request.Option) (*EstimateTemplateCostOutput, error)

EstimateTemplateCostWithContext is the same as EstimateTemplateCost with the addition of the ability to pass a context and additional request options.

See EstimateTemplateCost for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ExecuteChangeSet added in v1.1.15 

func (c *CloudFormation) ExecuteChangeSet(input *ExecuteChangeSetInput) (*ExecuteChangeSetOutput, error)

ExecuteChangeSet API operation for AWS CloudFormation.

Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.

When you execute a change set, CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.

If a stack policy is associated with the stack, CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.

To create a change set for the entire stack hierarchy, IncludeNestedStacks must have been set to True.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation ExecuteChangeSet for usage and error information.

Returned Error Codes:

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

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

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

  • ErrCodeTokenAlreadyExistsException "TokenAlreadyExistsException" A client request token already exists.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ExecuteChangeSet

func (*CloudFormation) ExecuteChangeSetRequest added in v1.1.15 

func (c *CloudFormation) ExecuteChangeSetRequest(input *ExecuteChangeSetInput) (req *request.Request, output *ExecuteChangeSetOutput)

ExecuteChangeSetRequest generates a "aws/request.Request" representing the client's request for the ExecuteChangeSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ExecuteChangeSet for more information on using the ExecuteChangeSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ExecuteChangeSetRequest method.
req, resp := client.ExecuteChangeSetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ExecuteChangeSet

func (*CloudFormation) ExecuteChangeSetWithContext added in v1.8.0 

func (c *CloudFormation) ExecuteChangeSetWithContext(ctx aws.Context, input *ExecuteChangeSetInput, opts ...request.Option) (*ExecuteChangeSetOutput, error)

ExecuteChangeSetWithContext is the same as ExecuteChangeSet with the addition of the ability to pass a context and additional request options.

See ExecuteChangeSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) GetStackPolicy 

func (c *CloudFormation) GetStackPolicy(input *GetStackPolicyInput) (*GetStackPolicyOutput, error)

GetStackPolicy API operation for AWS CloudFormation.

Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation GetStackPolicy for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/GetStackPolicy

func (*CloudFormation) GetStackPolicyRequest 

func (c *CloudFormation) GetStackPolicyRequest(input *GetStackPolicyInput) (req *request.Request, output *GetStackPolicyOutput)

GetStackPolicyRequest generates a "aws/request.Request" representing the client's request for the GetStackPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetStackPolicy for more information on using the GetStackPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetStackPolicyRequest method.
req, resp := client.GetStackPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/GetStackPolicy

func (*CloudFormation) GetStackPolicyWithContext added in v1.8.0 

func (c *CloudFormation) GetStackPolicyWithContext(ctx aws.Context, input *GetStackPolicyInput, opts ...request.Option) (*GetStackPolicyOutput, error)

GetStackPolicyWithContext is the same as GetStackPolicy with the addition of the ability to pass a context and additional request options.

See GetStackPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) GetTemplate 

func (c *CloudFormation) GetTemplate(input *GetTemplateInput) (*GetTemplateOutput, error)

GetTemplate API operation for AWS CloudFormation.

Returns the template body for a specified stack. You can get the template for running or deleted stacks.

For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.

If the template doesn't exist, a ValidationError is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation GetTemplate for usage and error information.

Returned Error Codes:

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/GetTemplate

func (*CloudFormation) GetTemplateRequest 

func (c *CloudFormation) GetTemplateRequest(input *GetTemplateInput) (req *request.Request, output *GetTemplateOutput)

GetTemplateRequest generates a "aws/request.Request" representing the client's request for the GetTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetTemplate for more information on using the GetTemplate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetTemplateRequest method.
req, resp := client.GetTemplateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/GetTemplate

func (*CloudFormation) GetTemplateSummary 

func (c *CloudFormation) GetTemplateSummary(input *GetTemplateSummaryInput) (*GetTemplateSummaryOutput, error)

GetTemplateSummary API operation for AWS CloudFormation.

Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or stack set.

You can use the GetTemplateSummary action when you submit a template, or you can get template information for a stack set, or a running or deleted stack.

For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has been deleted. If the template doesn't exist, a ValidationError is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation GetTemplateSummary for usage and error information.

Returned Error Codes:

  • ErrCodeStackSetNotFoundException "StackSetNotFoundException" The specified stack set doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/GetTemplateSummary

func (*CloudFormation) GetTemplateSummaryRequest 

func (c *CloudFormation) GetTemplateSummaryRequest(input *GetTemplateSummaryInput) (req *request.Request, output *GetTemplateSummaryOutput)

GetTemplateSummaryRequest generates a "aws/request.Request" representing the client's request for the GetTemplateSummary operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetTemplateSummary for more information on using the GetTemplateSummary API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetTemplateSummaryRequest method.
req, resp := client.GetTemplateSummaryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/GetTemplateSummary

func (*CloudFormation) GetTemplateSummaryWithContext added in v1.8.0 

func (c *CloudFormation) GetTemplateSummaryWithContext(ctx aws.Context, input *GetTemplateSummaryInput, opts ...request.Option) (*GetTemplateSummaryOutput, error)

GetTemplateSummaryWithContext is the same as GetTemplateSummary with the addition of the ability to pass a context and additional request options.

See GetTemplateSummary for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) GetTemplateWithContext added in v1.8.0 

func (c *CloudFormation) GetTemplateWithContext(ctx aws.Context, input *GetTemplateInput, opts ...request.Option) (*GetTemplateOutput, error)

GetTemplateWithContext is the same as GetTemplate with the addition of the ability to pass a context and additional request options.

See GetTemplate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ImportStacksToStackSet added in v1.40.10 

func (c *CloudFormation) ImportStacksToStackSet(input *ImportStacksToStackSetInput) (*ImportStacksToStackSetOutput, error)

ImportStacksToStackSet API operation for AWS CloudFormation.

Import existing stacks into a new stack sets. Use the stack import operation to import up to 10 stacks into a new stack set in the same account as the source stack or in a different administrator account and Region, by specifying the stack ID of the stack you intend to import.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation ImportStacksToStackSet for usage and error information.

Returned Error Codes:

  • ErrCodeLimitExceededException "LimitExceededException" The quota for the resource has already been reached.

    For information about resource and stack limitations, see CloudFormation quotas (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html) in the CloudFormation User Guide.

  • ErrCodeStackSetNotFoundException "StackSetNotFoundException" The specified stack set doesn't exist.

  • ErrCodeInvalidOperationException "InvalidOperationException" The specified operation isn't valid.

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

  • ErrCodeOperationIdAlreadyExistsException "OperationIdAlreadyExistsException" The specified operation ID already exists.

  • ErrCodeStackNotFoundException "StackNotFoundException" The specified stack ARN doesn't exist or stack doesn't exist corresponding to the ARN in input.

  • ErrCodeStaleRequestException "StaleRequestException" Another operation has been performed on this stack set since the specified operation was performed.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ImportStacksToStackSet

func (*CloudFormation) ImportStacksToStackSetRequest added in v1.40.10 

func (c *CloudFormation) ImportStacksToStackSetRequest(input *ImportStacksToStackSetInput) (req *request.Request, output *ImportStacksToStackSetOutput)

ImportStacksToStackSetRequest generates a "aws/request.Request" representing the client's request for the ImportStacksToStackSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ImportStacksToStackSet for more information on using the ImportStacksToStackSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ImportStacksToStackSetRequest method.
req, resp := client.ImportStacksToStackSetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ImportStacksToStackSet

func (*CloudFormation) ImportStacksToStackSetWithContext added in v1.40.10 

func (c *CloudFormation) ImportStacksToStackSetWithContext(ctx aws.Context, input *ImportStacksToStackSetInput, opts ...request.Option) (*ImportStacksToStackSetOutput, error)

ImportStacksToStackSetWithContext is the same as ImportStacksToStackSet with the addition of the ability to pass a context and additional request options.

See ImportStacksToStackSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ListChangeSets added in v1.1.15 

func (c *CloudFormation) ListChangeSets(input *ListChangeSetsInput) (*ListChangeSetsOutput, error)

ListChangeSets API operation for AWS CloudFormation.

Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation ListChangeSets for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListChangeSets

func (*CloudFormation) ListChangeSetsPages added in v1.30.29 

func (c *CloudFormation) ListChangeSetsPages(input *ListChangeSetsInput, fn func(*ListChangeSetsOutput, bool) bool) error

ListChangeSetsPages iterates over the pages of a ListChangeSets operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListChangeSets method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListChangeSets operation.
pageNum := 0
err := client.ListChangeSetsPages(params,
    func(page *cloudformation.ListChangeSetsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudFormation) ListChangeSetsPagesWithContext added in v1.30.29 

func (c *CloudFormation) ListChangeSetsPagesWithContext(ctx aws.Context, input *ListChangeSetsInput, fn func(*ListChangeSetsOutput, bool) bool, opts ...request.Option) error

ListChangeSetsPagesWithContext same as ListChangeSetsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ListChangeSetsRequest added in v1.1.15 

func (c *CloudFormation) ListChangeSetsRequest(input *ListChangeSetsInput) (req *request.Request, output *ListChangeSetsOutput)

ListChangeSetsRequest generates a "aws/request.Request" representing the client's request for the ListChangeSets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListChangeSets for more information on using the ListChangeSets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListChangeSetsRequest method.
req, resp := client.ListChangeSetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListChangeSets

func (*CloudFormation) ListChangeSetsWithContext added in v1.8.0 

func (c *CloudFormation) ListChangeSetsWithContext(ctx aws.Context, input *ListChangeSetsInput, opts ...request.Option) (*ListChangeSetsOutput, error)

ListChangeSetsWithContext is the same as ListChangeSets with the addition of the ability to pass a context and additional request options.

See ListChangeSets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ListExports added in v1.5.0 

func (c *CloudFormation) ListExports(input *ListExportsInput) (*ListExportsOutput, error)

ListExports API operation for AWS CloudFormation.

Lists all exported output values in the account and Region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the Fn::ImportValue (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html) function.

For more information, see CloudFormation export stack output values (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-exports.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation ListExports for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListExports

func (*CloudFormation) ListExportsPages added in v1.8.5 

func (c *CloudFormation) ListExportsPages(input *ListExportsInput, fn func(*ListExportsOutput, bool) bool) error

ListExportsPages iterates over the pages of a ListExports operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListExports method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListExports operation.
pageNum := 0
err := client.ListExportsPages(params,
    func(page *cloudformation.ListExportsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudFormation) ListExportsPagesWithContext added in v1.8.5 

func (c *CloudFormation) ListExportsPagesWithContext(ctx aws.Context, input *ListExportsInput, fn func(*ListExportsOutput, bool) bool, opts ...request.Option) error

ListExportsPagesWithContext same as ListExportsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ListExportsRequest added in v1.5.0 

func (c *CloudFormation) ListExportsRequest(input *ListExportsInput) (req *request.Request, output *ListExportsOutput)

ListExportsRequest generates a "aws/request.Request" representing the client's request for the ListExports operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListExports for more information on using the ListExports API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListExportsRequest method.
req, resp := client.ListExportsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListExports

func (*CloudFormation) ListExportsWithContext added in v1.8.0 

func (c *CloudFormation) ListExportsWithContext(ctx aws.Context, input *ListExportsInput, opts ...request.Option) (*ListExportsOutput, error)

ListExportsWithContext is the same as ListExports with the addition of the ability to pass a context and additional request options.

See ListExports for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ListImports added in v1.5.10 

func (c *CloudFormation) ListImports(input *ListImportsInput) (*ListImportsOutput, error)

ListImports API operation for AWS CloudFormation.

Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports.

For more information about importing an exported output value, see the Fn::ImportValue (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html) function.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation ListImports for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListImports

func (*CloudFormation) ListImportsPages added in v1.8.5 

func (c *CloudFormation) ListImportsPages(input *ListImportsInput, fn func(*ListImportsOutput, bool) bool) error

ListImportsPages iterates over the pages of a ListImports operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListImports method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListImports operation.
pageNum := 0
err := client.ListImportsPages(params,
    func(page *cloudformation.ListImportsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudFormation) ListImportsPagesWithContext added in v1.8.5 

func (c *CloudFormation) ListImportsPagesWithContext(ctx aws.Context, input *ListImportsInput, fn func(*ListImportsOutput, bool) bool, opts ...request.Option) error

ListImportsPagesWithContext same as ListImportsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ListImportsRequest added in v1.5.10 

func (c *CloudFormation) ListImportsRequest(input *ListImportsInput) (req *request.Request, output *ListImportsOutput)

ListImportsRequest generates a "aws/request.Request" representing the client's request for the ListImports operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListImports for more information on using the ListImports API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListImportsRequest method.
req, resp := client.ListImportsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListImports

func (*CloudFormation) ListImportsWithContext added in v1.8.0 

func (c *CloudFormation) ListImportsWithContext(ctx aws.Context, input *ListImportsInput, opts ...request.Option) (*ListImportsOutput, error)

ListImportsWithContext is the same as ListImports with the addition of the ability to pass a context and additional request options.

See ListImports for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ListStackInstanceResourceDrifts added in v1.44.307 

func (c *CloudFormation) ListStackInstanceResourceDrifts(input *ListStackInstanceResourceDriftsInput) (*ListStackInstanceResourceDriftsOutput, error)

ListStackInstanceResourceDrifts API operation for AWS CloudFormation.

Returns drift information for resources in a stack instance.

ListStackInstanceResourceDrifts returns drift information for the most recent drift detection operation. If an operation is in progress, it may only return partial results.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation ListStackInstanceResourceDrifts for usage and error information.

Returned Error Codes:

  • ErrCodeStackSetNotFoundException "StackSetNotFoundException" The specified stack set doesn't exist.

  • ErrCodeStackInstanceNotFoundException "StackInstanceNotFoundException" The specified stack instance doesn't exist.

  • ErrCodeOperationNotFoundException "OperationNotFoundException" The specified ID refers to an operation that doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackInstanceResourceDrifts

func (*CloudFormation) ListStackInstanceResourceDriftsRequest added in v1.44.307 

func (c *CloudFormation) ListStackInstanceResourceDriftsRequest(input *ListStackInstanceResourceDriftsInput) (req *request.Request, output *ListStackInstanceResourceDriftsOutput)

ListStackInstanceResourceDriftsRequest generates a "aws/request.Request" representing the client's request for the ListStackInstanceResourceDrifts operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListStackInstanceResourceDrifts for more information on using the ListStackInstanceResourceDrifts API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListStackInstanceResourceDriftsRequest method.
req, resp := client.ListStackInstanceResourceDriftsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackInstanceResourceDrifts

func (*CloudFormation) ListStackInstanceResourceDriftsWithContext added in v1.44.307 

func (c *CloudFormation) ListStackInstanceResourceDriftsWithContext(ctx aws.Context, input *ListStackInstanceResourceDriftsInput, opts ...request.Option) (*ListStackInstanceResourceDriftsOutput, error)

ListStackInstanceResourceDriftsWithContext is the same as ListStackInstanceResourceDrifts with the addition of the ability to pass a context and additional request options.

See ListStackInstanceResourceDrifts for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ListStackInstances added in v1.10.16 

func (c *CloudFormation) ListStackInstances(input *ListStackInstancesInput) (*ListStackInstancesOutput, error)

ListStackInstances API operation for AWS CloudFormation.

Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region, or that have a specific status.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation ListStackInstances for usage and error information.

Returned Error Codes:

  • ErrCodeStackSetNotFoundException "StackSetNotFoundException" The specified stack set doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackInstances

func (*CloudFormation) ListStackInstancesPages added in v1.30.29 

func (c *CloudFormation) ListStackInstancesPages(input *ListStackInstancesInput, fn func(*ListStackInstancesOutput, bool) bool) error

ListStackInstancesPages iterates over the pages of a ListStackInstances operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListStackInstances method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListStackInstances operation.
pageNum := 0
err := client.ListStackInstancesPages(params,
    func(page *cloudformation.ListStackInstancesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudFormation) ListStackInstancesPagesWithContext added in v1.30.29 

func (c *CloudFormation) ListStackInstancesPagesWithContext(ctx aws.Context, input *ListStackInstancesInput, fn func(*ListStackInstancesOutput, bool) bool, opts ...request.Option) error

ListStackInstancesPagesWithContext same as ListStackInstancesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ListStackInstancesRequest added in v1.10.16 

func (c *CloudFormation) ListStackInstancesRequest(input *ListStackInstancesInput) (req *request.Request, output *ListStackInstancesOutput)

ListStackInstancesRequest generates a "aws/request.Request" representing the client's request for the ListStackInstances operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListStackInstances for more information on using the ListStackInstances API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListStackInstancesRequest method.
req, resp := client.ListStackInstancesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackInstances

func (*CloudFormation) ListStackInstancesWithContext added in v1.10.16 

func (c *CloudFormation) ListStackInstancesWithContext(ctx aws.Context, input *ListStackInstancesInput, opts ...request.Option) (*ListStackInstancesOutput, error)

ListStackInstancesWithContext is the same as ListStackInstances with the addition of the ability to pass a context and additional request options.

See ListStackInstances for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ListStackResources 

func (c *CloudFormation) ListStackResources(input *ListStackResourcesInput) (*ListStackResourcesOutput, error)

ListStackResources API operation for AWS CloudFormation.

Returns descriptions of all resources of the specified stack.

For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation ListStackResources for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackResources

func (*CloudFormation) ListStackResourcesPages 

func (c *CloudFormation) ListStackResourcesPages(input *ListStackResourcesInput, fn func(*ListStackResourcesOutput, bool) bool) error

ListStackResourcesPages iterates over the pages of a ListStackResources operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListStackResources method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListStackResources operation.
pageNum := 0
err := client.ListStackResourcesPages(params,
    func(page *cloudformation.ListStackResourcesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudFormation) ListStackResourcesPagesWithContext added in v1.8.0 

func (c *CloudFormation) ListStackResourcesPagesWithContext(ctx aws.Context, input *ListStackResourcesInput, fn func(*ListStackResourcesOutput, bool) bool, opts ...request.Option) error

ListStackResourcesPagesWithContext same as ListStackResourcesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ListStackResourcesRequest 

func (c *CloudFormation) ListStackResourcesRequest(input *ListStackResourcesInput) (req *request.Request, output *ListStackResourcesOutput)

ListStackResourcesRequest generates a "aws/request.Request" representing the client's request for the ListStackResources operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListStackResources for more information on using the ListStackResources API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListStackResourcesRequest method.
req, resp := client.ListStackResourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackResources

func (*CloudFormation) ListStackResourcesWithContext added in v1.8.0 

func (c *CloudFormation) ListStackResourcesWithContext(ctx aws.Context, input *ListStackResourcesInput, opts ...request.Option) (*ListStackResourcesOutput, error)

ListStackResourcesWithContext is the same as ListStackResources with the addition of the ability to pass a context and additional request options.

See ListStackResources for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ListStackSetOperationResults added in v1.10.16 

func (c *CloudFormation) ListStackSetOperationResults(input *ListStackSetOperationResultsInput) (*ListStackSetOperationResultsOutput, error)

ListStackSetOperationResults API operation for AWS CloudFormation.

Returns summary information about the results of a stack set operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation ListStackSetOperationResults for usage and error information.

Returned Error Codes:

  • ErrCodeStackSetNotFoundException "StackSetNotFoundException" The specified stack set doesn't exist.

  • ErrCodeOperationNotFoundException "OperationNotFoundException" The specified ID refers to an operation that doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackSetOperationResults

func (*CloudFormation) ListStackSetOperationResultsPages added in v1.30.29 

func (c *CloudFormation) ListStackSetOperationResultsPages(input *ListStackSetOperationResultsInput, fn func(*ListStackSetOperationResultsOutput, bool) bool) error

ListStackSetOperationResultsPages iterates over the pages of a ListStackSetOperationResults operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListStackSetOperationResults method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListStackSetOperationResults operation.
pageNum := 0
err := client.ListStackSetOperationResultsPages(params,
    func(page *cloudformation.ListStackSetOperationResultsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudFormation) ListStackSetOperationResultsPagesWithContext added in v1.30.29 

func (c *CloudFormation) ListStackSetOperationResultsPagesWithContext(ctx aws.Context, input *ListStackSetOperationResultsInput, fn func(*ListStackSetOperationResultsOutput, bool) bool, opts ...request.Option) error

ListStackSetOperationResultsPagesWithContext same as ListStackSetOperationResultsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ListStackSetOperationResultsRequest added in v1.10.16 

func (c *CloudFormation) ListStackSetOperationResultsRequest(input *ListStackSetOperationResultsInput) (req *request.Request, output *ListStackSetOperationResultsOutput)

ListStackSetOperationResultsRequest generates a "aws/request.Request" representing the client's request for the ListStackSetOperationResults operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListStackSetOperationResults for more information on using the ListStackSetOperationResults API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListStackSetOperationResultsRequest method.
req, resp := client.ListStackSetOperationResultsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackSetOperationResults

func (*CloudFormation) ListStackSetOperationResultsWithContext added in v1.10.16 

func (c *CloudFormation) ListStackSetOperationResultsWithContext(ctx aws.Context, input *ListStackSetOperationResultsInput, opts ...request.Option) (*ListStackSetOperationResultsOutput, error)

ListStackSetOperationResultsWithContext is the same as ListStackSetOperationResults with the addition of the ability to pass a context and additional request options.

See ListStackSetOperationResults for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ListStackSetOperations added in v1.10.16 

func (c *CloudFormation) ListStackSetOperations(input *ListStackSetOperationsInput) (*ListStackSetOperationsOutput, error)

ListStackSetOperations API operation for AWS CloudFormation.

Returns summary information about operations performed on a stack set.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation ListStackSetOperations for usage and error information.

Returned Error Codes:

  • ErrCodeStackSetNotFoundException "StackSetNotFoundException" The specified stack set doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackSetOperations

func (*CloudFormation) ListStackSetOperationsPages added in v1.30.29 

func (c *CloudFormation) ListStackSetOperationsPages(input *ListStackSetOperationsInput, fn func(*ListStackSetOperationsOutput, bool) bool) error

ListStackSetOperationsPages iterates over the pages of a ListStackSetOperations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListStackSetOperations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListStackSetOperations operation.
pageNum := 0
err := client.ListStackSetOperationsPages(params,
    func(page *cloudformation.ListStackSetOperationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudFormation) ListStackSetOperationsPagesWithContext added in v1.30.29 

func (c *CloudFormation) ListStackSetOperationsPagesWithContext(ctx aws.Context, input *ListStackSetOperationsInput, fn func(*ListStackSetOperationsOutput, bool) bool, opts ...request.Option) error

ListStackSetOperationsPagesWithContext same as ListStackSetOperationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ListStackSetOperationsRequest added in v1.10.16 

func (c *CloudFormation) ListStackSetOperationsRequest(input *ListStackSetOperationsInput) (req *request.Request, output *ListStackSetOperationsOutput)

ListStackSetOperationsRequest generates a "aws/request.Request" representing the client's request for the ListStackSetOperations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListStackSetOperations for more information on using the ListStackSetOperations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListStackSetOperationsRequest method.
req, resp := client.ListStackSetOperationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackSetOperations

func (*CloudFormation) ListStackSetOperationsWithContext added in v1.10.16 

func (c *CloudFormation) ListStackSetOperationsWithContext(ctx aws.Context, input *ListStackSetOperationsInput, opts ...request.Option) (*ListStackSetOperationsOutput, error)

ListStackSetOperationsWithContext is the same as ListStackSetOperations with the addition of the ability to pass a context and additional request options.

See ListStackSetOperations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ListStackSets added in v1.10.16 

func (c *CloudFormation) ListStackSets(input *ListStackSetsInput) (*ListStackSetsOutput, error)

ListStackSets API operation for AWS CloudFormation.

Returns summary information about stack sets that are associated with the user.

  • [Self-managed permissions] If you set the CallAs parameter to SELF while signed in to your Amazon Web Services account, ListStackSets returns all self-managed stack sets in your Amazon Web Services account.

  • [Service-managed permissions] If you set the CallAs parameter to SELF while signed in to the organization's management account, ListStackSets returns all stack sets in the management account.

  • [Service-managed permissions] If you set the CallAs parameter to DELEGATED_ADMIN while signed in to your member account, ListStackSets returns all stack sets with service-managed permissions in the management account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation ListStackSets for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackSets

func (*CloudFormation) ListStackSetsPages added in v1.30.29 

func (c *CloudFormation) ListStackSetsPages(input *ListStackSetsInput, fn func(*ListStackSetsOutput, bool) bool) error

ListStackSetsPages iterates over the pages of a ListStackSets operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListStackSets method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListStackSets operation.
pageNum := 0
err := client.ListStackSetsPages(params,
    func(page *cloudformation.ListStackSetsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudFormation) ListStackSetsPagesWithContext added in v1.30.29 

func (c *CloudFormation) ListStackSetsPagesWithContext(ctx aws.Context, input *ListStackSetsInput, fn func(*ListStackSetsOutput, bool) bool, opts ...request.Option) error

ListStackSetsPagesWithContext same as ListStackSetsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ListStackSetsRequest added in v1.10.16 

func (c *CloudFormation) ListStackSetsRequest(input *ListStackSetsInput) (req *request.Request, output *ListStackSetsOutput)

ListStackSetsRequest generates a "aws/request.Request" representing the client's request for the ListStackSets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListStackSets for more information on using the ListStackSets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListStackSetsRequest method.
req, resp := client.ListStackSetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackSets

func (*CloudFormation) ListStackSetsWithContext added in v1.10.16 

func (c *CloudFormation) ListStackSetsWithContext(ctx aws.Context, input *ListStackSetsInput, opts ...request.Option) (*ListStackSetsOutput, error)

ListStackSetsWithContext is the same as ListStackSets with the addition of the ability to pass a context and additional request options.

See ListStackSets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ListStacks 

func (c *CloudFormation) ListStacks(input *ListStacksInput) (*ListStacksOutput, error)

ListStacks API operation for AWS CloudFormation.

Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation ListStacks for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStacks

func (*CloudFormation) ListStacksPages 

func (c *CloudFormation) ListStacksPages(input *ListStacksInput, fn func(*ListStacksOutput, bool) bool) error

ListStacksPages iterates over the pages of a ListStacks operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListStacks method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListStacks operation.
pageNum := 0
err := client.ListStacksPages(params,
    func(page *cloudformation.ListStacksOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudFormation) ListStacksPagesWithContext added in v1.8.0 

func (c *CloudFormation) ListStacksPagesWithContext(ctx aws.Context, input *ListStacksInput, fn func(*ListStacksOutput, bool) bool, opts ...request.Option) error

ListStacksPagesWithContext same as ListStacksPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ListStacksRequest 

func (c *CloudFormation) ListStacksRequest(input *ListStacksInput) (req *request.Request, output *ListStacksOutput)

ListStacksRequest generates a "aws/request.Request" representing the client's request for the ListStacks operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListStacks for more information on using the ListStacks API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListStacksRequest method.
req, resp := client.ListStacksRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStacks

func (*CloudFormation) ListStacksWithContext added in v1.8.0 

func (c *CloudFormation) ListStacksWithContext(ctx aws.Context, input *ListStacksInput, opts ...request.Option) (*ListStacksOutput, error)

ListStacksWithContext is the same as ListStacks with the addition of the ability to pass a context and additional request options.

See ListStacks for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ListTypeRegistrations added in v1.25.37 

func (c *CloudFormation) ListTypeRegistrations(input *ListTypeRegistrationsInput) (*ListTypeRegistrationsOutput, error)

ListTypeRegistrations API operation for AWS CloudFormation.

Returns a list of registration tokens for the specified extension(s).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation ListTypeRegistrations for usage and error information.

Returned Error Codes:

  • ErrCodeCFNRegistryException "CFNRegistryException" An error occurred during a CloudFormation registry operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListTypeRegistrations

func (*CloudFormation) ListTypeRegistrationsPages added in v1.25.37 

func (c *CloudFormation) ListTypeRegistrationsPages(input *ListTypeRegistrationsInput, fn func(*ListTypeRegistrationsOutput, bool) bool) error

ListTypeRegistrationsPages iterates over the pages of a ListTypeRegistrations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTypeRegistrations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListTypeRegistrations operation.
pageNum := 0
err := client.ListTypeRegistrationsPages(params,
    func(page *cloudformation.ListTypeRegistrationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudFormation) ListTypeRegistrationsPagesWithContext added in v1.25.37 

func (c *CloudFormation) ListTypeRegistrationsPagesWithContext(ctx aws.Context, input *ListTypeRegistrationsInput, fn func(*ListTypeRegistrationsOutput, bool) bool, opts ...request.Option) error

ListTypeRegistrationsPagesWithContext same as ListTypeRegistrationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ListTypeRegistrationsRequest added in v1.25.37 

func (c *CloudFormation) ListTypeRegistrationsRequest(input *ListTypeRegistrationsInput) (req *request.Request, output *ListTypeRegistrationsOutput)

ListTypeRegistrationsRequest generates a "aws/request.Request" representing the client's request for the ListTypeRegistrations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTypeRegistrations for more information on using the ListTypeRegistrations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTypeRegistrationsRequest method.
req, resp := client.ListTypeRegistrationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListTypeRegistrations

func (*CloudFormation) ListTypeRegistrationsWithContext added in v1.25.37 

func (c *CloudFormation) ListTypeRegistrationsWithContext(ctx aws.Context, input *ListTypeRegistrationsInput, opts ...request.Option) (*ListTypeRegistrationsOutput, error)

ListTypeRegistrationsWithContext is the same as ListTypeRegistrations with the addition of the ability to pass a context and additional request options.

See ListTypeRegistrations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ListTypeVersions added in v1.25.37 

func (c *CloudFormation) ListTypeVersions(input *ListTypeVersionsInput) (*ListTypeVersionsOutput, error)

ListTypeVersions API operation for AWS CloudFormation.

Returns summary information about the versions of an extension.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation ListTypeVersions for usage and error information.

Returned Error Codes:

  • ErrCodeCFNRegistryException "CFNRegistryException" An error occurred during a CloudFormation registry operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListTypeVersions

func (*CloudFormation) ListTypeVersionsPages added in v1.25.37 

func (c *CloudFormation) ListTypeVersionsPages(input *ListTypeVersionsInput, fn func(*ListTypeVersionsOutput, bool) bool) error

ListTypeVersionsPages iterates over the pages of a ListTypeVersions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTypeVersions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListTypeVersions operation.
pageNum := 0
err := client.ListTypeVersionsPages(params,
    func(page *cloudformation.ListTypeVersionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudFormation) ListTypeVersionsPagesWithContext added in v1.25.37 

func (c *CloudFormation) ListTypeVersionsPagesWithContext(ctx aws.Context, input *ListTypeVersionsInput, fn func(*ListTypeVersionsOutput, bool) bool, opts ...request.Option) error

ListTypeVersionsPagesWithContext same as ListTypeVersionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ListTypeVersionsRequest added in v1.25.37 

func (c *CloudFormation) ListTypeVersionsRequest(input *ListTypeVersionsInput) (req *request.Request, output *ListTypeVersionsOutput)

ListTypeVersionsRequest generates a "aws/request.Request" representing the client's request for the ListTypeVersions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTypeVersions for more information on using the ListTypeVersions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTypeVersionsRequest method.
req, resp := client.ListTypeVersionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListTypeVersions

func (*CloudFormation) ListTypeVersionsWithContext added in v1.25.37 

func (c *CloudFormation) ListTypeVersionsWithContext(ctx aws.Context, input *ListTypeVersionsInput, opts ...request.Option) (*ListTypeVersionsOutput, error)

ListTypeVersionsWithContext is the same as ListTypeVersions with the addition of the ability to pass a context and additional request options.

See ListTypeVersions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ListTypes added in v1.25.37 

func (c *CloudFormation) ListTypes(input *ListTypesInput) (*ListTypesOutput, error)

ListTypes API operation for AWS CloudFormation.

Returns summary information about extension that have been registered with CloudFormation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation ListTypes for usage and error information.

Returned Error Codes:

  • ErrCodeCFNRegistryException "CFNRegistryException" An error occurred during a CloudFormation registry operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListTypes

func (*CloudFormation) ListTypesPages added in v1.25.37 

func (c *CloudFormation) ListTypesPages(input *ListTypesInput, fn func(*ListTypesOutput, bool) bool) error

ListTypesPages iterates over the pages of a ListTypes operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTypes method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListTypes operation.
pageNum := 0
err := client.ListTypesPages(params,
    func(page *cloudformation.ListTypesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudFormation) ListTypesPagesWithContext added in v1.25.37 

func (c *CloudFormation) ListTypesPagesWithContext(ctx aws.Context, input *ListTypesInput, fn func(*ListTypesOutput, bool) bool, opts ...request.Option) error

ListTypesPagesWithContext same as ListTypesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ListTypesRequest added in v1.25.37 

func (c *CloudFormation) ListTypesRequest(input *ListTypesInput) (req *request.Request, output *ListTypesOutput)

ListTypesRequest generates a "aws/request.Request" representing the client's request for the ListTypes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTypes for more information on using the ListTypes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTypesRequest method.
req, resp := client.ListTypesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListTypes

func (*CloudFormation) ListTypesWithContext added in v1.25.37 

func (c *CloudFormation) ListTypesWithContext(ctx aws.Context, input *ListTypesInput, opts ...request.Option) (*ListTypesOutput, error)

ListTypesWithContext is the same as ListTypes with the addition of the ability to pass a context and additional request options.

See ListTypes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) PublishType added in v1.38.65 

func (c *CloudFormation) PublishType(input *PublishTypeInput) (*PublishTypeOutput, error)

PublishType API operation for AWS CloudFormation.

Publishes the specified extension to the CloudFormation registry as a public extension in this Region. Public extensions are available for use by all CloudFormation users. For more information about publishing extensions, see Publishing extensions to make them available for public use (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html) in the CloudFormation CLI User Guide.

To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation PublishType for usage and error information.

Returned Error Codes:

  • ErrCodeCFNRegistryException "CFNRegistryException" An error occurred during a CloudFormation registry operation.

  • ErrCodeTypeNotFoundException "TypeNotFoundException" The specified extension doesn't exist in the CloudFormation registry.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/PublishType

func (*CloudFormation) PublishTypeRequest added in v1.38.65 

func (c *CloudFormation) PublishTypeRequest(input *PublishTypeInput) (req *request.Request, output *PublishTypeOutput)

PublishTypeRequest generates a "aws/request.Request" representing the client's request for the PublishType operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PublishType for more information on using the PublishType API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PublishTypeRequest method.
req, resp := client.PublishTypeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/PublishType

func (*CloudFormation) PublishTypeWithContext added in v1.38.65 

func (c *CloudFormation) PublishTypeWithContext(ctx aws.Context, input *PublishTypeInput, opts ...request.Option) (*PublishTypeOutput, error)

PublishTypeWithContext is the same as PublishType with the addition of the ability to pass a context and additional request options.

See PublishType for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) RecordHandlerProgress added in v1.25.37 

func (c *CloudFormation) RecordHandlerProgress(input *RecordHandlerProgressInput) (*RecordHandlerProgressOutput, error)

RecordHandlerProgress API operation for AWS CloudFormation.

Reports progress of a resource handler to CloudFormation.

Reserved for use by the CloudFormation CLI (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html). Don't use this API in your code.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation RecordHandlerProgress for usage and error information.

Returned Error Codes:

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RecordHandlerProgress

func (*CloudFormation) RecordHandlerProgressRequest added in v1.25.37 

func (c *CloudFormation) RecordHandlerProgressRequest(input *RecordHandlerProgressInput) (req *request.Request, output *RecordHandlerProgressOutput)

RecordHandlerProgressRequest generates a "aws/request.Request" representing the client's request for the RecordHandlerProgress operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RecordHandlerProgress for more information on using the RecordHandlerProgress API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RecordHandlerProgressRequest method.
req, resp := client.RecordHandlerProgressRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RecordHandlerProgress

func (*CloudFormation) RecordHandlerProgressWithContext added in v1.25.37 

func (c *CloudFormation) RecordHandlerProgressWithContext(ctx aws.Context, input *RecordHandlerProgressInput, opts ...request.Option) (*RecordHandlerProgressOutput, error)

RecordHandlerProgressWithContext is the same as RecordHandlerProgress with the addition of the ability to pass a context and additional request options.

See RecordHandlerProgress for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) RegisterPublisher added in v1.38.65 

func (c *CloudFormation) RegisterPublisher(input *RegisterPublisherInput) (*RegisterPublisherOutput, error)

RegisterPublisher API operation for AWS CloudFormation.

Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users. This publisher ID applies to your account in all Amazon Web Services Regions.

For information about requirements for registering as a public extension publisher, see Registering your account to publish CloudFormation extensions (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs) in the CloudFormation CLI User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation RegisterPublisher for usage and error information.

Returned Error Codes:

  • ErrCodeCFNRegistryException "CFNRegistryException" An error occurred during a CloudFormation registry operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RegisterPublisher

func (*CloudFormation) RegisterPublisherRequest added in v1.38.65 

func (c *CloudFormation) RegisterPublisherRequest(input *RegisterPublisherInput) (req *request.Request, output *RegisterPublisherOutput)

RegisterPublisherRequest generates a "aws/request.Request" representing the client's request for the RegisterPublisher operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterPublisher for more information on using the RegisterPublisher API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RegisterPublisherRequest method.
req, resp := client.RegisterPublisherRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RegisterPublisher

func (*CloudFormation) RegisterPublisherWithContext added in v1.38.65 

func (c *CloudFormation) RegisterPublisherWithContext(ctx aws.Context, input *RegisterPublisherInput, opts ...request.Option) (*RegisterPublisherOutput, error)

RegisterPublisherWithContext is the same as RegisterPublisher with the addition of the ability to pass a context and additional request options.

See RegisterPublisher for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) RegisterType added in v1.25.37 

func (c *CloudFormation) RegisterType(input *RegisterTypeInput) (*RegisterTypeOutput, error)

RegisterType API operation for AWS CloudFormation.

Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:

  • Validating the extension schema.

  • Determining which handlers, if any, have been specified for the extension.

  • Making the extension available for use in your account.

For more information about how to develop extensions and ready them for registration, see Creating Resource Providers (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html) in the CloudFormation CLI User Guide.

You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and per Region. Use DeregisterType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeregisterType.html) to deregister specific extension versions if necessary.

Once you have initiated a registration request using RegisterType, you can use DescribeTypeRegistration to monitor the progress of the registration request.

Once you have registered a private extension in your account and Region, use SetTypeConfiguration (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html) to specify configuration properties for the extension. For more information, see Configuring extensions at the account level (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration) in the CloudFormation User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation RegisterType for usage and error information.

Returned Error Codes:

  • ErrCodeCFNRegistryException "CFNRegistryException" An error occurred during a CloudFormation registry operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RegisterType

func (*CloudFormation) RegisterTypeRequest added in v1.25.37 

func (c *CloudFormation) RegisterTypeRequest(input *RegisterTypeInput) (req *request.Request, output *RegisterTypeOutput)

RegisterTypeRequest generates a "aws/request.Request" representing the client's request for the RegisterType operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterType for more information on using the RegisterType API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RegisterTypeRequest method.
req, resp := client.RegisterTypeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RegisterType

func (*CloudFormation) RegisterTypeWithContext added in v1.25.37 

func (c *CloudFormation) RegisterTypeWithContext(ctx aws.Context, input *RegisterTypeInput, opts ...request.Option) (*RegisterTypeOutput, error)

RegisterTypeWithContext is the same as RegisterType with the addition of the ability to pass a context and additional request options.

See RegisterType for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) RollbackStack added in v1.40.33 

func (c *CloudFormation) RollbackStack(input *RollbackStackInput) (*RollbackStackOutput, error)

RollbackStack API operation for AWS CloudFormation.

When specifying RollbackStack, you preserve the state of previously provisioned resources when an operation fails. You can check the status of the stack through the DescribeStacks operation.

Rolls back the specified stack to the last known stable state from CREATE_FAILED or UPDATE_FAILED stack statuses.

This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state includes any status in a *_COMPLETE. This includes the following stack statuses.

  • CREATE_COMPLETE

  • UPDATE_COMPLETE

  • UPDATE_ROLLBACK_COMPLETE

  • IMPORT_COMPLETE

  • IMPORT_ROLLBACK_COMPLETE

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation RollbackStack for usage and error information.

Returned Error Codes:

  • ErrCodeTokenAlreadyExistsException "TokenAlreadyExistsException" A client request token already exists.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackStack

func (*CloudFormation) RollbackStackRequest added in v1.40.33 

func (c *CloudFormation) RollbackStackRequest(input *RollbackStackInput) (req *request.Request, output *RollbackStackOutput)

RollbackStackRequest generates a "aws/request.Request" representing the client's request for the RollbackStack operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RollbackStack for more information on using the RollbackStack API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RollbackStackRequest method.
req, resp := client.RollbackStackRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackStack

func (*CloudFormation) RollbackStackWithContext added in v1.40.33 

func (c *CloudFormation) RollbackStackWithContext(ctx aws.Context, input *RollbackStackInput, opts ...request.Option) (*RollbackStackOutput, error)

RollbackStackWithContext is the same as RollbackStack with the addition of the ability to pass a context and additional request options.

See RollbackStack for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) SetStackPolicy 

func (c *CloudFormation) SetStackPolicy(input *SetStackPolicyInput) (*SetStackPolicyOutput, error)

SetStackPolicy API operation for AWS CloudFormation.

Sets a stack policy for a specified stack.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation SetStackPolicy for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SetStackPolicy

func (*CloudFormation) SetStackPolicyRequest 

func (c *CloudFormation) SetStackPolicyRequest(input *SetStackPolicyInput) (req *request.Request, output *SetStackPolicyOutput)

SetStackPolicyRequest generates a "aws/request.Request" representing the client's request for the SetStackPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SetStackPolicy for more information on using the SetStackPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the SetStackPolicyRequest method.
req, resp := client.SetStackPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SetStackPolicy

func (*CloudFormation) SetStackPolicyWithContext added in v1.8.0 

func (c *CloudFormation) SetStackPolicyWithContext(ctx aws.Context, input *SetStackPolicyInput, opts ...request.Option) (*SetStackPolicyOutput, error)

SetStackPolicyWithContext is the same as SetStackPolicy with the addition of the ability to pass a context and additional request options.

See SetStackPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) SetTypeConfiguration added in v1.38.65 

func (c *CloudFormation) SetTypeConfiguration(input *SetTypeConfigurationInput) (*SetTypeConfigurationOutput, error)

SetTypeConfiguration API operation for AWS CloudFormation.

Specifies the configuration data for a registered CloudFormation extension, in the given account and Region.

To view the current configuration data for an extension, refer to the ConfigurationSchema element of DescribeType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html). For more information, see Configuring extensions at the account level (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration) in the CloudFormation User Guide.

It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more details on dynamic references, see Using dynamic references to specify template values (https://docs.aws.amazon.com/) in the CloudFormation User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation SetTypeConfiguration for usage and error information.

Returned Error Codes:

  • ErrCodeCFNRegistryException "CFNRegistryException" An error occurred during a CloudFormation registry operation.

  • ErrCodeTypeNotFoundException "TypeNotFoundException" The specified extension doesn't exist in the CloudFormation registry.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SetTypeConfiguration

func (*CloudFormation) SetTypeConfigurationRequest added in v1.38.65 

func (c *CloudFormation) SetTypeConfigurationRequest(input *SetTypeConfigurationInput) (req *request.Request, output *SetTypeConfigurationOutput)

SetTypeConfigurationRequest generates a "aws/request.Request" representing the client's request for the SetTypeConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SetTypeConfiguration for more information on using the SetTypeConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the SetTypeConfigurationRequest method.
req, resp := client.SetTypeConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SetTypeConfiguration

func (*CloudFormation) SetTypeConfigurationWithContext added in v1.38.65 

func (c *CloudFormation) SetTypeConfigurationWithContext(ctx aws.Context, input *SetTypeConfigurationInput, opts ...request.Option) (*SetTypeConfigurationOutput, error)

SetTypeConfigurationWithContext is the same as SetTypeConfiguration with the addition of the ability to pass a context and additional request options.

See SetTypeConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) SetTypeDefaultVersion added in v1.25.37 

func (c *CloudFormation) SetTypeDefaultVersion(input *SetTypeDefaultVersionInput) (*SetTypeDefaultVersionOutput, error)

SetTypeDefaultVersion API operation for AWS CloudFormation.

Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation SetTypeDefaultVersion for usage and error information.

Returned Error Codes:

  • ErrCodeCFNRegistryException "CFNRegistryException" An error occurred during a CloudFormation registry operation.

  • ErrCodeTypeNotFoundException "TypeNotFoundException" The specified extension doesn't exist in the CloudFormation registry.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SetTypeDefaultVersion

func (*CloudFormation) SetTypeDefaultVersionRequest added in v1.25.37 

func (c *CloudFormation) SetTypeDefaultVersionRequest(input *SetTypeDefaultVersionInput) (req *request.Request, output *SetTypeDefaultVersionOutput)

SetTypeDefaultVersionRequest generates a "aws/request.Request" representing the client's request for the SetTypeDefaultVersion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SetTypeDefaultVersion for more information on using the SetTypeDefaultVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the SetTypeDefaultVersionRequest method.
req, resp := client.SetTypeDefaultVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SetTypeDefaultVersion

func (*CloudFormation) SetTypeDefaultVersionWithContext added in v1.25.37 

func (c *CloudFormation) SetTypeDefaultVersionWithContext(ctx aws.Context, input *SetTypeDefaultVersionInput, opts ...request.Option) (*SetTypeDefaultVersionOutput, error)

SetTypeDefaultVersionWithContext is the same as SetTypeDefaultVersion with the addition of the ability to pass a context and additional request options.

See SetTypeDefaultVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) SignalResource 

func (c *CloudFormation) SignalResource(input *SignalResourceInput) (*SignalResourceOutput, error)

SignalResource API operation for AWS CloudFormation.

Sends a signal to the specified resource with a success or failure status. You can use the SignalResource operation in conjunction with a creation policy or update policy. CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource operation is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation SignalResource for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SignalResource

func (*CloudFormation) SignalResourceRequest 

func (c *CloudFormation) SignalResourceRequest(input *SignalResourceInput) (req *request.Request, output *SignalResourceOutput)

SignalResourceRequest generates a "aws/request.Request" representing the client's request for the SignalResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SignalResource for more information on using the SignalResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the SignalResourceRequest method.
req, resp := client.SignalResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/SignalResource

func (*CloudFormation) SignalResourceWithContext added in v1.8.0 

func (c *CloudFormation) SignalResourceWithContext(ctx aws.Context, input *SignalResourceInput, opts ...request.Option) (*SignalResourceOutput, error)

SignalResourceWithContext is the same as SignalResource with the addition of the ability to pass a context and additional request options.

See SignalResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) StopStackSetOperation added in v1.10.16 

func (c *CloudFormation) StopStackSetOperation(input *StopStackSetOperationInput) (*StopStackSetOperationOutput, error)

StopStackSetOperation API operation for AWS CloudFormation.

Stops an in-progress operation on a stack set and its associated stack instances. StackSets will cancel all the unstarted stack instance deployments and wait for those are in-progress to complete.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation StopStackSetOperation for usage and error information.

Returned Error Codes:

  • ErrCodeStackSetNotFoundException "StackSetNotFoundException" The specified stack set doesn't exist.

  • ErrCodeOperationNotFoundException "OperationNotFoundException" The specified ID refers to an operation that doesn't exist.

  • ErrCodeInvalidOperationException "InvalidOperationException" The specified operation isn't valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StopStackSetOperation

func (*CloudFormation) StopStackSetOperationRequest added in v1.10.16 

func (c *CloudFormation) StopStackSetOperationRequest(input *StopStackSetOperationInput) (req *request.Request, output *StopStackSetOperationOutput)

StopStackSetOperationRequest generates a "aws/request.Request" representing the client's request for the StopStackSetOperation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopStackSetOperation for more information on using the StopStackSetOperation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StopStackSetOperationRequest method.
req, resp := client.StopStackSetOperationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StopStackSetOperation

func (*CloudFormation) StopStackSetOperationWithContext added in v1.10.16 

func (c *CloudFormation) StopStackSetOperationWithContext(ctx aws.Context, input *StopStackSetOperationInput, opts ...request.Option) (*StopStackSetOperationOutput, error)

StopStackSetOperationWithContext is the same as StopStackSetOperation with the addition of the ability to pass a context and additional request options.

See StopStackSetOperation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) TestType added in v1.38.65 

func (c *CloudFormation) TestType(input *TestTypeInput) (*TestTypeOutput, error)

TestType API operation for AWS CloudFormation.

Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.

  • For resource types, this includes passing all contracts tests defined for the type.

  • For modules, this includes determining if the module's model meets all necessary requirements.

For more information, see Testing your public extension prior to publishing (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-testing) in the CloudFormation CLI User Guide.

If you don't specify a version, CloudFormation uses the default version of the extension in your account and Region for testing.

To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more information, see RegisterType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html).

Once you've initiated testing on an extension using TestType, you can pass the returned TypeVersionArn into DescribeType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html) to monitor the current test status and test status description for the extension.

An extension must have a test status of PASSED before it can be published. For more information, see Publishing extensions to make them available for public use (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html) in the CloudFormation CLI User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation TestType for usage and error information.

Returned Error Codes:

  • ErrCodeCFNRegistryException "CFNRegistryException" An error occurred during a CloudFormation registry operation.

  • ErrCodeTypeNotFoundException "TypeNotFoundException" The specified extension doesn't exist in the CloudFormation registry.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TestType

func (*CloudFormation) TestTypeRequest added in v1.38.65 

func (c *CloudFormation) TestTypeRequest(input *TestTypeInput) (req *request.Request, output *TestTypeOutput)

TestTypeRequest generates a "aws/request.Request" representing the client's request for the TestType operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TestType for more information on using the TestType API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TestTypeRequest method.
req, resp := client.TestTypeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/TestType

func (*CloudFormation) TestTypeWithContext added in v1.38.65 

func (c *CloudFormation) TestTypeWithContext(ctx aws.Context, input *TestTypeInput, opts ...request.Option) (*TestTypeOutput, error)

TestTypeWithContext is the same as TestType with the addition of the ability to pass a context and additional request options.

See TestType for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) UpdateStack 

func (c *CloudFormation) UpdateStack(input *UpdateStackInput) (*UpdateStackOutput, error)

UpdateStack API operation for AWS CloudFormation.

Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack through the DescribeStacks action.

To get a copy of the template for an existing stack, you can use the GetTemplate action.

For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation UpdateStack for usage and error information.

Returned Error Codes:

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

  • ErrCodeTokenAlreadyExistsException "TokenAlreadyExistsException" A client request token already exists.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateStack

func (*CloudFormation) UpdateStackInstances added in v1.12.32 

func (c *CloudFormation) UpdateStackInstances(input *UpdateStackInstancesInput) (*UpdateStackInstancesOutput, error)

UpdateStackInstances API operation for AWS CloudFormation.

Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.

You can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStackInstances.html).

During stack set updates, any parameters overridden for a stack instance aren't updated, but retain their overridden value.

You can only update the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html) to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html) to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation UpdateStackInstances for usage and error information.

Returned Error Codes:

  • ErrCodeStackSetNotFoundException "StackSetNotFoundException" The specified stack set doesn't exist.

  • ErrCodeStackInstanceNotFoundException "StackInstanceNotFoundException" The specified stack instance doesn't exist.

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

  • ErrCodeOperationIdAlreadyExistsException "OperationIdAlreadyExistsException" The specified operation ID already exists.

  • ErrCodeStaleRequestException "StaleRequestException" Another operation has been performed on this stack set since the specified operation was performed.

  • ErrCodeInvalidOperationException "InvalidOperationException" The specified operation isn't valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateStackInstances

func (*CloudFormation) UpdateStackInstancesRequest added in v1.12.32 

func (c *CloudFormation) UpdateStackInstancesRequest(input *UpdateStackInstancesInput) (req *request.Request, output *UpdateStackInstancesOutput)

UpdateStackInstancesRequest generates a "aws/request.Request" representing the client's request for the UpdateStackInstances operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateStackInstances for more information on using the UpdateStackInstances API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateStackInstancesRequest method.
req, resp := client.UpdateStackInstancesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateStackInstances

func (*CloudFormation) UpdateStackInstancesWithContext added in v1.12.32 

func (c *CloudFormation) UpdateStackInstancesWithContext(ctx aws.Context, input *UpdateStackInstancesInput, opts ...request.Option) (*UpdateStackInstancesOutput, error)

UpdateStackInstancesWithContext is the same as UpdateStackInstances with the addition of the ability to pass a context and additional request options.

See UpdateStackInstances for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) UpdateStackRequest 

func (c *CloudFormation) UpdateStackRequest(input *UpdateStackInput) (req *request.Request, output *UpdateStackOutput)

UpdateStackRequest generates a "aws/request.Request" representing the client's request for the UpdateStack operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateStack for more information on using the UpdateStack API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateStackRequest method.
req, resp := client.UpdateStackRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateStack

func (*CloudFormation) UpdateStackSet added in v1.10.16 

func (c *CloudFormation) UpdateStackSet(input *UpdateStackSetInput) (*UpdateStackSetOutput, error)

UpdateStackSet API operation for AWS CloudFormation.

Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.

Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation UpdateStackSet for usage and error information.

Returned Error Codes:

  • ErrCodeStackSetNotFoundException "StackSetNotFoundException" The specified stack set doesn't exist.

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

  • ErrCodeOperationIdAlreadyExistsException "OperationIdAlreadyExistsException" The specified operation ID already exists.

  • ErrCodeStaleRequestException "StaleRequestException" Another operation has been performed on this stack set since the specified operation was performed.

  • ErrCodeInvalidOperationException "InvalidOperationException" The specified operation isn't valid.

  • ErrCodeStackInstanceNotFoundException "StackInstanceNotFoundException" The specified stack instance doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateStackSet

func (*CloudFormation) UpdateStackSetRequest added in v1.10.16 

func (c *CloudFormation) UpdateStackSetRequest(input *UpdateStackSetInput) (req *request.Request, output *UpdateStackSetOutput)

UpdateStackSetRequest generates a "aws/request.Request" representing the client's request for the UpdateStackSet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateStackSet for more information on using the UpdateStackSet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateStackSetRequest method.
req, resp := client.UpdateStackSetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateStackSet

func (*CloudFormation) UpdateStackSetWithContext added in v1.10.16 

func (c *CloudFormation) UpdateStackSetWithContext(ctx aws.Context, input *UpdateStackSetInput, opts ...request.Option) (*UpdateStackSetOutput, error)

UpdateStackSetWithContext is the same as UpdateStackSet with the addition of the ability to pass a context and additional request options.

See UpdateStackSet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) UpdateStackWithContext added in v1.8.0 

func (c *CloudFormation) UpdateStackWithContext(ctx aws.Context, input *UpdateStackInput, opts ...request.Option) (*UpdateStackOutput, error)

UpdateStackWithContext is the same as UpdateStack with the addition of the ability to pass a context and additional request options.

See UpdateStack for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) UpdateTerminationProtection added in v1.11.0 

func (c *CloudFormation) UpdateTerminationProtection(input *UpdateTerminationProtectionInput) (*UpdateTerminationProtectionOutput, error)

UpdateTerminationProtection API operation for AWS CloudFormation.

Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) in the CloudFormation User Guide.

For nested stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html), termination protection is set on the root stack and can't be changed directly on the nested stack.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation UpdateTerminationProtection for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateTerminationProtection

func (*CloudFormation) UpdateTerminationProtectionRequest added in v1.11.0 

func (c *CloudFormation) UpdateTerminationProtectionRequest(input *UpdateTerminationProtectionInput) (req *request.Request, output *UpdateTerminationProtectionOutput)

UpdateTerminationProtectionRequest generates a "aws/request.Request" representing the client's request for the UpdateTerminationProtection operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateTerminationProtection for more information on using the UpdateTerminationProtection API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateTerminationProtectionRequest method.
req, resp := client.UpdateTerminationProtectionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/UpdateTerminationProtection

func (*CloudFormation) UpdateTerminationProtectionWithContext added in v1.11.0 

func (c *CloudFormation) UpdateTerminationProtectionWithContext(ctx aws.Context, input *UpdateTerminationProtectionInput, opts ...request.Option) (*UpdateTerminationProtectionOutput, error)

UpdateTerminationProtectionWithContext is the same as UpdateTerminationProtection with the addition of the ability to pass a context and additional request options.

See UpdateTerminationProtection for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) ValidateTemplate 

func (c *CloudFormation) ValidateTemplate(input *ValidateTemplateInput) (*ValidateTemplateOutput, error)

ValidateTemplate API operation for AWS CloudFormation.

Validates a specified template. CloudFormation first checks if the template is valid JSON. If it isn't, CloudFormation checks if the template is valid YAML. If both these checks fail, CloudFormation returns a template validation error.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudFormation's API operation ValidateTemplate for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ValidateTemplate

func (*CloudFormation) ValidateTemplateRequest 

func (c *CloudFormation) ValidateTemplateRequest(input *ValidateTemplateInput) (req *request.Request, output *ValidateTemplateOutput)

ValidateTemplateRequest generates a "aws/request.Request" representing the client's request for the ValidateTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ValidateTemplate for more information on using the ValidateTemplate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ValidateTemplateRequest method.
req, resp := client.ValidateTemplateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ValidateTemplate

func (*CloudFormation) ValidateTemplateWithContext added in v1.8.0 

func (c *CloudFormation) ValidateTemplateWithContext(ctx aws.Context, input *ValidateTemplateInput, opts ...request.Option) (*ValidateTemplateOutput, error)

ValidateTemplateWithContext is the same as ValidateTemplate with the addition of the ability to pass a context and additional request options.

See ValidateTemplate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) WaitUntilChangeSetCreateComplete added in v1.8.5 

func (c *CloudFormation) WaitUntilChangeSetCreateComplete(input *DescribeChangeSetInput) error

WaitUntilChangeSetCreateComplete uses the AWS CloudFormation API operation DescribeChangeSet to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*CloudFormation) WaitUntilChangeSetCreateCompleteWithContext added in v1.8.5 

func (c *CloudFormation) WaitUntilChangeSetCreateCompleteWithContext(ctx aws.Context, input *DescribeChangeSetInput, opts ...request.WaiterOption) error

WaitUntilChangeSetCreateCompleteWithContext is an extended version of WaitUntilChangeSetCreateComplete. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) WaitUntilStackCreateComplete added in v0.10.3 

func (c *CloudFormation) WaitUntilStackCreateComplete(input *DescribeStacksInput) error

WaitUntilStackCreateComplete uses the AWS CloudFormation API operation DescribeStacks to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*CloudFormation) WaitUntilStackCreateCompleteWithContext added in v1.8.0 

func (c *CloudFormation) WaitUntilStackCreateCompleteWithContext(ctx aws.Context, input *DescribeStacksInput, opts ...request.WaiterOption) error

WaitUntilStackCreateCompleteWithContext is an extended version of WaitUntilStackCreateComplete. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) WaitUntilStackDeleteComplete added in v0.10.3 

func (c *CloudFormation) WaitUntilStackDeleteComplete(input *DescribeStacksInput) error

WaitUntilStackDeleteComplete uses the AWS CloudFormation API operation DescribeStacks to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*CloudFormation) WaitUntilStackDeleteCompleteWithContext added in v1.8.0 

func (c *CloudFormation) WaitUntilStackDeleteCompleteWithContext(ctx aws.Context, input *DescribeStacksInput, opts ...request.WaiterOption) error

WaitUntilStackDeleteCompleteWithContext is an extended version of WaitUntilStackDeleteComplete. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) WaitUntilStackExists added in v1.1.15 

func (c *CloudFormation) WaitUntilStackExists(input *DescribeStacksInput) error

WaitUntilStackExists uses the AWS CloudFormation API operation DescribeStacks to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*CloudFormation) WaitUntilStackExistsWithContext added in v1.8.0 

func (c *CloudFormation) WaitUntilStackExistsWithContext(ctx aws.Context, input *DescribeStacksInput, opts ...request.WaiterOption) error

WaitUntilStackExistsWithContext is an extended version of WaitUntilStackExists. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) WaitUntilStackImportComplete added in v1.25.32 

func (c *CloudFormation) WaitUntilStackImportComplete(input *DescribeStacksInput) error

WaitUntilStackImportComplete uses the AWS CloudFormation API operation DescribeStacks to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*CloudFormation) WaitUntilStackImportCompleteWithContext added in v1.25.32 

func (c *CloudFormation) WaitUntilStackImportCompleteWithContext(ctx aws.Context, input *DescribeStacksInput, opts ...request.WaiterOption) error

WaitUntilStackImportCompleteWithContext is an extended version of WaitUntilStackImportComplete. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) WaitUntilStackRollbackComplete added in v1.30.29 

func (c *CloudFormation) WaitUntilStackRollbackComplete(input *DescribeStacksInput) error

WaitUntilStackRollbackComplete uses the AWS CloudFormation API operation DescribeStacks to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*CloudFormation) WaitUntilStackRollbackCompleteWithContext added in v1.30.29 

func (c *CloudFormation) WaitUntilStackRollbackCompleteWithContext(ctx aws.Context, input *DescribeStacksInput, opts ...request.WaiterOption) error

WaitUntilStackRollbackCompleteWithContext is an extended version of WaitUntilStackRollbackComplete. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) WaitUntilStackUpdateComplete added in v0.10.3 

func (c *CloudFormation) WaitUntilStackUpdateComplete(input *DescribeStacksInput) error

WaitUntilStackUpdateComplete uses the AWS CloudFormation API operation DescribeStacks to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*CloudFormation) WaitUntilStackUpdateCompleteWithContext added in v1.8.0 

func (c *CloudFormation) WaitUntilStackUpdateCompleteWithContext(ctx aws.Context, input *DescribeStacksInput, opts ...request.WaiterOption) error

WaitUntilStackUpdateCompleteWithContext is an extended version of WaitUntilStackUpdateComplete. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudFormation) WaitUntilTypeRegistrationComplete added in v1.25.37 

func (c *CloudFormation) WaitUntilTypeRegistrationComplete(input *DescribeTypeRegistrationInput) error

WaitUntilTypeRegistrationComplete uses the AWS CloudFormation API operation DescribeTypeRegistration to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*CloudFormation) WaitUntilTypeRegistrationCompleteWithContext added in v1.25.37 

func (c *CloudFormation) WaitUntilTypeRegistrationCompleteWithContext(ctx aws.Context, input *DescribeTypeRegistrationInput, opts ...request.WaiterOption) error

WaitUntilTypeRegistrationCompleteWithContext is an extended version of WaitUntilTypeRegistrationComplete. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ContinueUpdateRollbackInput added in v1.0.11 

type ContinueUpdateRollbackInput struct {

	// A unique identifier for this ContinueUpdateRollback request. Specify this
	// token if you plan to retry requests so that CloudFormation knows that you're
	// not attempting to continue the rollback to a stack with the same name. You
	// might retry ContinueUpdateRollback requests to ensure that CloudFormation
	// successfully received them.
	ClientRequestToken *string `min:"1" type:"string"`

	// A list of the logical IDs of the resources that CloudFormation skips during
	// the continue update rollback operation. You can specify only resources that
	// are in the UPDATE_FAILED state because a rollback failed. You can't specify
	// resources that are in the UPDATE_FAILED state for other reasons, for example,
	// because an update was canceled. To check why a resource update failed, use
	// the DescribeStackResources action, and view the resource status reason.
	//
	// Specify this property to skip rolling back resources that CloudFormation
	// can't successfully roll back. We recommend that you troubleshoot (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed)
	// resources before skipping them. CloudFormation sets the status of the specified
	// resources to UPDATE_COMPLETE and continues to roll back the stack. After
	// the rollback is complete, the state of the skipped resources will be inconsistent
	// with the state of the resources in the stack template. Before performing
	// another stack update, you must update the stack or resources to be consistent
	// with each other. If you don't, subsequent stack updates might fail, and the
	// stack will become unrecoverable.
	//
	// Specify the minimum number of resources required to successfully roll back
	// your stack. For example, a failed resource update might cause dependent resources
	// to fail. In this case, it might not be necessary to skip the dependent resources.
	//
	// To skip resources that are part of nested stacks, use the following format:
	// NestedStackName.ResourceLogicalID. If you want to specify the logical ID
	// of a stack resource (Type: AWS::CloudFormation::Stack) in the ResourcesToSkip
	// list, then its corresponding embedded stack must be in one of the following
	// states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or DELETE_FAILED.
	//
	// Don't confuse a child stack's name with its corresponding logical ID defined
	// in the parent stack. For an example of a continue update rollback operation
	// with nested stacks, see Using ResourcesToSkip to recover a nested stacks
	// hierarchy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html#nested-stacks).
	ResourcesToSkip []*string `type:"list"`

	// The Amazon Resource Name (ARN) of an Identity and Access Management (IAM)
	// role that CloudFormation assumes to roll back the stack. CloudFormation uses
	// the role's credentials to make calls on your behalf. CloudFormation always
	// uses this role for all future operations on the stack. Provided that users
	// have permission to operate on the stack, CloudFormation uses this role even
	// if the users don't have permission to pass it. Ensure that the role grants
	// least permission.
	//
	// If you don't specify a value, CloudFormation uses the role that was previously
	// associated with the stack. If no role is available, CloudFormation uses a
	// temporary session that's generated from your user credentials.
	RoleARN *string `min:"20" type:"string"`

	// The name or the unique ID of the stack that you want to continue rolling
	// back.
	//
	// Don't specify the name of a nested stack (a stack that was created by using
	// the AWS::CloudFormation::Stack resource). Instead, use this operation on
	// the parent stack (the stack that contains the AWS::CloudFormation::Stack
	// resource).
	//
	// StackName is a required field
	StackName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the ContinueUpdateRollback action.

func (ContinueUpdateRollbackInput) GoString added in v1.0.11 

func (s ContinueUpdateRollbackInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContinueUpdateRollbackInput) SetClientRequestToken added in v1.8.18 

func (s *ContinueUpdateRollbackInput) SetClientRequestToken(v string) *ContinueUpdateRollbackInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*ContinueUpdateRollbackInput) SetResourcesToSkip added in v1.5.0 

func (s *ContinueUpdateRollbackInput) SetResourcesToSkip(v []*string) *ContinueUpdateRollbackInput

SetResourcesToSkip sets the ResourcesToSkip field's value.

func (*ContinueUpdateRollbackInput) SetRoleARN added in v1.5.0 

func (s *ContinueUpdateRollbackInput) SetRoleARN(v string) *ContinueUpdateRollbackInput

SetRoleARN sets the RoleARN field's value.

func (*ContinueUpdateRollbackInput) SetStackName added in v1.5.0 

func (s *ContinueUpdateRollbackInput) SetStackName(v string) *ContinueUpdateRollbackInput

SetStackName sets the StackName field's value.

func (ContinueUpdateRollbackInput) String added in v1.0.11 

func (s ContinueUpdateRollbackInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContinueUpdateRollbackInput) Validate added in v1.1.21 

func (s *ContinueUpdateRollbackInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ContinueUpdateRollbackOutput added in v1.0.11 

type ContinueUpdateRollbackOutput struct {
	// contains filtered or unexported fields
}

The output for a ContinueUpdateRollback operation.

func (ContinueUpdateRollbackOutput) GoString added in v1.0.11 

func (s ContinueUpdateRollbackOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (ContinueUpdateRollbackOutput) String added in v1.0.11 

func (s ContinueUpdateRollbackOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateChangeSetInput added in v1.1.15 

type CreateChangeSetInput struct {

	// In some cases, you must explicitly acknowledge that your stack template contains
	// certain capabilities in order for CloudFormation to create the stack.
	//
	//    * CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack 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 those stacks, you must explicitly acknowledge this by specifying one
	//    of these capabilities. The following IAM resources require you to specify
	//    either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. If you have
	//    IAM resources, you can specify either capability. If you have IAM resources
	//    with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't
	//    specify either of these capabilities, CloudFormation returns an InsufficientCapabilities
	//    error. If your stack template contains these resources, we suggest that
	//    you review all permissions associated with them and edit their permissions
	//    if necessary. AWS::IAM::AccessKey (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html)
	//    AWS::IAM::Group (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html)
	//    AWS::IAM::InstanceProfile (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html)
	//    AWS::IAM::Policy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html)
	//    AWS::IAM::Role (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html)
	//    AWS::IAM::User (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html)
	//    AWS::IAM::UserToGroupAddition (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html)
	//    For more information, see Acknowledging IAM resources in CloudFormation
	//    templates (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities).
	//
	//    * CAPABILITY_AUTO_EXPAND Some template contain macros. Macros perform
	//    custom processing on templates; this can include simple actions like find-and-replace
	//    operations, all the way to extensive transformations of entire templates.
	//    Because of this, users typically create a change set from the processed
	//    template, so that they can review the changes resulting from the macros
	//    before actually creating the stack. If your stack template contains one
	//    or more macros, and you choose to create a stack directly from the processed
	//    template, without first reviewing the resulting changes in a change set,
	//    you must acknowledge this capability. This includes the AWS::Include (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html)
	//    and AWS::Serverless (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html)
	//    transforms, which are macros hosted by CloudFormation. This capacity doesn't
	//    apply to creating change sets, and specifying it when creating change
	//    sets has no effect. If you want to create a stack from a stack template
	//    that contains macros and nested stacks, you must create or update the
	//    stack directly from the template using the CreateStack or UpdateStack
	//    action, and specifying this capability. For more information about macros,
	//    see Using CloudFormation macros to perform custom processing on templates
	//    (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html).
	Capabilities []*string `type:"list" enum:"Capability"`

	// The name of the change set. The name must be unique among all change sets
	// that are associated with the specified stack.
	//
	// A change set name can contain only alphanumeric, case sensitive characters,
	// and hyphens. It must start with an alphabetical character and can't exceed
	// 128 characters.
	//
	// ChangeSetName is a required field
	ChangeSetName *string `min:"1" type:"string" required:"true"`

	// The type of change set operation. To create a change set for a new stack,
	// specify CREATE. To create a change set for an existing stack, specify UPDATE.
	// To create a change set for an import operation, specify IMPORT.
	//
	// If you create a change set for a new stack, CloudFormation creates a stack
	// with a unique stack ID, but no template or resources. The stack will be in
	// the REVIEW_IN_PROGRESS (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-describing-stacks.html#d0e11995)
	// state until you execute the change set.
	//
	// By default, CloudFormation specifies UPDATE. You can't use the UPDATE type
	// to create a change set for a new stack or the CREATE type to create a change
	// set for an existing stack.
	ChangeSetType *string `type:"string" enum:"ChangeSetType"`

	// A unique identifier for this CreateChangeSet request. Specify this token
	// if you plan to retry requests so that CloudFormation knows that you're not
	// attempting to create another change set with the same name. You might retry
	// CreateChangeSet requests to ensure that CloudFormation successfully received
	// them.
	ClientToken *string `min:"1" type:"string"`

	// A description to help you identify this change set.
	Description *string `min:"1" type:"string"`

	// Creates a change set for the all nested stacks specified in the template.
	// The default behavior of this action is set to False. To include nested sets
	// in a change set, specify True.
	IncludeNestedStacks *bool `type:"boolean"`

	// The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon
	// SNS) topics that CloudFormation associates with the stack. To remove all
	// associated notification topics, specify an empty list.
	NotificationARNs []*string `type:"list"`

	// Determines what action will be taken if stack creation fails. If this parameter
	// is specified, the DisableRollback parameter to the ExecuteChangeSet (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html)
	// API operation must not be specified. This must be one of these values:
	//
	//    * DELETE - Deletes the change set if the stack creation fails. This is
	//    only valid when the ChangeSetType parameter is set to CREATE. If the deletion
	//    of the stack fails, the status of the stack is DELETE_FAILED.
	//
	//    * DO_NOTHING - if the stack creation fails, do nothing. This is equivalent
	//    to specifying true for the DisableRollback parameter to the ExecuteChangeSet
	//    (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html)
	//    API operation.
	//
	//    * ROLLBACK - if the stack creation fails, roll back the stack. This is
	//    equivalent to specifying false for the DisableRollback parameter to the
	//    ExecuteChangeSet (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html)
	//    API operation.
	//
	// For nested stacks, when the OnStackFailure parameter is set to DELETE for
	// the change set for the parent stack, any failure in a child stack will cause
	// the parent stack creation to fail and all stacks to be deleted.
	OnStackFailure *string `type:"string" enum:"OnStackFailure"`

	// A list of Parameter structures that specify input parameters for the change
	// set. For more information, see the Parameter data type.
	Parameters []*Parameter `type:"list"`

	// The template resource types that you have permissions to work with if you
	// execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
	//
	// If the list of resource types doesn't include a resource type that you're
	// updating, the stack update fails. By default, CloudFormation grants permissions
	// to all resource types. Identity and Access Management (IAM) uses this parameter
	// for condition keys in IAM policies for CloudFormation. For more information,
	// see Controlling access with Identity and Access Management (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html)
	// in the CloudFormation User Guide.
	ResourceTypes []*string `type:"list"`

	// The resources to import into your stack.
	ResourcesToImport []*ResourceToImport `type:"list"`

	// The Amazon Resource Name (ARN) of an Identity and Access Management (IAM)
	// role that CloudFormation assumes when executing the change set. CloudFormation
	// uses the role's credentials to make calls on your behalf. CloudFormation
	// uses this role for all future operations on the stack. Provided that users
	// have permission to operate on the stack, CloudFormation uses this role even
	// if the users don't have permission to pass it. Ensure that the role grants
	// least permission.
	//
	// If you don't specify a value, CloudFormation uses the role that was previously
	// associated with the stack. If no role is available, CloudFormation uses a
	// temporary session that is generated from your user credentials.
	RoleARN *string `min:"20" type:"string"`

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

	// The name or the unique ID of the stack for which you are creating a change
	// set. CloudFormation generates the change set by comparing this stack's information
	// with the information that you submit, such as a modified template or different
	// parameter input values.
	//
	// StackName is a required field
	StackName *string `min:"1" type:"string" required:"true"`

	// Key-value pairs to associate with this stack. CloudFormation also propagates
	// these tags to resources in the stack. You can specify a maximum of 50 tags.
	Tags []*Tag `type:"list"`

	// A structure that contains the body of the revised template, with a minimum
	// length of 1 byte and a maximum length of 51,200 bytes. CloudFormation generates
	// the change set by comparing this template with the template of the stack
	// that you specified.
	//
	// Conditional: You must specify only TemplateBody or TemplateURL.
	TemplateBody *string `min:"1" type:"string"`

	// The location of the file that contains the revised template. The URL must
	// point to a template (max size: 460,800 bytes) that's located in an Amazon
	// S3 bucket or a Systems Manager document. CloudFormation generates the change
	// set by comparing this template with the stack that you specified.
	//
	// Conditional: You must specify only TemplateBody or TemplateURL.
	TemplateURL *string `min:"1" type:"string"`

	// Whether to reuse the template that's associated with the stack to create
	// the change set.
	UsePreviousTemplate *bool `type:"boolean"`
	// contains filtered or unexported fields
}

The input for the CreateChangeSet action.

func (CreateChangeSetInput) GoString added in v1.1.15 

func (s CreateChangeSetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateChangeSetInput) SetCapabilities added in v1.5.0 

func (s *CreateChangeSetInput) SetCapabilities(v []*string) *CreateChangeSetInput

SetCapabilities sets the Capabilities field's value.

func (*CreateChangeSetInput) SetChangeSetName added in v1.5.0 

func (s *CreateChangeSetInput) SetChangeSetName(v string) *CreateChangeSetInput

SetChangeSetName sets the ChangeSetName field's value.

func (*CreateChangeSetInput) SetChangeSetType added in v1.5.0 

func (s *CreateChangeSetInput) SetChangeSetType(v string) *CreateChangeSetInput

SetChangeSetType sets the ChangeSetType field's value.

func (*CreateChangeSetInput) SetClientToken added in v1.5.0 

func (s *CreateChangeSetInput) SetClientToken(v string) *CreateChangeSetInput

SetClientToken sets the ClientToken field's value.

func (*CreateChangeSetInput) SetDescription added in v1.5.0 

func (s *CreateChangeSetInput) SetDescription(v string) *CreateChangeSetInput

SetDescription sets the Description field's value.

func (*CreateChangeSetInput) SetIncludeNestedStacks added in v1.35.31 

func (s *CreateChangeSetInput) SetIncludeNestedStacks(v bool) *CreateChangeSetInput

SetIncludeNestedStacks sets the IncludeNestedStacks field's value.

func (*CreateChangeSetInput) SetNotificationARNs added in v1.5.0 

func (s *CreateChangeSetInput) SetNotificationARNs(v []*string) *CreateChangeSetInput

SetNotificationARNs sets the NotificationARNs field's value.

func (*CreateChangeSetInput) SetOnStackFailure added in v1.44.285 

func (s *CreateChangeSetInput) SetOnStackFailure(v string) *CreateChangeSetInput

SetOnStackFailure sets the OnStackFailure field's value.

func (*CreateChangeSetInput) SetParameters added in v1.5.0 

func (s *CreateChangeSetInput) SetParameters(v []*Parameter) *CreateChangeSetInput

SetParameters sets the Parameters field's value.

func (*CreateChangeSetInput) SetResourceTypes added in v1.5.0 

func (s *CreateChangeSetInput) SetResourceTypes(v []*string) *CreateChangeSetInput

SetResourceTypes sets the ResourceTypes field's value.

func (*CreateChangeSetInput) SetResourcesToImport added in v1.25.32 

func (s *CreateChangeSetInput) SetResourcesToImport(v []*ResourceToImport) *CreateChangeSetInput

SetResourcesToImport sets the ResourcesToImport field's value.

func (*CreateChangeSetInput) SetRoleARN added in v1.5.0 

func (s *CreateChangeSetInput) SetRoleARN(v string) *CreateChangeSetInput

SetRoleARN sets the RoleARN field's value.

func (*CreateChangeSetInput) SetRollbackConfiguration added in v1.10.33 

func (s *CreateChangeSetInput) SetRollbackConfiguration(v *RollbackConfiguration) *CreateChangeSetInput

SetRollbackConfiguration sets the RollbackConfiguration field's value.

func (*CreateChangeSetInput) SetStackName added in v1.5.0 

func (s *CreateChangeSetInput) SetStackName(v string) *CreateChangeSetInput

SetStackName sets the StackName field's value.

func (*CreateChangeSetInput) SetTags added in v1.5.0 

func (s *CreateChangeSetInput) SetTags(v []*Tag) *CreateChangeSetInput

SetTags sets the Tags field's value.

func (*CreateChangeSetInput) SetTemplateBody added in v1.5.0 

func (s *CreateChangeSetInput) SetTemplateBody(v string) *CreateChangeSetInput

SetTemplateBody sets the TemplateBody field's value.

func (*CreateChangeSetInput) SetTemplateURL added in v1.5.0 

func (s *CreateChangeSetInput) SetTemplateURL(v string) *CreateChangeSetInput

SetTemplateURL sets the TemplateURL field's value.

func (*CreateChangeSetInput) SetUsePreviousTemplate added in v1.5.0 

func (s *CreateChangeSetInput) SetUsePreviousTemplate(v bool) *CreateChangeSetInput

SetUsePreviousTemplate sets the UsePreviousTemplate field's value.

func (CreateChangeSetInput) String added in v1.1.15 

func (s CreateChangeSetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateChangeSetInput) Validate added in v1.1.21 

func (s *CreateChangeSetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateChangeSetOutput added in v1.1.15 

type CreateChangeSetOutput struct {

	// The Amazon Resource Name (ARN) of the change set.
	Id *string `min:"1" type:"string"`

	// The unique ID of the stack.
	StackId *string `type:"string"`
	// contains filtered or unexported fields
}

The output for the CreateChangeSet action.

func (CreateChangeSetOutput) GoString added in v1.1.15 

func (s CreateChangeSetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateChangeSetOutput) SetId added in v1.5.0 

func (s *CreateChangeSetOutput) SetId(v string) *CreateChangeSetOutput

SetId sets the Id field's value.

func (*CreateChangeSetOutput) SetStackId added in v1.5.0 

func (s *CreateChangeSetOutput) SetStackId(v string) *CreateChangeSetOutput

SetStackId sets the StackId field's value.

func (CreateChangeSetOutput) String added in v1.1.15 

func (s CreateChangeSetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateStackInput 

type CreateStackInput struct {

	// In some cases, you must explicitly acknowledge that your stack template contains
	// certain capabilities in order for CloudFormation to create the stack.
	//
	//    * CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack 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 those stacks, you must explicitly acknowledge this by specifying one
	//    of these capabilities. The following IAM resources require you to specify
	//    either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. If you have
	//    IAM resources, you can specify either capability. If you have IAM resources
	//    with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't
	//    specify either of these capabilities, CloudFormation returns an InsufficientCapabilities
	//    error. If your stack template contains these resources, we recommend that
	//    you review all permissions associated with them and edit their permissions
	//    if necessary. AWS::IAM::AccessKey (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html)
	//    AWS::IAM::Group (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html)
	//    AWS::IAM::InstanceProfile (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html)
	//    AWS::IAM::Policy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html)
	//    AWS::IAM::Role (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html)
	//    AWS::IAM::User (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html)
	//    AWS::IAM::UserToGroupAddition (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html)
	//    For more information, see Acknowledging IAM Resources in CloudFormation
	//    Templates (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities).
	//
	//    * CAPABILITY_AUTO_EXPAND Some template contain macros. Macros perform
	//    custom processing on templates; this can include simple actions like find-and-replace
	//    operations, all the way to extensive transformations of entire templates.
	//    Because of this, users typically create a change set from the processed
	//    template, so that they can review the changes resulting from the macros
	//    before actually creating the stack. If your stack template contains one
	//    or more macros, and you choose to create a stack directly from the processed
	//    template, without first reviewing the resulting changes in a change set,
	//    you must acknowledge this capability. This includes the AWS::Include (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html)
	//    and AWS::Serverless (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html)
	//    transforms, which are macros hosted by CloudFormation. If you want to
	//    create a stack from a stack template that contains macros and nested stacks,
	//    you must create the stack directly from the template using this capability.
	//    You should only create stacks directly from a stack template that contains
	//    macros if you know what processing the macro performs. Each macro relies
	//    on an underlying Lambda service function for processing stack templates.
	//    Be aware that the Lambda function owner can update the function operation
	//    without CloudFormation being notified. For more information, see Using
	//    CloudFormation macros to perform custom processing on templates (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html).
	Capabilities []*string `type:"list" enum:"Capability"`

	// A unique identifier for this CreateStack request. Specify this token if you
	// plan to retry requests so that CloudFormation knows that you're not attempting
	// to create a stack with the same name. You might retry CreateStack requests
	// to ensure that CloudFormation successfully received them.
	//
	// All events initiated by a given stack operation are assigned the same client
	// request token, which you can use to track operations. For example, if you
	// execute a CreateStack operation with the token token1, then all the StackEvents
	// generated by that operation will have ClientRequestToken set as token1.
	//
	// In the console, stack operations display the client request token on the
	// Events tab. Stack operations that are initiated from the console use the
	// token format Console-StackOperation-ID, which helps you easily identify the
	// stack operation . For example, if you create a stack using the console, each
	// stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
	ClientRequestToken *string `min:"1" type:"string"`

	// Set to true to disable rollback of the stack if stack creation failed. You
	// can specify either DisableRollback or OnFailure, but not both.
	//
	// Default: false
	DisableRollback *bool `type:"boolean"`

	// Whether to enable termination protection on the specified stack. If a user
	// attempts to delete a stack with termination protection enabled, the operation
	// fails and the stack remains unchanged. For more information, see Protecting
	// a Stack From Being Deleted (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html)
	// in the CloudFormation User Guide. Termination protection is deactivated on
	// stacks by default.
	//
	// For nested stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html),
	// termination protection is set on the root stack and can't be changed directly
	// on the nested stack.
	EnableTerminationProtection *bool `type:"boolean"`

	// The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish
	// stack related events. You can find your Amazon SNS topic ARNs using the Amazon
	// SNS console or your Command Line Interface (CLI).
	NotificationARNs []*string `type:"list"`

	// Determines what action will be taken if stack creation fails. This must be
	// one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure
	// or DisableRollback, but not both.
	//
	// Default: ROLLBACK
	OnFailure *string `type:"string" enum:"OnFailure"`

	// A list of Parameter structures that specify input parameters for the stack.
	// For more information, see the Parameter (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html)
	// data type.
	Parameters []*Parameter `type:"list"`

	// The template resource types that you have permissions to work with for this
	// create stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
	// Use the following syntax to describe template resource types: AWS::* (for
	// all Amazon Web Services resources), Custom::* (for all custom resources),
	// Custom::logical_ID (for a specific custom resource), AWS::service_name::*
	// (for all resources of a particular Amazon Web Services service), and AWS::service_name::resource_logical_ID
	// (for a specific Amazon Web Services resource).
	//
	// If the list of resource types doesn't include a resource that you're creating,
	// the stack creation fails. By default, CloudFormation grants permissions to
	// all resource types. Identity and Access Management (IAM) uses this parameter
	// for CloudFormation-specific condition keys in IAM policies. For more information,
	// see Controlling Access with Identity and Access Management (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html).
	ResourceTypes []*string `type:"list"`

	// 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 `type:"boolean"`

	// The Amazon Resource Name (ARN) of an Identity and Access Management (IAM)
	// role that CloudFormation assumes to create the stack. CloudFormation uses
	// the role's credentials to make calls on your behalf. CloudFormation always
	// uses this role for all future operations on the stack. Provided that users
	// have permission to operate on the stack, CloudFormation uses this role even
	// if the users don't have permission to pass it. Ensure that the role grants
	// least privilege.
	//
	// If you don't specify a value, CloudFormation uses the role that was previously
	// associated with the stack. If no role is available, CloudFormation uses a
	// temporary session that's generated from your user credentials.
	RoleARN *string `min:"20" type:"string"`

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

	// The name that's associated with the stack. The name must be unique in the
	// Region in which you are creating the stack.
	//
	// A stack name can contain only alphanumeric characters (case sensitive) and
	// hyphens. It must start with an alphabetical character and can't be longer
	// than 128 characters.
	//
	// StackName is a required field
	StackName *string `type:"string" required:"true"`

	// Structure containing the stack policy body. For more information, go to Prevent
	// Updates to Stack Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html)
	// in the CloudFormation User Guide. You can specify either the StackPolicyBody
	// or the StackPolicyURL parameter, but not both.
	StackPolicyBody *string `min:"1" type:"string"`

	// Location of a file containing the stack policy. The URL must point to a policy
	// (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack.
	// You can specify either the StackPolicyBody or the StackPolicyURL parameter,
	// but not both.
	StackPolicyURL *string `min:"1" type:"string"`

	// Key-value pairs to associate with this stack. CloudFormation also propagates
	// these tags to the resources created in the stack. A maximum number of 50
	// tags can be specified.
	Tags []*Tag `type:"list"`

	// Structure containing the template body with a minimum length of 1 byte and
	// a maximum length of 51,200 bytes. For more information, go to Template anatomy
	// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
	// in the CloudFormation User Guide.
	//
	// Conditional: You must specify either the TemplateBody or the TemplateURL
	// parameter, but not both.
	TemplateBody *string `min:"1" type:"string"`

	// Location of file containing the template body. The URL must point to a template
	// (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems
	// Manager document. For more information, go to the Template anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
	// in the CloudFormation User Guide.
	//
	// Conditional: You must specify either the TemplateBody or the TemplateURL
	// parameter, but not both.
	TemplateURL *string `min:"1" type:"string"`

	// The amount of time that can pass before the stack status becomes CREATE_FAILED;
	// if DisableRollback is not set or is set to false, the stack will be rolled
	// back.
	TimeoutInMinutes *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

The input for CreateStack action.

func (CreateStackInput) GoString added in v0.6.5 

func (s CreateStackInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStackInput) SetCapabilities added in v1.5.0 

func (s *CreateStackInput) SetCapabilities(v []*string) *CreateStackInput

SetCapabilities sets the Capabilities field's value.

func (*CreateStackInput) SetClientRequestToken added in v1.8.18 

func (s *CreateStackInput) SetClientRequestToken(v string) *CreateStackInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateStackInput) SetDisableRollback added in v1.5.0 

func (s *CreateStackInput) SetDisableRollback(v bool) *CreateStackInput

SetDisableRollback sets the DisableRollback field's value.

func (*CreateStackInput) SetEnableTerminationProtection added in v1.11.0 

func (s *CreateStackInput) SetEnableTerminationProtection(v bool) *CreateStackInput

SetEnableTerminationProtection sets the EnableTerminationProtection field's value.

func (*CreateStackInput) SetNotificationARNs added in v1.5.0 

func (s *CreateStackInput) SetNotificationARNs(v []*string) *CreateStackInput

SetNotificationARNs sets the NotificationARNs field's value.

func (*CreateStackInput) SetOnFailure added in v1.5.0 

func (s *CreateStackInput) SetOnFailure(v string) *CreateStackInput

SetOnFailure sets the OnFailure field's value.

func (*CreateStackInput) SetParameters added in v1.5.0 

func (s *CreateStackInput) SetParameters(v []*Parameter) *CreateStackInput

SetParameters sets the Parameters field's value.

func (*CreateStackInput) SetResourceTypes added in v1.5.0 

func (s *CreateStackInput) SetResourceTypes(v []*string) *CreateStackInput

SetResourceTypes sets the ResourceTypes field's value.

func (*CreateStackInput) SetRetainExceptOnCreate added in v1.44.312 

func (s *CreateStackInput) SetRetainExceptOnCreate(v bool) *CreateStackInput

SetRetainExceptOnCreate sets the RetainExceptOnCreate field's value.

func (*CreateStackInput) SetRoleARN added in v1.5.0 

func (s *CreateStackInput) SetRoleARN(v string) *CreateStackInput

SetRoleARN sets the RoleARN field's value.

func (*CreateStackInput) SetRollbackConfiguration added in v1.10.33 

func (s *CreateStackInput) SetRollbackConfiguration(v *RollbackConfiguration) *CreateStackInput

SetRollbackConfiguration sets the RollbackConfiguration field's value.

func (*CreateStackInput) SetStackName added in v1.5.0 

func (s *CreateStackInput) SetStackName(v string) *CreateStackInput

SetStackName sets the StackName field's value.

func (*CreateStackInput) SetStackPolicyBody added in v1.5.0 

func (s *CreateStackInput) SetStackPolicyBody(v string) *CreateStackInput

SetStackPolicyBody sets the StackPolicyBody field's value.

func (*CreateStackInput) SetStackPolicyURL added in v1.5.0 

func (s *CreateStackInput) SetStackPolicyURL(v string) *CreateStackInput

SetStackPolicyURL sets the StackPolicyURL field's value.

func (*CreateStackInput) SetTags added in v1.5.0 

func (s *CreateStackInput) SetTags(v []*Tag) *CreateStackInput

SetTags sets the Tags field's value.

func (*CreateStackInput) SetTemplateBody added in v1.5.0 

func (s *CreateStackInput) SetTemplateBody(v string) *CreateStackInput

SetTemplateBody sets the TemplateBody field's value.

func (*CreateStackInput) SetTemplateURL added in v1.5.0 

func (s *CreateStackInput) SetTemplateURL(v string) *CreateStackInput

SetTemplateURL sets the TemplateURL field's value.

func (*CreateStackInput) SetTimeoutInMinutes added in v1.5.0 

func (s *CreateStackInput) SetTimeoutInMinutes(v int64) *CreateStackInput

SetTimeoutInMinutes sets the TimeoutInMinutes field's value.

func (CreateStackInput) String added in v0.6.5 

func (s CreateStackInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStackInput) Validate added in v1.1.21 

func (s *CreateStackInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateStackInstancesInput added in v1.10.16 

type CreateStackInstancesInput struct {

	// [Self-managed permissions] The names of one or more Amazon Web Services accounts
	// that you want to create stack instances in the specified Region(s) for.
	//
	// You can specify Accounts or DeploymentTargets, but not both.
	Accounts []*string `type:"list"`

	// [Service-managed permissions] Specifies whether you are acting as an account
	// administrator in the organization's management account or as a delegated
	// administrator in a member account.
	//
	// By default, SELF is specified. Use SELF for stack sets with self-managed
	// permissions.
	//
	//    * If you are signed in to the management account, specify SELF.
	//
	//    * If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
	//    Your Amazon Web Services account must be registered as a delegated administrator
	//    in the management account. For more information, see Register a delegated
	//    administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html)
	//    in the CloudFormation User Guide.
	CallAs *string `type:"string" enum:"CallAs"`

	// [Service-managed permissions] The Organizations accounts for which to create
	// stack instances in the specified Amazon Web Services Regions.
	//
	// You can specify Accounts or DeploymentTargets, but not both.
	DeploymentTargets *DeploymentTargets `type:"structure"`

	// The unique identifier for this stack set operation.
	//
	// The operation ID also functions as an idempotency token, to ensure that CloudFormation
	// performs the stack set operation only once, even if you retry the request
	// multiple times. You might retry stack set operation requests to ensure that
	// CloudFormation successfully received them.
	//
	// If you don't specify an operation ID, the SDK generates one automatically.
	//
	// Repeating this stack set operation with a new operation ID retries all stack
	// instances whose status is OUTDATED.
	OperationId *string `min:"1" type:"string" idempotencyToken:"true"`

	// Preferences for how CloudFormation performs this stack set operation.
	OperationPreferences *StackSetOperationPreferences `type:"structure"`

	// A list of stack set parameters whose values you want to override in the selected
	// stack instances.
	//
	// Any overridden parameter values will be applied to all stack instances in
	// the specified accounts and Amazon Web Services Regions. When specifying parameters
	// and their values, be aware of how CloudFormation sets parameter values during
	// stack instance operations:
	//
	//    * To override the current value for a parameter, include the parameter
	//    and specify its value.
	//
	//    * To leave an overridden parameter set to its present value, include the
	//    parameter and specify UsePreviousValue as true. (You can't specify both
	//    a value and set UsePreviousValue to true.)
	//
	//    * To set an overridden parameter back to the value specified in the stack
	//    set, specify a parameter list but don't include the parameter in the list.
	//
	//    * To leave all parameters set to their present values, don't specify this
	//    property at all.
	//
	// During stack set updates, any parameter values overridden for a stack instance
	// aren't updated, but retain their overridden value.
	//
	// You can only override the parameter values that are specified in the stack
	// set; to add or delete a parameter itself, use UpdateStackSet (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html)
	// to update the stack set template.
	ParameterOverrides []*Parameter `type:"list"`

	// The names of one or more Amazon Web Services Regions where you want to create
	// stack instances using the specified Amazon Web Services accounts.
	//
	// Regions is a required field
	Regions []*string `type:"list" required:"true"`

	// The name or unique ID of the stack set that you want to create stack instances
	// from.
	//
	// StackSetName is a required field
	StackSetName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateStackInstancesInput) GoString added in v1.10.16 

func (s CreateStackInstancesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStackInstancesInput) SetAccounts added in v1.10.16 

func (s *CreateStackInstancesInput) SetAccounts(v []*string) *CreateStackInstancesInput

SetAccounts sets the Accounts field's value.

func (*CreateStackInstancesInput) SetCallAs added in v1.37.14 

func (s *CreateStackInstancesInput) SetCallAs(v string) *CreateStackInstancesInput

SetCallAs sets the CallAs field's value.

func (*CreateStackInstancesInput) SetDeploymentTargets added in v1.29.0 

func (s *CreateStackInstancesInput) SetDeploymentTargets(v *DeploymentTargets) *CreateStackInstancesInput

SetDeploymentTargets sets the DeploymentTargets field's value.

func (*CreateStackInstancesInput) SetOperationId added in v1.10.16 

func (s *CreateStackInstancesInput) SetOperationId(v string) *CreateStackInstancesInput

SetOperationId sets the OperationId field's value.

func (*CreateStackInstancesInput) SetOperationPreferences added in v1.10.16 

func (s *CreateStackInstancesInput) SetOperationPreferences(v *StackSetOperationPreferences) *CreateStackInstancesInput

SetOperationPreferences sets the OperationPreferences field's value.

func (*CreateStackInstancesInput) SetParameterOverrides added in v1.12.32 

func (s *CreateStackInstancesInput) SetParameterOverrides(v []*Parameter) *CreateStackInstancesInput

SetParameterOverrides sets the ParameterOverrides field's value.

func (*CreateStackInstancesInput) SetRegions added in v1.10.16 

func (s *CreateStackInstancesInput) SetRegions(v []*string) *CreateStackInstancesInput

SetRegions sets the Regions field's value.

func (*CreateStackInstancesInput) SetStackSetName added in v1.10.16 

func (s *CreateStackInstancesInput) SetStackSetName(v string) *CreateStackInstancesInput

SetStackSetName sets the StackSetName field's value.

func (CreateStackInstancesInput) String added in v1.10.16 

func (s CreateStackInstancesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStackInstancesInput) Validate added in v1.10.16 

func (s *CreateStackInstancesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateStackInstancesOutput added in v1.10.16 

type CreateStackInstancesOutput struct {

	// The unique identifier for this stack set operation.
	OperationId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateStackInstancesOutput) GoString added in v1.10.16 

func (s CreateStackInstancesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStackInstancesOutput) SetOperationId added in v1.10.16 

func (s *CreateStackInstancesOutput) SetOperationId(v string) *CreateStackInstancesOutput

SetOperationId sets the OperationId field's value.

func (CreateStackInstancesOutput) String added in v1.10.16 

func (s CreateStackInstancesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateStackOutput 

type CreateStackOutput struct {

	// Unique identifier of the stack.
	StackId *string `type:"string"`
	// contains filtered or unexported fields
}

The output for a CreateStack action.

func (CreateStackOutput) GoString added in v0.6.5 

func (s CreateStackOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStackOutput) SetStackId added in v1.5.0 

func (s *CreateStackOutput) SetStackId(v string) *CreateStackOutput

SetStackId sets the StackId field's value.

func (CreateStackOutput) String added in v0.6.5 

func (s CreateStackOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateStackSetInput added in v1.10.16 

type CreateStackSetInput struct {

	// The Amazon Resource Name (ARN) of the IAM role to use to create this stack
	// set.
	//
	// Specify an IAM role only if you are using customized administrator roles
	// to control which users or groups can manage specific stack sets within the
	// same administrator account. For more information, see Prerequisites: Granting
	// Permissions for Stack Set Operations (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html)
	// in the CloudFormation User Guide.
	AdministrationRoleARN *string `min:"20" type:"string"`

	// Describes whether StackSets automatically deploys to Organizations accounts
	// that are added to the target organization or organizational unit (OU). Specify
	// only if PermissionModel is SERVICE_MANAGED.
	AutoDeployment *AutoDeployment `type:"structure"`

	// [Service-managed permissions] Specifies whether you are acting as an account
	// administrator in the organization's management account or as a delegated
	// administrator in a member account.
	//
	// By default, SELF is specified. Use SELF for stack sets with self-managed
	// permissions.
	//
	//    * To create a stack set with service-managed permissions while signed
	//    in to the management account, specify SELF.
	//
	//    * To create a stack set with service-managed permissions while signed
	//    in to a delegated administrator account, specify DELEGATED_ADMIN. Your
	//    Amazon Web Services account must be registered as a delegated admin in
	//    the management account. For more information, see Register a delegated
	//    administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html)
	//    in the CloudFormation User Guide.
	//
	// Stack sets with service-managed permissions are created in the management
	// account, including stack sets that are created by delegated administrators.
	CallAs *string `type:"string" enum:"CallAs"`

	// In some cases, you must explicitly acknowledge that your stack set template
	// contains certain capabilities in order for CloudFormation to create the stack
	// set and related stack instances.
	//
	//    * CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include
	//    resources that can affect permissions in your Amazon Web Services account;
	//    for example, by creating new Identity and Access Management (IAM) users.
	//    For those stack sets, you must explicitly acknowledge this by specifying
	//    one of these capabilities. The following IAM resources require you to
	//    specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
	//    If you have IAM resources, you can specify either capability. If you have
	//    IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
	//    If you don't specify either of these capabilities, CloudFormation returns
	//    an InsufficientCapabilities error. If your stack template contains these
	//    resources, we recommend that you review all permissions associated with
	//    them and edit their permissions if necessary. AWS::IAM::AccessKey (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html)
	//    AWS::IAM::Group (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html)
	//    AWS::IAM::InstanceProfile (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html)
	//    AWS::IAM::Policy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html)
	//    AWS::IAM::Role (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html)
	//    AWS::IAM::User (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html)
	//    AWS::IAM::UserToGroupAddition (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html)
	//    For more information, see Acknowledging IAM Resources in CloudFormation
	//    Templates (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities).
	//
	//    * CAPABILITY_AUTO_EXPAND Some templates reference macros. If your stack
	//    set template references one or more macros, you must create the stack
	//    set directly from the processed template, without first reviewing the
	//    resulting changes in a change set. To create the stack set directly, you
	//    must acknowledge this capability. For more information, see Using CloudFormation
	//    Macros to Perform Custom Processing on Templates (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html).
	//    Stack sets with service-managed permissions don't currently support the
	//    use of macros in templates. (This includes the AWS::Include (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html)
	//    and AWS::Serverless (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html)
	//    transforms, which are macros hosted by CloudFormation.) Even if you specify
	//    this capability for a stack set with service-managed permissions, if you
	//    reference a macro in your template the stack set operation will fail.
	Capabilities []*string `type:"list" enum:"Capability"`

	// A unique identifier for this CreateStackSet request. Specify this token if
	// you plan to retry requests so that CloudFormation knows that you're not attempting
	// to create another stack set with the same name. You might retry CreateStackSet
	// requests to ensure that CloudFormation successfully received them.
	//
	// If you don't specify an operation ID, the SDK generates one automatically.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// A description of the stack set. You can use the description to identify the
	// stack set's purpose or other important information.
	Description *string `min:"1" type:"string"`

	// The name of the IAM execution role to use to create the stack set. If you
	// do not specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole
	// role for the stack set operation.
	//
	// Specify an IAM role only if you are using customized execution roles to control
	// which stack resources users and groups can include in their stack sets.
	ExecutionRoleName *string `min:"1" type:"string"`

	// Describes whether StackSets performs non-conflicting operations concurrently
	// and queues conflicting operations.
	ManagedExecution *ManagedExecution `type:"structure"`

	// The input parameters for the stack set template.
	Parameters []*Parameter `type:"list"`

	// Describes how the IAM roles required for stack set operations are created.
	// By default, SELF-MANAGED is specified.
	//
	//    * With self-managed permissions, you must create the administrator and
	//    execution roles required to deploy to target accounts. For more information,
	//    see Grant Self-Managed Stack Set Permissions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html).
	//
	//    * With service-managed permissions, StackSets automatically creates the
	//    IAM roles required to deploy to accounts managed by Organizations. For
	//    more information, see Grant Service-Managed Stack Set Permissions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html).
	PermissionModel *string `type:"string" enum:"PermissionModels"`

	// The stack ID you are importing into a new stack set. Specify the Amazon Resource
	// Name (ARN) of the stack.
	StackId *string `type:"string"`

	// The name to associate with the stack set. The name must be unique in the
	// Region where you create your stack set.
	//
	// A stack name can contain only alphanumeric characters (case-sensitive) and
	// hyphens. It must start with an alphabetic character and can't be longer than
	// 128 characters.
	//
	// StackSetName is a required field
	StackSetName *string `type:"string" required:"true"`

	// The key-value pairs to associate with this stack set and the stacks created
	// from it. CloudFormation also propagates these tags to supported resources
	// that are created in the stacks. A maximum number of 50 tags can be specified.
	//
	// If you specify tags as part of a CreateStackSet action, CloudFormation checks
	// to see if you have the required IAM permission to tag resources. If you don't,
	// the entire CreateStackSet action fails with an access denied error, and the
	// stack set is not created.
	Tags []*Tag `type:"list"`

	// The structure that contains the template body, with a minimum length of 1
	// byte and a maximum length of 51,200 bytes. For more information, see Template
	// Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
	// in the CloudFormation User Guide.
	//
	// Conditional: You must specify either the TemplateBody or the TemplateURL
	// parameter, but not both.
	TemplateBody *string `min:"1" type:"string"`

	// The location of the file that contains the template body. The URL must point
	// to a template (maximum size: 460,800 bytes) that's located in an Amazon S3
	// bucket or a Systems Manager document. For more information, see Template
	// Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
	// in the CloudFormation User Guide.
	//
	// Conditional: You must specify either the TemplateBody or the TemplateURL
	// parameter, but not both.
	TemplateURL *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateStackSetInput) GoString added in v1.10.16 

func (s CreateStackSetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStackSetInput) SetAdministrationRoleARN added in v1.13.24 

func (s *CreateStackSetInput) SetAdministrationRoleARN(v string) *CreateStackSetInput

SetAdministrationRoleARN sets the AdministrationRoleARN field's value.

func (*CreateStackSetInput) SetAutoDeployment added in v1.29.0 

func (s *CreateStackSetInput) SetAutoDeployment(v *AutoDeployment) *CreateStackSetInput

SetAutoDeployment sets the AutoDeployment field's value.

func (*CreateStackSetInput) SetCallAs added in v1.37.14 

func (s *CreateStackSetInput) SetCallAs(v string) *CreateStackSetInput

SetCallAs sets the CallAs field's value.

func (*CreateStackSetInput) SetCapabilities added in v1.10.16 

func (s *CreateStackSetInput) SetCapabilities(v []*string) *CreateStackSetInput

SetCapabilities sets the Capabilities field's value.

func (*CreateStackSetInput) SetClientRequestToken added in v1.10.16 

func (s *CreateStackSetInput) SetClientRequestToken(v string) *CreateStackSetInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateStackSetInput) SetDescription added in v1.10.16 

func (s *CreateStackSetInput) SetDescription(v string) *CreateStackSetInput

SetDescription sets the Description field's value.

func (*CreateStackSetInput) SetExecutionRoleName added in v1.13.53 

func (s *CreateStackSetInput) SetExecutionRoleName(v string) *CreateStackSetInput

SetExecutionRoleName sets the ExecutionRoleName field's value.

func (*CreateStackSetInput) SetManagedExecution added in v1.42.9 

func (s *CreateStackSetInput) SetManagedExecution(v *ManagedExecution) *CreateStackSetInput

SetManagedExecution sets the ManagedExecution field's value.

func (*CreateStackSetInput) SetParameters added in v1.10.16 

func (s *CreateStackSetInput) SetParameters(v []*Parameter) *CreateStackSetInput

SetParameters sets the Parameters field's value.

func (*CreateStackSetInput) SetPermissionModel added in v1.29.0 

func (s *CreateStackSetInput) SetPermissionModel(v string) *CreateStackSetInput

SetPermissionModel sets the PermissionModel field's value.

func (*CreateStackSetInput) SetStackId added in v1.40.10 

func (s *CreateStackSetInput) SetStackId(v string) *CreateStackSetInput

SetStackId sets the StackId field's value.

func (*CreateStackSetInput) SetStackSetName added in v1.10.16 

func (s *CreateStackSetInput) SetStackSetName(v string) *CreateStackSetInput

SetStackSetName sets the StackSetName field's value.

func (*CreateStackSetInput) SetTags added in v1.10.16 

func (s *CreateStackSetInput) SetTags(v []*Tag) *CreateStackSetInput

SetTags sets the Tags field's value.

func (*CreateStackSetInput) SetTemplateBody added in v1.10.16 

func (s *CreateStackSetInput) SetTemplateBody(v string) *CreateStackSetInput

SetTemplateBody sets the TemplateBody field's value.

func (*CreateStackSetInput) SetTemplateURL added in v1.10.16 

func (s *CreateStackSetInput) SetTemplateURL(v string) *CreateStackSetInput

SetTemplateURL sets the TemplateURL field's value.

func (CreateStackSetInput) String added in v1.10.16 

func (s CreateStackSetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStackSetInput) Validate added in v1.10.16 

func (s *CreateStackSetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateStackSetOutput added in v1.10.16 

type CreateStackSetOutput struct {

	// The ID of the stack set that you're creating.
	StackSetId *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateStackSetOutput) GoString added in v1.10.16 

func (s CreateStackSetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStackSetOutput) SetStackSetId added in v1.10.16 

func (s *CreateStackSetOutput) SetStackSetId(v string) *CreateStackSetOutput

SetStackSetId sets the StackSetId field's value.

func (CreateStackSetOutput) String added in v1.10.16 

func (s CreateStackSetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeactivateOrganizationsAccessInput added in v1.44.276 

type DeactivateOrganizationsAccessInput struct {
	// contains filtered or unexported fields
}

func (DeactivateOrganizationsAccessInput) GoString added in v1.44.276 

func (s DeactivateOrganizationsAccessInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeactivateOrganizationsAccessInput) String added in v1.44.276 

func (s DeactivateOrganizationsAccessInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeactivateOrganizationsAccessOutput added in v1.44.276 

type DeactivateOrganizationsAccessOutput struct {
	// contains filtered or unexported fields
}

func (DeactivateOrganizationsAccessOutput) GoString added in v1.44.276 

func (s DeactivateOrganizationsAccessOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeactivateOrganizationsAccessOutput) String added in v1.44.276 

func (s DeactivateOrganizationsAccessOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeactivateTypeInput added in v1.38.65 

type DeactivateTypeInput struct {

	// The Amazon Resource Name (ARN) for the extension, in this account and Region.
	//
	// Conditional: You must specify either Arn, or TypeName and Type.
	Arn *string `type:"string"`

	// The extension type.
	//
	// Conditional: You must specify either Arn, or TypeName and Type.
	Type *string `type:"string" enum:"ThirdPartyType"`

	// The type name of the extension, in this account and Region. If you specified
	// a type name alias when enabling the extension, use the type name alias.
	//
	// Conditional: You must specify either Arn, or TypeName and Type.
	TypeName *string `min:"10" type:"string"`
	// contains filtered or unexported fields
}

func (DeactivateTypeInput) GoString added in v1.38.65 

func (s DeactivateTypeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeactivateTypeInput) SetArn added in v1.38.65 

func (s *DeactivateTypeInput) SetArn(v string) *DeactivateTypeInput

SetArn sets the Arn field's value.

func (*DeactivateTypeInput) SetType added in v1.38.65 

func (s *DeactivateTypeInput) SetType(v string) *DeactivateTypeInput

SetType sets the Type field's value.

func (*DeactivateTypeInput) SetTypeName added in v1.38.65 

func (s *DeactivateTypeInput) SetTypeName(v string) *DeactivateTypeInput

SetTypeName sets the TypeName field's value.

func (DeactivateTypeInput) String added in v1.38.65 

func (s DeactivateTypeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeactivateTypeInput) Validate added in v1.38.65 

func (s *DeactivateTypeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeactivateTypeOutput added in v1.38.65 

type DeactivateTypeOutput struct {
	// contains filtered or unexported fields
}

func (DeactivateTypeOutput) GoString added in v1.38.65 

func (s DeactivateTypeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeactivateTypeOutput) String added in v1.38.65 

func (s DeactivateTypeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteChangeSetInput added in v1.1.15 

type DeleteChangeSetInput struct {

	// The name or Amazon Resource Name (ARN) of the change set that you want to
	// delete.
	//
	// ChangeSetName is a required field
	ChangeSetName *string `min:"1" type:"string" required:"true"`

	// If you specified the name of a change set to delete, specify the stack name
	// or Amazon Resource Name (ARN) that's associated with it.
	StackName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The input for the DeleteChangeSet action.

func (DeleteChangeSetInput) GoString added in v1.1.15 

func (s DeleteChangeSetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteChangeSetInput) SetChangeSetName added in v1.5.0 

func (s *DeleteChangeSetInput) SetChangeSetName(v string) *DeleteChangeSetInput

SetChangeSetName sets the ChangeSetName field's value.

func (*DeleteChangeSetInput) SetStackName added in v1.5.0 

func (s *DeleteChangeSetInput) SetStackName(v string) *DeleteChangeSetInput

SetStackName sets the StackName field's value.

func (DeleteChangeSetInput) String added in v1.1.15 

func (s DeleteChangeSetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteChangeSetInput) Validate added in v1.1.21 

func (s *DeleteChangeSetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteChangeSetOutput added in v1.1.15 

type DeleteChangeSetOutput struct {
	// contains filtered or unexported fields
}

The output for the DeleteChangeSet action.

func (DeleteChangeSetOutput) GoString added in v1.1.15 

func (s DeleteChangeSetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteChangeSetOutput) String added in v1.1.15 

func (s DeleteChangeSetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteStackInput 

type DeleteStackInput struct {

	// A unique identifier for this DeleteStack request. Specify this token if you
	// plan to retry requests so that CloudFormation knows that you're not attempting
	// to delete a stack with the same name. You might retry DeleteStack requests
	// to ensure that CloudFormation successfully received them.
	//
	// All events initiated by a given stack operation are assigned the same client
	// request token, which you can use to track operations. For example, if you
	// execute a CreateStack operation with the token token1, then all the StackEvents
	// generated by that operation will have ClientRequestToken set as token1.
	//
	// In the console, stack operations display the client request token on the
	// Events tab. Stack operations that are initiated from the console use the
	// token format Console-StackOperation-ID, which helps you easily identify the
	// stack operation . For example, if you create a stack using the console, each
	// stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
	ClientRequestToken *string `min:"1" type:"string"`

	// For stacks in the DELETE_FAILED state, a list of resource logical IDs that
	// are associated with the resources you want to retain. During deletion, CloudFormation
	// deletes the stack but doesn't delete the retained resources.
	//
	// Retaining resources is useful when you can't delete a resource, such as a
	// non-empty S3 bucket, but you want to delete the stack.
	RetainResources []*string `type:"list"`

	// The Amazon Resource Name (ARN) of an Identity and Access Management (IAM)
	// role that CloudFormation assumes to delete the stack. CloudFormation uses
	// the role's credentials to make calls on your behalf.
	//
	// If you don't specify a value, CloudFormation uses the role that was previously
	// associated with the stack. If no role is available, CloudFormation uses a
	// temporary session that's generated from your user credentials.
	RoleARN *string `min:"20" type:"string"`

	// The name or the unique stack ID that's associated with the stack.
	//
	// StackName is a required field
	StackName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for DeleteStack action.

func (DeleteStackInput) GoString added in v0.6.5 

func (s DeleteStackInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteStackInput) SetClientRequestToken added in v1.8.18 

func (s *DeleteStackInput) SetClientRequestToken(v string) *DeleteStackInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*DeleteStackInput) SetRetainResources added in v1.5.0 

func (s *DeleteStackInput) SetRetainResources(v []*string) *DeleteStackInput

SetRetainResources sets the RetainResources field's value.

func (*DeleteStackInput) SetRoleARN added in v1.5.0 

func (s *DeleteStackInput) SetRoleARN(v string) *DeleteStackInput

SetRoleARN sets the RoleARN field's value.

func (*DeleteStackInput) SetStackName added in v1.5.0 

func (s *DeleteStackInput) SetStackName(v string) *DeleteStackInput

SetStackName sets the StackName field's value.

func (DeleteStackInput) String added in v0.6.5 

func (s DeleteStackInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteStackInput) Validate added in v1.1.21 

func (s *DeleteStackInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteStackInstancesInput added in v1.10.16 

type DeleteStackInstancesInput struct {

	// [Self-managed permissions] The names of the Amazon Web Services accounts
	// that you want to delete stack instances for.
	//
	// You can specify Accounts or DeploymentTargets, but not both.
	Accounts []*string `type:"list"`

	// [Service-managed permissions] Specifies whether you are acting as an account
	// administrator in the organization's management account or as a delegated
	// administrator in a member account.
	//
	// By default, SELF is specified. Use SELF for stack sets with self-managed
	// permissions.
	//
	//    * If you are signed in to the management account, specify SELF.
	//
	//    * If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
	//    Your Amazon Web Services account must be registered as a delegated administrator
	//    in the management account. For more information, see Register a delegated
	//    administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html)
	//    in the CloudFormation User Guide.
	CallAs *string `type:"string" enum:"CallAs"`

	// [Service-managed permissions] The Organizations accounts from which to delete
	// stack instances.
	//
	// You can specify Accounts or DeploymentTargets, but not both.
	DeploymentTargets *DeploymentTargets `type:"structure"`

	// The unique identifier for this stack set operation.
	//
	// If you don't specify an operation ID, the SDK generates one automatically.
	//
	// The operation ID also functions as an idempotency token, to ensure that CloudFormation
	// performs the stack set operation only once, even if you retry the request
	// multiple times. You can retry stack set operation requests to ensure that
	// CloudFormation successfully received them.
	//
	// Repeating this stack set operation with a new operation ID retries all stack
	// instances whose status is OUTDATED.
	OperationId *string `min:"1" type:"string" idempotencyToken:"true"`

	// Preferences for how CloudFormation performs this stack set operation.
	OperationPreferences *StackSetOperationPreferences `type:"structure"`

	// The Amazon Web Services Regions where you want to delete stack set instances.
	//
	// Regions is a required field
	Regions []*string `type:"list" required:"true"`

	// Removes the stack instances from the specified stack set, but doesn't delete
	// the stacks. You can't reassociate a retained stack or add an existing, saved
	// stack to a new stack set.
	//
	// For more information, see Stack set operation options (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options).
	//
	// RetainStacks is a required field
	RetainStacks *bool `type:"boolean" required:"true"`

	// The name or unique ID of the stack set that you want to delete stack instances
	// for.
	//
	// StackSetName is a required field
	StackSetName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteStackInstancesInput) GoString added in v1.10.16 

func (s DeleteStackInstancesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteStackInstancesInput) SetAccounts added in v1.10.16 

func (s *DeleteStackInstancesInput) SetAccounts(v []*string) *DeleteStackInstancesInput

SetAccounts sets the Accounts field's value.

func (*DeleteStackInstancesInput) SetCallAs added in v1.37.14 

func (s *DeleteStackInstancesInput) SetCallAs(v string) *DeleteStackInstancesInput

SetCallAs sets the CallAs field's value.

func (*DeleteStackInstancesInput) SetDeploymentTargets added in v1.29.0 

func (s *DeleteStackInstancesInput) SetDeploymentTargets(v *DeploymentTargets) *DeleteStackInstancesInput

SetDeploymentTargets sets the DeploymentTargets field's value.

func (*DeleteStackInstancesInput) SetOperationId added in v1.10.16 

func (s *DeleteStackInstancesInput) SetOperationId(v string) *DeleteStackInstancesInput

SetOperationId sets the OperationId field's value.

func (*DeleteStackInstancesInput) SetOperationPreferences added in v1.10.16 

func (s *DeleteStackInstancesInput) SetOperationPreferences(v *StackSetOperationPreferences) *DeleteStackInstancesInput

SetOperationPreferences sets the OperationPreferences field's value.

func (*DeleteStackInstancesInput) SetRegions added in v1.10.16 

func (s *DeleteStackInstancesInput) SetRegions(v []*string) *DeleteStackInstancesInput

SetRegions sets the Regions field's value.

func (*DeleteStackInstancesInput) SetRetainStacks added in v1.10.16 

func (s *DeleteStackInstancesInput) SetRetainStacks(v bool) *DeleteStackInstancesInput

SetRetainStacks sets the RetainStacks field's value.

func (*DeleteStackInstancesInput) SetStackSetName added in v1.10.16 

func (s *DeleteStackInstancesInput) SetStackSetName(v string) *DeleteStackInstancesInput

SetStackSetName sets the StackSetName field's value.

func (DeleteStackInstancesInput) String added in v1.10.16 

func (s DeleteStackInstancesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteStackInstancesInput) Validate added in v1.10.16 

func (s *DeleteStackInstancesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteStackInstancesOutput added in v1.10.16 

type DeleteStackInstancesOutput struct {

	// The unique identifier for this stack set operation.
	OperationId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteStackInstancesOutput) GoString added in v1.10.16 

func (s DeleteStackInstancesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteStackInstancesOutput) SetOperationId added in v1.10.16 

func (s *DeleteStackInstancesOutput) SetOperationId(v string) *DeleteStackInstancesOutput

SetOperationId sets the OperationId field's value.

func (DeleteStackInstancesOutput) String added in v1.10.16 

func (s DeleteStackInstancesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteStackOutput 

type DeleteStackOutput struct {
	// contains filtered or unexported fields
}

func (DeleteStackOutput) GoString added in v0.6.5 

func (s DeleteStackOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteStackOutput) String added in v0.6.5 

func (s DeleteStackOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteStackSetInput added in v1.10.16 

type DeleteStackSetInput struct {

	// [Service-managed permissions] Specifies whether you are acting as an account
	// administrator in the organization's management account or as a delegated
	// administrator in a member account.
	//
	// By default, SELF is specified. Use SELF for stack sets with self-managed
	// permissions.
	//
	//    * If you are signed in to the management account, specify SELF.
	//
	//    * If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
	//    Your Amazon Web Services account must be registered as a delegated administrator
	//    in the management account. For more information, see Register a delegated
	//    administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html)
	//    in the CloudFormation User Guide.
	CallAs *string `type:"string" enum:"CallAs"`

	// The name or unique ID of the stack set that you're deleting. You can obtain
	// this value by running ListStackSets.
	//
	// StackSetName is a required field
	StackSetName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteStackSetInput) GoString added in v1.10.16 

func (s DeleteStackSetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteStackSetInput) SetCallAs added in v1.37.14 

func (s *DeleteStackSetInput) SetCallAs(v string) *DeleteStackSetInput

SetCallAs sets the CallAs field's value.

func (*DeleteStackSetInput) SetStackSetName added in v1.10.16 

func (s *DeleteStackSetInput) SetStackSetName(v string) *DeleteStackSetInput

SetStackSetName sets the StackSetName field's value.

func (DeleteStackSetInput) String added in v1.10.16 

func (s DeleteStackSetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteStackSetInput) Validate added in v1.10.16 

func (s *DeleteStackSetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteStackSetOutput added in v1.10.16 

type DeleteStackSetOutput struct {
	// contains filtered or unexported fields
}

func (DeleteStackSetOutput) GoString added in v1.10.16 

func (s DeleteStackSetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteStackSetOutput) String added in v1.10.16 

func (s DeleteStackSetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeploymentTargets added in v1.29.0 

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 *string `type:"string" enum:"AccountFilterType"`

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

	// Returns the value of the AccountsUrl property.
	AccountsUrl *string `min:"1" type:"string"`

	// The organization root ID or organizational unit (OU) IDs to which StackSets
	// deploys.
	OrganizationalUnitIds []*string `type:"list"`
	// 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.

func (DeploymentTargets) GoString added in v1.29.0 

func (s DeploymentTargets) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeploymentTargets) SetAccountFilterType added in v1.44.49 

func (s *DeploymentTargets) SetAccountFilterType(v string) *DeploymentTargets

SetAccountFilterType sets the AccountFilterType field's value.

func (*DeploymentTargets) SetAccounts added in v1.29.0 

func (s *DeploymentTargets) SetAccounts(v []*string) *DeploymentTargets

SetAccounts sets the Accounts field's value.

func (*DeploymentTargets) SetAccountsUrl added in v1.38.10 

func (s *DeploymentTargets) SetAccountsUrl(v string) *DeploymentTargets

SetAccountsUrl sets the AccountsUrl field's value.

func (*DeploymentTargets) SetOrganizationalUnitIds added in v1.29.0 

func (s *DeploymentTargets) SetOrganizationalUnitIds(v []*string) *DeploymentTargets

SetOrganizationalUnitIds sets the OrganizationalUnitIds field's value.

func (DeploymentTargets) String added in v1.29.0 

func (s DeploymentTargets) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeploymentTargets) Validate added in v1.38.10 

func (s *DeploymentTargets) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeregisterTypeInput added in v1.25.37 

type DeregisterTypeInput struct {

	// The Amazon Resource Name (ARN) of the extension.
	//
	// Conditional: You must specify either TypeName and Type, or Arn.
	Arn *string `type:"string"`

	// The kind of extension.
	//
	// Conditional: You must specify either TypeName and Type, or Arn.
	Type *string `type:"string" enum:"RegistryType"`

	// The name of the extension.
	//
	// Conditional: You must specify either TypeName and Type, or Arn.
	TypeName *string `min:"10" type:"string"`

	// The ID of a specific version of the extension. The version ID is the value
	// at the end of the Amazon Resource Name (ARN) assigned to the extension version
	// when it is registered.
	VersionId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DeregisterTypeInput) GoString added in v1.25.37 

func (s DeregisterTypeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeregisterTypeInput) SetArn added in v1.25.37 

func (s *DeregisterTypeInput) SetArn(v string) *DeregisterTypeInput

SetArn sets the Arn field's value.

func (*DeregisterTypeInput) SetType added in v1.25.37 

func (s *DeregisterTypeInput) SetType(v string) *DeregisterTypeInput

SetType sets the Type field's value.

func (*DeregisterTypeInput) SetTypeName added in v1.25.37 

func (s *DeregisterTypeInput) SetTypeName(v string) *DeregisterTypeInput

SetTypeName sets the TypeName field's value.

func (*DeregisterTypeInput) SetVersionId added in v1.25.37 

func (s *DeregisterTypeInput) SetVersionId(v string) *DeregisterTypeInput

SetVersionId sets the VersionId field's value.

func (DeregisterTypeInput) String added in v1.25.37 

func (s DeregisterTypeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeregisterTypeInput) Validate added in v1.25.37 

func (s *DeregisterTypeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeregisterTypeOutput added in v1.25.37 

type DeregisterTypeOutput struct {
	// contains filtered or unexported fields
}

func (DeregisterTypeOutput) GoString added in v1.25.37 

func (s DeregisterTypeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeregisterTypeOutput) String added in v1.25.37 

func (s DeregisterTypeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAccountLimitsInput added in v0.9.10 

type DescribeAccountLimitsInput struct {

	// A string that identifies the next page of limits that you want to retrieve.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The input for the DescribeAccountLimits action.

func (DescribeAccountLimitsInput) GoString added in v0.9.10 

func (s DescribeAccountLimitsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccountLimitsInput) SetNextToken added in v1.5.0 

func (s *DescribeAccountLimitsInput) SetNextToken(v string) *DescribeAccountLimitsInput

SetNextToken sets the NextToken field's value.

func (DescribeAccountLimitsInput) String added in v0.9.10 

func (s DescribeAccountLimitsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccountLimitsInput) Validate added in v1.1.21 

func (s *DescribeAccountLimitsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeAccountLimitsOutput added in v0.9.10 

type DescribeAccountLimitsOutput struct {

	// An account limit structure that contain a list of CloudFormation account
	// limits and their values.
	AccountLimits []*AccountLimit `type:"list"`

	// If the output exceeds 1 MB in size, a string that identifies the next page
	// of limits. If no additional page exists, this value is null.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The output for the DescribeAccountLimits action.

func (DescribeAccountLimitsOutput) GoString added in v0.9.10 

func (s DescribeAccountLimitsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccountLimitsOutput) SetAccountLimits added in v1.5.0 

func (s *DescribeAccountLimitsOutput) SetAccountLimits(v []*AccountLimit) *DescribeAccountLimitsOutput

SetAccountLimits sets the AccountLimits field's value.

func (*DescribeAccountLimitsOutput) SetNextToken added in v1.5.0 

func (s *DescribeAccountLimitsOutput) SetNextToken(v string) *DescribeAccountLimitsOutput

SetNextToken sets the NextToken field's value.

func (DescribeAccountLimitsOutput) String added in v0.9.10 

func (s DescribeAccountLimitsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeChangeSetHooksInput added in v1.42.50 

type DescribeChangeSetHooksInput struct {

	// The name or Amazon Resource Name (ARN) of the change set that you want to
	// describe.
	//
	// ChangeSetName is a required field
	ChangeSetName *string `min:"1" type:"string" required:"true"`

	// If specified, lists only the hooks related to the specified LogicalResourceId.
	LogicalResourceId *string `type:"string"`

	// A string, provided by the DescribeChangeSetHooks response output, that identifies
	// the next page of information that you want to retrieve.
	NextToken *string `min:"1" type:"string"`

	// If you specified the name of a change set, specify the stack name or stack
	// ID (ARN) of the change set you want to describe.
	StackName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeChangeSetHooksInput) GoString added in v1.42.50 

func (s DescribeChangeSetHooksInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeChangeSetHooksInput) SetChangeSetName added in v1.42.50 

func (s *DescribeChangeSetHooksInput) SetChangeSetName(v string) *DescribeChangeSetHooksInput

SetChangeSetName sets the ChangeSetName field's value.

func (*DescribeChangeSetHooksInput) SetLogicalResourceId added in v1.42.50 

func (s *DescribeChangeSetHooksInput) SetLogicalResourceId(v string) *DescribeChangeSetHooksInput

SetLogicalResourceId sets the LogicalResourceId field's value.

func (*DescribeChangeSetHooksInput) SetNextToken added in v1.42.50 

func (s *DescribeChangeSetHooksInput) SetNextToken(v string) *DescribeChangeSetHooksInput

SetNextToken sets the NextToken field's value.

func (*DescribeChangeSetHooksInput) SetStackName added in v1.42.50 

func (s *DescribeChangeSetHooksInput) SetStackName(v string) *DescribeChangeSetHooksInput

SetStackName sets the StackName field's value.

func (DescribeChangeSetHooksInput) String added in v1.42.50 

func (s DescribeChangeSetHooksInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeChangeSetHooksInput) Validate added in v1.42.50 

func (s *DescribeChangeSetHooksInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeChangeSetHooksOutput added in v1.42.50 

type DescribeChangeSetHooksOutput struct {

	// The change set identifier (stack ID).
	ChangeSetId *string `min:"1" type:"string"`

	// The change set name.
	ChangeSetName *string `min:"1" type:"string"`

	// List of hook objects.
	Hooks []*ChangeSetHook `type:"list"`

	// Pagination token, null or empty if no more results.
	NextToken *string `min:"1" type:"string"`

	// The stack identifier (stack ID).
	StackId *string `type:"string"`

	// The stack name.
	StackName *string `type:"string"`

	// Provides the status of the change set hook.
	Status *string `type:"string" enum:"ChangeSetHooksStatus"`
	// contains filtered or unexported fields
}

func (DescribeChangeSetHooksOutput) GoString added in v1.42.50 

func (s DescribeChangeSetHooksOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeChangeSetHooksOutput) SetChangeSetId added in v1.42.50 

func (s *DescribeChangeSetHooksOutput) SetChangeSetId(v string) *DescribeChangeSetHooksOutput

SetChangeSetId sets the ChangeSetId field's value.

func (*DescribeChangeSetHooksOutput) SetChangeSetName added in v1.42.50 

func (s *DescribeChangeSetHooksOutput) SetChangeSetName(v string) *DescribeChangeSetHooksOutput

SetChangeSetName sets the ChangeSetName field's value.

func (*DescribeChangeSetHooksOutput) SetHooks added in v1.42.50 

func (s *DescribeChangeSetHooksOutput) SetHooks(v []*ChangeSetHook) *DescribeChangeSetHooksOutput

SetHooks sets the Hooks field's value.

func (*DescribeChangeSetHooksOutput) SetNextToken added in v1.42.50 

func (s *DescribeChangeSetHooksOutput) SetNextToken(v string) *DescribeChangeSetHooksOutput

SetNextToken sets the NextToken field's value.

func (*DescribeChangeSetHooksOutput) SetStackId added in v1.42.50 

func (s *DescribeChangeSetHooksOutput) SetStackId(v string) *DescribeChangeSetHooksOutput

SetStackId sets the StackId field's value.

func (*DescribeChangeSetHooksOutput) SetStackName added in v1.42.50 

func (s *DescribeChangeSetHooksOutput) SetStackName(v string) *DescribeChangeSetHooksOutput

SetStackName sets the StackName field's value.

func (*DescribeChangeSetHooksOutput) SetStatus added in v1.42.50 

func (s *DescribeChangeSetHooksOutput) SetStatus(v string) *DescribeChangeSetHooksOutput

SetStatus sets the Status field's value.

func (DescribeChangeSetHooksOutput) String added in v1.42.50 

func (s DescribeChangeSetHooksOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeChangeSetInput added in v1.1.15 

type DescribeChangeSetInput struct {

	// The name or Amazon Resource Name (ARN) of the change set that you want to
	// describe.
	//
	// ChangeSetName is a required field
	ChangeSetName *string `min:"1" type:"string" required:"true"`

	// A string (provided by the DescribeChangeSet response output) that identifies
	// the next page of information that you want to retrieve.
	NextToken *string `min:"1" type:"string"`

	// If you specified the name of a change set, specify the stack name or ID (ARN)
	// of the change set you want to describe.
	StackName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The input for the DescribeChangeSet action.

func (DescribeChangeSetInput) GoString added in v1.1.15 

func (s DescribeChangeSetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeChangeSetInput) SetChangeSetName added in v1.5.0 

func (s *DescribeChangeSetInput) SetChangeSetName(v string) *DescribeChangeSetInput

SetChangeSetName sets the ChangeSetName field's value.

func (*DescribeChangeSetInput) SetNextToken added in v1.5.0 

func (s *DescribeChangeSetInput) SetNextToken(v string) *DescribeChangeSetInput

SetNextToken sets the NextToken field's value.

func (*DescribeChangeSetInput) SetStackName added in v1.5.0 

func (s *DescribeChangeSetInput) SetStackName(v string) *DescribeChangeSetInput

SetStackName sets the StackName field's value.

func (DescribeChangeSetInput) String added in v1.1.15 

func (s DescribeChangeSetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeChangeSetInput) Validate added in v1.1.21 

func (s *DescribeChangeSetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeChangeSetOutput added in v1.1.15 

type DescribeChangeSetOutput struct {

	// If you execute the change set, the list of capabilities that were explicitly
	// acknowledged when the change set was created.
	Capabilities []*string `type:"list" enum:"Capability"`

	// The Amazon Resource Name (ARN) of the change set.
	ChangeSetId *string `min:"1" type:"string"`

	// The name of the change set.
	ChangeSetName *string `min:"1" type:"string"`

	// A list of Change structures that describes the resources CloudFormation changes
	// if you execute the change set.
	Changes []*Change `type:"list"`

	// The start time when the change set was created, in UTC.
	CreationTime *time.Time `type:"timestamp"`

	// Information about the change set.
	Description *string `min:"1" type:"string"`

	// If the change set execution status is AVAILABLE, you can execute the change
	// set. If you can't execute the change set, the status indicates why. For example,
	// a change set might be in an UNAVAILABLE state because CloudFormation is still
	// creating it or in an OBSOLETE state because the stack was already updated.
	ExecutionStatus *string `type:"string" enum:"ExecutionStatus"`

	// Verifies if IncludeNestedStacks is set to True.
	IncludeNestedStacks *bool `type:"boolean"`

	// If the output exceeds 1 MB, a string that identifies the next page of changes.
	// If there is no additional page, this value is null.
	NextToken *string `min:"1" type:"string"`

	// The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that
	// will be associated with the stack if you execute the change set.
	NotificationARNs []*string `type:"list"`

	// Determines what action will be taken if stack creation fails. When this parameter
	// is specified, the DisableRollback parameter to the ExecuteChangeSet (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html)
	// API operation must not be specified. This must be one of these values:
	//
	//    * DELETE - Deletes the change set if the stack creation fails. This is
	//    only valid when the ChangeSetType parameter is set to CREATE. If the deletion
	//    of the stack fails, the status of the stack is DELETE_FAILED.
	//
	//    * DO_NOTHING - if the stack creation fails, do nothing. This is equivalent
	//    to specifying true for the DisableRollback parameter to the ExecuteChangeSet
	//    (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html)
	//    API operation.
	//
	//    * ROLLBACK - if the stack creation fails, roll back the stack. This is
	//    equivalent to specifying false for the DisableRollback parameter to the
	//    ExecuteChangeSet (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html)
	//    API operation.
	OnStackFailure *string `type:"string" enum:"OnStackFailure"`

	// A list of Parameter structures that describes the input parameters and their
	// values used to create the change set. For more information, see the Parameter
	// (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html)
	// data type.
	Parameters []*Parameter `type:"list"`

	// Specifies the change set ID of the parent change set in the current nested
	// change set hierarchy.
	ParentChangeSetId *string `min:"1" type:"string"`

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

	// Specifies the change set ID of the root change set in the current nested
	// change set hierarchy.
	RootChangeSetId *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the stack that's associated with the change
	// set.
	StackId *string `type:"string"`

	// The name of the stack that's associated with the change set.
	StackName *string `type:"string"`

	// The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE,
	// or FAILED.
	Status *string `type:"string" enum:"ChangeSetStatus"`

	// A description of the change set's status. For example, if your attempt to
	// create a change set failed, CloudFormation shows the error message.
	StatusReason *string `type:"string"`

	// If you execute the change set, the tags that will be associated with the
	// stack.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

The output for the DescribeChangeSet action.

func (DescribeChangeSetOutput) GoString added in v1.1.15 

func (s DescribeChangeSetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeChangeSetOutput) SetCapabilities added in v1.5.0 

func (s *DescribeChangeSetOutput) SetCapabilities(v []*string) *DescribeChangeSetOutput

SetCapabilities sets the Capabilities field's value.

func (*DescribeChangeSetOutput) SetChangeSetId added in v1.5.0 

func (s *DescribeChangeSetOutput) SetChangeSetId(v string) *DescribeChangeSetOutput

SetChangeSetId sets the ChangeSetId field's value.

func (*DescribeChangeSetOutput) SetChangeSetName added in v1.5.0 

func (s *DescribeChangeSetOutput) SetChangeSetName(v string) *DescribeChangeSetOutput

SetChangeSetName sets the ChangeSetName field's value.

func (*DescribeChangeSetOutput) SetChanges added in v1.5.0 

func (s *DescribeChangeSetOutput) SetChanges(v []*Change) *DescribeChangeSetOutput

SetChanges sets the Changes field's value.

func (*DescribeChangeSetOutput) SetCreationTime added in v1.5.0 

func (s *DescribeChangeSetOutput) SetCreationTime(v time.Time) *DescribeChangeSetOutput

SetCreationTime sets the CreationTime field's value.

func (*DescribeChangeSetOutput) SetDescription added in v1.5.0 

func (s *DescribeChangeSetOutput) SetDescription(v string) *DescribeChangeSetOutput

SetDescription sets the Description field's value.

func (*DescribeChangeSetOutput) SetExecutionStatus added in v1.5.0 

func (s *DescribeChangeSetOutput) SetExecutionStatus(v string) *DescribeChangeSetOutput

SetExecutionStatus sets the ExecutionStatus field's value.

func (*DescribeChangeSetOutput) SetIncludeNestedStacks added in v1.35.31 

func (s *DescribeChangeSetOutput) SetIncludeNestedStacks(v bool) *DescribeChangeSetOutput

SetIncludeNestedStacks sets the IncludeNestedStacks field's value.

func (*DescribeChangeSetOutput) SetNextToken added in v1.5.0 

func (s *DescribeChangeSetOutput) SetNextToken(v string) *DescribeChangeSetOutput

SetNextToken sets the NextToken field's value.

func (*DescribeChangeSetOutput) SetNotificationARNs added in v1.5.0 

func (s *DescribeChangeSetOutput) SetNotificationARNs(v []*string) *DescribeChangeSetOutput

SetNotificationARNs sets the NotificationARNs field's value.

func (*DescribeChangeSetOutput) SetOnStackFailure added in v1.44.285 

func (s *DescribeChangeSetOutput) SetOnStackFailure(v string) *DescribeChangeSetOutput

SetOnStackFailure sets the OnStackFailure field's value.

func (*DescribeChangeSetOutput) SetParameters added in v1.5.0 

func (s *DescribeChangeSetOutput) SetParameters(v []*Parameter) *DescribeChangeSetOutput

SetParameters sets the Parameters field's value.

func (*DescribeChangeSetOutput) SetParentChangeSetId added in v1.35.31 

func (s *DescribeChangeSetOutput) SetParentChangeSetId(v string) *DescribeChangeSetOutput

SetParentChangeSetId sets the ParentChangeSetId field's value.

func (*DescribeChangeSetOutput) SetRollbackConfiguration added in v1.10.33 

func (s *DescribeChangeSetOutput) SetRollbackConfiguration(v *RollbackConfiguration) *DescribeChangeSetOutput

SetRollbackConfiguration sets the RollbackConfiguration field's value.

func (*DescribeChangeSetOutput) SetRootChangeSetId added in v1.35.31 

func (s *DescribeChangeSetOutput) SetRootChangeSetId(v string) *DescribeChangeSetOutput

SetRootChangeSetId sets the RootChangeSetId field's value.

func (*DescribeChangeSetOutput) SetStackId added in v1.5.0 

func (s *DescribeChangeSetOutput) SetStackId(v string) *DescribeChangeSetOutput

SetStackId sets the StackId field's value.

func (*DescribeChangeSetOutput) SetStackName added in v1.5.0 

func (s *DescribeChangeSetOutput) SetStackName(v string) *DescribeChangeSetOutput

SetStackName sets the StackName field's value.

func (*DescribeChangeSetOutput) SetStatus added in v1.5.0 

func (s *DescribeChangeSetOutput) SetStatus(v string) *DescribeChangeSetOutput

SetStatus sets the Status field's value.

func (*DescribeChangeSetOutput) SetStatusReason added in v1.5.0 

func (s *DescribeChangeSetOutput) SetStatusReason(v string) *DescribeChangeSetOutput

SetStatusReason sets the StatusReason field's value.

func (*DescribeChangeSetOutput) SetTags added in v1.5.0 

func (s *DescribeChangeSetOutput) SetTags(v []*Tag) *DescribeChangeSetOutput

SetTags sets the Tags field's value.

func (DescribeChangeSetOutput) String added in v1.1.15 

func (s DescribeChangeSetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeOrganizationsAccessInput added in v1.44.276 

type DescribeOrganizationsAccessInput struct {

	// [Service-managed permissions] Specifies whether you are acting as an account
	// administrator in the organization's management account or as a delegated
	// administrator in a member account.
	//
	// By default, SELF is specified.
	//
	//    * If you are signed in to the management account, specify SELF.
	//
	//    * If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
	//    Your Amazon Web Services account must be registered as a delegated administrator
	//    in the management account. For more information, see Register a delegated
	//    administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html)
	//    in the CloudFormation User Guide.
	CallAs *string `type:"string" enum:"CallAs"`
	// contains filtered or unexported fields
}

func (DescribeOrganizationsAccessInput) GoString added in v1.44.276 

func (s DescribeOrganizationsAccessInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeOrganizationsAccessInput) SetCallAs added in v1.44.276 

func (s *DescribeOrganizationsAccessInput) SetCallAs(v string) *DescribeOrganizationsAccessInput

SetCallAs sets the CallAs field's value.

func (DescribeOrganizationsAccessInput) String added in v1.44.276 

func (s DescribeOrganizationsAccessInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeOrganizationsAccessOutput added in v1.44.276 

type DescribeOrganizationsAccessOutput struct {

	// Presents the status of the OrganizationAccess.
	Status *string `type:"string" enum:"OrganizationStatus"`
	// contains filtered or unexported fields
}

func (DescribeOrganizationsAccessOutput) GoString added in v1.44.276 

func (s DescribeOrganizationsAccessOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeOrganizationsAccessOutput) SetStatus added in v1.44.276 

func (s *DescribeOrganizationsAccessOutput) SetStatus(v string) *DescribeOrganizationsAccessOutput

SetStatus sets the Status field's value.

func (DescribeOrganizationsAccessOutput) String added in v1.44.276 

func (s DescribeOrganizationsAccessOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribePublisherInput added in v1.38.65 

type DescribePublisherInput struct {

	// The ID of the extension publisher.
	//
	// If you don't supply a PublisherId, and you have registered as an extension
	// publisher, DescribePublisher returns information about your own publisher
	// account.
	PublisherId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribePublisherInput) GoString added in v1.38.65 

func (s DescribePublisherInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePublisherInput) SetPublisherId added in v1.38.65 

func (s *DescribePublisherInput) SetPublisherId(v string) *DescribePublisherInput

SetPublisherId sets the PublisherId field's value.

func (DescribePublisherInput) String added in v1.38.65 

func (s DescribePublisherInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePublisherInput) Validate added in v1.38.65 

func (s *DescribePublisherInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribePublisherOutput added in v1.38.65 

type DescribePublisherOutput struct {

	// The type of account used as the identity provider when registering this publisher
	// with CloudFormation.
	IdentityProvider *string `type:"string" enum:"IdentityProvider"`

	// The ID of the extension publisher.
	PublisherId *string `min:"1" type:"string"`

	// The URL to the publisher's profile with the identity provider.
	PublisherProfile *string `type:"string"`

	// Whether the publisher is verified. Currently, all registered publishers are
	// verified.
	PublisherStatus *string `type:"string" enum:"PublisherStatus"`
	// contains filtered or unexported fields
}

func (DescribePublisherOutput) GoString added in v1.38.65 

func (s DescribePublisherOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePublisherOutput) SetIdentityProvider added in v1.38.65 

func (s *DescribePublisherOutput) SetIdentityProvider(v string) *DescribePublisherOutput

SetIdentityProvider sets the IdentityProvider field's value.

func (*DescribePublisherOutput) SetPublisherId added in v1.38.65 

func (s *DescribePublisherOutput) SetPublisherId(v string) *DescribePublisherOutput

SetPublisherId sets the PublisherId field's value.

func (*DescribePublisherOutput) SetPublisherProfile added in v1.38.65 

func (s *DescribePublisherOutput) SetPublisherProfile(v string) *DescribePublisherOutput

SetPublisherProfile sets the PublisherProfile field's value.

func (*DescribePublisherOutput) SetPublisherStatus added in v1.38.65 

func (s *DescribePublisherOutput) SetPublisherStatus(v string) *DescribePublisherOutput

SetPublisherStatus sets the PublisherStatus field's value.

func (DescribePublisherOutput) String added in v1.38.65 

func (s DescribePublisherOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeStackDriftDetectionStatusInput added in v1.15.74 

type DescribeStackDriftDetectionStatusInput struct {

	// The ID of the drift detection results of this operation.
	//
	// CloudFormation generates new results, with a new drift detection ID, each
	// time this operation is run. However, the number of drift results CloudFormation
	// retains for any given stack, and for how long, may vary.
	//
	// StackDriftDetectionId is a required field
	StackDriftDetectionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeStackDriftDetectionStatusInput) GoString added in v1.15.74 

func (s DescribeStackDriftDetectionStatusInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStackDriftDetectionStatusInput) SetStackDriftDetectionId added in v1.15.74 

func (s *DescribeStackDriftDetectionStatusInput) SetStackDriftDetectionId(v string) *DescribeStackDriftDetectionStatusInput

SetStackDriftDetectionId sets the StackDriftDetectionId field's value.

func (DescribeStackDriftDetectionStatusInput) String added in v1.15.74 

func (s DescribeStackDriftDetectionStatusInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStackDriftDetectionStatusInput) Validate added in v1.15.74 

func (s *DescribeStackDriftDetectionStatusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeStackDriftDetectionStatusOutput added in v1.15.74 

type DescribeStackDriftDetectionStatusOutput struct {

	// The status of the stack drift detection operation.
	//
	//    * DETECTION_COMPLETE: The stack drift detection operation has successfully
	//    completed for all resources in the stack that support drift detection.
	//    (Resources that don't currently support stack detection remain unchecked.)
	//    If you specified logical resource IDs for CloudFormation to use as a filter
	//    for the stack drift detection operation, only the resources with those
	//    logical IDs are checked for drift.
	//
	//    * DETECTION_FAILED: The stack drift detection operation has failed for
	//    at least one resource in the stack. Results will be available for resources
	//    on which CloudFormation successfully completed drift detection.
	//
	//    * DETECTION_IN_PROGRESS: The stack drift detection operation is currently
	//    in progress.
	//
	// DetectionStatus is a required field
	DetectionStatus *string `type:"string" required:"true" enum:"StackDriftDetectionStatus"`

	// The reason the stack drift detection operation has its current status.
	DetectionStatusReason *string `type:"string"`

	// Total number of stack resources that have drifted. This is NULL until the
	// drift detection operation reaches a status of DETECTION_COMPLETE. This value
	// will be 0 for stacks whose drift status is IN_SYNC.
	DriftedStackResourceCount *int64 `type:"integer"`

	// The ID of the drift detection results of this operation.
	//
	// CloudFormation generates new results, with a new drift detection ID, each
	// time this operation is run. However, the number of reports CloudFormation
	// retains for any given stack, and for how long, may vary.
	//
	// StackDriftDetectionId is a required field
	StackDriftDetectionId *string `min:"1" type:"string" required:"true"`

	// Status of the stack's actual configuration compared to its expected configuration.
	//
	//    * DRIFTED: The stack differs from its expected template configuration.
	//    A stack is considered to have drifted if one or more of its resources
	//    have drifted.
	//
	//    * NOT_CHECKED: 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.
	StackDriftStatus *string `type:"string" enum:"StackDriftStatus"`

	// The ID of the stack.
	//
	// StackId is a required field
	StackId *string `type:"string" required:"true"`

	// Time at which the stack drift detection operation was initiated.
	//
	// Timestamp is a required field
	Timestamp *time.Time `type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeStackDriftDetectionStatusOutput) GoString added in v1.15.74 

func (s DescribeStackDriftDetectionStatusOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStackDriftDetectionStatusOutput) SetDetectionStatus added in v1.15.74 

func (s *DescribeStackDriftDetectionStatusOutput) SetDetectionStatus(v string) *DescribeStackDriftDetectionStatusOutput

SetDetectionStatus sets the DetectionStatus field's value.

func (*DescribeStackDriftDetectionStatusOutput) SetDetectionStatusReason added in v1.15.74 

func (s *DescribeStackDriftDetectionStatusOutput) SetDetectionStatusReason(v string) *DescribeStackDriftDetectionStatusOutput

SetDetectionStatusReason sets the DetectionStatusReason field's value.

func (*DescribeStackDriftDetectionStatusOutput) SetDriftedStackResourceCount added in v1.15.74 

func (s *DescribeStackDriftDetectionStatusOutput) SetDriftedStackResourceCount(v int64) *DescribeStackDriftDetectionStatusOutput

SetDriftedStackResourceCount sets the DriftedStackResourceCount field's value.

func (*DescribeStackDriftDetectionStatusOutput) SetStackDriftDetectionId added in v1.15.74 

func (s *DescribeStackDriftDetectionStatusOutput) SetStackDriftDetectionId(v string) *DescribeStackDriftDetectionStatusOutput

SetStackDriftDetectionId sets the StackDriftDetectionId field's value.

func (*DescribeStackDriftDetectionStatusOutput) SetStackDriftStatus added in v1.15.74 

func (s *DescribeStackDriftDetectionStatusOutput) SetStackDriftStatus(v string) *DescribeStackDriftDetectionStatusOutput

SetStackDriftStatus sets the StackDriftStatus field's value.

func (*DescribeStackDriftDetectionStatusOutput) SetStackId added in v1.15.74 

func (s *DescribeStackDriftDetectionStatusOutput) SetStackId(v string) *DescribeStackDriftDetectionStatusOutput

SetStackId sets the StackId field's value.

func (*DescribeStackDriftDetectionStatusOutput) SetTimestamp added in v1.15.74 

func (s *DescribeStackDriftDetectionStatusOutput) SetTimestamp(v time.Time) *DescribeStackDriftDetectionStatusOutput

SetTimestamp sets the Timestamp field's value.

func (DescribeStackDriftDetectionStatusOutput) String added in v1.15.74 

func (s DescribeStackDriftDetectionStatusOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeStackEventsInput 

type DescribeStackEventsInput struct {

	// A string that identifies the next page of events that you want to retrieve.
	NextToken *string `min:"1" type:"string"`

	// The name or the unique stack ID that's associated with the stack, which aren't
	// always interchangeable:
	//
	//    * Running stacks: You can specify either the stack's name or its unique
	//    stack ID.
	//
	//    * Deleted stacks: You must specify the unique stack ID.
	//
	// Default: There is no default value.
	StackName *string `type:"string"`
	// contains filtered or unexported fields
}

The input for DescribeStackEvents action.

func (DescribeStackEventsInput) GoString added in v0.6.5 

func (s DescribeStackEventsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStackEventsInput) SetNextToken added in v1.5.0 

func (s *DescribeStackEventsInput) SetNextToken(v string) *DescribeStackEventsInput

SetNextToken sets the NextToken field's value.

func (*DescribeStackEventsInput) SetStackName added in v1.5.0 

func (s *DescribeStackEventsInput) SetStackName(v string) *DescribeStackEventsInput

SetStackName sets the StackName field's value.

func (DescribeStackEventsInput) String added in v0.6.5 

func (s DescribeStackEventsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStackEventsInput) Validate added in v1.1.21 

func (s *DescribeStackEventsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeStackEventsOutput 

type DescribeStackEventsOutput struct {

	// If the output exceeds 1 MB in size, a string that identifies the next page
	// of events. If no additional page exists, this value is null.
	NextToken *string `min:"1" type:"string"`

	// A list of StackEvents structures.
	StackEvents []*StackEvent `type:"list"`
	// contains filtered or unexported fields
}

The output for a DescribeStackEvents action.

func (DescribeStackEventsOutput) GoString added in v0.6.5 

func (s DescribeStackEventsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStackEventsOutput) SetNextToken added in v1.5.0 

func (s *DescribeStackEventsOutput) SetNextToken(v string) *DescribeStackEventsOutput

SetNextToken sets the NextToken field's value.

func (*DescribeStackEventsOutput) SetStackEvents added in v1.5.0 

func (s *DescribeStackEventsOutput) SetStackEvents(v []*StackEvent) *DescribeStackEventsOutput

SetStackEvents sets the StackEvents field's value.

func (DescribeStackEventsOutput) String added in v0.6.5 

func (s DescribeStackEventsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeStackInstanceInput added in v1.10.16 

type DescribeStackInstanceInput struct {

	// [Service-managed permissions] Specifies whether you are acting as an account
	// administrator in the organization's management account or as a delegated
	// administrator in a member account.
	//
	// By default, SELF is specified. Use SELF for stack sets with self-managed
	// permissions.
	//
	//    * If you are signed in to the management account, specify SELF.
	//
	//    * If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
	//    Your Amazon Web Services account must be registered as a delegated administrator
	//    in the management account. For more information, see Register a delegated
	//    administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html)
	//    in the CloudFormation User Guide.
	CallAs *string `type:"string" enum:"CallAs"`

	// The ID of an Amazon Web Services account that's associated with this stack
	// instance.
	//
	// StackInstanceAccount is a required field
	StackInstanceAccount *string `type:"string" required:"true"`

	// The name of a Region that's associated with this stack instance.
	//
	// StackInstanceRegion is a required field
	StackInstanceRegion *string `type:"string" required:"true"`

	// The name or the unique stack ID of the stack set that you want to get stack
	// instance information for.
	//
	// StackSetName is a required field
	StackSetName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeStackInstanceInput) GoString added in v1.10.16 

func (s DescribeStackInstanceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStackInstanceInput) SetCallAs added in v1.37.14 

func (s *DescribeStackInstanceInput) SetCallAs(v string) *DescribeStackInstanceInput

SetCallAs sets the CallAs field's value.

func (*DescribeStackInstanceInput) SetStackInstanceAccount added in v1.10.16 

func (s *DescribeStackInstanceInput) SetStackInstanceAccount(v string) *DescribeStackInstanceInput

SetStackInstanceAccount sets the StackInstanceAccount field's value.

func (*DescribeStackInstanceInput) SetStackInstanceRegion added in v1.10.16 

func (s *DescribeStackInstanceInput) SetStackInstanceRegion(v string) *DescribeStackInstanceInput

SetStackInstanceRegion sets the StackInstanceRegion field's value.

func (*DescribeStackInstanceInput) SetStackSetName added in v1.10.16 

func (s *DescribeStackInstanceInput) SetStackSetName(v string) *DescribeStackInstanceInput

SetStackSetName sets the StackSetName field's value.

func (DescribeStackInstanceInput) String added in v1.10.16 

func (s DescribeStackInstanceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStackInstanceInput) Validate added in v1.10.16 

func (s *DescribeStackInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeStackInstanceOutput added in v1.10.16 

type DescribeStackInstanceOutput struct {

	// The stack instance that matches the specified request parameters.
	StackInstance *StackInstance `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeStackInstanceOutput) GoString added in v1.10.16 

func (s DescribeStackInstanceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStackInstanceOutput) SetStackInstance added in v1.10.16 

func (s *DescribeStackInstanceOutput) SetStackInstance(v *StackInstance) *DescribeStackInstanceOutput

SetStackInstance sets the StackInstance field's value.

func (DescribeStackInstanceOutput) String added in v1.10.16 

func (s DescribeStackInstanceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeStackResourceDriftsInput added in v1.15.74 

type DescribeStackResourceDriftsInput struct {

	// The maximum number of results to be returned with a single call. If the number
	// of available results exceeds this maximum, the response includes a NextToken
	// value that you can assign to the NextToken request parameter to get the next
	// set of results.
	MaxResults *int64 `min:"1" type:"integer"`

	// A string that identifies the next page of stack resource drift results.
	NextToken *string `min:"1" type:"string"`

	// The name of the stack for which you want drift information.
	//
	// StackName is a required field
	StackName *string `min:"1" type:"string" required:"true"`

	// The resource drift status values to use as filters for the resource drift
	// results returned.
	//
	//    * DELETED: The resource differs from its expected template configuration
	//    in that the resource has been deleted.
	//
	//    * MODIFIED: One or more resource properties differ from their expected
	//    template values.
	//
	//    * IN_SYNC: The resource's actual configuration matches its expected template
	//    configuration.
	//
	//    * NOT_CHECKED: CloudFormation doesn't currently return this value.
	StackResourceDriftStatusFilters []*string `min:"1" type:"list" enum:"StackResourceDriftStatus"`
	// contains filtered or unexported fields
}

func (DescribeStackResourceDriftsInput) GoString added in v1.15.74 

func (s DescribeStackResourceDriftsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStackResourceDriftsInput) SetMaxResults added in v1.15.74 

func (s *DescribeStackResourceDriftsInput) SetMaxResults(v int64) *DescribeStackResourceDriftsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeStackResourceDriftsInput) SetNextToken added in v1.15.74 

func (s *DescribeStackResourceDriftsInput) SetNextToken(v string) *DescribeStackResourceDriftsInput

SetNextToken sets the NextToken field's value.

func (*DescribeStackResourceDriftsInput) SetStackName added in v1.15.74 

func (s *DescribeStackResourceDriftsInput) SetStackName(v string) *DescribeStackResourceDriftsInput

SetStackName sets the StackName field's value.

func (*DescribeStackResourceDriftsInput) SetStackResourceDriftStatusFilters added in v1.15.74 

func (s *DescribeStackResourceDriftsInput) SetStackResourceDriftStatusFilters(v []*string) *DescribeStackResourceDriftsInput

SetStackResourceDriftStatusFilters sets the StackResourceDriftStatusFilters field's value.

func (DescribeStackResourceDriftsInput) String added in v1.15.74 

func (s DescribeStackResourceDriftsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStackResourceDriftsInput) Validate added in v1.15.74 

func (s *DescribeStackResourceDriftsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeStackResourceDriftsOutput added in v1.15.74 

type DescribeStackResourceDriftsOutput struct {

	// If the request doesn't return all the remaining results, NextToken is set
	// to a token. To retrieve the next set of results, call DescribeStackResourceDrifts
	// again and assign that token to the request object's NextToken parameter.
	// If the request returns all results, NextToken is set to null.
	NextToken *string `min:"1" type:"string"`

	// Drift information for the resources that have been checked for drift in the
	// specified stack. This includes actual and expected configuration values for
	// resources where CloudFormation detects drift.
	//
	// For a given stack, there will be one StackResourceDrift for each stack resource
	// that has been checked for drift. Resources that haven't yet been checked
	// for drift aren't included. Resources that do not currently support drift
	// detection aren't checked, and so not included. For a list of resources that
	// support drift detection, see Resources that Support Drift Detection (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html).
	//
	// StackResourceDrifts is a required field
	StackResourceDrifts []*StackResourceDrift `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeStackResourceDriftsOutput) GoString added in v1.15.74 

func (s DescribeStackResourceDriftsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStackResourceDriftsOutput) SetNextToken added in v1.15.74 

func (s *DescribeStackResourceDriftsOutput) SetNextToken(v string) *DescribeStackResourceDriftsOutput

SetNextToken sets the NextToken field's value.

func (*DescribeStackResourceDriftsOutput) SetStackResourceDrifts added in v1.15.74 

func (s *DescribeStackResourceDriftsOutput) SetStackResourceDrifts(v []*StackResourceDrift) *DescribeStackResourceDriftsOutput

SetStackResourceDrifts sets the StackResourceDrifts field's value.

func (DescribeStackResourceDriftsOutput) String added in v1.15.74 

func (s DescribeStackResourceDriftsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeStackResourceInput 

type DescribeStackResourceInput struct {

	// The logical name of the resource as specified in the template.
	//
	// Default: There is no default value.
	//
	// LogicalResourceId is a required field
	LogicalResourceId *string `type:"string" required:"true"`

	// The name or the unique stack ID that's associated with the stack, which aren't
	// always interchangeable:
	//
	//    * Running stacks: You can specify either the stack's name or its unique
	//    stack ID.
	//
	//    * Deleted stacks: You must specify the unique stack ID.
	//
	// Default: There is no default value.
	//
	// StackName is a required field
	StackName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for DescribeStackResource action.

func (DescribeStackResourceInput) GoString added in v0.6.5 

func (s DescribeStackResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStackResourceInput) SetLogicalResourceId added in v1.5.0 

func (s *DescribeStackResourceInput) SetLogicalResourceId(v string) *DescribeStackResourceInput

SetLogicalResourceId sets the LogicalResourceId field's value.

func (*DescribeStackResourceInput) SetStackName added in v1.5.0 

func (s *DescribeStackResourceInput) SetStackName(v string) *DescribeStackResourceInput

SetStackName sets the StackName field's value.

func (DescribeStackResourceInput) String added in v0.6.5 

func (s DescribeStackResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStackResourceInput) Validate added in v1.1.21 

func (s *DescribeStackResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeStackResourceOutput 

type DescribeStackResourceOutput struct {

	// A StackResourceDetail structure containing the description of the specified
	// resource in the specified stack.
	StackResourceDetail *StackResourceDetail `type:"structure"`
	// contains filtered or unexported fields
}

The output for a DescribeStackResource action.

func (DescribeStackResourceOutput) GoString added in v0.6.5 

func (s DescribeStackResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStackResourceOutput) SetStackResourceDetail added in v1.5.0 

func (s *DescribeStackResourceOutput) SetStackResourceDetail(v *StackResourceDetail) *DescribeStackResourceOutput

SetStackResourceDetail sets the StackResourceDetail field's value.

func (DescribeStackResourceOutput) String added in v0.6.5 

func (s DescribeStackResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeStackResourcesInput 

type DescribeStackResourcesInput struct {

	// The logical name of the resource as specified in the template.
	//
	// Default: There is no default value.
	LogicalResourceId *string `type:"string"`

	// The name or unique identifier that corresponds to a physical instance ID
	// of a resource supported by CloudFormation.
	//
	// For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId
	// corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources
	// to find which stack the instance belongs to and what other resources are
	// part of the stack.
	//
	// Required: Conditional. If you don't specify PhysicalResourceId, you must
	// specify StackName.
	//
	// Default: There is no default value.
	PhysicalResourceId *string `type:"string"`

	// The name or the unique stack ID that is associated with the stack, which
	// aren't always interchangeable:
	//
	//    * Running stacks: You can specify either the stack's name or its unique
	//    stack ID.
	//
	//    * Deleted stacks: You must specify the unique stack ID.
	//
	// Default: There is no default value.
	//
	// Required: Conditional. If you don't specify StackName, you must specify PhysicalResourceId.
	StackName *string `type:"string"`
	// contains filtered or unexported fields
}

The input for DescribeStackResources action.

func (DescribeStackResourcesInput) GoString added in v0.6.5 

func (s DescribeStackResourcesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStackResourcesInput) SetLogicalResourceId added in v1.5.0 

func (s *DescribeStackResourcesInput) SetLogicalResourceId(v string) *DescribeStackResourcesInput

SetLogicalResourceId sets the LogicalResourceId field's value.

func (*DescribeStackResourcesInput) SetPhysicalResourceId added in v1.5.0 

func (s *DescribeStackResourcesInput) SetPhysicalResourceId(v string) *DescribeStackResourcesInput

SetPhysicalResourceId sets the PhysicalResourceId field's value.

func (*DescribeStackResourcesInput) SetStackName added in v1.5.0 

func (s *DescribeStackResourcesInput) SetStackName(v string) *DescribeStackResourcesInput

SetStackName sets the StackName field's value.

func (DescribeStackResourcesInput) String added in v0.6.5 

func (s DescribeStackResourcesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeStackResourcesOutput 

type DescribeStackResourcesOutput struct {

	// A list of StackResource structures.
	StackResources []*StackResource `type:"list"`
	// contains filtered or unexported fields
}

The output for a DescribeStackResources action.

func (DescribeStackResourcesOutput) GoString added in v0.6.5 

func (s DescribeStackResourcesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStackResourcesOutput) SetStackResources added in v1.5.0 

func (s *DescribeStackResourcesOutput) SetStackResources(v []*StackResource) *DescribeStackResourcesOutput

SetStackResources sets the StackResources field's value.

func (DescribeStackResourcesOutput) String added in v0.6.5 

func (s DescribeStackResourcesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeStackSetInput added in v1.10.16 

type DescribeStackSetInput struct {

	// [Service-managed permissions] Specifies whether you are acting as an account
	// administrator in the organization's management account or as a delegated
	// administrator in a member account.
	//
	// By default, SELF is specified. Use SELF for stack sets with self-managed
	// permissions.
	//
	//    * If you are signed in to the management account, specify SELF.
	//
	//    * If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
	//    Your Amazon Web Services account must be registered as a delegated administrator
	//    in the management account. For more information, see Register a delegated
	//    administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html)
	//    in the CloudFormation User Guide.
	CallAs *string `type:"string" enum:"CallAs"`

	// The name or unique ID of the stack set whose description you want.
	//
	// StackSetName is a required field
	StackSetName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeStackSetInput) GoString added in v1.10.16 

func (s DescribeStackSetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStackSetInput) SetCallAs added in v1.37.14 

func (s *DescribeStackSetInput) SetCallAs(v string) *DescribeStackSetInput

SetCallAs sets the CallAs field's value.

func (*DescribeStackSetInput) SetStackSetName added in v1.10.16 

func (s *DescribeStackSetInput) SetStackSetName(v string) *DescribeStackSetInput

SetStackSetName sets the StackSetName field's value.

func (DescribeStackSetInput) String added in v1.10.16 

func (s DescribeStackSetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStackSetInput) Validate added in v1.10.16 

func (s *DescribeStackSetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeStackSetOperationInput added in v1.10.16 

type DescribeStackSetOperationInput struct {

	// [Service-managed permissions] Specifies whether you are acting as an account
	// administrator in the organization's management account or as a delegated
	// administrator in a member account.
	//
	// By default, SELF is specified. Use SELF for stack sets with self-managed
	// permissions.
	//
	//    * If you are signed in to the management account, specify SELF.
	//
	//    * If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
	//    Your Amazon Web Services account must be registered as a delegated administrator
	//    in the management account. For more information, see Register a delegated
	//    administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html)
	//    in the CloudFormation User Guide.
	CallAs *string `type:"string" enum:"CallAs"`

	// The unique ID of the stack set operation.
	//
	// OperationId is a required field
	OperationId *string `min:"1" type:"string" required:"true"`

	// The name or the unique stack ID of the stack set for the stack operation.
	//
	// StackSetName is a required field
	StackSetName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeStackSetOperationInput) GoString added in v1.10.16 

func (s DescribeStackSetOperationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStackSetOperationInput) SetCallAs added in v1.37.14 

func (s *DescribeStackSetOperationInput) SetCallAs(v string) *DescribeStackSetOperationInput

SetCallAs sets the CallAs field's value.

func (*DescribeStackSetOperationInput) SetOperationId added in v1.10.16 

func (s *DescribeStackSetOperationInput) SetOperationId(v string) *DescribeStackSetOperationInput

SetOperationId sets the OperationId field's value.

func (*DescribeStackSetOperationInput) SetStackSetName added in v1.10.16 

func (s *DescribeStackSetOperationInput) SetStackSetName(v string) *DescribeStackSetOperationInput

SetStackSetName sets the StackSetName field's value.

func (DescribeStackSetOperationInput) String added in v1.10.16 

func (s DescribeStackSetOperationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStackSetOperationInput) Validate added in v1.10.16 

func (s *DescribeStackSetOperationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeStackSetOperationOutput added in v1.10.16 

type DescribeStackSetOperationOutput struct {

	// The specified stack set operation.
	StackSetOperation *StackSetOperation `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeStackSetOperationOutput) GoString added in v1.10.16 

func (s DescribeStackSetOperationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStackSetOperationOutput) SetStackSetOperation added in v1.10.16 

func (s *DescribeStackSetOperationOutput) SetStackSetOperation(v *StackSetOperation) *DescribeStackSetOperationOutput

SetStackSetOperation sets the StackSetOperation field's value.

func (DescribeStackSetOperationOutput) String added in v1.10.16 

func (s DescribeStackSetOperationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeStackSetOutput added in v1.10.16 

type DescribeStackSetOutput struct {

	// The specified stack set.
	StackSet *StackSet `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeStackSetOutput) GoString added in v1.10.16 

func (s DescribeStackSetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStackSetOutput) SetStackSet added in v1.10.16 

func (s *DescribeStackSetOutput) SetStackSet(v *StackSet) *DescribeStackSetOutput

SetStackSet sets the StackSet field's value.

func (DescribeStackSetOutput) String added in v1.10.16 

func (s DescribeStackSetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeStacksInput 

type DescribeStacksInput struct {

	// A string that identifies the next page of stacks that you want to retrieve.
	NextToken *string `min:"1" type:"string"`

	//
	// If you don't pass a parameter to StackName, the API returns a response that
	// describes all resources in the account, which can impact performance. This
	// requires ListStacks and DescribeStacks permissions.
	//
	// Consider using the ListStacks API if you're not passing a parameter to StackName.
	//
	// The IAM policy below can be added to IAM policies when you want to limit
	// resource-level permissions and avoid returning a response when no parameter
	// is sent in the request:
	//
	// { "Version": "2012-10-17", "Statement": [{ "Effect": "Deny", "Action": "cloudformation:DescribeStacks",
	// "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" }] }
	//
	// The name or the unique stack ID that's associated with the stack, which aren't
	// always interchangeable:
	//
	//    * Running stacks: You can specify either the stack's name or its unique
	//    stack ID.
	//
	//    * Deleted stacks: You must specify the unique stack ID.
	//
	// Default: There is no default value.
	StackName *string `type:"string"`
	// contains filtered or unexported fields
}

The input for DescribeStacks action.

func (DescribeStacksInput) GoString added in v0.6.5 

func (s DescribeStacksInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStacksInput) SetNextToken added in v1.5.0 

func (s *DescribeStacksInput) SetNextToken(v string) *DescribeStacksInput

SetNextToken sets the NextToken field's value.

func (*DescribeStacksInput) SetStackName added in v1.5.0 

func (s *DescribeStacksInput) SetStackName(v string) *DescribeStacksInput

SetStackName sets the StackName field's value.

func (DescribeStacksInput) String added in v0.6.5 

func (s DescribeStacksInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStacksInput) Validate added in v1.1.21 

func (s *DescribeStacksInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeStacksOutput 

type DescribeStacksOutput struct {

	// If the output exceeds 1 MB in size, a string that identifies the next page
	// of stacks. If no additional page exists, this value is null.
	NextToken *string `min:"1" type:"string"`

	// A list of stack structures.
	Stacks []*Stack `type:"list"`
	// contains filtered or unexported fields
}

The output for a DescribeStacks action.

func (DescribeStacksOutput) GoString added in v0.6.5 

func (s DescribeStacksOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStacksOutput) SetNextToken added in v1.5.0 

func (s *DescribeStacksOutput) SetNextToken(v string) *DescribeStacksOutput

SetNextToken sets the NextToken field's value.

func (*DescribeStacksOutput) SetStacks added in v1.5.0 

func (s *DescribeStacksOutput) SetStacks(v []*Stack) *DescribeStacksOutput

SetStacks sets the Stacks field's value.

func (DescribeStacksOutput) String added in v0.6.5 

func (s DescribeStacksOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeTypeInput added in v1.25.37 

type DescribeTypeInput struct {

	// The Amazon Resource Name (ARN) of the extension.
	//
	// Conditional: You must specify either TypeName and Type, or Arn.
	Arn *string `type:"string"`

	// The version number of a public third-party extension.
	PublicVersionNumber *string `min:"5" type:"string"`

	// The publisher ID of the extension publisher.
	//
	// Extensions provided by Amazon Web Services are not assigned a publisher ID.
	PublisherId *string `min:"1" type:"string"`

	// The kind of extension.
	//
	// Conditional: You must specify either TypeName and Type, or Arn.
	Type *string `type:"string" enum:"RegistryType"`

	// The name of the extension.
	//
	// Conditional: You must specify either TypeName and Type, or Arn.
	TypeName *string `min:"10" type:"string"`

	// The ID of a specific version of the extension. The version ID is the value
	// at the end of the Amazon Resource Name (ARN) assigned to the extension version
	// when it is registered.
	//
	// If you specify a VersionId, DescribeType returns information about that specific
	// extension version. Otherwise, it returns information about the default extension
	// version.
	VersionId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeTypeInput) GoString added in v1.25.37 

func (s DescribeTypeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTypeInput) SetArn added in v1.25.37 

func (s *DescribeTypeInput) SetArn(v string) *DescribeTypeInput

SetArn sets the Arn field's value.

func (*DescribeTypeInput) SetPublicVersionNumber added in v1.38.65 

func (s *DescribeTypeInput) SetPublicVersionNumber(v string) *DescribeTypeInput

SetPublicVersionNumber sets the PublicVersionNumber field's value.

func (*DescribeTypeInput) SetPublisherId added in v1.38.65 

func (s *DescribeTypeInput) SetPublisherId(v string) *DescribeTypeInput

SetPublisherId sets the PublisherId field's value.

func (*DescribeTypeInput) SetType added in v1.25.37 

func (s *DescribeTypeInput) SetType(v string) *DescribeTypeInput

SetType sets the Type field's value.

func (*DescribeTypeInput) SetTypeName added in v1.25.37 

func (s *DescribeTypeInput) SetTypeName(v string) *DescribeTypeInput

SetTypeName sets the TypeName field's value.

func (*DescribeTypeInput) SetVersionId added in v1.25.37 

func (s *DescribeTypeInput) SetVersionId(v string) *DescribeTypeInput

SetVersionId sets the VersionId field's value.

func (DescribeTypeInput) String added in v1.25.37 

func (s DescribeTypeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTypeInput) Validate added in v1.25.37 

func (s *DescribeTypeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeTypeOutput added in v1.25.37 

type DescribeTypeOutput struct {

	// The Amazon Resource Name (ARN) of the extension.
	Arn *string `type:"string"`

	// Whether CloudFormation automatically updates the extension in this account
	// and Region when a new minor version is published by the extension publisher.
	// Major versions released by the publisher must be manually updated. For more
	// information, see Activating public extensions for use in your account (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable)
	// in the CloudFormation User Guide.
	AutoUpdate *bool `type:"boolean"`

	// A JSON string that represent the current configuration data for the extension
	// in this account and Region.
	//
	// To set the configuration data for an extension, use SetTypeConfiguration
	// (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html).
	// For more information, see Configuring extensions at the account level (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration)
	// in the CloudFormation User Guide.
	ConfigurationSchema *string `min:"1" type:"string"`

	// 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 Web Services and published
	// by third parties, CloudFormation returns null. For more information, see
	// RegisterType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html).
	//
	// To set the default version of an extension, use SetTypeDefaultVersion.
	DefaultVersionId *string `min:"1" type:"string"`

	// The deprecation status of the extension version.
	//
	// Valid values include:
	//
	//    * LIVE: The extension is activated or registered and can be used in CloudFormation
	//    operations, dependent on its provisioning behavior and visibility scope.
	//
	//    * DEPRECATED: The extension has been deactivated or deregistered and can
	//    no longer be used in CloudFormation operations.
	//
	// For public third-party extensions, CloudFormation returns null.
	DeprecatedStatus *string `type:"string" enum:"DeprecatedStatus"`

	// The description of the extension.
	Description *string `min:"1" type:"string"`

	// The URL of a page providing detailed documentation for this extension.
	DocumentationUrl *string `type:"string"`

	// The Amazon Resource Name (ARN) of the IAM execution role used to register
	// the extension. This applies only to private extensions you have registered
	// in your account. For more information, see RegisterType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html).
	//
	// If the registered extension calls any Amazon Web Services APIs, you must
	// create an IAM execution role (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html)
	// that includes the necessary permissions to call those Amazon Web Services
	// APIs, and provision that execution role in your account. CloudFormation then
	// assumes that execution role to provide your extension with the appropriate
	// credentials.
	ExecutionRoleArn *string `min:"1" type:"string"`

	// Whether the extension is activated in the account and Region.
	//
	// This only applies to public third-party extensions. For all other extensions,
	// CloudFormation returns null.
	IsActivated *bool `type:"boolean"`

	// 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 Web Services. For public third-party extensions,
	// whether they are activated in your account, CloudFormation returns null.
	IsDefaultVersion *bool `type:"boolean"`

	// When the specified extension version was registered. This applies only to:
	//
	//    * Private extensions you have registered in your account. For more information,
	//    see RegisterType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html).
	//
	//    * Public extensions you have activated in your account with auto-update
	//    specified. For more information, see ActivateType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html).
	LastUpdated *time.Time `type:"timestamp"`

	// The latest version of a public extension that is available for use.
	//
	// This only applies if you specify a public extension, and you don't specify
	// a version. For all other requests, CloudFormation returns null.
	LatestPublicVersion *string `min:"5" type:"string"`

	// Contains logging configuration information for private extensions. This applies
	// only to private extensions you have registered in your account. For public
	// extensions, both those provided by Amazon Web Services and published by third
	// parties, CloudFormation returns null. For more information, see RegisterType
	// (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html).
	LoggingConfig *LoggingConfig `type:"structure"`

	// For public extensions that have been activated for this account and Region,
	// the Amazon Resource Name (ARN) of the public extension.
	OriginalTypeArn *string `type:"string"`

	// For public extensions that have been activated for this account and Region,
	// the type name of the public extension.
	//
	// If you specified a TypeNameAlias when enabling the extension in this account
	// and Region, CloudFormation treats that alias as the extension's type name
	// within the account and Region, not the type name of the public extension.
	// For more information, see Specifying aliases to refer to extensions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias)
	// in the CloudFormation User Guide.
	OriginalTypeName *string `min:"10" type:"string"`

	// For resource type extensions, the provisioning behavior of the resource type.
	// CloudFormation determines the provisioning type during registration, based
	// on the types of handlers in the schema handler package submitted.
	//
	// Valid values include:
	//
	//    * FULLY_MUTABLE: The resource type includes an update handler to process
	//    updates to the type during stack update operations.
	//
	//    * IMMUTABLE: The resource type doesn't include an update handler, so the
	//    type can't be updated and must instead be replaced during stack update
	//    operations.
	//
	//    * NON_PROVISIONABLE: The resource type doesn't include all the following
	//    handlers, and therefore can't actually be provisioned. create read delete
	ProvisioningType *string `type:"string" enum:"ProvisioningType"`

	// The version number of a public third-party extension.
	//
	// This applies only if you specify a public extension you have activated in
	// your account, or specify a public extension without specifying a version.
	// For all other extensions, CloudFormation returns null.
	PublicVersionNumber *string `min:"5" type:"string"`

	// The publisher ID of the extension publisher.
	//
	// This applies only to public third-party extensions. For private registered
	// extensions, and extensions provided by Amazon Web Services, CloudFormation
	// returns null.
	PublisherId *string `min:"1" type:"string"`

	// For extensions that are modules, the public third-party extensions that must
	// be activated in your account in order for the module itself to be activated.
	RequiredActivatedTypes []*RequiredActivatedType `type:"list"`

	// The schema that defines the extension.
	//
	// For more information about extension schemas, see Resource Provider Schema
	// (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html)
	// in the CloudFormation CLI User Guide.
	Schema *string `min:"1" type:"string"`

	// The URL of the source code for the extension.
	SourceUrl *string `type:"string"`

	// When the specified private extension version was registered or activated
	// in your account.
	TimeCreated *time.Time `type:"timestamp"`

	// The kind of extension.
	Type *string `type:"string" enum:"RegistryType"`

	// The name of the extension.
	//
	// If the extension is a public third-party type you have activated with a type
	// name alias, CloudFormation returns the type name alias. For more information,
	// see ActivateType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html).
	TypeName *string `min:"10" type:"string"`

	// The contract test status of the registered extension version. To return the
	// extension test status of a specific extension version, you must specify VersionId.
	//
	// This applies only to registered private extension versions. CloudFormation
	// doesn't return this information for public extensions, whether they are activated
	// in your account.
	//
	//    * PASSED: The extension has passed all its contract tests. An extension
	//    must have a test status of PASSED before it can be published. For more
	//    information, see Publishing extensions to make them available for public
	//    use (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html)
	//    in the CloudFormation Command Line Interface User Guide.
	//
	//    * FAILED: The extension has failed one or more contract tests.
	//
	//    * IN_PROGRESS: Contract tests are currently being performed on the extension.
	//
	//    * NOT_TESTED: Contract tests haven't been performed on the extension.
	TypeTestsStatus *string `type:"string" enum:"TypeTestsStatus"`

	// The description of the test status. To return the extension test status of
	// a specific extension version, you must specify VersionId.
	//
	// This applies only to registered private extension versions. CloudFormation
	// doesn't return this information for public extensions, whether they are activated
	// in your account.
	TypeTestsStatusDescription *string `min:"1" type:"string"`

	// The scope at which the extension is visible and usable in CloudFormation
	// operations.
	//
	// Valid values include:
	//
	//    * PRIVATE: The extension is only visible and usable within the account
	//    in which it is registered. CloudFormation marks any extensions you register
	//    as PRIVATE.
	//
	//    * PUBLIC: The extension is publicly visible and usable within any Amazon
	//    Web Services account.
	Visibility *string `type:"string" enum:"Visibility"`
	// contains filtered or unexported fields
}

func (DescribeTypeOutput) GoString added in v1.25.37 

func (s DescribeTypeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTypeOutput) SetArn added in v1.25.37 

func (s *DescribeTypeOutput) SetArn(v string) *DescribeTypeOutput

SetArn sets the Arn field's value.

func (*DescribeTypeOutput) SetAutoUpdate added in v1.38.65 

func (s *DescribeTypeOutput) SetAutoUpdate(v bool) *DescribeTypeOutput

SetAutoUpdate sets the AutoUpdate field's value.

func (*DescribeTypeOutput) SetConfigurationSchema added in v1.38.65 

func (s *DescribeTypeOutput) SetConfigurationSchema(v string) *DescribeTypeOutput

SetConfigurationSchema sets the ConfigurationSchema field's value.

func (*DescribeTypeOutput) SetDefaultVersionId added in v1.25.37 

func (s *DescribeTypeOutput) SetDefaultVersionId(v string) *DescribeTypeOutput

SetDefaultVersionId sets the DefaultVersionId field's value.

func (*DescribeTypeOutput) SetDeprecatedStatus added in v1.25.37 

func (s *DescribeTypeOutput) SetDeprecatedStatus(v string) *DescribeTypeOutput

SetDeprecatedStatus sets the DeprecatedStatus field's value.

func (*DescribeTypeOutput) SetDescription added in v1.25.37 

func (s *DescribeTypeOutput) SetDescription(v string) *DescribeTypeOutput

SetDescription sets the Description field's value.

func (*DescribeTypeOutput) SetDocumentationUrl added in v1.25.37 

func (s *DescribeTypeOutput) SetDocumentationUrl(v string) *DescribeTypeOutput

SetDocumentationUrl sets the DocumentationUrl field's value.

func (*DescribeTypeOutput) SetExecutionRoleArn added in v1.25.37 

func (s *DescribeTypeOutput) SetExecutionRoleArn(v string) *DescribeTypeOutput

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*DescribeTypeOutput) SetIsActivated added in v1.38.65 

func (s *DescribeTypeOutput) SetIsActivated(v bool) *DescribeTypeOutput

SetIsActivated sets the IsActivated field's value.

func (*DescribeTypeOutput) SetIsDefaultVersion added in v1.30.29 

func (s *DescribeTypeOutput) SetIsDefaultVersion(v bool) *DescribeTypeOutput

SetIsDefaultVersion sets the IsDefaultVersion field's value.

func (*DescribeTypeOutput) SetLastUpdated added in v1.25.37 

func (s *DescribeTypeOutput) SetLastUpdated(v time.Time) *DescribeTypeOutput

SetLastUpdated sets the LastUpdated field's value.

func (*DescribeTypeOutput) SetLatestPublicVersion added in v1.38.65 

func (s *DescribeTypeOutput) SetLatestPublicVersion(v string) *DescribeTypeOutput

SetLatestPublicVersion sets the LatestPublicVersion field's value.

func (*DescribeTypeOutput) SetLoggingConfig added in v1.25.37 

func (s *DescribeTypeOutput) SetLoggingConfig(v *LoggingConfig) *DescribeTypeOutput

SetLoggingConfig sets the LoggingConfig field's value.

func (*DescribeTypeOutput) SetOriginalTypeArn added in v1.38.65 

func (s *DescribeTypeOutput) SetOriginalTypeArn(v string) *DescribeTypeOutput

SetOriginalTypeArn sets the OriginalTypeArn field's value.

func (*DescribeTypeOutput) SetOriginalTypeName added in v1.38.65 

func (s *DescribeTypeOutput) SetOriginalTypeName(v string) *DescribeTypeOutput

SetOriginalTypeName sets the OriginalTypeName field's value.

func (*DescribeTypeOutput) SetProvisioningType added in v1.25.37 

func (s *DescribeTypeOutput) SetProvisioningType(v string) *DescribeTypeOutput

SetProvisioningType sets the ProvisioningType field's value.

func (*DescribeTypeOutput) SetPublicVersionNumber added in v1.38.65 

func (s *DescribeTypeOutput) SetPublicVersionNumber(v string) *DescribeTypeOutput

SetPublicVersionNumber sets the PublicVersionNumber field's value.

func (*DescribeTypeOutput) SetPublisherId added in v1.38.65 

func (s *DescribeTypeOutput) SetPublisherId(v string) *DescribeTypeOutput

SetPublisherId sets the PublisherId field's value.

func (*DescribeTypeOutput) SetRequiredActivatedTypes added in v1.38.65 

func (s *DescribeTypeOutput) SetRequiredActivatedTypes(v []*RequiredActivatedType) *DescribeTypeOutput

SetRequiredActivatedTypes sets the RequiredActivatedTypes field's value.

func (*DescribeTypeOutput) SetSchema added in v1.25.37 

func (s *DescribeTypeOutput) SetSchema(v string) *DescribeTypeOutput

SetSchema sets the Schema field's value.

func (*DescribeTypeOutput) SetSourceUrl added in v1.25.37 

func (s *DescribeTypeOutput) SetSourceUrl(v string) *DescribeTypeOutput

SetSourceUrl sets the SourceUrl field's value.

func (*DescribeTypeOutput) SetTimeCreated added in v1.25.37 

func (s *DescribeTypeOutput) SetTimeCreated(v time.Time) *DescribeTypeOutput

SetTimeCreated sets the TimeCreated field's value.

func (*DescribeTypeOutput) SetType added in v1.25.37 

func (s *DescribeTypeOutput) SetType(v string) *DescribeTypeOutput

SetType sets the Type field's value.

func (*DescribeTypeOutput) SetTypeName added in v1.25.37 

func (s *DescribeTypeOutput) SetTypeName(v string) *DescribeTypeOutput

SetTypeName sets the TypeName field's value.

func (*DescribeTypeOutput) SetTypeTestsStatus added in v1.38.65 

func (s *DescribeTypeOutput) SetTypeTestsStatus(v string) *DescribeTypeOutput

SetTypeTestsStatus sets the TypeTestsStatus field's value.

func (*DescribeTypeOutput) SetTypeTestsStatusDescription added in v1.38.65 

func (s *DescribeTypeOutput) SetTypeTestsStatusDescription(v string) *DescribeTypeOutput

SetTypeTestsStatusDescription sets the TypeTestsStatusDescription field's value.

func (*DescribeTypeOutput) SetVisibility added in v1.25.37 

func (s *DescribeTypeOutput) SetVisibility(v string) *DescribeTypeOutput

SetVisibility sets the Visibility field's value.

func (DescribeTypeOutput) String added in v1.25.37 

func (s DescribeTypeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeTypeRegistrationInput added in v1.25.37 

type DescribeTypeRegistrationInput struct {

	// The identifier for this registration request.
	//
	// This registration token is generated by CloudFormation when you initiate
	// a registration request using RegisterType.
	//
	// RegistrationToken is a required field
	RegistrationToken *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeTypeRegistrationInput) GoString added in v1.25.37 

func (s DescribeTypeRegistrationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTypeRegistrationInput) SetRegistrationToken added in v1.25.37 

func (s *DescribeTypeRegistrationInput) SetRegistrationToken(v string) *DescribeTypeRegistrationInput

SetRegistrationToken sets the RegistrationToken field's value.

func (DescribeTypeRegistrationInput) String added in v1.25.37 

func (s DescribeTypeRegistrationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTypeRegistrationInput) Validate added in v1.25.37 

func (s *DescribeTypeRegistrationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeTypeRegistrationOutput added in v1.25.37 

type DescribeTypeRegistrationOutput struct {

	// The description of the extension registration request.
	Description *string `min:"1" type:"string"`

	// The current status of the extension registration request.
	ProgressStatus *string `type:"string" enum:"RegistrationStatus"`

	// The Amazon Resource Name (ARN) of the extension being registered.
	//
	// For registration requests with a ProgressStatus of other than COMPLETE, this
	// will be null.
	TypeArn *string `type:"string"`

	// The Amazon Resource Name (ARN) of this specific version of the extension
	// being registered.
	//
	// For registration requests with a ProgressStatus of other than COMPLETE, this
	// will be null.
	TypeVersionArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeTypeRegistrationOutput) GoString added in v1.25.37 

func (s DescribeTypeRegistrationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTypeRegistrationOutput) SetDescription added in v1.25.37 

func (s *DescribeTypeRegistrationOutput) SetDescription(v string) *DescribeTypeRegistrationOutput

SetDescription sets the Description field's value.

func (*DescribeTypeRegistrationOutput) SetProgressStatus added in v1.25.37 

func (s *DescribeTypeRegistrationOutput) SetProgressStatus(v string) *DescribeTypeRegistrationOutput

SetProgressStatus sets the ProgressStatus field's value.

func (*DescribeTypeRegistrationOutput) SetTypeArn added in v1.25.37 

func (s *DescribeTypeRegistrationOutput) SetTypeArn(v string) *DescribeTypeRegistrationOutput

SetTypeArn sets the TypeArn field's value.

func (*DescribeTypeRegistrationOutput) SetTypeVersionArn added in v1.25.37 

func (s *DescribeTypeRegistrationOutput) SetTypeVersionArn(v string) *DescribeTypeRegistrationOutput

SetTypeVersionArn sets the TypeVersionArn field's value.

func (DescribeTypeRegistrationOutput) String added in v1.25.37 

func (s DescribeTypeRegistrationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DetectStackDriftInput added in v1.15.74 

type DetectStackDriftInput struct {

	// The logical names of any resources you want to use as filters.
	LogicalResourceIds []*string `min:"1" type:"list"`

	// The name of the stack for which you want to detect drift.
	//
	// StackName is a required field
	StackName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DetectStackDriftInput) GoString added in v1.15.74 

func (s DetectStackDriftInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectStackDriftInput) SetLogicalResourceIds added in v1.15.74 

func (s *DetectStackDriftInput) SetLogicalResourceIds(v []*string) *DetectStackDriftInput

SetLogicalResourceIds sets the LogicalResourceIds field's value.

func (*DetectStackDriftInput) SetStackName added in v1.15.74 

func (s *DetectStackDriftInput) SetStackName(v string) *DetectStackDriftInput

SetStackName sets the StackName field's value.

func (DetectStackDriftInput) String added in v1.15.74 

func (s DetectStackDriftInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectStackDriftInput) Validate added in v1.15.74 

func (s *DetectStackDriftInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetectStackDriftOutput added in v1.15.74 

type DetectStackDriftOutput struct {

	// The ID of the drift detection results of this operation.
	//
	// CloudFormation generates new results, with a new drift detection ID, each
	// time this operation is run. However, the number of drift results CloudFormation
	// retains for any given stack, and for how long, may vary.
	//
	// StackDriftDetectionId is a required field
	StackDriftDetectionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DetectStackDriftOutput) GoString added in v1.15.74 

func (s DetectStackDriftOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectStackDriftOutput) SetStackDriftDetectionId added in v1.15.74 

func (s *DetectStackDriftOutput) SetStackDriftDetectionId(v string) *DetectStackDriftOutput

SetStackDriftDetectionId sets the StackDriftDetectionId field's value.

func (DetectStackDriftOutput) String added in v1.15.74 

func (s DetectStackDriftOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DetectStackResourceDriftInput added in v1.15.74 

type DetectStackResourceDriftInput struct {

	// The logical name of the resource for which to return drift information.
	//
	// LogicalResourceId is a required field
	LogicalResourceId *string `type:"string" required:"true"`

	// The name of the stack to which the resource belongs.
	//
	// StackName is a required field
	StackName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DetectStackResourceDriftInput) GoString added in v1.15.74 

func (s DetectStackResourceDriftInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectStackResourceDriftInput) SetLogicalResourceId added in v1.15.74 

func (s *DetectStackResourceDriftInput) SetLogicalResourceId(v string) *DetectStackResourceDriftInput

SetLogicalResourceId sets the LogicalResourceId field's value.

func (*DetectStackResourceDriftInput) SetStackName added in v1.15.74 

func (s *DetectStackResourceDriftInput) SetStackName(v string) *DetectStackResourceDriftInput

SetStackName sets the StackName field's value.

func (DetectStackResourceDriftInput) String added in v1.15.74 

func (s DetectStackResourceDriftInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectStackResourceDriftInput) Validate added in v1.15.74 

func (s *DetectStackResourceDriftInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetectStackResourceDriftOutput added in v1.15.74 

type DetectStackResourceDriftOutput struct {

	// Information about whether the resource's actual configuration has drifted
	// from its expected template configuration, including actual and expected property
	// values and any differences detected.
	//
	// StackResourceDrift is a required field
	StackResourceDrift *StackResourceDrift `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DetectStackResourceDriftOutput) GoString added in v1.15.74 

func (s DetectStackResourceDriftOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectStackResourceDriftOutput) SetStackResourceDrift added in v1.15.74 

func (s *DetectStackResourceDriftOutput) SetStackResourceDrift(v *StackResourceDrift) *DetectStackResourceDriftOutput

SetStackResourceDrift sets the StackResourceDrift field's value.

func (DetectStackResourceDriftOutput) String added in v1.15.74 

func (s DetectStackResourceDriftOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DetectStackSetDriftInput added in v1.25.38 

type DetectStackSetDriftInput struct {

	// [Service-managed permissions] Specifies whether you are acting as an account
	// administrator in the organization's management account or as a delegated
	// administrator in a member account.
	//
	// By default, SELF is specified. Use SELF for stack sets with self-managed
	// permissions.
	//
	//    * If you are signed in to the management account, specify SELF.
	//
	//    * If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
	//    Your Amazon Web Services account must be registered as a delegated administrator
	//    in the management account. For more information, see Register a delegated
	//    administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html)
	//    in the CloudFormation User Guide.
	CallAs *string `type:"string" enum:"CallAs"`

	// The ID of the stack set operation.
	OperationId *string `min:"1" type:"string" idempotencyToken:"true"`

	// 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options).
	OperationPreferences *StackSetOperationPreferences `type:"structure"`

	// The name of the stack set on which to perform the drift detection operation.
	//
	// StackSetName is a required field
	StackSetName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DetectStackSetDriftInput) GoString added in v1.25.38 

func (s DetectStackSetDriftInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectStackSetDriftInput) SetCallAs added in v1.37.14 

func (s *DetectStackSetDriftInput) SetCallAs(v string) *DetectStackSetDriftInput

SetCallAs sets the CallAs field's value.

func (*DetectStackSetDriftInput) SetOperationId added in v1.25.38 

func (s *DetectStackSetDriftInput) SetOperationId(v string) *DetectStackSetDriftInput

SetOperationId sets the OperationId field's value.

func (*DetectStackSetDriftInput) SetOperationPreferences added in v1.25.38 

func (s *DetectStackSetDriftInput) SetOperationPreferences(v *StackSetOperationPreferences) *DetectStackSetDriftInput

SetOperationPreferences sets the OperationPreferences field's value.

func (*DetectStackSetDriftInput) SetStackSetName added in v1.25.38 

func (s *DetectStackSetDriftInput) SetStackSetName(v string) *DetectStackSetDriftInput

SetStackSetName sets the StackSetName field's value.

func (DetectStackSetDriftInput) String added in v1.25.38 

func (s DetectStackSetDriftInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectStackSetDriftInput) Validate added in v1.25.38 

func (s *DetectStackSetDriftInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetectStackSetDriftOutput added in v1.25.38 

type DetectStackSetDriftOutput struct {

	// The ID of the drift detection stack set operation.
	//
	// You can use this operation ID with DescribeStackSetOperation to monitor the
	// progress of the drift detection operation.
	OperationId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DetectStackSetDriftOutput) GoString added in v1.25.38 

func (s DetectStackSetDriftOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectStackSetDriftOutput) SetOperationId added in v1.25.38 

func (s *DetectStackSetDriftOutput) SetOperationId(v string) *DetectStackSetDriftOutput

SetOperationId sets the OperationId field's value.

func (DetectStackSetDriftOutput) String added in v1.25.38 

func (s DetectStackSetDriftOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EstimateTemplateCostInput 

type EstimateTemplateCostInput struct {

	// A list of Parameter structures that specify input parameters.
	Parameters []*Parameter `type:"list"`

	// Structure containing the template body with a minimum length of 1 byte and
	// a maximum length of 51,200 bytes. (For more information, go to Template Anatomy
	// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
	// in the CloudFormation User Guide.)
	//
	// Conditional: You must pass TemplateBody or TemplateURL. If both are passed,
	// only TemplateBody is used.
	TemplateBody *string `min:"1" type:"string"`

	// Location of file containing the template body. The URL must point to a template
	// that's located in an Amazon S3 bucket or a Systems Manager document. For
	// more information, go to Template Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
	// in the CloudFormation User Guide.
	//
	// Conditional: You must pass TemplateURL or TemplateBody. If both are passed,
	// only TemplateBody is used.
	TemplateURL *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The input for an EstimateTemplateCost action.

func (EstimateTemplateCostInput) GoString added in v0.6.5 

func (s EstimateTemplateCostInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EstimateTemplateCostInput) SetParameters added in v1.5.0 

func (s *EstimateTemplateCostInput) SetParameters(v []*Parameter) *EstimateTemplateCostInput

SetParameters sets the Parameters field's value.

func (*EstimateTemplateCostInput) SetTemplateBody added in v1.5.0 

func (s *EstimateTemplateCostInput) SetTemplateBody(v string) *EstimateTemplateCostInput

SetTemplateBody sets the TemplateBody field's value.

func (*EstimateTemplateCostInput) SetTemplateURL added in v1.5.0 

func (s *EstimateTemplateCostInput) SetTemplateURL(v string) *EstimateTemplateCostInput

SetTemplateURL sets the TemplateURL field's value.

func (EstimateTemplateCostInput) String added in v0.6.5 

func (s EstimateTemplateCostInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EstimateTemplateCostInput) Validate added in v1.1.21 

func (s *EstimateTemplateCostInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EstimateTemplateCostOutput 

type EstimateTemplateCostOutput struct {

	// An Amazon Web Services Simple Monthly Calculator URL with a query string
	// that describes the resources required to run the template.
	Url *string `type:"string"`
	// contains filtered or unexported fields
}

The output for a EstimateTemplateCost action.

func (EstimateTemplateCostOutput) GoString added in v0.6.5 

func (s EstimateTemplateCostOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EstimateTemplateCostOutput) SetUrl added in v1.5.0 

func (s *EstimateTemplateCostOutput) SetUrl(v string) *EstimateTemplateCostOutput

SetUrl sets the Url field's value.

func (EstimateTemplateCostOutput) String added in v0.6.5 

func (s EstimateTemplateCostOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExecuteChangeSetInput added in v1.1.15 

type ExecuteChangeSetInput struct {

	// The name or Amazon Resource Name (ARN) of the change set that you want use
	// to update the specified stack.
	//
	// ChangeSetName is a required field
	ChangeSetName *string `min:"1" type:"string" required:"true"`

	// A unique identifier for this ExecuteChangeSet request. Specify this token
	// if you plan to retry requests so that CloudFormation knows that you're not
	// attempting to execute a change set to update a stack with the same name.
	// You might retry ExecuteChangeSet requests to ensure that CloudFormation successfully
	// received them.
	ClientRequestToken *string `min:"1" type:"string"`

	// Preserves the state of previously provisioned resources when an operation
	// fails. This parameter can't be specified when the OnStackFailure parameter
	// to the CreateChangeSet (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html)
	// API operation was specified.
	//
	//    * True - if the stack creation fails, do nothing. This is equivalent to
	//    specifying DO_NOTHING for the OnStackFailure parameter to the CreateChangeSet
	//    (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html)
	//    API operation.
	//
	//    * False - if the stack creation fails, roll back the stack. This is equivalent
	//    to specifying ROLLBACK for the OnStackFailure parameter to the CreateChangeSet
	//    (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html)
	//    API operation.
	//
	// Default: True
	DisableRollback *bool `type:"boolean"`

	// 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 `type:"boolean"`

	// If you specified the name of a change set, specify the stack name or Amazon
	// Resource Name (ARN) that's associated with the change set you want to execute.
	StackName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The input for the ExecuteChangeSet action.

func (ExecuteChangeSetInput) GoString added in v1.1.15 

func (s ExecuteChangeSetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecuteChangeSetInput) SetChangeSetName added in v1.5.0 

func (s *ExecuteChangeSetInput) SetChangeSetName(v string) *ExecuteChangeSetInput

SetChangeSetName sets the ChangeSetName field's value.

func (*ExecuteChangeSetInput) SetClientRequestToken added in v1.8.18 

func (s *ExecuteChangeSetInput) SetClientRequestToken(v string) *ExecuteChangeSetInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*ExecuteChangeSetInput) SetDisableRollback added in v1.40.33 

func (s *ExecuteChangeSetInput) SetDisableRollback(v bool) *ExecuteChangeSetInput

SetDisableRollback sets the DisableRollback field's value.

func (*ExecuteChangeSetInput) SetRetainExceptOnCreate added in v1.44.312 

func (s *ExecuteChangeSetInput) SetRetainExceptOnCreate(v bool) *ExecuteChangeSetInput

SetRetainExceptOnCreate sets the RetainExceptOnCreate field's value.

func (*ExecuteChangeSetInput) SetStackName added in v1.5.0 

func (s *ExecuteChangeSetInput) SetStackName(v string) *ExecuteChangeSetInput

SetStackName sets the StackName field's value.

func (ExecuteChangeSetInput) String added in v1.1.15 

func (s ExecuteChangeSetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecuteChangeSetInput) Validate added in v1.1.21 

func (s *ExecuteChangeSetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExecuteChangeSetOutput added in v1.1.15 

type ExecuteChangeSetOutput struct {
	// contains filtered or unexported fields
}

The output for the ExecuteChangeSet action.

func (ExecuteChangeSetOutput) GoString added in v1.1.15 

func (s ExecuteChangeSetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (ExecuteChangeSetOutput) String added in v1.1.15 

func (s ExecuteChangeSetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Export added in v1.5.0 

type Export struct {

	// The stack that contains the exported output name and value.
	ExportingStackId *string `type:"string"`

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

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

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

func (Export) GoString added in v1.5.0 

func (s Export) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Export) SetExportingStackId added in v1.5.0 

func (s *Export) SetExportingStackId(v string) *Export

SetExportingStackId sets the ExportingStackId field's value.

func (*Export) SetName added in v1.5.0 

func (s *Export) SetName(v string) *Export

SetName sets the Name field's value.

func (*Export) SetValue added in v1.5.0 

func (s *Export) SetValue(v string) *Export

SetValue sets the Value field's value.

func (Export) String added in v1.5.0 

func (s Export) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetStackPolicyInput 

type GetStackPolicyInput struct {

	// The name or unique stack ID that's associated with the stack whose policy
	// you want to get.
	//
	// StackName is a required field
	StackName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the GetStackPolicy action.

func (GetStackPolicyInput) GoString added in v0.6.5 

func (s GetStackPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetStackPolicyInput) SetStackName added in v1.5.0 

func (s *GetStackPolicyInput) SetStackName(v string) *GetStackPolicyInput

SetStackName sets the StackName field's value.

func (GetStackPolicyInput) String added in v0.6.5 

func (s GetStackPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetStackPolicyInput) Validate added in v1.1.21 

func (s *GetStackPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetStackPolicyOutput 

type GetStackPolicyOutput struct {

	// Structure containing the stack policy body. (For more information, go to
	// Prevent Updates to Stack Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html)
	// in the CloudFormation User Guide.)
	StackPolicyBody *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The output for the GetStackPolicy action.

func (GetStackPolicyOutput) GoString added in v0.6.5 

func (s GetStackPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetStackPolicyOutput) SetStackPolicyBody added in v1.5.0 

func (s *GetStackPolicyOutput) SetStackPolicyBody(v string) *GetStackPolicyOutput

SetStackPolicyBody sets the StackPolicyBody field's value.

func (GetStackPolicyOutput) String added in v0.6.5 

func (s GetStackPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetTemplateInput 

type GetTemplateInput struct {

	// The name or Amazon Resource Name (ARN) of a change set for which CloudFormation
	// returns the associated template. If you specify a name, you must also specify
	// the StackName.
	ChangeSetName *string `min:"1" type:"string"`

	// The name or the unique stack ID that's associated with the stack, which aren't
	// always interchangeable:
	//
	//    * Running stacks: You can specify either the stack's name or its unique
	//    stack ID.
	//
	//    * Deleted stacks: You must specify the unique stack ID.
	//
	// Default: There is no default value.
	StackName *string `type:"string"`

	// For templates that include transforms, the stage of the template that CloudFormation
	// returns. To get the user-submitted template, specify Original. To get the
	// template after CloudFormation has processed all transforms, specify Processed.
	//
	// If the template doesn't include transforms, Original and Processed return
	// the same template. By default, CloudFormation specifies Processed.
	TemplateStage *string `type:"string" enum:"TemplateStage"`
	// contains filtered or unexported fields
}

The input for a GetTemplate action.

func (GetTemplateInput) GoString added in v0.6.5 

func (s GetTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTemplateInput) SetChangeSetName added in v1.5.0 

func (s *GetTemplateInput) SetChangeSetName(v string) *GetTemplateInput

SetChangeSetName sets the ChangeSetName field's value.

func (*GetTemplateInput) SetStackName added in v1.5.0 

func (s *GetTemplateInput) SetStackName(v string) *GetTemplateInput

SetStackName sets the StackName field's value.

func (*GetTemplateInput) SetTemplateStage added in v1.5.0 

func (s *GetTemplateInput) SetTemplateStage(v string) *GetTemplateInput

SetTemplateStage sets the TemplateStage field's value.

func (GetTemplateInput) String added in v0.6.5 

func (s GetTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTemplateInput) Validate added in v1.1.21 

func (s *GetTemplateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetTemplateOutput 

type GetTemplateOutput struct {

	// The stage of the template that you can retrieve. For stacks, the Original
	// and Processed templates are always available. For change sets, the Original
	// template is always available. After CloudFormation finishes creating the
	// change set, the Processed template becomes available.
	StagesAvailable []*string `type:"list" enum:"TemplateStage"`

	// Structure containing the template body. (For more information, go to Template
	// Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
	// in the CloudFormation User Guide.)
	//
	// CloudFormation returns the same template that was used when the stack was
	// created.
	TemplateBody *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The output for GetTemplate action.

func (GetTemplateOutput) GoString added in v0.6.5 

func (s GetTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTemplateOutput) SetStagesAvailable added in v1.5.0 

func (s *GetTemplateOutput) SetStagesAvailable(v []*string) *GetTemplateOutput

SetStagesAvailable sets the StagesAvailable field's value.

func (*GetTemplateOutput) SetTemplateBody added in v1.5.0 

func (s *GetTemplateOutput) SetTemplateBody(v string) *GetTemplateOutput

SetTemplateBody sets the TemplateBody field's value.

func (GetTemplateOutput) String added in v0.6.5 

func (s GetTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetTemplateSummaryInput 

type GetTemplateSummaryInput struct {

	// [Service-managed permissions] Specifies whether you are acting as an account
	// administrator in the organization's management account or as a delegated
	// administrator in a member account.
	//
	// By default, SELF is specified. Use SELF for stack sets with self-managed
	// permissions.
	//
	//    * If you are signed in to the management account, specify SELF.
	//
	//    * If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
	//    Your Amazon Web Services account must be registered as a delegated administrator
	//    in the management account. For more information, see Register a delegated
	//    administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html)
	//    in the CloudFormation User Guide.
	CallAs *string `type:"string" enum:"CallAs"`

	// The name or the stack ID that's associated with the stack, which aren't always
	// interchangeable. For running stacks, you can specify either the stack's name
	// or its unique stack ID. For deleted stack, you must specify the unique stack
	// ID.
	//
	// Conditional: You must specify only one of the following parameters: StackName,
	// StackSetName, TemplateBody, or TemplateURL.
	StackName *string `min:"1" type:"string"`

	// The name or unique ID of the stack set from which the stack was created.
	//
	// Conditional: You must specify only one of the following parameters: StackName,
	// StackSetName, TemplateBody, or TemplateURL.
	StackSetName *string `type:"string"`

	// Structure containing the template body with a minimum length of 1 byte and
	// a maximum length of 51,200 bytes. For more information about templates, see
	// Template anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
	// in the CloudFormation User Guide.
	//
	// Conditional: You must specify only one of the following parameters: StackName,
	// StackSetName, TemplateBody, or TemplateURL.
	TemplateBody *string `min:"1" type:"string"`

	// Specifies options for the GetTemplateSummary API action.
	TemplateSummaryConfig *TemplateSummaryConfig `type:"structure"`

	// Location of file containing the template body. The URL must point to a template
	// (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems
	// Manager document. For more information about templates, see Template anatomy
	// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
	// in the CloudFormation User Guide.
	//
	// Conditional: You must specify only one of the following parameters: StackName,
	// StackSetName, TemplateBody, or TemplateURL.
	TemplateURL *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The input for the GetTemplateSummary action.

func (GetTemplateSummaryInput) GoString added in v0.6.5 

func (s GetTemplateSummaryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTemplateSummaryInput) SetCallAs added in v1.38.28 

func (s *GetTemplateSummaryInput) SetCallAs(v string) *GetTemplateSummaryInput

SetCallAs sets the CallAs field's value.

func (*GetTemplateSummaryInput) SetStackName added in v1.5.0 

func (s *GetTemplateSummaryInput) SetStackName(v string) *GetTemplateSummaryInput

SetStackName sets the StackName field's value.

func (*GetTemplateSummaryInput) SetStackSetName added in v1.10.16 

func (s *GetTemplateSummaryInput) SetStackSetName(v string) *GetTemplateSummaryInput

SetStackSetName sets the StackSetName field's value.

func (*GetTemplateSummaryInput) SetTemplateBody added in v1.5.0 

func (s *GetTemplateSummaryInput) SetTemplateBody(v string) *GetTemplateSummaryInput

SetTemplateBody sets the TemplateBody field's value.

func (*GetTemplateSummaryInput) SetTemplateSummaryConfig added in v1.44.303 

func (s *GetTemplateSummaryInput) SetTemplateSummaryConfig(v *TemplateSummaryConfig) *GetTemplateSummaryInput

SetTemplateSummaryConfig sets the TemplateSummaryConfig field's value.

func (*GetTemplateSummaryInput) SetTemplateURL added in v1.5.0 

func (s *GetTemplateSummaryInput) SetTemplateURL(v string) *GetTemplateSummaryInput

SetTemplateURL sets the TemplateURL field's value.

func (GetTemplateSummaryInput) String added in v0.6.5 

func (s GetTemplateSummaryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTemplateSummaryInput) Validate added in v1.1.21 

func (s *GetTemplateSummaryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetTemplateSummaryOutput 

type GetTemplateSummaryOutput struct {

	// The capabilities found within the template. If your template contains IAM
	// resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value
	// for this parameter when you use the CreateStack or UpdateStack actions with
	// your template; otherwise, those actions return an InsufficientCapabilities
	// error.
	//
	// For more information, see Acknowledging IAM Resources in CloudFormation Templates
	// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities).
	Capabilities []*string `type:"list" enum:"Capability"`

	// The list of resources that generated the values in the Capabilities response
	// element.
	CapabilitiesReason *string `type:"string"`

	// A list of the transforms that are declared in the template.
	DeclaredTransforms []*string `type:"list"`

	// The value that's defined in the Description property of the template.
	Description *string `min:"1" type:"string"`

	// The value that's defined for the Metadata property of the template.
	Metadata *string `type:"string"`

	// A list of parameter declarations that describe various properties for each
	// parameter.
	Parameters []*ParameterDeclaration `type:"list"`

	// A list of resource identifier summaries that describe the target resources
	// of an import operation and the properties you can provide during the import
	// to identify the target resources. For example, BucketName is a possible identifier
	// property for an AWS::S3::Bucket resource.
	ResourceIdentifierSummaries []*ResourceIdentifierSummary `type:"list"`

	// A list of all the template resource types that are defined in the template,
	// such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.
	ResourceTypes []*string `type:"list"`

	// The Amazon Web Services template format version, which identifies the capabilities
	// of the template.
	Version *string `type:"string"`

	// An object containing any warnings returned.
	Warnings *Warnings `type:"structure"`
	// contains filtered or unexported fields
}

The output for the GetTemplateSummary action.

func (GetTemplateSummaryOutput) GoString added in v0.6.5 

func (s GetTemplateSummaryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTemplateSummaryOutput) SetCapabilities added in v1.5.0 

func (s *GetTemplateSummaryOutput) SetCapabilities(v []*string) *GetTemplateSummaryOutput

SetCapabilities sets the Capabilities field's value.

func (*GetTemplateSummaryOutput) SetCapabilitiesReason added in v1.5.0 

func (s *GetTemplateSummaryOutput) SetCapabilitiesReason(v string) *GetTemplateSummaryOutput

SetCapabilitiesReason sets the CapabilitiesReason field's value.

func (*GetTemplateSummaryOutput) SetDeclaredTransforms added in v1.5.0 

func (s *GetTemplateSummaryOutput) SetDeclaredTransforms(v []*string) *GetTemplateSummaryOutput

SetDeclaredTransforms sets the DeclaredTransforms field's value.

func (*GetTemplateSummaryOutput) SetDescription added in v1.5.0 

func (s *GetTemplateSummaryOutput) SetDescription(v string) *GetTemplateSummaryOutput

SetDescription sets the Description field's value.

func (*GetTemplateSummaryOutput) SetMetadata added in v1.5.0 

func (s *GetTemplateSummaryOutput) SetMetadata(v string) *GetTemplateSummaryOutput

SetMetadata sets the Metadata field's value.

func (*GetTemplateSummaryOutput) SetParameters added in v1.5.0 

func (s *GetTemplateSummaryOutput) SetParameters(v []*ParameterDeclaration) *GetTemplateSummaryOutput

SetParameters sets the Parameters field's value.

func (*GetTemplateSummaryOutput) SetResourceIdentifierSummaries added in v1.25.32 

func (s *GetTemplateSummaryOutput) SetResourceIdentifierSummaries(v []*ResourceIdentifierSummary) *GetTemplateSummaryOutput

SetResourceIdentifierSummaries sets the ResourceIdentifierSummaries field's value.

func (*GetTemplateSummaryOutput) SetResourceTypes added in v1.5.0 

func (s *GetTemplateSummaryOutput) SetResourceTypes(v []*string) *GetTemplateSummaryOutput

SetResourceTypes sets the ResourceTypes field's value.

func (*GetTemplateSummaryOutput) SetVersion added in v1.5.0 

func (s *GetTemplateSummaryOutput) SetVersion(v string) *GetTemplateSummaryOutput

SetVersion sets the Version field's value.

func (*GetTemplateSummaryOutput) SetWarnings added in v1.44.303 

func (s *GetTemplateSummaryOutput) SetWarnings(v *Warnings) *GetTemplateSummaryOutput

SetWarnings sets the Warnings field's value.

func (GetTemplateSummaryOutput) String added in v0.6.5 

func (s GetTemplateSummaryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ImportStacksToStackSetInput added in v1.40.10 

type ImportStacksToStackSetInput struct {

	// By default, SELF is specified. Use SELF for stack sets with self-managed
	// permissions.
	//
	//    * If you are signed in to the management account, specify SELF.
	//
	//    * For service managed stack sets, specify DELEGATED_ADMIN.
	CallAs *string `type:"string" enum:"CallAs"`

	// A unique, user defined, identifier for the stack set operation.
	OperationId *string `min:"1" type:"string" idempotencyToken:"true"`

	// 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options).
	OperationPreferences *StackSetOperationPreferences `type:"structure"`

	// The list of OU ID's to which the stacks being imported has to be mapped as
	// deployment target.
	OrganizationalUnitIds []*string `type:"list"`

	// The IDs of the stacks you are importing into a stack set. You import up to
	// 10 stacks per stack set at a time.
	//
	// Specify either StackIds or StackIdsUrl.
	StackIds []*string `type:"list"`

	// The Amazon S3 URL which contains list of stack ids to be inputted.
	//
	// Specify either StackIds or StackIdsUrl.
	StackIdsUrl *string `min:"1" type:"string"`

	// The name of the stack set. The name must be unique in the Region where you
	// create your stack set.
	//
	// StackSetName is a required field
	StackSetName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ImportStacksToStackSetInput) GoString added in v1.40.10 

func (s ImportStacksToStackSetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportStacksToStackSetInput) SetCallAs added in v1.40.10 

func (s *ImportStacksToStackSetInput) SetCallAs(v string) *ImportStacksToStackSetInput

SetCallAs sets the CallAs field's value.

func (*ImportStacksToStackSetInput) SetOperationId added in v1.40.10 

func (s *ImportStacksToStackSetInput) SetOperationId(v string) *ImportStacksToStackSetInput

SetOperationId sets the OperationId field's value.

func (*ImportStacksToStackSetInput) SetOperationPreferences added in v1.40.10 

func (s *ImportStacksToStackSetInput) SetOperationPreferences(v *StackSetOperationPreferences) *ImportStacksToStackSetInput

SetOperationPreferences sets the OperationPreferences field's value.

func (*ImportStacksToStackSetInput) SetOrganizationalUnitIds added in v1.42.10 

func (s *ImportStacksToStackSetInput) SetOrganizationalUnitIds(v []*string) *ImportStacksToStackSetInput

SetOrganizationalUnitIds sets the OrganizationalUnitIds field's value.

func (*ImportStacksToStackSetInput) SetStackIds added in v1.40.10 

func (s *ImportStacksToStackSetInput) SetStackIds(v []*string) *ImportStacksToStackSetInput

SetStackIds sets the StackIds field's value.

func (*ImportStacksToStackSetInput) SetStackIdsUrl added in v1.42.10 

func (s *ImportStacksToStackSetInput) SetStackIdsUrl(v string) *ImportStacksToStackSetInput

SetStackIdsUrl sets the StackIdsUrl field's value.

func (*ImportStacksToStackSetInput) SetStackSetName added in v1.40.10 

func (s *ImportStacksToStackSetInput) SetStackSetName(v string) *ImportStacksToStackSetInput

SetStackSetName sets the StackSetName field's value.

func (ImportStacksToStackSetInput) String added in v1.40.10 

func (s ImportStacksToStackSetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportStacksToStackSetInput) Validate added in v1.40.10 

func (s *ImportStacksToStackSetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ImportStacksToStackSetOutput added in v1.40.10 

type ImportStacksToStackSetOutput struct {

	// The unique identifier for the stack set operation.
	OperationId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ImportStacksToStackSetOutput) GoString added in v1.40.10 

func (s ImportStacksToStackSetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportStacksToStackSetOutput) SetOperationId added in v1.40.10 

func (s *ImportStacksToStackSetOutput) SetOperationId(v string) *ImportStacksToStackSetOutput

SetOperationId sets the OperationId field's value.

func (ImportStacksToStackSetOutput) String added in v1.40.10 

func (s ImportStacksToStackSetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListChangeSetsInput added in v1.1.15 

type ListChangeSetsInput struct {

	// A string (provided by the ListChangeSets response output) that identifies
	// the next page of change sets that you want to retrieve.
	NextToken *string `min:"1" type:"string"`

	// The name or the Amazon Resource Name (ARN) of the stack for which you want
	// to list change sets.
	//
	// StackName is a required field
	StackName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the ListChangeSets action.

func (ListChangeSetsInput) GoString added in v1.1.15 

func (s ListChangeSetsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListChangeSetsInput) SetNextToken added in v1.5.0 

func (s *ListChangeSetsInput) SetNextToken(v string) *ListChangeSetsInput

SetNextToken sets the NextToken field's value.

func (*ListChangeSetsInput) SetStackName added in v1.5.0 

func (s *ListChangeSetsInput) SetStackName(v string) *ListChangeSetsInput

SetStackName sets the StackName field's value.

func (ListChangeSetsInput) String added in v1.1.15 

func (s ListChangeSetsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListChangeSetsInput) Validate added in v1.1.21 

func (s *ListChangeSetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListChangeSetsOutput added in v1.1.15 

type ListChangeSetsOutput struct {

	// If the output exceeds 1 MB, a string that identifies the next page of change
	// sets. If there is no additional page, this value is null.
	NextToken *string `min:"1" type:"string"`

	// A list of ChangeSetSummary structures that provides the ID and status of
	// each change set for the specified stack.
	Summaries []*ChangeSetSummary `type:"list"`
	// contains filtered or unexported fields
}

The output for the ListChangeSets action.

func (ListChangeSetsOutput) GoString added in v1.1.15 

func (s ListChangeSetsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListChangeSetsOutput) SetNextToken added in v1.5.0 

func (s *ListChangeSetsOutput) SetNextToken(v string) *ListChangeSetsOutput

SetNextToken sets the NextToken field's value.

func (*ListChangeSetsOutput) SetSummaries added in v1.5.0 

func (s *ListChangeSetsOutput) SetSummaries(v []*ChangeSetSummary) *ListChangeSetsOutput

SetSummaries sets the Summaries field's value.

func (ListChangeSetsOutput) String added in v1.1.15 

func (s ListChangeSetsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListExportsInput added in v1.5.0 

type ListExportsInput struct {

	// A string (provided by the ListExports response output) that identifies the
	// next page of exported output values that you asked to retrieve.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListExportsInput) GoString added in v1.5.0 

func (s ListExportsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListExportsInput) SetNextToken added in v1.5.0 

func (s *ListExportsInput) SetNextToken(v string) *ListExportsInput

SetNextToken sets the NextToken field's value.

func (ListExportsInput) String added in v1.5.0 

func (s ListExportsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListExportsInput) Validate added in v1.5.0 

func (s *ListExportsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListExportsOutput added in v1.5.0 

type ListExportsOutput struct {

	// The output for the ListExports action.
	Exports []*Export `type:"list"`

	// If the output exceeds 100 exported output values, a string that identifies
	// the next page of exports. If there is no additional page, this value is null.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListExportsOutput) GoString added in v1.5.0 

func (s ListExportsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListExportsOutput) SetExports added in v1.5.0 

func (s *ListExportsOutput) SetExports(v []*Export) *ListExportsOutput

SetExports sets the Exports field's value.

func (*ListExportsOutput) SetNextToken added in v1.5.0 

func (s *ListExportsOutput) SetNextToken(v string) *ListExportsOutput

SetNextToken sets the NextToken field's value.

func (ListExportsOutput) String added in v1.5.0 

func (s ListExportsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListImportsInput added in v1.5.10 

type ListImportsInput struct {

	// The name of the exported output value. CloudFormation returns the stack names
	// that are importing this value.
	//
	// ExportName is a required field
	ExportName *string `type:"string" required:"true"`

	// A string (provided by the ListImports response output) that identifies the
	// next page of stacks that are importing the specified exported output value.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListImportsInput) GoString added in v1.5.10 

func (s ListImportsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListImportsInput) SetExportName added in v1.5.10 

func (s *ListImportsInput) SetExportName(v string) *ListImportsInput

SetExportName sets the ExportName field's value.

func (*ListImportsInput) SetNextToken added in v1.5.10 

func (s *ListImportsInput) SetNextToken(v string) *ListImportsInput

SetNextToken sets the NextToken field's value.

func (ListImportsInput) String added in v1.5.10 

func (s ListImportsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListImportsInput) Validate added in v1.5.10 

func (s *ListImportsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListImportsOutput added in v1.5.10 

type ListImportsOutput struct {

	// A list of stack names that are importing the specified exported output value.
	Imports []*string `type:"list"`

	// A string that identifies the next page of exports. If there is no additional
	// page, this value is null.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListImportsOutput) GoString added in v1.5.10 

func (s ListImportsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListImportsOutput) SetImports added in v1.5.10 

func (s *ListImportsOutput) SetImports(v []*string) *ListImportsOutput

SetImports sets the Imports field's value.

func (*ListImportsOutput) SetNextToken added in v1.5.10 

func (s *ListImportsOutput) SetNextToken(v string) *ListImportsOutput

SetNextToken sets the NextToken field's value.

func (ListImportsOutput) String added in v1.5.10 

func (s ListImportsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListStackInstanceResourceDriftsInput added in v1.44.307 

type ListStackInstanceResourceDriftsInput struct {

	// [Service-managed permissions] Specifies whether you are acting as an account
	// administrator in the organization's management account or as a delegated
	// administrator in a member account.
	//
	// By default, SELF is specified. Use SELF for stack sets with self-managed
	// permissions.
	//
	//    * If you are signed in to the management account, specify SELF.
	//
	//    * If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
	//    Your Amazon Web Services account must be registered as a delegated administrator
	//    in the management account. For more information, see Register a delegated
	//    administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html)
	//    in the CloudFormation User Guide.
	CallAs *string `type:"string" enum:"CallAs"`

	// The maximum number of results to be returned with a single call. If the number
	// of available results exceeds this maximum, the response includes a NextToken
	// value that you can assign to the NextToken request parameter to get the next
	// set of results.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the previous paginated request didn't return all of the remaining results,
	// the response object's NextToken parameter value is set to a token. To retrieve
	// the next set of results, call this action again and assign that token to
	// the request object's NextToken parameter. If there are no remaining results,
	// the previous response object's NextToken parameter is set to null.
	NextToken *string `min:"1" type:"string"`

	// The unique ID of the drift operation.
	//
	// OperationId is a required field
	OperationId *string `min:"1" type:"string" required:"true"`

	// The name of the Amazon Web Services account that you want to list resource
	// drifts for.
	//
	// StackInstanceAccount is a required field
	StackInstanceAccount *string `type:"string" required:"true"`

	// The name of the Region where you want to list resource drifts.
	//
	// StackInstanceRegion is a required field
	StackInstanceRegion *string `type:"string" required:"true"`

	// The resource drift status of the 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.
	StackInstanceResourceDriftStatuses []*string `min:"1" type:"list" enum:"StackResourceDriftStatus"`

	// The name or unique ID of the stack set that you want to list drifted resources
	// for.
	//
	// StackSetName is a required field
	StackSetName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListStackInstanceResourceDriftsInput) GoString added in v1.44.307 

func (s ListStackInstanceResourceDriftsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStackInstanceResourceDriftsInput) SetCallAs added in v1.44.307 

func (s *ListStackInstanceResourceDriftsInput) SetCallAs(v string) *ListStackInstanceResourceDriftsInput

SetCallAs sets the CallAs field's value.

func (*ListStackInstanceResourceDriftsInput) SetMaxResults added in v1.44.307 

func (s *ListStackInstanceResourceDriftsInput) SetMaxResults(v int64) *ListStackInstanceResourceDriftsInput

SetMaxResults sets the MaxResults field's value.

func (*ListStackInstanceResourceDriftsInput) SetNextToken added in v1.44.307 

func (s *ListStackInstanceResourceDriftsInput) SetNextToken(v string) *ListStackInstanceResourceDriftsInput

SetNextToken sets the NextToken field's value.

func (*ListStackInstanceResourceDriftsInput) SetOperationId added in v1.44.307 

func (s *ListStackInstanceResourceDriftsInput) SetOperationId(v string) *ListStackInstanceResourceDriftsInput

SetOperationId sets the OperationId field's value.

func (*ListStackInstanceResourceDriftsInput) SetStackInstanceAccount added in v1.44.307 

func (s *ListStackInstanceResourceDriftsInput) SetStackInstanceAccount(v string) *ListStackInstanceResourceDriftsInput

SetStackInstanceAccount sets the StackInstanceAccount field's value.

func (*ListStackInstanceResourceDriftsInput) SetStackInstanceRegion added in v1.44.307 

func (s *ListStackInstanceResourceDriftsInput) SetStackInstanceRegion(v string) *ListStackInstanceResourceDriftsInput

SetStackInstanceRegion sets the StackInstanceRegion field's value.

func (*ListStackInstanceResourceDriftsInput) SetStackInstanceResourceDriftStatuses added in v1.44.307 

func (s *ListStackInstanceResourceDriftsInput) SetStackInstanceResourceDriftStatuses(v []*string) *ListStackInstanceResourceDriftsInput

SetStackInstanceResourceDriftStatuses sets the StackInstanceResourceDriftStatuses field's value.

func (*ListStackInstanceResourceDriftsInput) SetStackSetName added in v1.44.307 

func (s *ListStackInstanceResourceDriftsInput) SetStackSetName(v string) *ListStackInstanceResourceDriftsInput

SetStackSetName sets the StackSetName field's value.

func (ListStackInstanceResourceDriftsInput) String added in v1.44.307 

func (s ListStackInstanceResourceDriftsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStackInstanceResourceDriftsInput) Validate added in v1.44.307 

func (s *ListStackInstanceResourceDriftsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListStackInstanceResourceDriftsOutput added in v1.44.307 

type ListStackInstanceResourceDriftsOutput struct {

	// If the previous paginated request didn't return all of the remaining results,
	// the response object's NextToken parameter value is set to a token. To retrieve
	// the next set of results, call this action again and assign that token to
	// the request object's NextToken parameter. If there are no remaining results,
	// the previous response object's NextToken parameter is set to null.
	NextToken *string `min:"1" type:"string"`

	// A list of StackInstanceResourceDriftSummary structures that contain information
	// about the specified stack instances.
	Summaries []*StackInstanceResourceDriftsSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListStackInstanceResourceDriftsOutput) GoString added in v1.44.307 

func (s ListStackInstanceResourceDriftsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStackInstanceResourceDriftsOutput) SetNextToken added in v1.44.307 

func (s *ListStackInstanceResourceDriftsOutput) SetNextToken(v string) *ListStackInstanceResourceDriftsOutput

SetNextToken sets the NextToken field's value.

func (*ListStackInstanceResourceDriftsOutput) SetSummaries added in v1.44.307 

func (s *ListStackInstanceResourceDriftsOutput) SetSummaries(v []*StackInstanceResourceDriftsSummary) *ListStackInstanceResourceDriftsOutput

SetSummaries sets the Summaries field's value.

func (ListStackInstanceResourceDriftsOutput) String added in v1.44.307 

func (s ListStackInstanceResourceDriftsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListStackInstancesInput added in v1.10.16 

type ListStackInstancesInput struct {

	// [Service-managed permissions] Specifies whether you are acting as an account
	// administrator in the organization's management account or as a delegated
	// administrator in a member account.
	//
	// By default, SELF is specified. Use SELF for stack sets with self-managed
	// permissions.
	//
	//    * If you are signed in to the management account, specify SELF.
	//
	//    * If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
	//    Your Amazon Web Services account must be registered as a delegated administrator
	//    in the management account. For more information, see Register a delegated
	//    administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html)
	//    in the CloudFormation User Guide.
	CallAs *string `type:"string" enum:"CallAs"`

	// The filter to apply to stack instances
	Filters []*StackInstanceFilter `type:"list"`

	// The maximum number of results to be returned with a single call. If the number
	// of available results exceeds this maximum, the response includes a NextToken
	// value that you can assign to the NextToken request parameter to get the next
	// set of results.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the previous request didn't return all the remaining results, the response's
	// NextToken parameter value is set to a token. To retrieve the next set of
	// results, call ListStackInstances again and assign that token to the request
	// object's NextToken parameter. If there are no remaining results, the previous
	// response object's NextToken parameter is set to null.
	NextToken *string `min:"1" type:"string"`

	// The name of the Amazon Web Services account that you want to list stack instances
	// for.
	StackInstanceAccount *string `type:"string"`

	// The name of the Region where you want to list stack instances.
	StackInstanceRegion *string `type:"string"`

	// The name or unique ID of the stack set that you want to list stack instances
	// for.
	//
	// StackSetName is a required field
	StackSetName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListStackInstancesInput) GoString added in v1.10.16 

func (s ListStackInstancesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStackInstancesInput) SetCallAs added in v1.37.14 

func (s *ListStackInstancesInput) SetCallAs(v string) *ListStackInstancesInput

SetCallAs sets the CallAs field's value.

func (*ListStackInstancesInput) SetFilters added in v1.32.11 

func (s *ListStackInstancesInput) SetFilters(v []*StackInstanceFilter) *ListStackInstancesInput

SetFilters sets the Filters field's value.

func (*ListStackInstancesInput) SetMaxResults added in v1.10.16 

func (s *ListStackInstancesInput) SetMaxResults(v int64) *ListStackInstancesInput

SetMaxResults sets the MaxResults field's value.

func (*ListStackInstancesInput) SetNextToken added in v1.10.16 

func (s *ListStackInstancesInput) SetNextToken(v string) *ListStackInstancesInput

SetNextToken sets the NextToken field's value.

func (*ListStackInstancesInput) SetStackInstanceAccount added in v1.10.16 

func (s *ListStackInstancesInput) SetStackInstanceAccount(v string) *ListStackInstancesInput

SetStackInstanceAccount sets the StackInstanceAccount field's value.

func (*ListStackInstancesInput) SetStackInstanceRegion added in v1.10.16 

func (s *ListStackInstancesInput) SetStackInstanceRegion(v string) *ListStackInstancesInput

SetStackInstanceRegion sets the StackInstanceRegion field's value.

func (*ListStackInstancesInput) SetStackSetName added in v1.10.16 

func (s *ListStackInstancesInput) SetStackSetName(v string) *ListStackInstancesInput

SetStackSetName sets the StackSetName field's value.

func (ListStackInstancesInput) String added in v1.10.16 

func (s ListStackInstancesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStackInstancesInput) Validate added in v1.10.16 

func (s *ListStackInstancesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListStackInstancesOutput added in v1.10.16 

type ListStackInstancesOutput struct {

	// If the request doesn't return all the remaining results, NextToken is set
	// to a token. To retrieve the next set of results, call ListStackInstances
	// again and assign that token to the request object's NextToken parameter.
	// If the request returns all results, NextToken is set to null.
	NextToken *string `min:"1" type:"string"`

	// A list of StackInstanceSummary structures that contain information about
	// the specified stack instances.
	Summaries []*StackInstanceSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListStackInstancesOutput) GoString added in v1.10.16 

func (s ListStackInstancesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStackInstancesOutput) SetNextToken added in v1.10.16 

func (s *ListStackInstancesOutput) SetNextToken(v string) *ListStackInstancesOutput

SetNextToken sets the NextToken field's value.

func (*ListStackInstancesOutput) SetSummaries added in v1.10.16 

func (s *ListStackInstancesOutput) SetSummaries(v []*StackInstanceSummary) *ListStackInstancesOutput

SetSummaries sets the Summaries field's value.

func (ListStackInstancesOutput) String added in v1.10.16 

func (s ListStackInstancesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListStackResourcesInput 

type ListStackResourcesInput struct {

	// A string that identifies the next page of stack resources that you want to
	// retrieve.
	NextToken *string `min:"1" type:"string"`

	// The name or the unique stack ID that is associated with the stack, which
	// aren't always interchangeable:
	//
	//    * Running stacks: You can specify either the stack's name or its unique
	//    stack ID.
	//
	//    * Deleted stacks: You must specify the unique stack ID.
	//
	// Default: There is no default value.
	//
	// StackName is a required field
	StackName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the ListStackResource action.

func (ListStackResourcesInput) GoString added in v0.6.5 

func (s ListStackResourcesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStackResourcesInput) SetNextToken added in v1.5.0 

func (s *ListStackResourcesInput) SetNextToken(v string) *ListStackResourcesInput

SetNextToken sets the NextToken field's value.

func (*ListStackResourcesInput) SetStackName added in v1.5.0 

func (s *ListStackResourcesInput) SetStackName(v string) *ListStackResourcesInput

SetStackName sets the StackName field's value.

func (ListStackResourcesInput) String added in v0.6.5 

func (s ListStackResourcesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStackResourcesInput) Validate added in v1.1.21 

func (s *ListStackResourcesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListStackResourcesOutput 

type ListStackResourcesOutput struct {

	// If the output exceeds 1 MB, a string that identifies the next page of stack
	// resources. If no additional page exists, this value is null.
	NextToken *string `min:"1" type:"string"`

	// A list of StackResourceSummary structures.
	StackResourceSummaries []*StackResourceSummary `type:"list"`
	// contains filtered or unexported fields
}

The output for a ListStackResources action.

func (ListStackResourcesOutput) GoString added in v0.6.5 

func (s ListStackResourcesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStackResourcesOutput) SetNextToken added in v1.5.0 

func (s *ListStackResourcesOutput) SetNextToken(v string) *ListStackResourcesOutput

SetNextToken sets the NextToken field's value.

func (*ListStackResourcesOutput) SetStackResourceSummaries added in v1.5.0 

func (s *ListStackResourcesOutput) SetStackResourceSummaries(v []*StackResourceSummary) *ListStackResourcesOutput

SetStackResourceSummaries sets the StackResourceSummaries field's value.

func (ListStackResourcesOutput) String added in v0.6.5 

func (s ListStackResourcesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListStackSetOperationResultsInput added in v1.10.16 

type ListStackSetOperationResultsInput struct {

	// [Service-managed permissions] Specifies whether you are acting as an account
	// administrator in the organization's management account or as a delegated
	// administrator in a member account.
	//
	// By default, SELF is specified. Use SELF for stack sets with self-managed
	// permissions.
	//
	//    * If you are signed in to the management account, specify SELF.
	//
	//    * If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
	//    Your Amazon Web Services account must be registered as a delegated administrator
	//    in the management account. For more information, see Register a delegated
	//    administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html)
	//    in the CloudFormation User Guide.
	CallAs *string `type:"string" enum:"CallAs"`

	// The filter to apply to operation results.
	Filters []*OperationResultFilter `type:"list"`

	// The maximum number of results to be returned with a single call. If the number
	// of available results exceeds this maximum, the response includes a NextToken
	// value that you can assign to the NextToken request parameter to get the next
	// set of results.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the previous request didn't return all the remaining results, the response
	// object's NextToken parameter value is set to a token. To retrieve the next
	// set of results, call ListStackSetOperationResults again and assign that token
	// to the request object's NextToken parameter. If there are no remaining results,
	// the previous response object's NextToken parameter is set to null.
	NextToken *string `min:"1" type:"string"`

	// The ID of the stack set operation.
	//
	// OperationId is a required field
	OperationId *string `min:"1" type:"string" required:"true"`

	// The name or unique ID of the stack set that you want to get operation results
	// for.
	//
	// StackSetName is a required field
	StackSetName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListStackSetOperationResultsInput) GoString added in v1.10.16 

func (s ListStackSetOperationResultsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStackSetOperationResultsInput) SetCallAs added in v1.37.14 

func (s *ListStackSetOperationResultsInput) SetCallAs(v string) *ListStackSetOperationResultsInput

SetCallAs sets the CallAs field's value.

func (*ListStackSetOperationResultsInput) SetFilters added in v1.44.126 

func (s *ListStackSetOperationResultsInput) SetFilters(v []*OperationResultFilter) *ListStackSetOperationResultsInput

SetFilters sets the Filters field's value.

func (*ListStackSetOperationResultsInput) SetMaxResults added in v1.10.16 

func (s *ListStackSetOperationResultsInput) SetMaxResults(v int64) *ListStackSetOperationResultsInput

SetMaxResults sets the MaxResults field's value.

func (*ListStackSetOperationResultsInput) SetNextToken added in v1.10.16 

func (s *ListStackSetOperationResultsInput) SetNextToken(v string) *ListStackSetOperationResultsInput

SetNextToken sets the NextToken field's value.

func (*ListStackSetOperationResultsInput) SetOperationId added in v1.10.16 

func (s *ListStackSetOperationResultsInput) SetOperationId(v string) *ListStackSetOperationResultsInput

SetOperationId sets the OperationId field's value.

func (*ListStackSetOperationResultsInput) SetStackSetName added in v1.10.16 

func (s *ListStackSetOperationResultsInput) SetStackSetName(v string) *ListStackSetOperationResultsInput

SetStackSetName sets the StackSetName field's value.

func (ListStackSetOperationResultsInput) String added in v1.10.16 

func (s ListStackSetOperationResultsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStackSetOperationResultsInput) Validate added in v1.10.16 

func (s *ListStackSetOperationResultsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListStackSetOperationResultsOutput added in v1.10.16 

type ListStackSetOperationResultsOutput struct {

	// If the request doesn't return all results, NextToken is set to a token. To
	// retrieve the next set of results, call ListOperationResults again and assign
	// that token to the request object's NextToken parameter. If there are no remaining
	// results, NextToken is set to null.
	NextToken *string `min:"1" type:"string"`

	// A list of StackSetOperationResultSummary structures that contain information
	// about the specified operation results, for accounts and Amazon Web Services
	// Regions that are included in the operation.
	Summaries []*StackSetOperationResultSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListStackSetOperationResultsOutput) GoString added in v1.10.16 

func (s ListStackSetOperationResultsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStackSetOperationResultsOutput) SetNextToken added in v1.10.16 

func (s *ListStackSetOperationResultsOutput) SetNextToken(v string) *ListStackSetOperationResultsOutput

SetNextToken sets the NextToken field's value.

func (*ListStackSetOperationResultsOutput) SetSummaries added in v1.10.16 

func (s *ListStackSetOperationResultsOutput) SetSummaries(v []*StackSetOperationResultSummary) *ListStackSetOperationResultsOutput

SetSummaries sets the Summaries field's value.

func (ListStackSetOperationResultsOutput) String added in v1.10.16 

func (s ListStackSetOperationResultsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListStackSetOperationsInput added in v1.10.16 

type ListStackSetOperationsInput struct {

	// [Service-managed permissions] Specifies whether you are acting as an account
	// administrator in the organization's management account or as a delegated
	// administrator in a member account.
	//
	// By default, SELF is specified. Use SELF for stack sets with self-managed
	// permissions.
	//
	//    * If you are signed in to the management account, specify SELF.
	//
	//    * If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
	//    Your Amazon Web Services account must be registered as a delegated administrator
	//    in the management account. For more information, see Register a delegated
	//    administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html)
	//    in the CloudFormation User Guide.
	CallAs *string `type:"string" enum:"CallAs"`

	// The maximum number of results to be returned with a single call. If the number
	// of available results exceeds this maximum, the response includes a NextToken
	// value that you can assign to the NextToken request parameter to get the next
	// set of results.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the previous paginated request didn't return all of the remaining results,
	// the response object's NextToken parameter value is set to a token. To retrieve
	// the next set of results, call ListStackSetOperations again and assign that
	// token to the request object's NextToken parameter. If there are no remaining
	// results, the previous response object's NextToken parameter is set to null.
	NextToken *string `min:"1" type:"string"`

	// The name or unique ID of the stack set that you want to get operation summaries
	// for.
	//
	// StackSetName is a required field
	StackSetName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListStackSetOperationsInput) GoString added in v1.10.16 

func (s ListStackSetOperationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStackSetOperationsInput) SetCallAs added in v1.37.14 

func (s *ListStackSetOperationsInput) SetCallAs(v string) *ListStackSetOperationsInput

SetCallAs sets the CallAs field's value.

func (*ListStackSetOperationsInput) SetMaxResults added in v1.10.16 

func (s *ListStackSetOperationsInput) SetMaxResults(v int64) *ListStackSetOperationsInput

SetMaxResults sets the MaxResults field's value.

func (*ListStackSetOperationsInput) SetNextToken added in v1.10.16 

func (s *ListStackSetOperationsInput) SetNextToken(v string) *ListStackSetOperationsInput

SetNextToken sets the NextToken field's value.

func (*ListStackSetOperationsInput) SetStackSetName added in v1.10.16 

func (s *ListStackSetOperationsInput) SetStackSetName(v string) *ListStackSetOperationsInput

SetStackSetName sets the StackSetName field's value.

func (ListStackSetOperationsInput) String added in v1.10.16 

func (s ListStackSetOperationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStackSetOperationsInput) Validate added in v1.10.16 

func (s *ListStackSetOperationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListStackSetOperationsOutput added in v1.10.16 

type ListStackSetOperationsOutput struct {

	// If the request doesn't return all results, NextToken is set to a token. To
	// retrieve the next set of results, call ListOperationResults again and assign
	// that token to the request object's NextToken parameter. If there are no remaining
	// results, NextToken is set to null.
	NextToken *string `min:"1" type:"string"`

	// A list of StackSetOperationSummary structures that contain summary information
	// about operations for the specified stack set.
	Summaries []*StackSetOperationSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListStackSetOperationsOutput) GoString added in v1.10.16 

func (s ListStackSetOperationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStackSetOperationsOutput) SetNextToken added in v1.10.16 

func (s *ListStackSetOperationsOutput) SetNextToken(v string) *ListStackSetOperationsOutput

SetNextToken sets the NextToken field's value.

func (*ListStackSetOperationsOutput) SetSummaries added in v1.10.16 

func (s *ListStackSetOperationsOutput) SetSummaries(v []*StackSetOperationSummary) *ListStackSetOperationsOutput

SetSummaries sets the Summaries field's value.

func (ListStackSetOperationsOutput) String added in v1.10.16 

func (s ListStackSetOperationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListStackSetsInput added in v1.10.16 

type ListStackSetsInput struct {

	// [Service-managed permissions] Specifies whether you are acting as an account
	// administrator in the management account or as a delegated administrator in
	// a member account.
	//
	// By default, SELF is specified. Use SELF for stack sets with self-managed
	// permissions.
	//
	//    * If you are signed in to the management account, specify SELF.
	//
	//    * If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
	//    Your Amazon Web Services account must be registered as a delegated administrator
	//    in the management account. For more information, see Register a delegated
	//    administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html)
	//    in the CloudFormation User Guide.
	CallAs *string `type:"string" enum:"CallAs"`

	// The maximum number of results to be returned with a single call. If the number
	// of available results exceeds this maximum, the response includes a NextToken
	// value that you can assign to the NextToken request parameter to get the next
	// set of results.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the previous paginated request didn't return all the remaining results,
	// the response object's NextToken parameter value is set to a token. To retrieve
	// the next set of results, call ListStackSets again and assign that token to
	// the request object's NextToken parameter. If there are no remaining results,
	// the previous response object's NextToken parameter is set to null.
	NextToken *string `min:"1" type:"string"`

	// The status of the stack sets that you want to get summary information about.
	Status *string `type:"string" enum:"StackSetStatus"`
	// contains filtered or unexported fields
}

func (ListStackSetsInput) GoString added in v1.10.16 

func (s ListStackSetsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStackSetsInput) SetCallAs added in v1.37.14 

func (s *ListStackSetsInput) SetCallAs(v string) *ListStackSetsInput

SetCallAs sets the CallAs field's value.

func (*ListStackSetsInput) SetMaxResults added in v1.10.16 

func (s *ListStackSetsInput) SetMaxResults(v int64) *ListStackSetsInput

SetMaxResults sets the MaxResults field's value.

func (*ListStackSetsInput) SetNextToken added in v1.10.16 

func (s *ListStackSetsInput) SetNextToken(v string) *ListStackSetsInput

SetNextToken sets the NextToken field's value.

func (*ListStackSetsInput) SetStatus added in v1.10.16 

func (s *ListStackSetsInput) SetStatus(v string) *ListStackSetsInput

SetStatus sets the Status field's value.

func (ListStackSetsInput) String added in v1.10.16 

func (s ListStackSetsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStackSetsInput) Validate added in v1.10.16 

func (s *ListStackSetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListStackSetsOutput added in v1.10.16 

type ListStackSetsOutput struct {

	// If the request doesn't return all of the remaining results, NextToken is
	// set to a token. To retrieve the next set of results, call ListStackInstances
	// again and assign that token to the request object's NextToken parameter.
	// If the request returns all results, NextToken is set to null.
	NextToken *string `min:"1" type:"string"`

	// A list of StackSetSummary structures that contain information about the user's
	// stack sets.
	Summaries []*StackSetSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListStackSetsOutput) GoString added in v1.10.16 

func (s ListStackSetsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStackSetsOutput) SetNextToken added in v1.10.16 

func (s *ListStackSetsOutput) SetNextToken(v string) *ListStackSetsOutput

SetNextToken sets the NextToken field's value.

func (*ListStackSetsOutput) SetSummaries added in v1.10.16 

func (s *ListStackSetsOutput) SetSummaries(v []*StackSetSummary) *ListStackSetsOutput

SetSummaries sets the Summaries field's value.

func (ListStackSetsOutput) String added in v1.10.16 

func (s ListStackSetsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListStacksInput 

type ListStacksInput struct {

	// A string that identifies the next page of stacks that you want to retrieve.
	NextToken *string `min:"1" type:"string"`

	// Stack status to use as a filter. Specify one or more stack status codes to
	// list only stacks with the specified status codes. For a complete list of
	// stack status codes, see the StackStatus parameter of the Stack data type.
	StackStatusFilter []*string `type:"list" enum:"StackStatus"`
	// contains filtered or unexported fields
}

The input for ListStacks action.

func (ListStacksInput) GoString added in v0.6.5 

func (s ListStacksInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStacksInput) SetNextToken added in v1.5.0 

func (s *ListStacksInput) SetNextToken(v string) *ListStacksInput

SetNextToken sets the NextToken field's value.

func (*ListStacksInput) SetStackStatusFilter added in v1.5.0 

func (s *ListStacksInput) SetStackStatusFilter(v []*string) *ListStacksInput

SetStackStatusFilter sets the StackStatusFilter field's value.

func (ListStacksInput) String added in v0.6.5 

func (s ListStacksInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStacksInput) Validate added in v1.1.21 

func (s *ListStacksInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListStacksOutput 

type ListStacksOutput struct {

	// If the output exceeds 1 MB in size, a string that identifies the next page
	// of stacks. If no additional page exists, this value is null.
	NextToken *string `min:"1" type:"string"`

	// A list of StackSummary structures containing information about the specified
	// stacks.
	StackSummaries []*StackSummary `type:"list"`
	// contains filtered or unexported fields
}

The output for ListStacks action.

func (ListStacksOutput) GoString added in v0.6.5 

func (s ListStacksOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStacksOutput) SetNextToken added in v1.5.0 

func (s *ListStacksOutput) SetNextToken(v string) *ListStacksOutput

SetNextToken sets the NextToken field's value.

func (*ListStacksOutput) SetStackSummaries added in v1.5.0 

func (s *ListStacksOutput) SetStackSummaries(v []*StackSummary) *ListStacksOutput

SetStackSummaries sets the StackSummaries field's value.

func (ListStacksOutput) String added in v0.6.5 

func (s ListStacksOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTypeRegistrationsInput added in v1.25.37 

type ListTypeRegistrationsInput struct {

	// The maximum number of results to be returned with a single call. If the number
	// of available results exceeds this maximum, the response includes a NextToken
	// value that you can assign to the NextToken request parameter to get the next
	// set of results.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the previous paginated request didn't return all the remaining results,
	// the response object's NextToken parameter value is set to a token. To retrieve
	// the next set of results, call this action again and assign that token to
	// the request object's NextToken parameter. If there are no remaining results,
	// the previous response object's NextToken parameter is set to null.
	NextToken *string `min:"1" type:"string"`

	// The current status of the extension registration request.
	//
	// The default is IN_PROGRESS.
	RegistrationStatusFilter *string `type:"string" enum:"RegistrationStatus"`

	// The kind of extension.
	//
	// Conditional: You must specify either TypeName and Type, or Arn.
	Type *string `type:"string" enum:"RegistryType"`

	// The Amazon Resource Name (ARN) of the extension.
	//
	// Conditional: You must specify either TypeName and Type, or Arn.
	TypeArn *string `type:"string"`

	// The name of the extension.
	//
	// Conditional: You must specify either TypeName and Type, or Arn.
	TypeName *string `min:"10" type:"string"`
	// contains filtered or unexported fields
}

func (ListTypeRegistrationsInput) GoString added in v1.25.37 

func (s ListTypeRegistrationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTypeRegistrationsInput) SetMaxResults added in v1.25.37 

func (s *ListTypeRegistrationsInput) SetMaxResults(v int64) *ListTypeRegistrationsInput

SetMaxResults sets the MaxResults field's value.

func (*ListTypeRegistrationsInput) SetNextToken added in v1.25.37 

func (s *ListTypeRegistrationsInput) SetNextToken(v string) *ListTypeRegistrationsInput

SetNextToken sets the NextToken field's value.

func (*ListTypeRegistrationsInput) SetRegistrationStatusFilter added in v1.25.37 

func (s *ListTypeRegistrationsInput) SetRegistrationStatusFilter(v string) *ListTypeRegistrationsInput

SetRegistrationStatusFilter sets the RegistrationStatusFilter field's value.

func (*ListTypeRegistrationsInput) SetType added in v1.25.37 

func (s *ListTypeRegistrationsInput) SetType(v string) *ListTypeRegistrationsInput

SetType sets the Type field's value.

func (*ListTypeRegistrationsInput) SetTypeArn added in v1.25.37 

func (s *ListTypeRegistrationsInput) SetTypeArn(v string) *ListTypeRegistrationsInput

SetTypeArn sets the TypeArn field's value.

func (*ListTypeRegistrationsInput) SetTypeName added in v1.25.37 

func (s *ListTypeRegistrationsInput) SetTypeName(v string) *ListTypeRegistrationsInput

SetTypeName sets the TypeName field's value.

func (ListTypeRegistrationsInput) String added in v1.25.37 

func (s ListTypeRegistrationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTypeRegistrationsInput) Validate added in v1.25.37 

func (s *ListTypeRegistrationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTypeRegistrationsOutput added in v1.25.37 

type ListTypeRegistrationsOutput struct {

	// If the request doesn't return all the remaining results, NextToken is set
	// to a token. To retrieve the next set of results, call this action again and
	// assign that token to the request object's NextToken parameter. If the request
	// returns all results, NextToken is set to null.
	NextToken *string `min:"1" type:"string"`

	// A list of extension registration tokens.
	//
	// Use DescribeTypeRegistration to return detailed information about a type
	// registration request.
	RegistrationTokenList []*string `type:"list"`
	// contains filtered or unexported fields
}

func (ListTypeRegistrationsOutput) GoString added in v1.25.37 

func (s ListTypeRegistrationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTypeRegistrationsOutput) SetNextToken added in v1.25.37 

func (s *ListTypeRegistrationsOutput) SetNextToken(v string) *ListTypeRegistrationsOutput

SetNextToken sets the NextToken field's value.

func (*ListTypeRegistrationsOutput) SetRegistrationTokenList added in v1.25.37 

func (s *ListTypeRegistrationsOutput) SetRegistrationTokenList(v []*string) *ListTypeRegistrationsOutput

SetRegistrationTokenList sets the RegistrationTokenList field's value.

func (ListTypeRegistrationsOutput) String added in v1.25.37 

func (s ListTypeRegistrationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTypeVersionsInput added in v1.25.37 

type ListTypeVersionsInput struct {

	// The Amazon Resource Name (ARN) of the extension for which you want version
	// summary information.
	//
	// Conditional: You must specify either TypeName and Type, or Arn.
	Arn *string `type:"string"`

	// The deprecation status of the extension versions that you want to get summary
	// information about.
	//
	// Valid values include:
	//
	//    * LIVE: The extension version is registered and can be used in CloudFormation
	//    operations, dependent on its provisioning behavior and visibility scope.
	//
	//    * DEPRECATED: The extension version has been deregistered and can no longer
	//    be used in CloudFormation operations.
	//
	// The default is LIVE.
	DeprecatedStatus *string `type:"string" enum:"DeprecatedStatus"`

	// The maximum number of results to be returned with a single call. If the number
	// of available results exceeds this maximum, the response includes a NextToken
	// value that you can assign to the NextToken request parameter to get the next
	// set of results.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the previous paginated request didn't return all of the remaining results,
	// the response object's NextToken parameter value is set to a token. To retrieve
	// the next set of results, call this action again and assign that token to
	// the request object's NextToken parameter. If there are no remaining results,
	// the previous response object's NextToken parameter is set to null.
	NextToken *string `min:"1" type:"string"`

	// The publisher ID of the extension publisher.
	//
	// Extensions published by Amazon aren't assigned a publisher ID.
	PublisherId *string `min:"1" type:"string"`

	// The kind of the extension.
	//
	// Conditional: You must specify either TypeName and Type, or Arn.
	Type *string `type:"string" enum:"RegistryType"`

	// The name of the extension for which you want version summary information.
	//
	// Conditional: You must specify either TypeName and Type, or Arn.
	TypeName *string `min:"10" type:"string"`
	// contains filtered or unexported fields
}

func (ListTypeVersionsInput) GoString added in v1.25.37 

func (s ListTypeVersionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTypeVersionsInput) SetArn added in v1.25.37 

func (s *ListTypeVersionsInput) SetArn(v string) *ListTypeVersionsInput

SetArn sets the Arn field's value.

func (*ListTypeVersionsInput) SetDeprecatedStatus added in v1.25.37 

func (s *ListTypeVersionsInput) SetDeprecatedStatus(v string) *ListTypeVersionsInput

SetDeprecatedStatus sets the DeprecatedStatus field's value.

func (*ListTypeVersionsInput) SetMaxResults added in v1.25.37 

func (s *ListTypeVersionsInput) SetMaxResults(v int64) *ListTypeVersionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListTypeVersionsInput) SetNextToken added in v1.25.37 

func (s *ListTypeVersionsInput) SetNextToken(v string) *ListTypeVersionsInput

SetNextToken sets the NextToken field's value.

func (*ListTypeVersionsInput) SetPublisherId added in v1.38.65 

func (s *ListTypeVersionsInput) SetPublisherId(v string) *ListTypeVersionsInput

SetPublisherId sets the PublisherId field's value.

func (*ListTypeVersionsInput) SetType added in v1.25.37 

func (s *ListTypeVersionsInput) SetType(v string) *ListTypeVersionsInput

SetType sets the Type field's value.

func (*ListTypeVersionsInput) SetTypeName added in v1.25.37 

func (s *ListTypeVersionsInput) SetTypeName(v string) *ListTypeVersionsInput

SetTypeName sets the TypeName field's value.

func (ListTypeVersionsInput) String added in v1.25.37 

func (s ListTypeVersionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTypeVersionsInput) Validate added in v1.25.37 

func (s *ListTypeVersionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTypeVersionsOutput added in v1.25.37 

type ListTypeVersionsOutput struct {

	// If the request doesn't return all of the remaining results, NextToken is
	// set to a token. To retrieve the next set of results, call this action again
	// and assign that token to the request object's NextToken parameter. If the
	// request returns all results, NextToken is set to null.
	NextToken *string `min:"1" type:"string"`

	// A list of TypeVersionSummary structures that contain information about the
	// specified extension's versions.
	TypeVersionSummaries []*TypeVersionSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListTypeVersionsOutput) GoString added in v1.25.37 

func (s ListTypeVersionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTypeVersionsOutput) SetNextToken added in v1.25.37 

func (s *ListTypeVersionsOutput) SetNextToken(v string) *ListTypeVersionsOutput

SetNextToken sets the NextToken field's value.

func (*ListTypeVersionsOutput) SetTypeVersionSummaries added in v1.25.37 

func (s *ListTypeVersionsOutput) SetTypeVersionSummaries(v []*TypeVersionSummary) *ListTypeVersionsOutput

SetTypeVersionSummaries sets the TypeVersionSummaries field's value.

func (ListTypeVersionsOutput) String added in v1.25.37 

func (s ListTypeVersionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTypesInput added in v1.25.37 

type ListTypesInput struct {

	// The deprecation status of the extension that you want to get summary information
	// about.
	//
	// Valid values include:
	//
	//    * LIVE: The extension is registered for use in CloudFormation operations.
	//
	//    * DEPRECATED: The extension has been deregistered and can no longer be
	//    used in CloudFormation operations.
	DeprecatedStatus *string `type:"string" enum:"DeprecatedStatus"`

	// Filter criteria to use in determining which extensions to return.
	//
	// Filters must be compatible with Visibility to return valid results. For example,
	// specifying AWS_TYPES for Category and PRIVATE for Visibility returns an empty
	// list of types, but specifying PUBLIC for Visibility returns the desired list.
	Filters *TypeFilters `type:"structure"`

	// The maximum number of results to be returned with a single call. If the number
	// of available results exceeds this maximum, the response includes a NextToken
	// value that you can assign to the NextToken request parameter to get the next
	// set of results.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the previous paginated request didn't return all the remaining results,
	// the response object's NextToken parameter value is set to a token. To retrieve
	// the next set of results, call this action again and assign that token to
	// the request object's NextToken parameter. If there are no remaining results,
	// the previous response object's NextToken parameter is set to null.
	NextToken *string `min:"1" type:"string"`

	// For resource types, the provisioning behavior of the resource type. CloudFormation
	// determines the provisioning type during registration, based on the types
	// of handlers in the schema handler package submitted.
	//
	// Valid values include:
	//
	//    * FULLY_MUTABLE: The resource type includes an update handler to process
	//    updates to the type during stack update operations.
	//
	//    * IMMUTABLE: The resource type doesn't include an update handler, so the
	//    type can't be updated and must instead be replaced during stack update
	//    operations.
	//
	//    * NON_PROVISIONABLE: The resource type doesn't include create, read, and
	//    delete handlers, and therefore can't actually be provisioned.
	//
	// The default is FULLY_MUTABLE.
	ProvisioningType *string `type:"string" enum:"ProvisioningType"`

	// The type of extension.
	Type *string `type:"string" enum:"RegistryType"`

	// The scope at which the extensions are visible and usable in CloudFormation
	// operations.
	//
	// Valid values include:
	//
	//    * PRIVATE: Extensions that are visible and usable within this account
	//    and Region. This includes: Private extensions you have registered in this
	//    account and Region. Public extensions that you have activated in this
	//    account and Region.
	//
	//    * PUBLIC: Extensions that are publicly visible and available to be activated
	//    within any Amazon Web Services account. This includes extensions from
	//    Amazon Web Services, in addition to third-party publishers.
	//
	// The default is PRIVATE.
	Visibility *string `type:"string" enum:"Visibility"`
	// contains filtered or unexported fields
}

func (ListTypesInput) GoString added in v1.25.37 

func (s ListTypesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTypesInput) SetDeprecatedStatus added in v1.25.37 

func (s *ListTypesInput) SetDeprecatedStatus(v string) *ListTypesInput

SetDeprecatedStatus sets the DeprecatedStatus field's value.

func (*ListTypesInput) SetFilters added in v1.38.65 

func (s *ListTypesInput) SetFilters(v *TypeFilters) *ListTypesInput

SetFilters sets the Filters field's value.

func (*ListTypesInput) SetMaxResults added in v1.25.37 

func (s *ListTypesInput) SetMaxResults(v int64) *ListTypesInput

SetMaxResults sets the MaxResults field's value.

func (*ListTypesInput) SetNextToken added in v1.25.37 

func (s *ListTypesInput) SetNextToken(v string) *ListTypesInput

SetNextToken sets the NextToken field's value.

func (*ListTypesInput) SetProvisioningType added in v1.25.37 

func (s *ListTypesInput) SetProvisioningType(v string) *ListTypesInput

SetProvisioningType sets the ProvisioningType field's value.

func (*ListTypesInput) SetType added in v1.35.35 

func (s *ListTypesInput) SetType(v string) *ListTypesInput

SetType sets the Type field's value.

func (*ListTypesInput) SetVisibility added in v1.25.37 

func (s *ListTypesInput) SetVisibility(v string) *ListTypesInput

SetVisibility sets the Visibility field's value.

func (ListTypesInput) String added in v1.25.37 

func (s ListTypesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTypesInput) Validate added in v1.25.37 

func (s *ListTypesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTypesOutput added in v1.25.37 

type ListTypesOutput struct {

	// If the request doesn't return all the remaining results, NextToken is set
	// to a token. To retrieve the next set of results, call this action again and
	// assign that token to the request object's NextToken parameter. If the request
	// returns all results, NextToken is set to null.
	NextToken *string `min:"1" type:"string"`

	// A list of TypeSummary structures that contain information about the specified
	// extensions.
	TypeSummaries []*TypeSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListTypesOutput) GoString added in v1.25.37 

func (s ListTypesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTypesOutput) SetNextToken added in v1.25.37 

func (s *ListTypesOutput) SetNextToken(v string) *ListTypesOutput

SetNextToken sets the NextToken field's value.

func (*ListTypesOutput) SetTypeSummaries added in v1.25.37 

func (s *ListTypesOutput) SetTypeSummaries(v []*TypeSummary) *ListTypesOutput

SetTypeSummaries sets the TypeSummaries field's value.

func (ListTypesOutput) String added in v1.25.37 

func (s ListTypesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LoggingConfig added in v1.25.37 

type LoggingConfig struct {

	// The Amazon CloudWatch Logs group to which CloudFormation sends error logging
	// information when invoking the extension's handlers.
	//
	// LogGroupName is a required field
	LogGroupName *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the role that CloudFormation should assume
	// when sending log entries to CloudWatch Logs.
	//
	// LogRoleArn is a required field
	LogRoleArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains logging configuration information for an extension.

func (LoggingConfig) GoString added in v1.25.37 

func (s LoggingConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LoggingConfig) SetLogGroupName added in v1.25.37 

func (s *LoggingConfig) SetLogGroupName(v string) *LoggingConfig

SetLogGroupName sets the LogGroupName field's value.

func (*LoggingConfig) SetLogRoleArn added in v1.25.37 

func (s *LoggingConfig) SetLogRoleArn(v string) *LoggingConfig

SetLogRoleArn sets the LogRoleArn field's value.

func (LoggingConfig) String added in v1.25.37 

func (s LoggingConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LoggingConfig) Validate added in v1.25.37 

func (s *LoggingConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ManagedExecution added in v1.42.9 

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 `type:"boolean"`
	// contains filtered or unexported fields
}

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

func (ManagedExecution) GoString added in v1.42.9 

func (s ManagedExecution) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ManagedExecution) SetActive added in v1.42.9 

func (s *ManagedExecution) SetActive(v bool) *ManagedExecution

SetActive sets the Active field's value.

func (ManagedExecution) String added in v1.42.9 

func (s ManagedExecution) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModuleInfo added in v1.35.35 

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 Referencing resources in a module (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html#module-ref-resources)
	// in the CloudFormation User Guide.
	LogicalIdHierarchy *string `type:"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 `type:"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 Using modules to encapsulate and reuse resource configurations (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html) in the CloudFormation User Guide.

func (ModuleInfo) GoString added in v1.35.35 

func (s ModuleInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModuleInfo) SetLogicalIdHierarchy added in v1.35.35 

func (s *ModuleInfo) SetLogicalIdHierarchy(v string) *ModuleInfo

SetLogicalIdHierarchy sets the LogicalIdHierarchy field's value.

func (*ModuleInfo) SetTypeHierarchy added in v1.35.35 

func (s *ModuleInfo) SetTypeHierarchy(v string) *ModuleInfo

SetTypeHierarchy sets the TypeHierarchy field's value.

func (ModuleInfo) String added in v1.35.35 

func (s ModuleInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OperationResultFilter added in v1.44.126 

type OperationResultFilter struct {

	// The type of filter to apply.
	Name *string `type:"string" enum:"OperationResultFilterName"`

	// The value to filter by.
	Values *string `min:"6" type:"string"`
	// contains filtered or unexported fields
}

The status that operation results are filtered by.

func (OperationResultFilter) GoString added in v1.44.126 

func (s OperationResultFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OperationResultFilter) SetName added in v1.44.126 

func (s *OperationResultFilter) SetName(v string) *OperationResultFilter

SetName sets the Name field's value.

func (*OperationResultFilter) SetValues added in v1.44.126 

func (s *OperationResultFilter) SetValues(v string) *OperationResultFilter

SetValues sets the Values field's value.

func (OperationResultFilter) String added in v1.44.126 

func (s OperationResultFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OperationResultFilter) Validate added in v1.44.126 

func (s *OperationResultFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Output 

type Output struct {

	// User defined description associated with the output.
	Description *string `min:"1" type:"string"`

	// The name of the export associated with the output.
	ExportName *string `type:"string"`

	// The key associated with the output.
	OutputKey *string `type:"string"`

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

The Output data type.

func (Output) GoString added in v0.6.5 

func (s Output) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Output) SetDescription added in v1.5.0 

func (s *Output) SetDescription(v string) *Output

SetDescription sets the Description field's value.

func (*Output) SetExportName added in v1.10.16 

func (s *Output) SetExportName(v string) *Output

SetExportName sets the ExportName field's value.

func (*Output) SetOutputKey added in v1.5.0 

func (s *Output) SetOutputKey(v string) *Output

SetOutputKey sets the OutputKey field's value.

func (*Output) SetOutputValue added in v1.5.0 

func (s *Output) SetOutputValue(v string) *Output

SetOutputValue sets the OutputValue field's value.

func (Output) String added in v0.6.5 

func (s Output) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 `type:"string"`

	// The input value associated with the parameter.
	ParameterValue *string `type:"string"`

	// Read-only. The value that corresponds to a SSM parameter key. This field
	// is returned only for SSM (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types)
	// parameter types in the template.
	ResolvedValue *string `type:"string"`

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

The Parameter data type.

func (Parameter) GoString added in v0.6.5 

func (s Parameter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Parameter) SetParameterKey added in v1.5.0 

func (s *Parameter) SetParameterKey(v string) *Parameter

SetParameterKey sets the ParameterKey field's value.

func (*Parameter) SetParameterValue added in v1.5.0 

func (s *Parameter) SetParameterValue(v string) *Parameter

SetParameterValue sets the ParameterValue field's value.

func (*Parameter) SetResolvedValue added in v1.12.32 

func (s *Parameter) SetResolvedValue(v string) *Parameter

SetResolvedValue sets the ResolvedValue field's value.

func (*Parameter) SetUsePreviousValue added in v1.5.0 

func (s *Parameter) SetUsePreviousValue(v bool) *Parameter

SetUsePreviousValue sets the UsePreviousValue field's value.

func (Parameter) String added in v0.6.5 

func (s Parameter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ParameterConstraints 

type ParameterConstraints struct {

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

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

func (ParameterConstraints) GoString added in v0.6.5 

func (s ParameterConstraints) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ParameterConstraints) SetAllowedValues added in v1.5.0 

func (s *ParameterConstraints) SetAllowedValues(v []*string) *ParameterConstraints

SetAllowedValues sets the AllowedValues field's value.

func (ParameterConstraints) String added in v0.6.5 

func (s ParameterConstraints) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ParameterDeclaration 

type ParameterDeclaration struct {

	// The default value of the parameter.
	DefaultValue *string `type:"string"`

	// The description that's associate with the parameter.
	Description *string `min:"1" type:"string"`

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

	// The criteria that CloudFormation uses to validate parameter values.
	ParameterConstraints *ParameterConstraints `type:"structure"`

	// The name that's associated with the parameter.
	ParameterKey *string `type:"string"`

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

The ParameterDeclaration data type.

func (ParameterDeclaration) GoString added in v0.6.5 

func (s ParameterDeclaration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ParameterDeclaration) SetDefaultValue added in v1.5.0 

func (s *ParameterDeclaration) SetDefaultValue(v string) *ParameterDeclaration

SetDefaultValue sets the DefaultValue field's value.

func (*ParameterDeclaration) SetDescription added in v1.5.0 

func (s *ParameterDeclaration) SetDescription(v string) *ParameterDeclaration

SetDescription sets the Description field's value.

func (*ParameterDeclaration) SetNoEcho added in v1.5.0 

func (s *ParameterDeclaration) SetNoEcho(v bool) *ParameterDeclaration

SetNoEcho sets the NoEcho field's value.

func (*ParameterDeclaration) SetParameterConstraints added in v1.5.0 

func (s *ParameterDeclaration) SetParameterConstraints(v *ParameterConstraints) *ParameterDeclaration

SetParameterConstraints sets the ParameterConstraints field's value.

func (*ParameterDeclaration) SetParameterKey added in v1.5.0 

func (s *ParameterDeclaration) SetParameterKey(v string) *ParameterDeclaration

SetParameterKey sets the ParameterKey field's value.

func (*ParameterDeclaration) SetParameterType added in v1.5.0 

func (s *ParameterDeclaration) SetParameterType(v string) *ParameterDeclaration

SetParameterType sets the ParameterType field's value.

func (ParameterDeclaration) String added in v0.6.5 

func (s ParameterDeclaration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PhysicalResourceIdContextKeyValuePair added in v1.15.74 

type PhysicalResourceIdContextKeyValuePair struct {

	// The resource context key.
	//
	// Key is a required field
	Key *string `type:"string" required:"true"`

	// The resource context value.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Context information that enables 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.

func (PhysicalResourceIdContextKeyValuePair) GoString added in v1.15.74 

func (s PhysicalResourceIdContextKeyValuePair) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PhysicalResourceIdContextKeyValuePair) SetKey added in v1.15.74 

func (s *PhysicalResourceIdContextKeyValuePair) SetKey(v string) *PhysicalResourceIdContextKeyValuePair

SetKey sets the Key field's value.

func (*PhysicalResourceIdContextKeyValuePair) SetValue added in v1.15.74 

func (s *PhysicalResourceIdContextKeyValuePair) SetValue(v string) *PhysicalResourceIdContextKeyValuePair

SetValue sets the Value field's value.

func (PhysicalResourceIdContextKeyValuePair) String added in v1.15.74 

func (s PhysicalResourceIdContextKeyValuePair) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PropertyDifference added in v1.15.74 

type PropertyDifference struct {

	// The actual property value of the resource property.
	//
	// ActualValue is a required field
	ActualValue *string `type:"string" required:"true"`

	// The type of property difference.
	//
	//    * ADD: A value has been added to a resource property that'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).
	//
	// DifferenceType is a required field
	DifferenceType *string `type:"string" required:"true" enum:"DifferenceType"`

	// The expected property value of the resource property, as defined in the stack
	// template and any values specified as template parameters.
	//
	// ExpectedValue is a required field
	ExpectedValue *string `type:"string" required:"true"`

	// The fully-qualified path to the resource property.
	//
	// PropertyPath is a required field
	PropertyPath *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information about a resource property whose actual value differs from its expected value, as defined in the stack template and any values specified as template parameters. These will be present only for resources whose StackResourceDriftStatus is MODIFIED. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html).

func (PropertyDifference) GoString added in v1.15.74 

func (s PropertyDifference) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PropertyDifference) SetActualValue added in v1.15.74 

func (s *PropertyDifference) SetActualValue(v string) *PropertyDifference

SetActualValue sets the ActualValue field's value.

func (*PropertyDifference) SetDifferenceType added in v1.15.74 

func (s *PropertyDifference) SetDifferenceType(v string) *PropertyDifference

SetDifferenceType sets the DifferenceType field's value.

func (*PropertyDifference) SetExpectedValue added in v1.15.74 

func (s *PropertyDifference) SetExpectedValue(v string) *PropertyDifference

SetExpectedValue sets the ExpectedValue field's value.

func (*PropertyDifference) SetPropertyPath added in v1.15.74 

func (s *PropertyDifference) SetPropertyPath(v string) *PropertyDifference

SetPropertyPath sets the PropertyPath field's value.

func (PropertyDifference) String added in v1.15.74 

func (s PropertyDifference) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PublishTypeInput added in v1.38.65 

type PublishTypeInput struct {

	// The Amazon Resource Name (ARN) of the extension.
	//
	// Conditional: You must specify Arn, or TypeName and Type.
	Arn *string `type:"string"`

	// The version number to assign to this version of the extension.
	//
	// Use the following format, and adhere to semantic versioning when assigning
	// a version number to your extension:
	//
	// MAJOR.MINOR.PATCH
	//
	// For more information, see Semantic Versioning 2.0.0 (https://semver.org/).
	//
	// If you don't specify a version number, CloudFormation increments the version
	// number by one minor version release.
	//
	// You cannot specify a version number the first time you publish a type. CloudFormation
	// automatically sets the first version number to be 1.0.0.
	PublicVersionNumber *string `min:"5" type:"string"`

	// The type of the extension.
	//
	// Conditional: You must specify Arn, or TypeName and Type.
	Type *string `type:"string" enum:"ThirdPartyType"`

	// The name of the extension.
	//
	// Conditional: You must specify Arn, or TypeName and Type.
	TypeName *string `min:"10" type:"string"`
	// contains filtered or unexported fields
}

func (PublishTypeInput) GoString added in v1.38.65 

func (s PublishTypeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PublishTypeInput) SetArn added in v1.38.65 

func (s *PublishTypeInput) SetArn(v string) *PublishTypeInput

SetArn sets the Arn field's value.

func (*PublishTypeInput) SetPublicVersionNumber added in v1.38.65 

func (s *PublishTypeInput) SetPublicVersionNumber(v string) *PublishTypeInput

SetPublicVersionNumber sets the PublicVersionNumber field's value.

func (*PublishTypeInput) SetType added in v1.38.65 

func (s *PublishTypeInput) SetType(v string) *PublishTypeInput

SetType sets the Type field's value.

func (*PublishTypeInput) SetTypeName added in v1.38.65 

func (s *PublishTypeInput) SetTypeName(v string) *PublishTypeInput

SetTypeName sets the TypeName field's value.

func (PublishTypeInput) String added in v1.38.65 

func (s PublishTypeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PublishTypeInput) Validate added in v1.38.65 

func (s *PublishTypeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PublishTypeOutput added in v1.38.65 

type PublishTypeOutput struct {

	// The Amazon Resource Name (ARN) assigned to the public extension upon publication.
	PublicTypeArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (PublishTypeOutput) GoString added in v1.38.65 

func (s PublishTypeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PublishTypeOutput) SetPublicTypeArn added in v1.38.65 

func (s *PublishTypeOutput) SetPublicTypeArn(v string) *PublishTypeOutput

SetPublicTypeArn sets the PublicTypeArn field's value.

func (PublishTypeOutput) String added in v1.38.65 

func (s PublishTypeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RecordHandlerProgressInput added in v1.25.37 

type RecordHandlerProgressInput struct {

	// Reserved for use by the CloudFormation CLI (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html).
	//
	// BearerToken is a required field
	BearerToken *string `min:"1" type:"string" required:"true"`

	// Reserved for use by the CloudFormation CLI (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html).
	ClientRequestToken *string `min:"1" type:"string"`

	// Reserved for use by the CloudFormation CLI (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html).
	CurrentOperationStatus *string `type:"string" enum:"OperationStatus"`

	// Reserved for use by the CloudFormation CLI (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html).
	ErrorCode *string `type:"string" enum:"HandlerErrorCode"`

	// Reserved for use by the CloudFormation CLI (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html).
	//
	// OperationStatus is a required field
	OperationStatus *string `type:"string" required:"true" enum:"OperationStatus"`

	// Reserved for use by the CloudFormation CLI (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html).
	ResourceModel *string `min:"1" type:"string"`

	// Reserved for use by the CloudFormation CLI (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html).
	StatusMessage *string `type:"string"`
	// contains filtered or unexported fields
}

func (RecordHandlerProgressInput) GoString added in v1.25.37 

func (s RecordHandlerProgressInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecordHandlerProgressInput) SetBearerToken added in v1.25.37 

func (s *RecordHandlerProgressInput) SetBearerToken(v string) *RecordHandlerProgressInput

SetBearerToken sets the BearerToken field's value.

func (*RecordHandlerProgressInput) SetClientRequestToken added in v1.25.37 

func (s *RecordHandlerProgressInput) SetClientRequestToken(v string) *RecordHandlerProgressInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*RecordHandlerProgressInput) SetCurrentOperationStatus added in v1.25.37 

func (s *RecordHandlerProgressInput) SetCurrentOperationStatus(v string) *RecordHandlerProgressInput

SetCurrentOperationStatus sets the CurrentOperationStatus field's value.

func (*RecordHandlerProgressInput) SetErrorCode added in v1.25.37 

func (s *RecordHandlerProgressInput) SetErrorCode(v string) *RecordHandlerProgressInput

SetErrorCode sets the ErrorCode field's value.

func (*RecordHandlerProgressInput) SetOperationStatus added in v1.25.37 

func (s *RecordHandlerProgressInput) SetOperationStatus(v string) *RecordHandlerProgressInput

SetOperationStatus sets the OperationStatus field's value.

func (*RecordHandlerProgressInput) SetResourceModel added in v1.25.37 

func (s *RecordHandlerProgressInput) SetResourceModel(v string) *RecordHandlerProgressInput

SetResourceModel sets the ResourceModel field's value.

func (*RecordHandlerProgressInput) SetStatusMessage added in v1.25.37 

func (s *RecordHandlerProgressInput) SetStatusMessage(v string) *RecordHandlerProgressInput

SetStatusMessage sets the StatusMessage field's value.

func (RecordHandlerProgressInput) String added in v1.25.37 

func (s RecordHandlerProgressInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecordHandlerProgressInput) Validate added in v1.25.37 

func (s *RecordHandlerProgressInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RecordHandlerProgressOutput added in v1.25.37 

type RecordHandlerProgressOutput struct {
	// contains filtered or unexported fields
}

func (RecordHandlerProgressOutput) GoString added in v1.25.37 

func (s RecordHandlerProgressOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (RecordHandlerProgressOutput) String added in v1.25.37 

func (s RecordHandlerProgressOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RegisterPublisherInput added in v1.38.65 

type RegisterPublisherInput struct {

	// Whether you accept the Terms and Conditions (https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf)
	// for publishing extensions in the CloudFormation registry. You must accept
	// the terms and conditions in order to register to publish public extensions
	// to the CloudFormation registry.
	//
	// The default is false.
	AcceptTermsAndConditions *bool `type:"boolean"`

	// If you are using a Bitbucket or GitHub account for identity verification,
	// the Amazon Resource Name (ARN) for your connection to that account.
	//
	// For more information, see Registering your account to publish CloudFormation
	// extensions (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs)
	// in the CloudFormation CLI User Guide.
	ConnectionArn *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (RegisterPublisherInput) GoString added in v1.38.65 

func (s RegisterPublisherInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterPublisherInput) SetAcceptTermsAndConditions added in v1.38.65 

func (s *RegisterPublisherInput) SetAcceptTermsAndConditions(v bool) *RegisterPublisherInput

SetAcceptTermsAndConditions sets the AcceptTermsAndConditions field's value.

func (*RegisterPublisherInput) SetConnectionArn added in v1.38.65 

func (s *RegisterPublisherInput) SetConnectionArn(v string) *RegisterPublisherInput

SetConnectionArn sets the ConnectionArn field's value.

func (RegisterPublisherInput) String added in v1.38.65 

func (s RegisterPublisherInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterPublisherInput) Validate added in v1.38.65 

func (s *RegisterPublisherInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RegisterPublisherOutput added in v1.38.65 

type RegisterPublisherOutput struct {

	// The ID assigned this account by CloudFormation for publishing extensions.
	PublisherId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (RegisterPublisherOutput) GoString added in v1.38.65 

func (s RegisterPublisherOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterPublisherOutput) SetPublisherId added in v1.38.65 

func (s *RegisterPublisherOutput) SetPublisherId(v string) *RegisterPublisherOutput

SetPublisherId sets the PublisherId field's value.

func (RegisterPublisherOutput) String added in v1.38.65 

func (s RegisterPublisherOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RegisterTypeInput added in v1.25.37 

type RegisterTypeInput struct {

	// A unique identifier that acts as an idempotency key for this registration
	// request. Specifying a client request token prevents CloudFormation from generating
	// more than one version of an extension from the same registration request,
	// even if the request is submitted multiple times.
	ClientRequestToken *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume
	// when invoking the extension.
	//
	// For CloudFormation to assume the specified execution role, the role must
	// contain a trust relationship with the CloudFormation service principle (resources.cloudformation.amazonaws.com).
	// For more information about adding trust relationships, see Modifying a role
	// trust policy (https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-managingrole-editing-console.html#roles-managingrole_edit-trust-policy)
	// in the Identity and Access Management User Guide.
	//
	// If your extension calls Amazon Web Services APIs in any of its handlers,
	// you must create an IAM execution role (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html)
	// that includes the necessary permissions to call those Amazon Web Services
	// APIs, and provision that execution role in your account. When CloudFormation
	// needs to invoke the resource type handler, CloudFormation assumes this execution
	// role to create a temporary session token, which it then passes to the resource
	// type handler, thereby supplying your resource type with the appropriate credentials.
	ExecutionRoleArn *string `min:"1" type:"string"`

	// Specifies logging configuration information for an extension.
	LoggingConfig *LoggingConfig `type:"structure"`

	// A URL to the S3 bucket containing the extension project package that contains
	// the necessary files for the extension you want to register.
	//
	// For information about generating a schema handler package for the extension
	// you want to register, see submit (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html)
	// in the CloudFormation CLI User Guide.
	//
	// The user registering the extension must be able to access the package in
	// the S3 bucket. That's, the user needs to have GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
	// permissions for the schema handler package. For more information, see Actions,
	// Resources, and Condition Keys for Amazon S3 (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html)
	// in the Identity and Access Management User Guide.
	//
	// SchemaHandlerPackage is a required field
	SchemaHandlerPackage *string `min:"1" type:"string" required:"true"`

	// The kind of extension.
	Type *string `type:"string" enum:"RegistryType"`

	// The name of the extension being registered.
	//
	// We suggest that extension names adhere to the following patterns:
	//
	//    * For resource types, company_or_organization::service::type.
	//
	//    * For modules, company_or_organization::service::type::MODULE.
	//
	//    * For hooks, MyCompany::Testing::MyTestHook.
	//
	// The following organization namespaces are reserved and can't be used in your
	// extension names:
	//
	//    * Alexa
	//
	//    * AMZN
	//
	//    * Amazon
	//
	//    * AWS
	//
	//    * Custom
	//
	//    * Dev
	//
	// TypeName is a required field
	TypeName *string `min:"10" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RegisterTypeInput) GoString added in v1.25.37 

func (s RegisterTypeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterTypeInput) SetClientRequestToken added in v1.25.37 

func (s *RegisterTypeInput) SetClientRequestToken(v string) *RegisterTypeInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*RegisterTypeInput) SetExecutionRoleArn added in v1.25.37 

func (s *RegisterTypeInput) SetExecutionRoleArn(v string) *RegisterTypeInput

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*RegisterTypeInput) SetLoggingConfig added in v1.25.37 

func (s *RegisterTypeInput) SetLoggingConfig(v *LoggingConfig) *RegisterTypeInput

SetLoggingConfig sets the LoggingConfig field's value.

func (*RegisterTypeInput) SetSchemaHandlerPackage added in v1.25.37 

func (s *RegisterTypeInput) SetSchemaHandlerPackage(v string) *RegisterTypeInput

SetSchemaHandlerPackage sets the SchemaHandlerPackage field's value.

func (*RegisterTypeInput) SetType added in v1.25.37 

func (s *RegisterTypeInput) SetType(v string) *RegisterTypeInput

SetType sets the Type field's value.

func (*RegisterTypeInput) SetTypeName added in v1.25.37 

func (s *RegisterTypeInput) SetTypeName(v string) *RegisterTypeInput

SetTypeName sets the TypeName field's value.

func (RegisterTypeInput) String added in v1.25.37 

func (s RegisterTypeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterTypeInput) Validate added in v1.25.37 

func (s *RegisterTypeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RegisterTypeOutput added in v1.25.37 

type RegisterTypeOutput struct {

	// The identifier for this registration request.
	//
	// Use this registration token when calling DescribeTypeRegistration, which
	// returns information about the status and IDs of the extension registration.
	RegistrationToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (RegisterTypeOutput) GoString added in v1.25.37 

func (s RegisterTypeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterTypeOutput) SetRegistrationToken added in v1.25.37 

func (s *RegisterTypeOutput) SetRegistrationToken(v string) *RegisterTypeOutput

SetRegistrationToken sets the RegistrationToken field's value.

func (RegisterTypeOutput) String added in v1.25.37 

func (s RegisterTypeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RequiredActivatedType added in v1.38.65 

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 Specifying aliases to refer to extensions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias)
	// in the CloudFormation User Guide.
	OriginalTypeName *string `min:"10" type:"string"`

	// The publisher ID of the extension publisher.
	PublisherId *string `min:"1" type:"string"`

	// A list of the major versions of the extension type that the macro supports.
	SupportedMajorVersions []*int64 `type:"list"`

	// 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 `min:"10" type:"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 Activating public modules for use in your account (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/modules.html#module-enabling) in the CloudFormation User Guide.

func (RequiredActivatedType) GoString added in v1.38.65 

func (s RequiredActivatedType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RequiredActivatedType) SetOriginalTypeName added in v1.38.65 

func (s *RequiredActivatedType) SetOriginalTypeName(v string) *RequiredActivatedType

SetOriginalTypeName sets the OriginalTypeName field's value.

func (*RequiredActivatedType) SetPublisherId added in v1.38.65 

func (s *RequiredActivatedType) SetPublisherId(v string) *RequiredActivatedType

SetPublisherId sets the PublisherId field's value.

func (*RequiredActivatedType) SetSupportedMajorVersions added in v1.38.65 

func (s *RequiredActivatedType) SetSupportedMajorVersions(v []*int64) *RequiredActivatedType

SetSupportedMajorVersions sets the SupportedMajorVersions field's value.

func (*RequiredActivatedType) SetTypeNameAlias added in v1.38.65 

func (s *RequiredActivatedType) SetTypeNameAlias(v string) *RequiredActivatedType

SetTypeNameAlias sets the TypeNameAlias field's value.

func (RequiredActivatedType) String added in v1.38.65 

func (s RequiredActivatedType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceChange added in v1.1.15 

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 *string `type:"string" enum:"ChangeAction"`

	// The change set ID of the nested change set.
	ChangeSetId *string `min:"1" type:"string"`

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

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

	// 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 `type:"structure"`

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

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

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

	// For the Modify action, indicates which resource attribute is triggering this
	// update, such as a change in the resource attribute's Metadata, Properties,
	// or Tags.
	Scope []*string `type:"list" enum:"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.

func (ResourceChange) GoString added in v1.1.15 

func (s ResourceChange) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceChange) SetAction added in v1.5.0 

func (s *ResourceChange) SetAction(v string) *ResourceChange

SetAction sets the Action field's value.

func (*ResourceChange) SetChangeSetId added in v1.35.31 

func (s *ResourceChange) SetChangeSetId(v string) *ResourceChange

SetChangeSetId sets the ChangeSetId field's value.

func (*ResourceChange) SetDetails added in v1.5.0 

func (s *ResourceChange) SetDetails(v []*ResourceChangeDetail) *ResourceChange

SetDetails sets the Details field's value.

func (*ResourceChange) SetLogicalResourceId added in v1.5.0 

func (s *ResourceChange) SetLogicalResourceId(v string) *ResourceChange

SetLogicalResourceId sets the LogicalResourceId field's value.

func (*ResourceChange) SetModuleInfo added in v1.35.35 

func (s *ResourceChange) SetModuleInfo(v *ModuleInfo) *ResourceChange

SetModuleInfo sets the ModuleInfo field's value.

func (*ResourceChange) SetPhysicalResourceId added in v1.5.0 

func (s *ResourceChange) SetPhysicalResourceId(v string) *ResourceChange

SetPhysicalResourceId sets the PhysicalResourceId field's value.

func (*ResourceChange) SetReplacement added in v1.5.0 

func (s *ResourceChange) SetReplacement(v string) *ResourceChange

SetReplacement sets the Replacement field's value.

func (*ResourceChange) SetResourceType added in v1.5.0 

func (s *ResourceChange) SetResourceType(v string) *ResourceChange

SetResourceType sets the ResourceType field's value.

func (*ResourceChange) SetScope added in v1.5.0 

func (s *ResourceChange) SetScope(v []*string) *ResourceChange

SetScope sets the Scope field's value.

func (ResourceChange) String added in v1.1.15 

func (s ResourceChange) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceChangeDetail added in v1.1.15 

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 `type:"string"`

	// The group to which the CausingEntity value belongs. There are five entity
	// groups:
	//
	//    * ResourceReference entities are Ref intrinsic functions that refer to
	//    resources in the template, such as { "Ref" : "MyEC2InstanceResource" }.
	//
	//    * ParameterReference entities are Ref intrinsic functions that get template
	//    parameter values, such as { "Ref" : "MyPasswordParameter" }.
	//
	//    * ResourceAttribute entities are Fn::GetAtt intrinsic functions that get
	//    resource attribute values, such as { "Fn::GetAtt" : [ "MyEC2InstanceResource",
	//    "PublicDnsName" ] }.
	//
	//    * DirectModification entities are changes that are made directly to the
	//    template.
	//
	//    * Automatic entities are AWS::CloudFormation::Stack resource types, which
	//    are also known as nested stacks. If you made no changes to the AWS::CloudFormation::Stack
	//    resource, 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 *string `type:"string" enum:"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 *string `type:"string" enum:"EvaluationType"`

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

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

func (ResourceChangeDetail) GoString added in v1.1.15 

func (s ResourceChangeDetail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceChangeDetail) SetCausingEntity added in v1.5.0 

func (s *ResourceChangeDetail) SetCausingEntity(v string) *ResourceChangeDetail

SetCausingEntity sets the CausingEntity field's value.

func (*ResourceChangeDetail) SetChangeSource added in v1.5.0 

func (s *ResourceChangeDetail) SetChangeSource(v string) *ResourceChangeDetail

SetChangeSource sets the ChangeSource field's value.

func (*ResourceChangeDetail) SetEvaluation added in v1.5.0 

func (s *ResourceChangeDetail) SetEvaluation(v string) *ResourceChangeDetail

SetEvaluation sets the Evaluation field's value.

func (*ResourceChangeDetail) SetTarget added in v1.5.0 

func (s *ResourceChangeDetail) SetTarget(v *ResourceTargetDefinition) *ResourceChangeDetail

SetTarget sets the Target field's value.

func (ResourceChangeDetail) String added in v1.1.15 

func (s ResourceChangeDetail) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceIdentifierSummary added in v1.25.32 

type ResourceIdentifierSummary struct {

	// The logical IDs of the target resources of the specified ResourceType, as
	// defined in the import template.
	LogicalResourceIds []*string `min:"1" type:"list"`

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

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

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

func (ResourceIdentifierSummary) GoString added in v1.25.32 

func (s ResourceIdentifierSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceIdentifierSummary) SetLogicalResourceIds added in v1.25.32 

func (s *ResourceIdentifierSummary) SetLogicalResourceIds(v []*string) *ResourceIdentifierSummary

SetLogicalResourceIds sets the LogicalResourceIds field's value.

func (*ResourceIdentifierSummary) SetResourceIdentifiers added in v1.25.32 

func (s *ResourceIdentifierSummary) SetResourceIdentifiers(v []*string) *ResourceIdentifierSummary

SetResourceIdentifiers sets the ResourceIdentifiers field's value.

func (*ResourceIdentifierSummary) SetResourceType added in v1.25.32 

func (s *ResourceIdentifierSummary) SetResourceType(v string) *ResourceIdentifierSummary

SetResourceType sets the ResourceType field's value.

func (ResourceIdentifierSummary) String added in v1.25.32 

func (s ResourceIdentifierSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceTargetDefinition added in v1.1.15 

type ResourceTargetDefinition struct {

	// Indicates which resource attribute is triggering this update, such as a change
	// in the resource attribute's Metadata, Properties, or Tags.
	Attribute *string `type:"string" enum:"ResourceAttribute"`

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

	// If the Attribute value is Properties, indicates whether a change to this
	// property causes the resource to be recreated. The value can be Never, Always,
	// or Conditionally. To determine the conditions for a Conditionally recreation,
	// see the update behavior for that property (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
	// in the CloudFormation User Guide.
	RequiresRecreation *string `type:"string" enum:"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.

func (ResourceTargetDefinition) GoString added in v1.1.15 

func (s ResourceTargetDefinition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceTargetDefinition) SetAttribute added in v1.5.0 

func (s *ResourceTargetDefinition) SetAttribute(v string) *ResourceTargetDefinition

SetAttribute sets the Attribute field's value.

func (*ResourceTargetDefinition) SetName added in v1.5.0 

func (s *ResourceTargetDefinition) SetName(v string) *ResourceTargetDefinition

SetName sets the Name field's value.

func (*ResourceTargetDefinition) SetRequiresRecreation added in v1.5.0 

func (s *ResourceTargetDefinition) SetRequiresRecreation(v string) *ResourceTargetDefinition

SetRequiresRecreation sets the RequiresRecreation field's value.

func (ResourceTargetDefinition) String added in v1.1.15 

func (s ResourceTargetDefinition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceToImport added in v1.25.32 

type ResourceToImport struct {

	// The logical ID of the target resource as specified in the template.
	//
	// LogicalResourceId is a required field
	LogicalResourceId *string `type:"string" required:"true"`

	// A key-value pair that identifies the target resource. The key is an identifier
	// property (for example, BucketName for AWS::S3::Bucket resources) and the
	// value is the actual property value (for example, MyS3Bucket).
	//
	// ResourceIdentifier is a required field
	ResourceIdentifier map[string]*string `min:"1" type:"map" required:"true"`

	// The type of resource to import into your stack, such as AWS::S3::Bucket.
	// For a list of supported resource types, see Resources that support import
	// operations (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html)
	// in the CloudFormation User Guide.
	//
	// ResourceType is a required field
	ResourceType *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes the target resource of an import operation.

func (ResourceToImport) GoString added in v1.25.32 

func (s ResourceToImport) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceToImport) SetLogicalResourceId added in v1.25.32 

func (s *ResourceToImport) SetLogicalResourceId(v string) *ResourceToImport

SetLogicalResourceId sets the LogicalResourceId field's value.

func (*ResourceToImport) SetResourceIdentifier added in v1.25.32 

func (s *ResourceToImport) SetResourceIdentifier(v map[string]*string) *ResourceToImport

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (*ResourceToImport) SetResourceType added in v1.25.32 

func (s *ResourceToImport) SetResourceType(v string) *ResourceToImport

SetResourceType sets the ResourceType field's value.

func (ResourceToImport) String added in v1.25.32 

func (s ResourceToImport) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceToImport) Validate added in v1.25.32 

func (s *ResourceToImport) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RollbackConfiguration added in v1.10.33 

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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CancelUpdateStack.html),
	// for example) as necessary.
	//
	// If you specify 0 for this parameter, CloudFormation still monitors the specified
	// rollback triggers during stack creation and update operations. Then, for
	// update operations, it begins disposing of old resources immediately once
	// the operation completes.
	MonitoringTimeInMinutes *int64 `type:"integer"`

	// The triggers to monitor during stack creation or update actions.
	//
	// By default, 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 `type:"list"`
	// 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 Monitor and Roll Back Stack Operations (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-rollback-triggers.html).

func (RollbackConfiguration) GoString added in v1.10.33 

func (s RollbackConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RollbackConfiguration) SetMonitoringTimeInMinutes added in v1.10.33 

func (s *RollbackConfiguration) SetMonitoringTimeInMinutes(v int64) *RollbackConfiguration

SetMonitoringTimeInMinutes sets the MonitoringTimeInMinutes field's value.

func (*RollbackConfiguration) SetRollbackTriggers added in v1.10.33 

func (s *RollbackConfiguration) SetRollbackTriggers(v []*RollbackTrigger) *RollbackConfiguration

SetRollbackTriggers sets the RollbackTriggers field's value.

func (RollbackConfiguration) String added in v1.10.33 

func (s RollbackConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RollbackConfiguration) Validate added in v1.10.33 

func (s *RollbackConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RollbackStackInput added in v1.40.33 

type RollbackStackInput struct {

	// A unique identifier for this RollbackStack request.
	ClientRequestToken *string `min:"1" type:"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 `type:"boolean"`

	// The Amazon Resource Name (ARN) of an Identity and Access Management role
	// that CloudFormation assumes to rollback the stack.
	RoleARN *string `min:"20" type:"string"`

	// The name that's associated with the stack.
	//
	// StackName is a required field
	StackName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RollbackStackInput) GoString added in v1.40.33 

func (s RollbackStackInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RollbackStackInput) SetClientRequestToken added in v1.40.33 

func (s *RollbackStackInput) SetClientRequestToken(v string) *RollbackStackInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*RollbackStackInput) SetRetainExceptOnCreate added in v1.44.312 

func (s *RollbackStackInput) SetRetainExceptOnCreate(v bool) *RollbackStackInput

SetRetainExceptOnCreate sets the RetainExceptOnCreate field's value.

func (*RollbackStackInput) SetRoleARN added in v1.40.33 

func (s *RollbackStackInput) SetRoleARN(v string) *RollbackStackInput

SetRoleARN sets the RoleARN field's value.

func (*RollbackStackInput) SetStackName added in v1.40.33 

func (s *RollbackStackInput) SetStackName(v string) *RollbackStackInput

SetStackName sets the StackName field's value.

func (RollbackStackInput) String added in v1.40.33 

func (s RollbackStackInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RollbackStackInput) Validate added in v1.40.33 

func (s *RollbackStackInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RollbackStackOutput added in v1.40.33 

type RollbackStackOutput struct {

	// Unique identifier of the stack.
	StackId *string `type:"string"`
	// contains filtered or unexported fields
}

func (RollbackStackOutput) GoString added in v1.40.33 

func (s RollbackStackOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RollbackStackOutput) SetStackId added in v1.40.33 

func (s *RollbackStackOutput) SetStackId(v string) *RollbackStackOutput

SetStackId sets the StackId field's value.

func (RollbackStackOutput) String added in v1.40.33 

func (s RollbackStackOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RollbackTrigger added in v1.10.33 

type RollbackTrigger struct {

	// The Amazon Resource Name (ARN) of the rollback trigger.
	//
	// If a specified trigger is missing, the entire stack operation fails and is
	// rolled back.
	//
	// Arn is a required field
	Arn *string `type:"string" required:"true"`

	// The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm
	// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html)
	// or AWS::CloudWatch::CompositeAlarm (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html)
	// resource types.
	//
	// Type is a required field
	Type *string `type:"string" required:"true"`
	// 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.

func (RollbackTrigger) GoString added in v1.10.33 

func (s RollbackTrigger) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RollbackTrigger) SetArn added in v1.10.33 

func (s *RollbackTrigger) SetArn(v string) *RollbackTrigger

SetArn sets the Arn field's value.

func (*RollbackTrigger) SetType added in v1.10.33 

func (s *RollbackTrigger) SetType(v string) *RollbackTrigger

SetType sets the Type field's value.

func (RollbackTrigger) String added in v1.10.33 

func (s RollbackTrigger) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RollbackTrigger) Validate added in v1.10.33 

func (s *RollbackTrigger) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SetStackPolicyInput 

type SetStackPolicyInput struct {

	// The name or unique stack ID that you want to associate a policy with.
	//
	// StackName is a required field
	StackName *string `type:"string" required:"true"`

	// Structure containing the stack policy body. For more information, go to Prevent
	// updates to stack resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html)
	// in the CloudFormation User Guide. You can specify either the StackPolicyBody
	// or the StackPolicyURL parameter, but not both.
	StackPolicyBody *string `min:"1" type:"string"`

	// Location of a file containing the stack policy. The URL must point to a policy
	// (maximum size: 16 KB) located in an Amazon S3 bucket in the same Amazon Web
	// Services Region as the stack. You can specify either the StackPolicyBody
	// or the StackPolicyURL parameter, but not both.
	StackPolicyURL *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The input for the SetStackPolicy action.

func (SetStackPolicyInput) GoString added in v0.6.5 

func (s SetStackPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetStackPolicyInput) SetStackName added in v1.5.0 

func (s *SetStackPolicyInput) SetStackName(v string) *SetStackPolicyInput

SetStackName sets the StackName field's value.

func (*SetStackPolicyInput) SetStackPolicyBody added in v1.5.0 

func (s *SetStackPolicyInput) SetStackPolicyBody(v string) *SetStackPolicyInput

SetStackPolicyBody sets the StackPolicyBody field's value.

func (*SetStackPolicyInput) SetStackPolicyURL added in v1.5.0 

func (s *SetStackPolicyInput) SetStackPolicyURL(v string) *SetStackPolicyInput

SetStackPolicyURL sets the StackPolicyURL field's value.

func (SetStackPolicyInput) String added in v0.6.5 

func (s SetStackPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetStackPolicyInput) Validate added in v1.1.21 

func (s *SetStackPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SetStackPolicyOutput 

type SetStackPolicyOutput struct {
	// contains filtered or unexported fields
}

func (SetStackPolicyOutput) GoString added in v0.6.5 

func (s SetStackPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (SetStackPolicyOutput) String added in v0.6.5 

func (s SetStackPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SetTypeConfigurationInput added in v1.38.65 

type SetTypeConfigurationInput struct {

	// The configuration data for the extension, in this account and Region.
	//
	// The configuration data must be formatted as JSON, and validate against the
	// schema returned in the ConfigurationSchema response element of DescribeType
	// (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html).
	// For more information, see Defining account-level configuration data for an
	// extension (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-model.html#resource-type-howto-configuration)
	// in the CloudFormation CLI User Guide.
	//
	// Configuration is a required field
	Configuration *string `min:"1" type:"string" required:"true"`

	// An alias by which to refer to this extension configuration data.
	//
	// Conditional: Specifying a configuration alias is required when setting a
	// configuration for a resource type extension.
	ConfigurationAlias *string `min:"1" type:"string"`

	// The type of extension.
	//
	// Conditional: You must specify ConfigurationArn, or Type and TypeName.
	Type *string `type:"string" enum:"ThirdPartyType"`

	// The Amazon Resource Name (ARN) for the extension, in this account and Region.
	//
	// For public extensions, this will be the ARN assigned when you activate the
	// type (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html)
	// in this account and Region. For private extensions, this will be the ARN
	// assigned when you register the type (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html)
	// in this account and Region.
	//
	// Do not include the extension versions suffix at the end of the ARN. You can
	// set the configuration for an extension, but not for a specific extension
	// version.
	TypeArn *string `type:"string"`

	// The name of the extension.
	//
	// Conditional: You must specify ConfigurationArn, or Type and TypeName.
	TypeName *string `min:"10" type:"string"`
	// contains filtered or unexported fields
}

func (SetTypeConfigurationInput) GoString added in v1.38.65 

func (s SetTypeConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetTypeConfigurationInput) SetConfiguration added in v1.38.65 

func (s *SetTypeConfigurationInput) SetConfiguration(v string) *SetTypeConfigurationInput

SetConfiguration sets the Configuration field's value.

func (*SetTypeConfigurationInput) SetConfigurationAlias added in v1.38.65 

func (s *SetTypeConfigurationInput) SetConfigurationAlias(v string) *SetTypeConfigurationInput

SetConfigurationAlias sets the ConfigurationAlias field's value.

func (*SetTypeConfigurationInput) SetType added in v1.38.65 

func (s *SetTypeConfigurationInput) SetType(v string) *SetTypeConfigurationInput

SetType sets the Type field's value.

func (*SetTypeConfigurationInput) SetTypeArn added in v1.38.65 

func (s *SetTypeConfigurationInput) SetTypeArn(v string) *SetTypeConfigurationInput

SetTypeArn sets the TypeArn field's value.

func (*SetTypeConfigurationInput) SetTypeName added in v1.38.65 

func (s *SetTypeConfigurationInput) SetTypeName(v string) *SetTypeConfigurationInput

SetTypeName sets the TypeName field's value.

func (SetTypeConfigurationInput) String added in v1.38.65 

func (s SetTypeConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetTypeConfigurationInput) Validate added in v1.38.65 

func (s *SetTypeConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SetTypeConfigurationOutput added in v1.38.65 

type SetTypeConfigurationOutput struct {

	// The Amazon Resource Name (ARN) for the configuration data, in this account
	// and Region.
	//
	// Conditional: You must specify ConfigurationArn, or Type and TypeName.
	ConfigurationArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (SetTypeConfigurationOutput) GoString added in v1.38.65 

func (s SetTypeConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetTypeConfigurationOutput) SetConfigurationArn added in v1.38.65 

func (s *SetTypeConfigurationOutput) SetConfigurationArn(v string) *SetTypeConfigurationOutput

SetConfigurationArn sets the ConfigurationArn field's value.

func (SetTypeConfigurationOutput) String added in v1.38.65 

func (s SetTypeConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SetTypeDefaultVersionInput added in v1.25.37 

type SetTypeDefaultVersionInput struct {

	// The Amazon Resource Name (ARN) of the extension for which you want version
	// summary information.
	//
	// Conditional: You must specify either TypeName and Type, or Arn.
	Arn *string `type:"string"`

	// The kind of extension.
	//
	// Conditional: You must specify either TypeName and Type, or Arn.
	Type *string `type:"string" enum:"RegistryType"`

	// The name of the extension.
	//
	// Conditional: You must specify either TypeName and Type, or Arn.
	TypeName *string `min:"10" type:"string"`

	// The ID of a specific version of the extension. The version ID is the value
	// at the end of the Amazon Resource Name (ARN) assigned to the extension version
	// when it is registered.
	VersionId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (SetTypeDefaultVersionInput) GoString added in v1.25.37 

func (s SetTypeDefaultVersionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetTypeDefaultVersionInput) SetArn added in v1.25.37 

func (s *SetTypeDefaultVersionInput) SetArn(v string) *SetTypeDefaultVersionInput

SetArn sets the Arn field's value.

func (*SetTypeDefaultVersionInput) SetType added in v1.25.37 

func (s *SetTypeDefaultVersionInput) SetType(v string) *SetTypeDefaultVersionInput

SetType sets the Type field's value.

func (*SetTypeDefaultVersionInput) SetTypeName added in v1.25.37 

func (s *SetTypeDefaultVersionInput) SetTypeName(v string) *SetTypeDefaultVersionInput

SetTypeName sets the TypeName field's value.

func (*SetTypeDefaultVersionInput) SetVersionId added in v1.25.37 

func (s *SetTypeDefaultVersionInput) SetVersionId(v string) *SetTypeDefaultVersionInput

SetVersionId sets the VersionId field's value.

func (SetTypeDefaultVersionInput) String added in v1.25.37 

func (s SetTypeDefaultVersionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SetTypeDefaultVersionInput) Validate added in v1.25.37 

func (s *SetTypeDefaultVersionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SetTypeDefaultVersionOutput added in v1.25.37 

type SetTypeDefaultVersionOutput struct {
	// contains filtered or unexported fields
}

func (SetTypeDefaultVersionOutput) GoString added in v1.25.37 

func (s SetTypeDefaultVersionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (SetTypeDefaultVersionOutput) String added in v1.25.37 

func (s SetTypeDefaultVersionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SignalResourceInput 

type SignalResourceInput struct {

	// The logical ID of the resource that you want to signal. The logical ID is
	// the name of the resource that given in the template.
	//
	// LogicalResourceId is a required field
	LogicalResourceId *string `type:"string" required:"true"`

	// The stack name or unique stack ID that includes the resource that you want
	// to signal.
	//
	// StackName is a required field
	StackName *string `min:"1" type:"string" required:"true"`

	// The status of the signal, which is either success or failure. A failure signal
	// causes CloudFormation to immediately fail the stack creation or update.
	//
	// Status is a required field
	Status *string `type:"string" required:"true" enum:"ResourceSignalStatus"`

	// A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling
	// groups, specify the instance ID that you are signaling as the unique ID.
	// If you send multiple signals to a single resource (such as signaling a wait
	// condition), each signal requires a different unique ID.
	//
	// UniqueId is a required field
	UniqueId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the SignalResource action.

func (SignalResourceInput) GoString added in v0.6.5 

func (s SignalResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SignalResourceInput) SetLogicalResourceId added in v1.5.0 

func (s *SignalResourceInput) SetLogicalResourceId(v string) *SignalResourceInput

SetLogicalResourceId sets the LogicalResourceId field's value.

func (*SignalResourceInput) SetStackName added in v1.5.0 

func (s *SignalResourceInput) SetStackName(v string) *SignalResourceInput

SetStackName sets the StackName field's value.

func (*SignalResourceInput) SetStatus added in v1.5.0 

func (s *SignalResourceInput) SetStatus(v string) *SignalResourceInput

SetStatus sets the Status field's value.

func (*SignalResourceInput) SetUniqueId added in v1.5.0 

func (s *SignalResourceInput) SetUniqueId(v string) *SignalResourceInput

SetUniqueId sets the UniqueId field's value.

func (SignalResourceInput) String added in v0.6.5 

func (s SignalResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SignalResourceInput) Validate added in v1.1.21 

func (s *SignalResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SignalResourceOutput 

type SignalResourceOutput struct {
	// contains filtered or unexported fields
}

func (SignalResourceOutput) GoString added in v0.6.5 

func (s SignalResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (SignalResourceOutput) String added in v0.6.5 

func (s SignalResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Stack 

type Stack struct {

	// The capabilities allowed in the stack.
	Capabilities []*string `type:"list" enum:"Capability"`

	// The unique ID of the change set.
	ChangeSetId *string `min:"1" type:"string"`

	// The time at which the stack was created.
	//
	// CreationTime is a required field
	CreationTime *time.Time `type:"timestamp" required:"true"`

	// The time the stack was deleted.
	DeletionTime *time.Time `type:"timestamp"`

	// A user-defined description associated with the stack.
	Description *string `min:"1" type:"string"`

	// Boolean to enable or disable rollback on stack creation failures:
	//
	//    * true: disable rollback.
	//
	//    * false: enable rollback.
	DisableRollback *bool `type:"boolean"`

	// Information 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
	// Detecting Unregulated Configuration Changes to Stacks and Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html).
	DriftInformation *StackDriftInformation `type:"structure"`

	// Whether termination protection is enabled for the stack.
	//
	// For nested stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html),
	// termination protection is set on the root stack and can't be changed directly
	// on the nested stack. For more information, see Protecting a Stack From Being
	// Deleted (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html)
	// in the CloudFormation User Guide.
	EnableTerminationProtection *bool `type:"boolean"`

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

	// Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events
	// are published.
	NotificationARNs []*string `type:"list"`

	// A list of output structures.
	Outputs []*Output `type:"list"`

	// A list of Parameter structures.
	Parameters []*Parameter `type:"list"`

	// For nested stacks--stacks created as resources for another stack--the stack
	// ID of the direct parent of this stack. For the first level of nested stacks,
	// the root stack is also the parent stack.
	//
	// For more information, see Working with Nested Stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html)
	// in the CloudFormation User Guide.
	ParentId *string `type:"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 `type:"boolean"`

	// The Amazon Resource Name (ARN) of an Identity and Access Management (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 `min:"20" type:"string"`

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

	// For nested stacks--stacks created as resources for another stack--the stack
	// ID of the top-level stack to which the nested stack ultimately belongs.
	//
	// For more information, see Working with Nested Stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html)
	// in the CloudFormation User Guide.
	RootId *string `type:"string"`

	// Unique identifier of the stack.
	StackId *string `type:"string"`

	// The name associated with the stack.
	//
	// StackName is a required field
	StackName *string `type:"string" required:"true"`

	// Current status of the stack.
	//
	// StackStatus is a required field
	StackStatus *string `type:"string" required:"true" enum:"StackStatus"`

	// Success/failure message associated with the stack status.
	StackStatusReason *string `type:"string"`

	// A list of Tags that specify information about the stack.
	Tags []*Tag `type:"list"`

	// The amount of time within which stack creation should complete.
	TimeoutInMinutes *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

The Stack data type.

func (Stack) GoString added in v0.6.5 

func (s Stack) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Stack) SetCapabilities added in v1.5.0 

func (s *Stack) SetCapabilities(v []*string) *Stack

SetCapabilities sets the Capabilities field's value.

func (*Stack) SetChangeSetId added in v1.5.0 

func (s *Stack) SetChangeSetId(v string) *Stack

SetChangeSetId sets the ChangeSetId field's value.

func (*Stack) SetCreationTime added in v1.5.0 

func (s *Stack) SetCreationTime(v time.Time) *Stack

SetCreationTime sets the CreationTime field's value.

func (*Stack) SetDeletionTime added in v1.11.0 

func (s *Stack) SetDeletionTime(v time.Time) *Stack

SetDeletionTime sets the DeletionTime field's value.

func (*Stack) SetDescription added in v1.5.0 

func (s *Stack) SetDescription(v string) *Stack

SetDescription sets the Description field's value.

func (*Stack) SetDisableRollback added in v1.5.0 

func (s *Stack) SetDisableRollback(v bool) *Stack

SetDisableRollback sets the DisableRollback field's value.

func (*Stack) SetDriftInformation added in v1.15.74 

func (s *Stack) SetDriftInformation(v *StackDriftInformation) *Stack

SetDriftInformation sets the DriftInformation field's value.

func (*Stack) SetEnableTerminationProtection added in v1.11.0 

func (s *Stack) SetEnableTerminationProtection(v bool) *Stack

SetEnableTerminationProtection sets the EnableTerminationProtection field's value.

func (*Stack) SetLastUpdatedTime added in v1.5.0 

func (s *Stack) SetLastUpdatedTime(v time.Time) *Stack

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*Stack) SetNotificationARNs added in v1.5.0 

func (s *Stack) SetNotificationARNs(v []*string) *Stack

SetNotificationARNs sets the NotificationARNs field's value.

func (*Stack) SetOutputs added in v1.5.0 

func (s *Stack) SetOutputs(v []*Output) *Stack

SetOutputs sets the Outputs field's value.

func (*Stack) SetParameters added in v1.5.0 

func (s *Stack) SetParameters(v []*Parameter) *Stack

SetParameters sets the Parameters field's value.

func (*Stack) SetParentId added in v1.11.0 

func (s *Stack) SetParentId(v string) *Stack

SetParentId sets the ParentId field's value.

func (*Stack) SetRetainExceptOnCreate added in v1.44.312 

func (s *Stack) SetRetainExceptOnCreate(v bool) *Stack

SetRetainExceptOnCreate sets the RetainExceptOnCreate field's value.

func (*Stack) SetRoleARN added in v1.5.0 

func (s *Stack) SetRoleARN(v string) *Stack

SetRoleARN sets the RoleARN field's value.

func (*Stack) SetRollbackConfiguration added in v1.10.33 

func (s *Stack) SetRollbackConfiguration(v *RollbackConfiguration) *Stack

SetRollbackConfiguration sets the RollbackConfiguration field's value.

func (*Stack) SetRootId added in v1.11.0 

func (s *Stack) SetRootId(v string) *Stack

SetRootId sets the RootId field's value.

func (*Stack) SetStackId added in v1.5.0 

func (s *Stack) SetStackId(v string) *Stack

SetStackId sets the StackId field's value.

func (*Stack) SetStackName added in v1.5.0 

func (s *Stack) SetStackName(v string) *Stack

SetStackName sets the StackName field's value.

func (*Stack) SetStackStatus added in v1.5.0 

func (s *Stack) SetStackStatus(v string) *Stack

SetStackStatus sets the StackStatus field's value.

func (*Stack) SetStackStatusReason added in v1.5.0 

func (s *Stack) SetStackStatusReason(v string) *Stack

SetStackStatusReason sets the StackStatusReason field's value.

func (*Stack) SetTags added in v1.5.0 

func (s *Stack) SetTags(v []*Tag) *Stack

SetTags sets the Tags field's value.

func (*Stack) SetTimeoutInMinutes added in v1.5.0 

func (s *Stack) SetTimeoutInMinutes(v int64) *Stack

SetTimeoutInMinutes sets the TimeoutInMinutes field's value.

func (Stack) String added in v0.6.5 

func (s Stack) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StackDriftInformation added in v1.15.74 

type StackDriftInformation struct {

	// Most recent time when a drift detection operation was initiated on the stack,
	// or any of its individual resources that support drift detection.
	LastCheckTimestamp *time.Time `type:"timestamp"`

	// Status of the stack's actual configuration compared to its expected template
	// configuration.
	//
	//    * DRIFTED: The stack differs from its expected template configuration.
	//    A stack is considered to have drifted if one or more of its resources
	//    have drifted.
	//
	//    * NOT_CHECKED: 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.
	//
	// StackDriftStatus is a required field
	StackDriftStatus *string `type:"string" required:"true" enum:"StackDriftStatus"`
	// contains filtered or unexported fields
}

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

func (StackDriftInformation) GoString added in v1.15.74 

func (s StackDriftInformation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StackDriftInformation) SetLastCheckTimestamp added in v1.15.74 

func (s *StackDriftInformation) SetLastCheckTimestamp(v time.Time) *StackDriftInformation

SetLastCheckTimestamp sets the LastCheckTimestamp field's value.

func (*StackDriftInformation) SetStackDriftStatus added in v1.15.74 

func (s *StackDriftInformation) SetStackDriftStatus(v string) *StackDriftInformation

SetStackDriftStatus sets the StackDriftStatus field's value.

func (StackDriftInformation) String added in v1.15.74 

func (s StackDriftInformation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StackDriftInformationSummary added in v1.15.74 

type StackDriftInformationSummary struct {

	// Most recent time when a drift detection operation was initiated on the stack,
	// or any of its individual resources that support drift detection.
	LastCheckTimestamp *time.Time `type:"timestamp"`

	// Status of the stack's actual configuration compared to its expected template
	// configuration.
	//
	//    * DRIFTED: The stack differs from its expected template configuration.
	//    A stack is considered to have drifted if one or more of its resources
	//    have drifted.
	//
	//    * NOT_CHECKED: 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.
	//
	// StackDriftStatus is a required field
	StackDriftStatus *string `type:"string" required:"true" enum:"StackDriftStatus"`
	// contains filtered or unexported fields
}

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

func (StackDriftInformationSummary) GoString added in v1.15.74 

func (s StackDriftInformationSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StackDriftInformationSummary) SetLastCheckTimestamp added in v1.15.74 

func (s *StackDriftInformationSummary) SetLastCheckTimestamp(v time.Time) *StackDriftInformationSummary

SetLastCheckTimestamp sets the LastCheckTimestamp field's value.

func (*StackDriftInformationSummary) SetStackDriftStatus added in v1.15.74 

func (s *StackDriftInformationSummary) SetStackDriftStatus(v string) *StackDriftInformationSummary

SetStackDriftStatus sets the StackDriftStatus field's value.

func (StackDriftInformationSummary) String added in v1.15.74 

func (s StackDriftInformationSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StackEvent 

type StackEvent struct {

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

	// The unique ID of this event.
	//
	// EventId is a required field
	EventId *string `type:"string" required:"true"`

	// 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 *string `type:"string" enum:"HookFailureMode"`

	// Invocation points are points in provisioning logic where hooks are initiated.
	HookInvocationPoint *string `type:"string" enum:"HookInvocationPoint"`

	// Provides the status of the change set hook.
	HookStatus *string `type:"string" enum:"HookStatus"`

	// Provides the reason for the hook status.
	HookStatusReason *string `min:"1" type:"string"`

	// The name of the hook.
	HookType *string `min:"1" type:"string"`

	// The logical name of the resource specified in the template.
	LogicalResourceId *string `type:"string"`

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

	// BLOB of the properties used to create the resource.
	ResourceProperties *string `type:"string"`

	// Current status of the resource.
	ResourceStatus *string `type:"string" enum:"ResourceStatus"`

	// Success/failure message associated with the resource.
	ResourceStatusReason *string `type:"string"`

	// Type of resource. (For more information, go to Amazon Web Services Resource
	// Types Reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
	// in the CloudFormation User Guide.)
	ResourceType *string `min:"1" type:"string"`

	// The unique ID name of the instance of the stack.
	//
	// StackId is a required field
	StackId *string `type:"string" required:"true"`

	// The name associated with a stack.
	//
	// StackName is a required field
	StackName *string `type:"string" required:"true"`

	// Time the status was updated.
	//
	// Timestamp is a required field
	Timestamp *time.Time `type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

The StackEvent data type.

func (StackEvent) GoString added in v0.6.5 

func (s StackEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StackEvent) SetClientRequestToken added in v1.8.18 

func (s *StackEvent) SetClientRequestToken(v string) *StackEvent

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StackEvent) SetEventId added in v1.5.0 

func (s *StackEvent) SetEventId(v string) *StackEvent

SetEventId sets the EventId field's value.

func (*StackEvent) SetHookFailureMode added in v1.42.50 

func (s *StackEvent) SetHookFailureMode(v string) *StackEvent

SetHookFailureMode sets the HookFailureMode field's value.

func (*StackEvent) SetHookInvocationPoint added in v1.42.50 

func (s *StackEvent) SetHookInvocationPoint(v string) *StackEvent

SetHookInvocationPoint sets the HookInvocationPoint field's value.

func (*StackEvent) SetHookStatus added in v1.42.50 

func (s *StackEvent) SetHookStatus(v string) *StackEvent

SetHookStatus sets the HookStatus field's value.

func (*StackEvent) SetHookStatusReason added in v1.42.50 

func (s *StackEvent) SetHookStatusReason(v string) *StackEvent

SetHookStatusReason sets the HookStatusReason field's value.

func (*StackEvent) SetHookType added in v1.42.50 

func (s *StackEvent) SetHookType(v string) *StackEvent

SetHookType sets the HookType field's value.

func (*StackEvent) SetLogicalResourceId added in v1.5.0 

func (s *StackEvent) SetLogicalResourceId(v string) *StackEvent

SetLogicalResourceId sets the LogicalResourceId field's value.

func (*StackEvent) SetPhysicalResourceId added in v1.5.0 

func (s *StackEvent) SetPhysicalResourceId(v string) *StackEvent

SetPhysicalResourceId sets the PhysicalResourceId field's value.

func (*StackEvent) SetResourceProperties added in v1.5.0 

func (s *StackEvent) SetResourceProperties(v string) *StackEvent

SetResourceProperties sets the ResourceProperties field's value.

func (*StackEvent) SetResourceStatus added in v1.5.0 

func (s *StackEvent) SetResourceStatus(v string) *StackEvent

SetResourceStatus sets the ResourceStatus field's value.

func (*StackEvent) SetResourceStatusReason added in v1.5.0 

func (s *StackEvent) SetResourceStatusReason(v string) *StackEvent

SetResourceStatusReason sets the ResourceStatusReason field's value.

func (*StackEvent) SetResourceType added in v1.5.0 

func (s *StackEvent) SetResourceType(v string) *StackEvent

SetResourceType sets the ResourceType field's value.

func (*StackEvent) SetStackId added in v1.5.0 

func (s *StackEvent) SetStackId(v string) *StackEvent

SetStackId sets the StackId field's value.

func (*StackEvent) SetStackName added in v1.5.0 

func (s *StackEvent) SetStackName(v string) *StackEvent

SetStackName sets the StackName field's value.

func (*StackEvent) SetTimestamp added in v1.5.0 

func (s *StackEvent) SetTimestamp(v time.Time) *StackEvent

SetTimestamp sets the Timestamp field's value.

func (StackEvent) String added in v0.6.5 

func (s StackEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StackInstance added in v1.10.16 

type StackInstance struct {

	// [Self-managed permissions] The name of the Amazon Web Services account that
	// the stack instance is associated with.
	Account *string `type:"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 *string `type:"string" enum:"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 `type:"timestamp"`

	// The last unique ID of a StackSet operation performed on a stack instance.
	LastOperationId *string `min:"1" type:"string"`

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

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

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

	// The ID of the stack instance.
	StackId *string `type:"string"`

	// The detailed status of the stack instance.
	StackInstanceStatus *StackInstanceComprehensiveStatus `type:"structure"`

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

	// The status of the stack instance, in terms of its synchronization with its
	// associated stack set.
	//
	//    * INOPERABLE: A DeleteStackInstances operation has failed and left the
	//    stack in an unstable state. Stacks in this state are excluded from further
	//    UpdateStackSet operations. You might need to perform a DeleteStackInstances
	//    operation, with RetainStacks set to true, to delete the stack instance,
	//    and then delete the stack manually.
	//
	//    * OUTDATED: The stack isn't currently up to date with the stack set because:
	//    The associated stack failed during a CreateStackSet or UpdateStackSet
	//    operation. The stack was part of a CreateStackSet or UpdateStackSet operation
	//    that failed or was stopped before the stack was created or updated.
	//
	//    * CURRENT: The stack is currently up to date with the stack set.
	Status *string `type:"string" enum:"StackInstanceStatus"`

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

An 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.

func (StackInstance) GoString added in v1.10.16 

func (s StackInstance) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StackInstance) SetAccount added in v1.10.16 

func (s *StackInstance) SetAccount(v string) *StackInstance

SetAccount sets the Account field's value.

func (*StackInstance) SetDriftStatus added in v1.25.38 

func (s *StackInstance) SetDriftStatus(v string) *StackInstance

SetDriftStatus sets the DriftStatus field's value.

func (*StackInstance) SetLastDriftCheckTimestamp added in v1.25.38 

func (s *StackInstance) SetLastDriftCheckTimestamp(v time.Time) *StackInstance

SetLastDriftCheckTimestamp sets the LastDriftCheckTimestamp field's value.

func (*StackInstance) SetLastOperationId added in v1.44.126 

func (s *StackInstance) SetLastOperationId(v string) *StackInstance

SetLastOperationId sets the LastOperationId field's value.

func (*StackInstance) SetOrganizationalUnitId added in v1.29.0 

func (s *StackInstance) SetOrganizationalUnitId(v string) *StackInstance

SetOrganizationalUnitId sets the OrganizationalUnitId field's value.

func (*StackInstance) SetParameterOverrides added in v1.12.32 

func (s *StackInstance) SetParameterOverrides(v []*Parameter) *StackInstance

SetParameterOverrides sets the ParameterOverrides field's value.

func (*StackInstance) SetRegion added in v1.10.16 

func (s *StackInstance) SetRegion(v string) *StackInstance

SetRegion sets the Region field's value.

func (*StackInstance) SetStackId added in v1.10.16 

func (s *StackInstance) SetStackId(v string) *StackInstance

SetStackId sets the StackId field's value.

func (*StackInstance) SetStackInstanceStatus added in v1.32.11 

func (s *StackInstance) SetStackInstanceStatus(v *StackInstanceComprehensiveStatus) *StackInstance

SetStackInstanceStatus sets the StackInstanceStatus field's value.

func (*StackInstance) SetStackSetId added in v1.10.16 

func (s *StackInstance) SetStackSetId(v string) *StackInstance

SetStackSetId sets the StackSetId field's value.

func (*StackInstance) SetStatus added in v1.10.16 

func (s *StackInstance) SetStatus(v string) *StackInstance

SetStatus sets the Status field's value.

func (*StackInstance) SetStatusReason added in v1.10.16 

func (s *StackInstance) SetStatusReason(v string) *StackInstance

SetStatusReason sets the StatusReason field's value.

func (StackInstance) String added in v1.10.16 

func (s StackInstance) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StackInstanceComprehensiveStatus added in v1.32.11 

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.
	//
	//    * 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 *string `type:"string" enum:"StackInstanceDetailedStatus"`
	// contains filtered or unexported fields
}

The detailed status of the stack instance.

func (StackInstanceComprehensiveStatus) GoString added in v1.32.11 

func (s StackInstanceComprehensiveStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StackInstanceComprehensiveStatus) SetDetailedStatus added in v1.32.11 

func (s *StackInstanceComprehensiveStatus) SetDetailedStatus(v string) *StackInstanceComprehensiveStatus

SetDetailedStatus sets the DetailedStatus field's value.

func (StackInstanceComprehensiveStatus) String added in v1.32.11 

func (s StackInstanceComprehensiveStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StackInstanceFilter added in v1.32.11 

type StackInstanceFilter struct {

	// The type of filter to apply.
	Name *string `type:"string" enum:"StackInstanceFilterName"`

	// The status to filter by.
	Values *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The filter to apply to stack instances

func (StackInstanceFilter) GoString added in v1.32.11 

func (s StackInstanceFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StackInstanceFilter) SetName added in v1.32.11 

func (s *StackInstanceFilter) SetName(v string) *StackInstanceFilter

SetName sets the Name field's value.

func (*StackInstanceFilter) SetValues added in v1.32.11 

func (s *StackInstanceFilter) SetValues(v string) *StackInstanceFilter

SetValues sets the Values field's value.

func (StackInstanceFilter) String added in v1.32.11 

func (s StackInstanceFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StackInstanceFilter) Validate added in v1.32.11 

func (s *StackInstanceFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StackInstanceResourceDriftsSummary added in v1.44.307 

type StackInstanceResourceDriftsSummary struct {

	// The logical name of the resource specified in the template.
	//
	// LogicalResourceId is a required field
	LogicalResourceId *string `type:"string" required:"true"`

	// The name or unique identifier that corresponds to a physical instance ID
	// of a resource supported by CloudFormation.
	PhysicalResourceId *string `type:"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 `type:"list"`

	// 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 `type:"list"`

	// Type of resource. For more information, go to Amazon Web Services Resource
	// Types Reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
	// in the CloudFormation User Guide.
	//
	// ResourceType is a required field
	ResourceType *string `min:"1" type:"string" required:"true"`

	// The ID of the stack instance.
	//
	// StackId is a required field
	StackId *string `type:"string" required:"true"`

	// 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.
	//
	// StackResourceDriftStatus is a required field
	StackResourceDriftStatus *string `type:"string" required:"true" enum:"StackResourceDriftStatus"`

	// Time at which the stack instance drift detection operation was initiated.
	//
	// Timestamp is a required field
	Timestamp *time.Time `type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

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

func (StackInstanceResourceDriftsSummary) GoString added in v1.44.307 

func (s StackInstanceResourceDriftsSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StackInstanceResourceDriftsSummary) SetLogicalResourceId added in v1.44.307 

func (s *StackInstanceResourceDriftsSummary) SetLogicalResourceId(v string) *StackInstanceResourceDriftsSummary

SetLogicalResourceId sets the LogicalResourceId field's value.

func (*StackInstanceResourceDriftsSummary) SetPhysicalResourceId added in v1.44.307 

func (s *StackInstanceResourceDriftsSummary) SetPhysicalResourceId(v string) *StackInstanceResourceDriftsSummary

SetPhysicalResourceId sets the PhysicalResourceId field's value.

func (*StackInstanceResourceDriftsSummary) SetPhysicalResourceIdContext added in v1.44.307 

func (s *StackInstanceResourceDriftsSummary) SetPhysicalResourceIdContext(v []*PhysicalResourceIdContextKeyValuePair) *StackInstanceResourceDriftsSummary

SetPhysicalResourceIdContext sets the PhysicalResourceIdContext field's value.

func (*StackInstanceResourceDriftsSummary) SetPropertyDifferences added in v1.44.307 

func (s *StackInstanceResourceDriftsSummary) SetPropertyDifferences(v []*PropertyDifference) *StackInstanceResourceDriftsSummary

SetPropertyDifferences sets the PropertyDifferences field's value.

func (*StackInstanceResourceDriftsSummary) SetResourceType added in v1.44.307 

func (s *StackInstanceResourceDriftsSummary) SetResourceType(v string) *StackInstanceResourceDriftsSummary

SetResourceType sets the ResourceType field's value.

func (*StackInstanceResourceDriftsSummary) SetStackId added in v1.44.307 

func (s *StackInstanceResourceDriftsSummary) SetStackId(v string) *StackInstanceResourceDriftsSummary

SetStackId sets the StackId field's value.

func (*StackInstanceResourceDriftsSummary) SetStackResourceDriftStatus added in v1.44.307 

func (s *StackInstanceResourceDriftsSummary) SetStackResourceDriftStatus(v string) *StackInstanceResourceDriftsSummary

SetStackResourceDriftStatus sets the StackResourceDriftStatus field's value.

func (*StackInstanceResourceDriftsSummary) SetTimestamp added in v1.44.307 

func (s *StackInstanceResourceDriftsSummary) SetTimestamp(v time.Time) *StackInstanceResourceDriftsSummary

SetTimestamp sets the Timestamp field's value.

func (StackInstanceResourceDriftsSummary) String added in v1.44.307 

func (s StackInstanceResourceDriftsSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StackInstanceSummary added in v1.10.16 

type StackInstanceSummary struct {

	// [Self-managed permissions] The name of the Amazon Web Services account that
	// the stack instance is associated with.
	Account *string `type:"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 *string `type:"string" enum:"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 `type:"timestamp"`

	// The last unique ID of a StackSet operation performed on a stack instance.
	LastOperationId *string `min:"1" type:"string"`

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

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

	// The ID of the stack instance.
	StackId *string `type:"string"`

	// The detailed status of the stack instance.
	StackInstanceStatus *StackInstanceComprehensiveStatus `type:"structure"`

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

	// The status of the stack instance, in terms of its synchronization with its
	// associated stack set.
	//
	//    * INOPERABLE: A DeleteStackInstances operation has failed and left the
	//    stack in an unstable state. Stacks in this state are excluded from further
	//    UpdateStackSet operations. You might need to perform a DeleteStackInstances
	//    operation, with RetainStacks set to true, to delete the stack instance,
	//    and then delete the stack manually.
	//
	//    * OUTDATED: The stack isn't currently up to date with the stack set because:
	//    The associated stack failed during a CreateStackSet or UpdateStackSet
	//    operation. The stack was part of a CreateStackSet or UpdateStackSet operation
	//    that failed or was stopped before the stack was created or updated.
	//
	//    * CURRENT: The stack is currently up to date with the stack set.
	Status *string `type:"string" enum:"StackInstanceStatus"`

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

The structure that contains summary information about a stack instance.

func (StackInstanceSummary) GoString added in v1.10.16 

func (s StackInstanceSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StackInstanceSummary) SetAccount added in v1.10.16 

func (s *StackInstanceSummary) SetAccount(v string) *StackInstanceSummary

SetAccount sets the Account field's value.

func (*StackInstanceSummary) SetDriftStatus added in v1.25.38 

func (s *StackInstanceSummary) SetDriftStatus(v string) *StackInstanceSummary

SetDriftStatus sets the DriftStatus field's value.

func (*StackInstanceSummary) SetLastDriftCheckTimestamp added in v1.25.38 

func (s *StackInstanceSummary) SetLastDriftCheckTimestamp(v time.Time) *StackInstanceSummary

SetLastDriftCheckTimestamp sets the LastDriftCheckTimestamp field's value.

func (*StackInstanceSummary) SetLastOperationId added in v1.44.126 

func (s *StackInstanceSummary) SetLastOperationId(v string) *StackInstanceSummary

SetLastOperationId sets the LastOperationId field's value.

func (*StackInstanceSummary) SetOrganizationalUnitId added in v1.29.0 

func (s *StackInstanceSummary) SetOrganizationalUnitId(v string) *StackInstanceSummary

SetOrganizationalUnitId sets the OrganizationalUnitId field's value.

func (*StackInstanceSummary) SetRegion added in v1.10.16 

func (s *StackInstanceSummary) SetRegion(v string) *StackInstanceSummary

SetRegion sets the Region field's value.

func (*StackInstanceSummary) SetStackId added in v1.10.16 

func (s *StackInstanceSummary) SetStackId(v string) *StackInstanceSummary

SetStackId sets the StackId field's value.

func (*StackInstanceSummary) SetStackInstanceStatus added in v1.32.11 

func (s *StackInstanceSummary) SetStackInstanceStatus(v *StackInstanceComprehensiveStatus) *StackInstanceSummary

SetStackInstanceStatus sets the StackInstanceStatus field's value.

func (*StackInstanceSummary) SetStackSetId added in v1.10.16 

func (s *StackInstanceSummary) SetStackSetId(v string) *StackInstanceSummary

SetStackSetId sets the StackSetId field's value.

func (*StackInstanceSummary) SetStatus added in v1.10.16 

func (s *StackInstanceSummary) SetStatus(v string) *StackInstanceSummary

SetStatus sets the Status field's value.

func (*StackInstanceSummary) SetStatusReason added in v1.10.16 

func (s *StackInstanceSummary) SetStatusReason(v string) *StackInstanceSummary

SetStatusReason sets the StatusReason field's value.

func (StackInstanceSummary) String added in v1.10.16 

func (s StackInstanceSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StackResource 

type StackResource struct {

	// User defined description associated with the resource.
	Description *string `min:"1" type:"string"`

	// Information about whether the resource's actual configuration differs, or
	// has drifted, from its expected configuration, as defined in the stack template
	// and any values specified as template parameters. For more information, see
	// Detecting Unregulated Configuration Changes to Stacks and Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html).
	DriftInformation *StackResourceDriftInformation `type:"structure"`

	// The logical name of the resource specified in the template.
	//
	// LogicalResourceId is a required field
	LogicalResourceId *string `type:"string" required:"true"`

	// 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 `type:"structure"`

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

	// Current status of the resource.
	//
	// ResourceStatus is a required field
	ResourceStatus *string `type:"string" required:"true" enum:"ResourceStatus"`

	// Success/failure message associated with the resource.
	ResourceStatusReason *string `type:"string"`

	// Type of resource. For more information, go to Amazon Web Services Resource
	// Types Reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
	// in the CloudFormation User Guide.
	//
	// ResourceType is a required field
	ResourceType *string `min:"1" type:"string" required:"true"`

	// Unique identifier of the stack.
	StackId *string `type:"string"`

	// The name associated with the stack.
	StackName *string `type:"string"`

	// Time the status was updated.
	//
	// Timestamp is a required field
	Timestamp *time.Time `type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

The StackResource data type.

func (StackResource) GoString added in v0.6.5 

func (s StackResource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StackResource) SetDescription added in v1.5.0 

func (s *StackResource) SetDescription(v string) *StackResource

SetDescription sets the Description field's value.

func (*StackResource) SetDriftInformation added in v1.15.74 

func (s *StackResource) SetDriftInformation(v *StackResourceDriftInformation) *StackResource

SetDriftInformation sets the DriftInformation field's value.

func (*StackResource) SetLogicalResourceId added in v1.5.0 

func (s *StackResource) SetLogicalResourceId(v string) *StackResource

SetLogicalResourceId sets the LogicalResourceId field's value.

func (*StackResource) SetModuleInfo added in v1.35.35 

func (s *StackResource) SetModuleInfo(v *ModuleInfo) *StackResource

SetModuleInfo sets the ModuleInfo field's value.

func (*StackResource) SetPhysicalResourceId added in v1.5.0 

func (s *StackResource) SetPhysicalResourceId(v string) *StackResource

SetPhysicalResourceId sets the PhysicalResourceId field's value.

func (*StackResource) SetResourceStatus added in v1.5.0 

func (s *StackResource) SetResourceStatus(v string) *StackResource

SetResourceStatus sets the ResourceStatus field's value.

func (*StackResource) SetResourceStatusReason added in v1.5.0 

func (s *StackResource) SetResourceStatusReason(v string) *StackResource

SetResourceStatusReason sets the ResourceStatusReason field's value.

func (*StackResource) SetResourceType added in v1.5.0 

func (s *StackResource) SetResourceType(v string) *StackResource

SetResourceType sets the ResourceType field's value.

func (*StackResource) SetStackId added in v1.5.0 

func (s *StackResource) SetStackId(v string) *StackResource

SetStackId sets the StackId field's value.

func (*StackResource) SetStackName added in v1.5.0 

func (s *StackResource) SetStackName(v string) *StackResource

SetStackName sets the StackName field's value.

func (*StackResource) SetTimestamp added in v1.5.0 

func (s *StackResource) SetTimestamp(v time.Time) *StackResource

SetTimestamp sets the Timestamp field's value.

func (StackResource) String added in v0.6.5 

func (s StackResource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StackResourceDetail 

type StackResourceDetail struct {

	// User defined description associated with the resource.
	Description *string `min:"1" type:"string"`

	// Information about whether the resource's actual configuration differs, or
	// has drifted, from its expected configuration, as defined in the stack template
	// and any values specified as template parameters. For more information, see
	// Detecting Unregulated Configuration Changes to Stacks and Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html).
	DriftInformation *StackResourceDriftInformation `type:"structure"`

	// Time the status was updated.
	//
	// LastUpdatedTimestamp is a required field
	LastUpdatedTimestamp *time.Time `type:"timestamp" required:"true"`

	// The logical name of the resource specified in the template.
	//
	// LogicalResourceId is a required field
	LogicalResourceId *string `type:"string" required:"true"`

	// The content of the Metadata attribute declared for the resource. For more
	// information, see Metadata Attribute (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html)
	// in the CloudFormation User Guide.
	Metadata *string `type:"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 `type:"structure"`

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

	// Current status of the resource.
	//
	// ResourceStatus is a required field
	ResourceStatus *string `type:"string" required:"true" enum:"ResourceStatus"`

	// Success/failure message associated with the resource.
	ResourceStatusReason *string `type:"string"`

	// Type of resource. For more information, go to Amazon Web Services Resource
	// Types Reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
	// in the CloudFormation User Guide.
	//
	// ResourceType is a required field
	ResourceType *string `min:"1" type:"string" required:"true"`

	// Unique identifier of the stack.
	StackId *string `type:"string"`

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

Contains detailed information about the specified stack resource.

func (StackResourceDetail) GoString added in v0.6.5 

func (s StackResourceDetail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StackResourceDetail) SetDescription added in v1.5.0 

func (s *StackResourceDetail) SetDescription(v string) *StackResourceDetail

SetDescription sets the Description field's value.

func (*StackResourceDetail) SetDriftInformation added in v1.15.74 

func (s *StackResourceDetail) SetDriftInformation(v *StackResourceDriftInformation) *StackResourceDetail

SetDriftInformation sets the DriftInformation field's value.

func (*StackResourceDetail) SetLastUpdatedTimestamp added in v1.5.0 

func (s *StackResourceDetail) SetLastUpdatedTimestamp(v time.Time) *StackResourceDetail

SetLastUpdatedTimestamp sets the LastUpdatedTimestamp field's value.

func (*StackResourceDetail) SetLogicalResourceId added in v1.5.0 

func (s *StackResourceDetail) SetLogicalResourceId(v string) *StackResourceDetail

SetLogicalResourceId sets the LogicalResourceId field's value.

func (*StackResourceDetail) SetMetadata added in v1.5.0 

func (s *StackResourceDetail) SetMetadata(v string) *StackResourceDetail

SetMetadata sets the Metadata field's value.

func (*StackResourceDetail) SetModuleInfo added in v1.35.35 

func (s *StackResourceDetail) SetModuleInfo(v *ModuleInfo) *StackResourceDetail

SetModuleInfo sets the ModuleInfo field's value.

func (*StackResourceDetail) SetPhysicalResourceId added in v1.5.0 

func (s *StackResourceDetail) SetPhysicalResourceId(v string) *StackResourceDetail

SetPhysicalResourceId sets the PhysicalResourceId field's value.

func (*StackResourceDetail) SetResourceStatus added in v1.5.0 

func (s *StackResourceDetail) SetResourceStatus(v string) *StackResourceDetail

SetResourceStatus sets the ResourceStatus field's value.

func (*StackResourceDetail) SetResourceStatusReason added in v1.5.0 

func (s *StackResourceDetail) SetResourceStatusReason(v string) *StackResourceDetail

SetResourceStatusReason sets the ResourceStatusReason field's value.

func (*StackResourceDetail) SetResourceType added in v1.5.0 

func (s *StackResourceDetail) SetResourceType(v string) *StackResourceDetail

SetResourceType sets the ResourceType field's value.

func (*StackResourceDetail) SetStackId added in v1.5.0 

func (s *StackResourceDetail) SetStackId(v string) *StackResourceDetail

SetStackId sets the StackId field's value.

func (*StackResourceDetail) SetStackName added in v1.5.0 

func (s *StackResourceDetail) SetStackName(v string) *StackResourceDetail

SetStackName sets the StackName field's value.

func (StackResourceDetail) String added in v0.6.5 

func (s StackResourceDetail) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StackResourceDrift added in v1.15.74 

type StackResourceDrift struct {

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

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

	// The logical name of the resource specified in the template.
	//
	// LogicalResourceId is a required field
	LogicalResourceId *string `type:"string" required:"true"`

	// 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 `type:"structure"`

	// The name or unique identifier that corresponds to a physical instance ID
	// of a resource supported by CloudFormation.
	PhysicalResourceId *string `type:"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 `type:"list"`

	// A collection of the resource properties whose actual values differ from their
	// expected values. These will be present only for resources whose StackResourceDriftStatus
	// is MODIFIED.
	PropertyDifferences []*PropertyDifference `type:"list"`

	// The type of the resource.
	//
	// ResourceType is a required field
	ResourceType *string `min:"1" type:"string" required:"true"`

	// The ID of the stack.
	//
	// StackId is a required field
	StackId *string `type:"string" required:"true"`

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

	// Time at which CloudFormation performed drift detection on the stack resource.
	//
	// Timestamp is a required field
	Timestamp *time.Time `type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

Contains the drift information for a resource that has been checked for drift. This includes actual and expected property values for resources in which CloudFormation has detected drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html).

Resources that don't currently support drift detection can't be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html).

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

func (StackResourceDrift) GoString added in v1.15.74 

func (s StackResourceDrift) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StackResourceDrift) SetActualProperties added in v1.15.74 

func (s *StackResourceDrift) SetActualProperties(v string) *StackResourceDrift

SetActualProperties sets the ActualProperties field's value.

func (*StackResourceDrift) SetExpectedProperties added in v1.15.74 

func (s *StackResourceDrift) SetExpectedProperties(v string) *StackResourceDrift

SetExpectedProperties sets the ExpectedProperties field's value.

func (*StackResourceDrift) SetLogicalResourceId added in v1.15.74 

func (s *StackResourceDrift) SetLogicalResourceId(v string) *StackResourceDrift

SetLogicalResourceId sets the LogicalResourceId field's value.

func (*StackResourceDrift) SetModuleInfo added in v1.35.35 

func (s *StackResourceDrift) SetModuleInfo(v *ModuleInfo) *StackResourceDrift

SetModuleInfo sets the ModuleInfo field's value.

func (*StackResourceDrift) SetPhysicalResourceId added in v1.15.74 

func (s *StackResourceDrift) SetPhysicalResourceId(v string) *StackResourceDrift

SetPhysicalResourceId sets the PhysicalResourceId field's value.

func (*StackResourceDrift) SetPhysicalResourceIdContext added in v1.15.74 

func (s *StackResourceDrift) SetPhysicalResourceIdContext(v []*PhysicalResourceIdContextKeyValuePair) *StackResourceDrift

SetPhysicalResourceIdContext sets the PhysicalResourceIdContext field's value.

func (*StackResourceDrift) SetPropertyDifferences added in v1.15.74 

func (s *StackResourceDrift) SetPropertyDifferences(v []*PropertyDifference) *StackResourceDrift

SetPropertyDifferences sets the PropertyDifferences field's value.

func (*StackResourceDrift) SetResourceType added in v1.15.74 

func (s *StackResourceDrift) SetResourceType(v string) *StackResourceDrift

SetResourceType sets the ResourceType field's value.

func (*StackResourceDrift) SetStackId added in v1.15.74 

func (s *StackResourceDrift) SetStackId(v string) *StackResourceDrift

SetStackId sets the StackId field's value.

func (*StackResourceDrift) SetStackResourceDriftStatus added in v1.15.74 

func (s *StackResourceDrift) SetStackResourceDriftStatus(v string) *StackResourceDrift

SetStackResourceDriftStatus sets the StackResourceDriftStatus field's value.

func (*StackResourceDrift) SetTimestamp added in v1.15.74 

func (s *StackResourceDrift) SetTimestamp(v time.Time) *StackResourceDrift

SetTimestamp sets the Timestamp field's value.

func (StackResourceDrift) String added in v1.15.74 

func (s StackResourceDrift) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StackResourceDriftInformation added in v1.15.74 

type StackResourceDriftInformation struct {

	// When CloudFormation last checked if the resource had drifted from its expected
	// configuration.
	LastCheckTimestamp *time.Time `type:"timestamp"`

	// Status of the resource's actual configuration compared to its expected configuration
	//
	//    * DELETED: The resource differs from its expected configuration in that
	//    it has been deleted.
	//
	//    * MODIFIED: The resource differs from its expected configuration.
	//
	//    * NOT_CHECKED: CloudFormation has not checked if the resource differs
	//    from its expected configuration. Any resources that do not currently support
	//    drift detection have a status of NOT_CHECKED. For more information, see
	//    Resources that Support Drift Detection (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html).
	//
	//    * IN_SYNC: The resource's actual configuration matches its expected configuration.
	//
	// StackResourceDriftStatus is a required field
	StackResourceDriftStatus *string `type:"string" required:"true" enum:"StackResourceDriftStatus"`
	// contains filtered or unexported fields
}

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

func (StackResourceDriftInformation) GoString added in v1.15.74 

func (s StackResourceDriftInformation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StackResourceDriftInformation) SetLastCheckTimestamp added in v1.15.74 

func (s *StackResourceDriftInformation) SetLastCheckTimestamp(v time.Time) *StackResourceDriftInformation

SetLastCheckTimestamp sets the LastCheckTimestamp field's value.

func (*StackResourceDriftInformation) SetStackResourceDriftStatus added in v1.15.74 

func (s *StackResourceDriftInformation) SetStackResourceDriftStatus(v string) *StackResourceDriftInformation

SetStackResourceDriftStatus sets the StackResourceDriftStatus field's value.

func (StackResourceDriftInformation) String added in v1.15.74 

func (s StackResourceDriftInformation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StackResourceDriftInformationSummary added in v1.15.74 

type StackResourceDriftInformationSummary struct {

	// When CloudFormation last checked if the resource had drifted from its expected
	// configuration.
	LastCheckTimestamp *time.Time `type:"timestamp"`

	// Status of the resource's actual configuration compared to its expected configuration.
	//
	//    * DELETED: The resource differs from its expected configuration in that
	//    it has been deleted.
	//
	//    * MODIFIED: The resource differs from its expected configuration.
	//
	//    * NOT_CHECKED: 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
	//    Resources that Support Drift Detection (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html).
	//    If you performed an ContinueUpdateRollback operation on a stack, any resources
	//    included in ResourcesToSkip will also have a status of NOT_CHECKED. For
	//    more information about skipping resources during rollback operations,
	//    see Continue Rolling Back an Update (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html)
	//    in the CloudFormation User Guide.
	//
	//    * IN_SYNC: The resource's actual configuration matches its expected configuration.
	//
	// StackResourceDriftStatus is a required field
	StackResourceDriftStatus *string `type:"string" required:"true" enum:"StackResourceDriftStatus"`
	// contains filtered or unexported fields
}

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

func (StackResourceDriftInformationSummary) GoString added in v1.15.74 

func (s StackResourceDriftInformationSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StackResourceDriftInformationSummary) SetLastCheckTimestamp added in v1.15.74 

func (s *StackResourceDriftInformationSummary) SetLastCheckTimestamp(v time.Time) *StackResourceDriftInformationSummary

SetLastCheckTimestamp sets the LastCheckTimestamp field's value.

func (*StackResourceDriftInformationSummary) SetStackResourceDriftStatus added in v1.15.74 

func (s *StackResourceDriftInformationSummary) SetStackResourceDriftStatus(v string) *StackResourceDriftInformationSummary

SetStackResourceDriftStatus sets the StackResourceDriftStatus field's value.

func (StackResourceDriftInformationSummary) String added in v1.15.74 

func (s StackResourceDriftInformationSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StackResourceSummary 

type StackResourceSummary struct {

	// Information about whether the resource's actual configuration differs, or
	// has drifted, from its expected configuration, as defined in the stack template
	// and any values specified as template parameters. For more information, see
	// Detecting Unregulated Configuration Changes to Stacks and Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html).
	DriftInformation *StackResourceDriftInformationSummary `type:"structure"`

	// Time the status was updated.
	//
	// LastUpdatedTimestamp is a required field
	LastUpdatedTimestamp *time.Time `type:"timestamp" required:"true"`

	// The logical name of the resource specified in the template.
	//
	// LogicalResourceId is a required field
	LogicalResourceId *string `type:"string" required:"true"`

	// 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 `type:"structure"`

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

	// Current status of the resource.
	//
	// ResourceStatus is a required field
	ResourceStatus *string `type:"string" required:"true" enum:"ResourceStatus"`

	// Success/failure message associated with the resource.
	ResourceStatusReason *string `type:"string"`

	// Type of resource. (For more information, go to Amazon Web Services Resource
	// Types Reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
	// in the CloudFormation User Guide.)
	//
	// ResourceType is a required field
	ResourceType *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains high-level information about the specified stack resource.

func (StackResourceSummary) GoString added in v0.6.5 

func (s StackResourceSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StackResourceSummary) SetDriftInformation added in v1.15.74 

func (s *StackResourceSummary) SetDriftInformation(v *StackResourceDriftInformationSummary) *StackResourceSummary

SetDriftInformation sets the DriftInformation field's value.

func (*StackResourceSummary) SetLastUpdatedTimestamp added in v1.5.0 

func (s *StackResourceSummary) SetLastUpdatedTimestamp(v time.Time) *StackResourceSummary

SetLastUpdatedTimestamp sets the LastUpdatedTimestamp field's value.

func (*StackResourceSummary) SetLogicalResourceId added in v1.5.0 

func (s *StackResourceSummary) SetLogicalResourceId(v string) *StackResourceSummary

SetLogicalResourceId sets the LogicalResourceId field's value.

func (*StackResourceSummary) SetModuleInfo added in v1.35.35 

func (s *StackResourceSummary) SetModuleInfo(v *ModuleInfo) *StackResourceSummary

SetModuleInfo sets the ModuleInfo field's value.

func (*StackResourceSummary) SetPhysicalResourceId added in v1.5.0 

func (s *StackResourceSummary) SetPhysicalResourceId(v string) *StackResourceSummary

SetPhysicalResourceId sets the PhysicalResourceId field's value.

func (*StackResourceSummary) SetResourceStatus added in v1.5.0 

func (s *StackResourceSummary) SetResourceStatus(v string) *StackResourceSummary

SetResourceStatus sets the ResourceStatus field's value.

func (*StackResourceSummary) SetResourceStatusReason added in v1.5.0 

func (s *StackResourceSummary) SetResourceStatusReason(v string) *StackResourceSummary

SetResourceStatusReason sets the ResourceStatusReason field's value.

func (*StackResourceSummary) SetResourceType added in v1.5.0 

func (s *StackResourceSummary) SetResourceType(v string) *StackResourceSummary

SetResourceType sets the ResourceType field's value.

func (StackResourceSummary) String added in v0.6.5 

func (s StackResourceSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StackSet added in v1.10.16 

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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html)
	// in the CloudFormation User Guide.
	AdministrationRoleARN *string `min:"20" type:"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 `type:"structure"`

	// 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. (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities)
	Capabilities []*string `type:"list" enum:"Capability"`

	// A description of the stack set that you specify when the stack set is created
	// or updated.
	Description *string `min:"1" type:"string"`

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

	// Describes whether StackSets performs non-conflicting operations concurrently
	// and queues conflicting operations.
	ManagedExecution *ManagedExecution `type:"structure"`

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

	// A list of input parameters for a stack set.
	Parameters []*Parameter `type:"list"`

	// 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html).
	//
	//    * With service-managed permissions, StackSets automatically creates the
	//    IAM roles required to deploy to accounts managed by Organizations. For
	//    more information, see Grant Service-Managed Stack Set Permissions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html).
	PermissionModel *string `type:"string" enum:"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 `type:"list"`

	// The Amazon Resource Name (ARN) of the stack set.
	StackSetARN *string `type:"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 `type:"structure"`

	// The ID of the stack set.
	StackSetId *string `type:"string"`

	// The name that's associated with the stack set.
	StackSetName *string `type:"string"`

	// The status of the stack set.
	Status *string `type:"string" enum:"StackSetStatus"`

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

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

A structure that contains information about a stack set. A stack set enables you to provision stacks into 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.

func (StackSet) GoString added in v1.10.16 

func (s StackSet) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StackSet) SetAdministrationRoleARN added in v1.13.24 

func (s *StackSet) SetAdministrationRoleARN(v string) *StackSet

SetAdministrationRoleARN sets the AdministrationRoleARN field's value.

func (*StackSet) SetAutoDeployment added in v1.29.0 

func (s *StackSet) SetAutoDeployment(v *AutoDeployment) *StackSet

SetAutoDeployment sets the AutoDeployment field's value.

func (*StackSet) SetCapabilities added in v1.10.16 

func (s *StackSet) SetCapabilities(v []*string) *StackSet

SetCapabilities sets the Capabilities field's value.

func (*StackSet) SetDescription added in v1.10.16 

func (s *StackSet) SetDescription(v string) *StackSet

SetDescription sets the Description field's value.

func (*StackSet) SetExecutionRoleName added in v1.13.53 

func (s *StackSet) SetExecutionRoleName(v string) *StackSet

SetExecutionRoleName sets the ExecutionRoleName field's value.

func (*StackSet) SetManagedExecution added in v1.42.9 

func (s *StackSet) SetManagedExecution(v *ManagedExecution) *StackSet

SetManagedExecution sets the ManagedExecution field's value.

func (*StackSet) SetOrganizationalUnitIds added in v1.29.0 

func (s *StackSet) SetOrganizationalUnitIds(v []*string) *StackSet

SetOrganizationalUnitIds sets the OrganizationalUnitIds field's value.

func (*StackSet) SetParameters added in v1.10.16 

func (s *StackSet) SetParameters(v []*Parameter) *StackSet

SetParameters sets the Parameters field's value.

func (*StackSet) SetPermissionModel added in v1.29.0 

func (s *StackSet) SetPermissionModel(v string) *StackSet

SetPermissionModel sets the PermissionModel field's value.

func (*StackSet) SetRegions added in v1.44.190 

func (s *StackSet) SetRegions(v []*string) *StackSet

SetRegions sets the Regions field's value.

func (*StackSet) SetStackSetARN added in v1.13.24 

func (s *StackSet) SetStackSetARN(v string) *StackSet

SetStackSetARN sets the StackSetARN field's value.

func (*StackSet) SetStackSetDriftDetectionDetails added in v1.25.38 

func (s *StackSet) SetStackSetDriftDetectionDetails(v *StackSetDriftDetectionDetails) *StackSet

SetStackSetDriftDetectionDetails sets the StackSetDriftDetectionDetails field's value.

func (*StackSet) SetStackSetId added in v1.10.16 

func (s *StackSet) SetStackSetId(v string) *StackSet

SetStackSetId sets the StackSetId field's value.

func (*StackSet) SetStackSetName added in v1.10.16 

func (s *StackSet) SetStackSetName(v string) *StackSet

SetStackSetName sets the StackSetName field's value.

func (*StackSet) SetStatus added in v1.10.16 

func (s *StackSet) SetStatus(v string) *StackSet

SetStatus sets the Status field's value.

func (*StackSet) SetTags added in v1.10.16 

func (s *StackSet) SetTags(v []*Tag) *StackSet

SetTags sets the Tags field's value.

func (*StackSet) SetTemplateBody added in v1.10.16 

func (s *StackSet) SetTemplateBody(v string) *StackSet

SetTemplateBody sets the TemplateBody field's value.

func (StackSet) String added in v1.10.16 

func (s StackSet) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StackSetDriftDetectionDetails added in v1.25.38 

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 *string `type:"string" enum:"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 *string `type:"string" enum:"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 *int64 `type:"integer"`

	// The number of stack instances for which the drift detection operation failed.
	FailedStackInstancesCount *int64 `type:"integer"`

	// The number of stack instances that are currently being checked for drift.
	InProgressStackInstancesCount *int64 `type:"integer"`

	// The number of stack instances which match the expected template and parameter
	// configuration of the stack set.
	InSyncStackInstancesCount *int64 `type:"integer"`

	// 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 `type:"timestamp"`

	// 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 *int64 `type:"integer"`
	// 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html) in the CloudFormation User Guide.

func (StackSetDriftDetectionDetails) GoString added in v1.25.38 

func (s StackSetDriftDetectionDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StackSetDriftDetectionDetails) SetDriftDetectionStatus added in v1.25.38 

func (s *StackSetDriftDetectionDetails) SetDriftDetectionStatus(v string) *StackSetDriftDetectionDetails

SetDriftDetectionStatus sets the DriftDetectionStatus field's value.

func (*StackSetDriftDetectionDetails) SetDriftStatus added in v1.25.38 

func (s *StackSetDriftDetectionDetails) SetDriftStatus(v string) *StackSetDriftDetectionDetails

SetDriftStatus sets the DriftStatus field's value.

func (*StackSetDriftDetectionDetails) SetDriftedStackInstancesCount added in v1.25.38 

func (s *StackSetDriftDetectionDetails) SetDriftedStackInstancesCount(v int64) *StackSetDriftDetectionDetails

SetDriftedStackInstancesCount sets the DriftedStackInstancesCount field's value.

func (*StackSetDriftDetectionDetails) SetFailedStackInstancesCount added in v1.25.38 

func (s *StackSetDriftDetectionDetails) SetFailedStackInstancesCount(v int64) *StackSetDriftDetectionDetails

SetFailedStackInstancesCount sets the FailedStackInstancesCount field's value.

func (*StackSetDriftDetectionDetails) SetInProgressStackInstancesCount added in v1.25.38 

func (s *StackSetDriftDetectionDetails) SetInProgressStackInstancesCount(v int64) *StackSetDriftDetectionDetails

SetInProgressStackInstancesCount sets the InProgressStackInstancesCount field's value.

func (*StackSetDriftDetectionDetails) SetInSyncStackInstancesCount added in v1.25.38 

func (s *StackSetDriftDetectionDetails) SetInSyncStackInstancesCount(v int64) *StackSetDriftDetectionDetails

SetInSyncStackInstancesCount sets the InSyncStackInstancesCount field's value.

func (*StackSetDriftDetectionDetails) SetLastDriftCheckTimestamp added in v1.25.38 

func (s *StackSetDriftDetectionDetails) SetLastDriftCheckTimestamp(v time.Time) *StackSetDriftDetectionDetails

SetLastDriftCheckTimestamp sets the LastDriftCheckTimestamp field's value.

func (*StackSetDriftDetectionDetails) SetTotalStackInstancesCount added in v1.25.38 

func (s *StackSetDriftDetectionDetails) SetTotalStackInstancesCount(v int64) *StackSetDriftDetectionDetails

SetTotalStackInstancesCount sets the TotalStackInstancesCount field's value.

func (StackSetDriftDetectionDetails) String added in v1.25.38 

func (s StackSetDriftDetectionDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StackSetOperation added in v1.10.16 

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 *string `type:"string" enum:"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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html)
	// in the CloudFormation User Guide.
	AdministrationRoleARN *string `min:"20" type:"string"`

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

	// [Service-managed permissions] The Organizations accounts affected by the
	// stack operation.
	DeploymentTargets *DeploymentTargets `type:"structure"`

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

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

	// The unique ID of a stack set operation.
	OperationId *string `min:"1" type:"string"`

	// The preferences for how CloudFormation performs this stack set operation.
	OperationPreferences *StackSetOperationPreferences `type:"structure"`

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

	// 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 Detecting Unmanaged Changes in Stack Sets (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html)
	// in the CloudFormation User Guide.
	StackSetDriftDetectionDetails *StackSetDriftDetectionDetails `type:"structure"`

	// The ID of the stack set.
	StackSetId *string `type:"string"`

	// The status of the operation.
	//
	//    * FAILED: The operation exceeded the specified failure tolerance. The
	//    failure tolerance value that you've set for an operation is applied for
	//    each Region during stack create and update operations. If the number of
	//    failed stacks within a Region exceeds the failure tolerance, the status
	//    of the operation in the Region is set to FAILED. This in turn sets the
	//    status of the operation as a whole to FAILED, and 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-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.
	Status *string `type:"string" enum:"StackSetOperationStatus"`

	// Detailed information about the StackSet operation.
	StatusDetails *StackSetOperationStatusDetails `type:"structure"`

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

The structure that contains information about a stack set operation.

func (StackSetOperation) GoString added in v1.10.16 

func (s StackSetOperation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StackSetOperation) SetAction added in v1.10.16 

func (s *StackSetOperation) SetAction(v string) *StackSetOperation

SetAction sets the Action field's value.

func (*StackSetOperation) SetAdministrationRoleARN added in v1.13.24 

func (s *StackSetOperation) SetAdministrationRoleARN(v string) *StackSetOperation

SetAdministrationRoleARN sets the AdministrationRoleARN field's value.

func (*StackSetOperation) SetCreationTimestamp added in v1.10.16 

func (s *StackSetOperation) SetCreationTimestamp(v time.Time) *StackSetOperation

SetCreationTimestamp sets the CreationTimestamp field's value.

func (*StackSetOperation) SetDeploymentTargets added in v1.29.0 

func (s *StackSetOperation) SetDeploymentTargets(v *DeploymentTargets) *StackSetOperation

SetDeploymentTargets sets the DeploymentTargets field's value.

func (*StackSetOperation) SetEndTimestamp added in v1.10.16 

func (s *StackSetOperation) SetEndTimestamp(v time.Time) *StackSetOperation

SetEndTimestamp sets the EndTimestamp field's value.

func (*StackSetOperation) SetExecutionRoleName added in v1.13.53 

func (s *StackSetOperation) SetExecutionRoleName(v string) *StackSetOperation

SetExecutionRoleName sets the ExecutionRoleName field's value.

func (*StackSetOperation) SetOperationId added in v1.10.16 

func (s *StackSetOperation) SetOperationId(v string) *StackSetOperation

SetOperationId sets the OperationId field's value.

func (*StackSetOperation) SetOperationPreferences added in v1.10.16 

func (s *StackSetOperation) SetOperationPreferences(v *StackSetOperationPreferences) *StackSetOperation

SetOperationPreferences sets the OperationPreferences field's value.

func (*StackSetOperation) SetRetainStacks added in v1.10.16 

func (s *StackSetOperation) SetRetainStacks(v bool) *StackSetOperation

SetRetainStacks sets the RetainStacks field's value.

func (*StackSetOperation) SetStackSetDriftDetectionDetails added in v1.25.38 

func (s *StackSetOperation) SetStackSetDriftDetectionDetails(v *StackSetDriftDetectionDetails) *StackSetOperation

SetStackSetDriftDetectionDetails sets the StackSetDriftDetectionDetails field's value.

func (*StackSetOperation) SetStackSetId added in v1.10.16 

func (s *StackSetOperation) SetStackSetId(v string) *StackSetOperation

SetStackSetId sets the StackSetId field's value.

func (*StackSetOperation) SetStatus added in v1.10.16 

func (s *StackSetOperation) SetStatus(v string) *StackSetOperation

SetStatus sets the Status field's value.

func (*StackSetOperation) SetStatusDetails added in v1.44.126 

func (s *StackSetOperation) SetStatusDetails(v *StackSetOperationStatusDetails) *StackSetOperation

SetStatusDetails sets the StatusDetails field's value.

func (*StackSetOperation) SetStatusReason added in v1.44.22 

func (s *StackSetOperation) SetStatusReason(v string) *StackSetOperation

SetStatusReason sets the StatusReason field's value.

func (StackSetOperation) String added in v1.10.16 

func (s StackSetOperation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StackSetOperationPreferences added in v1.10.16 

type StackSetOperationPreferences struct {

	// 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 *int64 `type:"integer"`

	// 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 *int64 `type:"integer"`

	// The maximum number of accounts in which to perform this operation at one
	// time. This is dependent on the value of FailureToleranceCount.MaxConcurrentCount
	// is at most one more than the FailureToleranceCount.
	//
	// Note that this setting lets you specify the maximum for operations. For large
	// deployments, under certain circumstances the actual number of accounts acted
	// upon concurrently may be lower due to service throttling.
	//
	// Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage,
	// but not both.
	//
	// By default, 1 is specified.
	MaxConcurrentCount *int64 `min:"1" type:"integer"`

	// The maximum percentage of accounts in which to perform this operation at
	// one time.
	//
	// When calculating the number of accounts based on the specified percentage,
	// 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 *int64 `min:"1" type:"integer"`

	// The concurrency type of deploying StackSets operations in Regions, could
	// be in parallel or one Region at a time.
	RegionConcurrencyType *string `type:"string" enum:"RegionConcurrencyType"`

	// The order of the Regions where you want to perform the stack operation.
	RegionOrder []*string `type:"list"`
	// 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options).

func (StackSetOperationPreferences) GoString added in v1.10.16 

func (s StackSetOperationPreferences) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StackSetOperationPreferences) SetFailureToleranceCount added in v1.10.16 

func (s *StackSetOperationPreferences) SetFailureToleranceCount(v int64) *StackSetOperationPreferences

SetFailureToleranceCount sets the FailureToleranceCount field's value.

func (*StackSetOperationPreferences) SetFailureTolerancePercentage added in v1.10.16 

func (s *StackSetOperationPreferences) SetFailureTolerancePercentage(v int64) *StackSetOperationPreferences

SetFailureTolerancePercentage sets the FailureTolerancePercentage field's value.

func (*StackSetOperationPreferences) SetMaxConcurrentCount added in v1.10.16 

func (s *StackSetOperationPreferences) SetMaxConcurrentCount(v int64) *StackSetOperationPreferences

SetMaxConcurrentCount sets the MaxConcurrentCount field's value.

func (*StackSetOperationPreferences) SetMaxConcurrentPercentage added in v1.10.16 

func (s *StackSetOperationPreferences) SetMaxConcurrentPercentage(v int64) *StackSetOperationPreferences

SetMaxConcurrentPercentage sets the MaxConcurrentPercentage field's value.

func (*StackSetOperationPreferences) SetRegionConcurrencyType added in v1.38.10 

func (s *StackSetOperationPreferences) SetRegionConcurrencyType(v string) *StackSetOperationPreferences

SetRegionConcurrencyType sets the RegionConcurrencyType field's value.

func (*StackSetOperationPreferences) SetRegionOrder added in v1.10.16 

func (s *StackSetOperationPreferences) SetRegionOrder(v []*string) *StackSetOperationPreferences

SetRegionOrder sets the RegionOrder field's value.

func (StackSetOperationPreferences) String added in v1.10.16 

func (s StackSetOperationPreferences) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StackSetOperationPreferences) Validate added in v1.10.16 

func (s *StackSetOperationPreferences) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StackSetOperationResultSummary added in v1.10.16 

type StackSetOperationResultSummary struct {

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

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

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

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

	// The result status of the stack set operation for the given account in the
	// given Region.
	//
	//    * CANCELLED: The operation in the specified account and Region has been
	//    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 *string `type:"string" enum:"StackSetOperationResultStatus"`

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

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

func (StackSetOperationResultSummary) GoString added in v1.10.16 

func (s StackSetOperationResultSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StackSetOperationResultSummary) SetAccount added in v1.10.16 

func (s *StackSetOperationResultSummary) SetAccount(v string) *StackSetOperationResultSummary

SetAccount sets the Account field's value.

func (*StackSetOperationResultSummary) SetAccountGateResult added in v1.10.16 

func (s *StackSetOperationResultSummary) SetAccountGateResult(v *AccountGateResult) *StackSetOperationResultSummary

SetAccountGateResult sets the AccountGateResult field's value.

func (*StackSetOperationResultSummary) SetOrganizationalUnitId added in v1.29.0 

func (s *StackSetOperationResultSummary) SetOrganizationalUnitId(v string) *StackSetOperationResultSummary

SetOrganizationalUnitId sets the OrganizationalUnitId field's value.

func (*StackSetOperationResultSummary) SetRegion added in v1.10.16 

func (s *StackSetOperationResultSummary) SetRegion(v string) *StackSetOperationResultSummary

SetRegion sets the Region field's value.

func (*StackSetOperationResultSummary) SetStatus added in v1.10.16 

func (s *StackSetOperationResultSummary) SetStatus(v string) *StackSetOperationResultSummary

SetStatus sets the Status field's value.

func (*StackSetOperationResultSummary) SetStatusReason added in v1.10.16 

func (s *StackSetOperationResultSummary) SetStatusReason(v string) *StackSetOperationResultSummary

SetStatusReason sets the StatusReason field's value.

func (StackSetOperationResultSummary) String added in v1.10.16 

func (s StackSetOperationResultSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StackSetOperationStatusDetails added in v1.44.126 

type StackSetOperationStatusDetails struct {

	// The number of stack instances for which the StackSet operation failed.
	FailedStackInstancesCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Detailed information about the StackSet operation.

func (StackSetOperationStatusDetails) GoString added in v1.44.126 

func (s StackSetOperationStatusDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StackSetOperationStatusDetails) SetFailedStackInstancesCount added in v1.44.126 

func (s *StackSetOperationStatusDetails) SetFailedStackInstancesCount(v int64) *StackSetOperationStatusDetails

SetFailedStackInstancesCount sets the FailedStackInstancesCount field's value.

func (StackSetOperationStatusDetails) String added in v1.44.126 

func (s StackSetOperationStatusDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StackSetOperationSummary added in v1.10.16 

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 *string `type:"string" enum:"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 `type:"timestamp"`

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

	// The unique ID of the stack set operation.
	OperationId *string `min:"1" type:"string"`

	// The 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options).
	OperationPreferences *StackSetOperationPreferences `type:"structure"`

	// 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-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.
	Status *string `type:"string" enum:"StackSetOperationStatus"`

	// Detailed information about the stack set operation.
	StatusDetails *StackSetOperationStatusDetails `type:"structure"`

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

The structures that contain summary information about the specified operation.

func (StackSetOperationSummary) GoString added in v1.10.16 

func (s StackSetOperationSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StackSetOperationSummary) SetAction added in v1.10.16 

func (s *StackSetOperationSummary) SetAction(v string) *StackSetOperationSummary

SetAction sets the Action field's value.

func (*StackSetOperationSummary) SetCreationTimestamp added in v1.10.16 

func (s *StackSetOperationSummary) SetCreationTimestamp(v time.Time) *StackSetOperationSummary

SetCreationTimestamp sets the CreationTimestamp field's value.

func (*StackSetOperationSummary) SetEndTimestamp added in v1.10.16 

func (s *StackSetOperationSummary) SetEndTimestamp(v time.Time) *StackSetOperationSummary

SetEndTimestamp sets the EndTimestamp field's value.

func (*StackSetOperationSummary) SetOperationId added in v1.10.16 

func (s *StackSetOperationSummary) SetOperationId(v string) *StackSetOperationSummary

SetOperationId sets the OperationId field's value.

func (*StackSetOperationSummary) SetOperationPreferences added in v1.44.126 

func (s *StackSetOperationSummary) SetOperationPreferences(v *StackSetOperationPreferences) *StackSetOperationSummary

SetOperationPreferences sets the OperationPreferences field's value.

func (*StackSetOperationSummary) SetStatus added in v1.10.16 

func (s *StackSetOperationSummary) SetStatus(v string) *StackSetOperationSummary

SetStatus sets the Status field's value.

func (*StackSetOperationSummary) SetStatusDetails added in v1.44.126 

func (s *StackSetOperationSummary) SetStatusDetails(v *StackSetOperationStatusDetails) *StackSetOperationSummary

SetStatusDetails sets the StatusDetails field's value.

func (*StackSetOperationSummary) SetStatusReason added in v1.44.22 

func (s *StackSetOperationSummary) SetStatusReason(v string) *StackSetOperationSummary

SetStatusReason sets the StatusReason field's value.

func (StackSetOperationSummary) String added in v1.10.16 

func (s StackSetOperationSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StackSetSummary added in v1.10.16 

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 `type:"structure"`

	// A description of the stack set that you specify when the stack set is created
	// or updated.
	Description *string `min:"1" type:"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 *string `type:"string" enum:"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 `type:"timestamp"`

	// Describes whether StackSets performs non-conflicting operations concurrently
	// and queues conflicting operations.
	ManagedExecution *ManagedExecution `type:"structure"`

	// 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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html).
	//
	//    * With service-managed permissions, StackSets automatically creates the
	//    IAM roles required to deploy to accounts managed by Organizations. For
	//    more information, see Grant Service-Managed Stack Set Permissions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html).
	PermissionModel *string `type:"string" enum:"PermissionModels"`

	// The ID of the stack set.
	StackSetId *string `type:"string"`

	// The name of the stack set.
	StackSetName *string `type:"string"`

	// The status of the stack set.
	Status *string `type:"string" enum:"StackSetStatus"`
	// contains filtered or unexported fields
}

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

func (StackSetSummary) GoString added in v1.10.16 

func (s StackSetSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StackSetSummary) SetAutoDeployment added in v1.29.0 

func (s *StackSetSummary) SetAutoDeployment(v *AutoDeployment) *StackSetSummary

SetAutoDeployment sets the AutoDeployment field's value.

func (*StackSetSummary) SetDescription added in v1.10.16 

func (s *StackSetSummary) SetDescription(v string) *StackSetSummary

SetDescription sets the Description field's value.

func (*StackSetSummary) SetDriftStatus added in v1.25.38 

func (s *StackSetSummary) SetDriftStatus(v string) *StackSetSummary

SetDriftStatus sets the DriftStatus field's value.

func (*StackSetSummary) SetLastDriftCheckTimestamp added in v1.25.38 

func (s *StackSetSummary) SetLastDriftCheckTimestamp(v time.Time) *StackSetSummary

SetLastDriftCheckTimestamp sets the LastDriftCheckTimestamp field's value.

func (*StackSetSummary) SetManagedExecution added in v1.42.9 

func (s *StackSetSummary) SetManagedExecution(v *ManagedExecution) *StackSetSummary

SetManagedExecution sets the ManagedExecution field's value.

func (*StackSetSummary) SetPermissionModel added in v1.29.0 

func (s *StackSetSummary) SetPermissionModel(v string) *StackSetSummary

SetPermissionModel sets the PermissionModel field's value.

func (*StackSetSummary) SetStackSetId added in v1.10.16 

func (s *StackSetSummary) SetStackSetId(v string) *StackSetSummary

SetStackSetId sets the StackSetId field's value.

func (*StackSetSummary) SetStackSetName added in v1.10.16 

func (s *StackSetSummary) SetStackSetName(v string) *StackSetSummary

SetStackSetName sets the StackSetName field's value.

func (*StackSetSummary) SetStatus added in v1.10.16 

func (s *StackSetSummary) SetStatus(v string) *StackSetSummary

SetStatus sets the Status field's value.

func (StackSetSummary) String added in v1.10.16 

func (s StackSetSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StackSummary 

type StackSummary struct {

	// The time the stack was created.
	//
	// CreationTime is a required field
	CreationTime *time.Time `type:"timestamp" required:"true"`

	// The time the stack was deleted.
	DeletionTime *time.Time `type:"timestamp"`

	// Summarizes information 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 Detecting Unregulated Configuration Changes to Stacks and Resources (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html).
	DriftInformation *StackDriftInformationSummary `type:"structure"`

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

	// For nested stacks--stacks created as resources for another stack--the stack
	// ID of the direct parent of this stack. For the first level of nested stacks,
	// the root stack is also the parent stack.
	//
	// For more information, see Working with Nested Stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html)
	// in the CloudFormation User Guide.
	ParentId *string `type:"string"`

	// For nested stacks--stacks created as resources for another stack--the stack
	// ID of the top-level stack to which the nested stack ultimately belongs.
	//
	// For more information, see Working with Nested Stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html)
	// in the CloudFormation User Guide.
	RootId *string `type:"string"`

	// Unique stack identifier.
	StackId *string `type:"string"`

	// The name associated with the stack.
	//
	// StackName is a required field
	StackName *string `type:"string" required:"true"`

	// The current status of the stack.
	//
	// StackStatus is a required field
	StackStatus *string `type:"string" required:"true" enum:"StackStatus"`

	// Success/Failure message associated with the stack status.
	StackStatusReason *string `type:"string"`

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

The StackSummary Data Type

func (StackSummary) GoString added in v0.6.5 

func (s StackSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StackSummary) SetCreationTime added in v1.5.0 

func (s *StackSummary) SetCreationTime(v time.Time) *StackSummary

SetCreationTime sets the CreationTime field's value.

func (*StackSummary) SetDeletionTime added in v1.5.0 

func (s *StackSummary) SetDeletionTime(v time.Time) *StackSummary

SetDeletionTime sets the DeletionTime field's value.

func (*StackSummary) SetDriftInformation added in v1.15.74 

func (s *StackSummary) SetDriftInformation(v *StackDriftInformationSummary) *StackSummary

SetDriftInformation sets the DriftInformation field's value.

func (*StackSummary) SetLastUpdatedTime added in v1.5.0 

func (s *StackSummary) SetLastUpdatedTime(v time.Time) *StackSummary

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*StackSummary) SetParentId added in v1.11.0 

func (s *StackSummary) SetParentId(v string) *StackSummary

SetParentId sets the ParentId field's value.

func (*StackSummary) SetRootId added in v1.11.0 

func (s *StackSummary) SetRootId(v string) *StackSummary

SetRootId sets the RootId field's value.

func (*StackSummary) SetStackId added in v1.5.0 

func (s *StackSummary) SetStackId(v string) *StackSummary

SetStackId sets the StackId field's value.

func (*StackSummary) SetStackName added in v1.5.0 

func (s *StackSummary) SetStackName(v string) *StackSummary

SetStackName sets the StackName field's value.

func (*StackSummary) SetStackStatus added in v1.5.0 

func (s *StackSummary) SetStackStatus(v string) *StackSummary

SetStackStatus sets the StackStatus field's value.

func (*StackSummary) SetStackStatusReason added in v1.5.0 

func (s *StackSummary) SetStackStatusReason(v string) *StackSummary

SetStackStatusReason sets the StackStatusReason field's value.

func (*StackSummary) SetTemplateDescription added in v1.5.0 

func (s *StackSummary) SetTemplateDescription(v string) *StackSummary

SetTemplateDescription sets the TemplateDescription field's value.

func (StackSummary) String added in v0.6.5 

func (s StackSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopStackSetOperationInput added in v1.10.16 

type StopStackSetOperationInput struct {

	// [Service-managed permissions] Specifies whether you are acting as an account
	// administrator in the organization's management account or as a delegated
	// administrator in a member account.
	//
	// By default, SELF is specified. Use SELF for stack sets with self-managed
	// permissions.
	//
	//    * If you are signed in to the management account, specify SELF.
	//
	//    * If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
	//    Your Amazon Web Services account must be registered as a delegated administrator
	//    in the management account. For more information, see Register a delegated
	//    administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html)
	//    in the CloudFormation User Guide.
	CallAs *string `type:"string" enum:"CallAs"`

	// The ID of the stack operation.
	//
	// OperationId is a required field
	OperationId *string `min:"1" type:"string" required:"true"`

	// The name or unique ID of the stack set that you want to stop the operation
	// for.
	//
	// StackSetName is a required field
	StackSetName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopStackSetOperationInput) GoString added in v1.10.16 

func (s StopStackSetOperationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopStackSetOperationInput) SetCallAs added in v1.37.14 

func (s *StopStackSetOperationInput) SetCallAs(v string) *StopStackSetOperationInput

SetCallAs sets the CallAs field's value.

func (*StopStackSetOperationInput) SetOperationId added in v1.10.16 

func (s *StopStackSetOperationInput) SetOperationId(v string) *StopStackSetOperationInput

SetOperationId sets the OperationId field's value.

func (*StopStackSetOperationInput) SetStackSetName added in v1.10.16 

func (s *StopStackSetOperationInput) SetStackSetName(v string) *StopStackSetOperationInput

SetStackSetName sets the StackSetName field's value.

func (StopStackSetOperationInput) String added in v1.10.16 

func (s StopStackSetOperationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopStackSetOperationInput) Validate added in v1.10.16 

func (s *StopStackSetOperationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopStackSetOperationOutput added in v1.10.16 

type StopStackSetOperationOutput struct {
	// contains filtered or unexported fields
}

func (StopStackSetOperationOutput) GoString added in v1.10.16 

func (s StopStackSetOperationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (StopStackSetOperationOutput) String added in v1.10.16 

func (s StopStackSetOperationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 (Amazon Web
	// Services) have the reserved prefix: aws:.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// Required. A string containing the value for this tag. You can specify a maximum
	// of 256 characters for a tag value.
	//
	// Value is a required field
	Value *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (Tag) GoString added in v0.6.5 

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey added in v1.5.0 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.5.0 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v0.6.5 

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) Validate added in v1.10.16 

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TemplateParameter 

type TemplateParameter struct {

	// The default value associated with the parameter.
	DefaultValue *string `type:"string"`

	// User defined description associated with the parameter.
	Description *string `min:"1" type:"string"`

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

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

The TemplateParameter data type.

func (TemplateParameter) GoString added in v0.6.5 

func (s TemplateParameter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TemplateParameter) SetDefaultValue added in v1.5.0 

func (s *TemplateParameter) SetDefaultValue(v string) *TemplateParameter

SetDefaultValue sets the DefaultValue field's value.

func (*TemplateParameter) SetDescription added in v1.5.0 

func (s *TemplateParameter) SetDescription(v string) *TemplateParameter

SetDescription sets the Description field's value.

func (*TemplateParameter) SetNoEcho added in v1.5.0 

func (s *TemplateParameter) SetNoEcho(v bool) *TemplateParameter

SetNoEcho sets the NoEcho field's value.

func (*TemplateParameter) SetParameterKey added in v1.5.0 

func (s *TemplateParameter) SetParameterKey(v string) *TemplateParameter

SetParameterKey sets the ParameterKey field's value.

func (TemplateParameter) String added in v0.6.5 

func (s TemplateParameter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TemplateSummaryConfig added in v1.44.303 

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 `type:"boolean"`
	// contains filtered or unexported fields
}

Options for the GetTemplateSummary API action.

func (TemplateSummaryConfig) GoString added in v1.44.303 

func (s TemplateSummaryConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TemplateSummaryConfig) SetTreatUnrecognizedResourceTypesAsWarnings added in v1.44.303 

func (s *TemplateSummaryConfig) SetTreatUnrecognizedResourceTypesAsWarnings(v bool) *TemplateSummaryConfig

SetTreatUnrecognizedResourceTypesAsWarnings sets the TreatUnrecognizedResourceTypesAsWarnings field's value.

func (TemplateSummaryConfig) String added in v1.44.303 

func (s TemplateSummaryConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TestTypeInput added in v1.38.65 

type TestTypeInput struct {

	// The Amazon Resource Name (ARN) of the extension.
	//
	// Conditional: You must specify Arn, or TypeName and Type.
	Arn *string `type:"string"`

	// The S3 bucket to which CloudFormation delivers the contract test execution
	// logs.
	//
	// CloudFormation delivers the logs by the time contract testing has completed
	// and the extension has been assigned a test type status of PASSED or FAILED.
	//
	// The user calling TestType must be able to access items in the specified S3
	// bucket. Specifically, the user needs the following permissions:
	//
	//    * GetObject
	//
	//    * PutObject
	//
	// For more information, see Actions, Resources, and Condition Keys for Amazon
	// S3 (https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html)
	// in the Amazon Web Services Identity and Access Management User Guide.
	LogDeliveryBucket *string `min:"3" type:"string"`

	// The type of the extension to test.
	//
	// Conditional: You must specify Arn, or TypeName and Type.
	Type *string `type:"string" enum:"ThirdPartyType"`

	// The name of the extension to test.
	//
	// Conditional: You must specify Arn, or TypeName and Type.
	TypeName *string `min:"10" type:"string"`

	// The version of the extension to test.
	//
	// You can specify the version id with either Arn, or with TypeName and Type.
	//
	// If you don't specify a version, CloudFormation uses the default version of
	// the extension in this account and Region for testing.
	VersionId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (TestTypeInput) GoString added in v1.38.65 

func (s TestTypeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TestTypeInput) SetArn added in v1.38.65 

func (s *TestTypeInput) SetArn(v string) *TestTypeInput

SetArn sets the Arn field's value.

func (*TestTypeInput) SetLogDeliveryBucket added in v1.38.65 

func (s *TestTypeInput) SetLogDeliveryBucket(v string) *TestTypeInput

SetLogDeliveryBucket sets the LogDeliveryBucket field's value.

func (*TestTypeInput) SetType added in v1.38.65 

func (s *TestTypeInput) SetType(v string) *TestTypeInput

SetType sets the Type field's value.

func (*TestTypeInput) SetTypeName added in v1.38.65 

func (s *TestTypeInput) SetTypeName(v string) *TestTypeInput

SetTypeName sets the TypeName field's value.

func (*TestTypeInput) SetVersionId added in v1.38.65 

func (s *TestTypeInput) SetVersionId(v string) *TestTypeInput

SetVersionId sets the VersionId field's value.

func (TestTypeInput) String added in v1.38.65 

func (s TestTypeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TestTypeInput) Validate added in v1.38.65 

func (s *TestTypeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TestTypeOutput added in v1.38.65 

type TestTypeOutput struct {

	// The Amazon Resource Name (ARN) of the extension.
	TypeVersionArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (TestTypeOutput) GoString added in v1.38.65 

func (s TestTypeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TestTypeOutput) SetTypeVersionArn added in v1.38.65 

func (s *TestTypeOutput) SetTypeVersionArn(v string) *TestTypeOutput

SetTypeVersionArn sets the TypeVersionArn field's value.

func (TestTypeOutput) String added in v1.38.65 

func (s TestTypeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TypeConfigurationDetails added in v1.38.65 

type TypeConfigurationDetails struct {

	// The alias specified for this configuration, if one was specified when the
	// configuration was set.
	Alias *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) for the configuration data, in this account
	// and Region.
	Arn *string `type:"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 `min:"1" type:"string"`

	// Whether this configuration data is the default configuration for the extension.
	IsDefaultConfiguration *bool `type:"boolean"`

	// 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 `type:"timestamp"`

	// The Amazon Resource Name (ARN) for the extension, in this account and Region.
	//
	// For public extensions, this will be the ARN assigned when you activate the
	// type (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html)
	// in this account and Region. For private extensions, this will be the ARN
	// assigned when you register the type (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html)
	// in this account and Region.
	TypeArn *string `type:"string"`

	// The name of the extension.
	TypeName *string `min:"10" type:"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 Configuring extensions at the account level (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration) in the CloudFormation User Guide.

func (TypeConfigurationDetails) GoString added in v1.38.65 

func (s TypeConfigurationDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TypeConfigurationDetails) SetAlias added in v1.38.65 

func (s *TypeConfigurationDetails) SetAlias(v string) *TypeConfigurationDetails

SetAlias sets the Alias field's value.

func (*TypeConfigurationDetails) SetArn added in v1.38.65 

func (s *TypeConfigurationDetails) SetArn(v string) *TypeConfigurationDetails

SetArn sets the Arn field's value.

func (*TypeConfigurationDetails) SetConfiguration added in v1.38.65 

func (s *TypeConfigurationDetails) SetConfiguration(v string) *TypeConfigurationDetails

SetConfiguration sets the Configuration field's value.

func (*TypeConfigurationDetails) SetIsDefaultConfiguration added in v1.38.65 

func (s *TypeConfigurationDetails) SetIsDefaultConfiguration(v bool) *TypeConfigurationDetails

SetIsDefaultConfiguration sets the IsDefaultConfiguration field's value.

func (*TypeConfigurationDetails) SetLastUpdated added in v1.38.65 

func (s *TypeConfigurationDetails) SetLastUpdated(v time.Time) *TypeConfigurationDetails

SetLastUpdated sets the LastUpdated field's value.

func (*TypeConfigurationDetails) SetTypeArn added in v1.38.65 

func (s *TypeConfigurationDetails) SetTypeArn(v string) *TypeConfigurationDetails

SetTypeArn sets the TypeArn field's value.

func (*TypeConfigurationDetails) SetTypeName added in v1.38.65 

func (s *TypeConfigurationDetails) SetTypeName(v string) *TypeConfigurationDetails

SetTypeName sets the TypeName field's value.

func (TypeConfigurationDetails) String added in v1.38.65 

func (s TypeConfigurationDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TypeConfigurationIdentifier added in v1.38.65 

type TypeConfigurationIdentifier struct {

	// The type of extension.
	Type *string `type:"string" enum:"ThirdPartyType"`

	// The Amazon Resource Name (ARN) for the extension, in this account and Region.
	//
	// For public extensions, this will be the ARN assigned when you activate the
	// type (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html)
	// in this account and Region. For private extensions, this will be the ARN
	// assigned when you register the type (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html)
	// in this account and Region.
	TypeArn *string `type:"string"`

	// The alias specified for this configuration, if one was specified when the
	// configuration was set.
	TypeConfigurationAlias *string `min:"1" type:"string"`

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

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

Identifying information for the configuration of a CloudFormation extension.

func (TypeConfigurationIdentifier) GoString added in v1.38.65 

func (s TypeConfigurationIdentifier) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TypeConfigurationIdentifier) SetType added in v1.38.65 

func (s *TypeConfigurationIdentifier) SetType(v string) *TypeConfigurationIdentifier

SetType sets the Type field's value.

func (*TypeConfigurationIdentifier) SetTypeArn added in v1.38.65 

func (s *TypeConfigurationIdentifier) SetTypeArn(v string) *TypeConfigurationIdentifier

SetTypeArn sets the TypeArn field's value.

func (*TypeConfigurationIdentifier) SetTypeConfigurationAlias added in v1.38.65 

func (s *TypeConfigurationIdentifier) SetTypeConfigurationAlias(v string) *TypeConfigurationIdentifier

SetTypeConfigurationAlias sets the TypeConfigurationAlias field's value.

func (*TypeConfigurationIdentifier) SetTypeConfigurationArn added in v1.38.65 

func (s *TypeConfigurationIdentifier) SetTypeConfigurationArn(v string) *TypeConfigurationIdentifier

SetTypeConfigurationArn sets the TypeConfigurationArn field's value.

func (*TypeConfigurationIdentifier) SetTypeName added in v1.38.65 

func (s *TypeConfigurationIdentifier) SetTypeName(v string) *TypeConfigurationIdentifier

SetTypeName sets the TypeName field's value.

func (TypeConfigurationIdentifier) String added in v1.38.65 

func (s TypeConfigurationIdentifier) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TypeConfigurationIdentifier) Validate added in v1.38.65 

func (s *TypeConfigurationIdentifier) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TypeFilters added in v1.38.65 

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 *string `type:"string" enum:"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 `min:"1" type:"string"`

	// A prefix to use as a filter for results.
	TypeNamePrefix *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Filter criteria to use in determining which extensions to return.

func (TypeFilters) GoString added in v1.38.65 

func (s TypeFilters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TypeFilters) SetCategory added in v1.38.65 

func (s *TypeFilters) SetCategory(v string) *TypeFilters

SetCategory sets the Category field's value.

func (*TypeFilters) SetPublisherId added in v1.38.65 

func (s *TypeFilters) SetPublisherId(v string) *TypeFilters

SetPublisherId sets the PublisherId field's value.

func (*TypeFilters) SetTypeNamePrefix added in v1.38.65 

func (s *TypeFilters) SetTypeNamePrefix(v string) *TypeFilters

SetTypeNamePrefix sets the TypeNamePrefix field's value.

func (TypeFilters) String added in v1.38.65 

func (s TypeFilters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TypeFilters) Validate added in v1.38.65 

func (s *TypeFilters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TypeSummary added in v1.25.37 

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
	// (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html).
	//
	// To set the default version of an extension, use SetTypeDefaultVersion.
	DefaultVersionId *string `min:"1" type:"string"`

	// The description of the extension.
	Description *string `min:"1" type:"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 `type:"boolean"`

	// When the specified extension version was registered. This applies only to:
	//
	//    * Private extensions you have registered in your account. For more information,
	//    see RegisterType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html).
	//
	//    * Public extensions you have activated in your account with auto-update
	//    specified. For more information, see ActivateType (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html).
	//
	// For all other extension types, CloudFormation returns null.
	LastUpdated *time.Time `type:"timestamp"`

	// 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-arty 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 Setting CloudFormation
	// to automatically use new versions of extensions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto)
	// in the CloudFormation User Guide.
	LatestPublicVersion *string `min:"5" type:"string"`

	// For public extensions that have been activated for this account and Region,
	// the type name of the public extension.
	//
	// If you specified a TypeNameAlias when enabling the extension in this account
	// and Region, CloudFormation treats that alias as the extension's type name
	// within the account and Region, not the type name of the public extension.
	// For more information, see Specifying aliases to refer to extensions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-alias)
	// in the CloudFormation User Guide.
	OriginalTypeName *string `min:"10" type:"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 Setting CloudFormation
	// to automatically use new versions of extensions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto)
	// in the CloudFormation User Guide.
	PublicVersionNumber *string `min:"5" type:"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 `min:"1" type:"string"`

	// The service used to verify the publisher identity.
	//
	// For more information, see Registering your account to publish CloudFormation
	// extensions (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html)
	// in the CFN-CLI User Guide for Extension Development.
	PublisherIdentity *string `type:"string" enum:"IdentityProvider"`

	// The publisher name, as defined in the public profile for that publisher in
	// the service used to verify the publisher identity.
	PublisherName *string `min:"1" type:"string"`

	// The kind of extension.
	Type *string `type:"string" enum:"RegistryType"`

	// The Amazon Resource Name (ARN) of the extension.
	TypeArn *string `type:"string"`

	// The name of the extension.
	//
	// If you specified a TypeNameAlias when you activate this extension (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ActivateType.html)
	// in your account and Region, CloudFormation considers that alias as the type
	// name.
	TypeName *string `min:"10" type:"string"`
	// contains filtered or unexported fields
}

Contains summary information about the specified CloudFormation extension.

func (TypeSummary) GoString added in v1.25.37 

func (s TypeSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TypeSummary) SetDefaultVersionId added in v1.25.37 

func (s *TypeSummary) SetDefaultVersionId(v string) *TypeSummary

SetDefaultVersionId sets the DefaultVersionId field's value.

func (*TypeSummary) SetDescription added in v1.25.37 

func (s *TypeSummary) SetDescription(v string) *TypeSummary

SetDescription sets the Description field's value.

func (*TypeSummary) SetIsActivated added in v1.38.65 

func (s *TypeSummary) SetIsActivated(v bool) *TypeSummary

SetIsActivated sets the IsActivated field's value.

func (*TypeSummary) SetLastUpdated added in v1.25.37 

func (s *TypeSummary) SetLastUpdated(v time.Time) *TypeSummary

SetLastUpdated sets the LastUpdated field's value.

func (*TypeSummary) SetLatestPublicVersion added in v1.38.65 

func (s *TypeSummary) SetLatestPublicVersion(v string) *TypeSummary

SetLatestPublicVersion sets the LatestPublicVersion field's value.

func (*TypeSummary) SetOriginalTypeName added in v1.38.65 

func (s *TypeSummary) SetOriginalTypeName(v string) *TypeSummary

SetOriginalTypeName sets the OriginalTypeName field's value.

func (*TypeSummary) SetPublicVersionNumber added in v1.38.65 

func (s *TypeSummary) SetPublicVersionNumber(v string) *TypeSummary

SetPublicVersionNumber sets the PublicVersionNumber field's value.

func (*TypeSummary) SetPublisherId added in v1.38.65 

func (s *TypeSummary) SetPublisherId(v string) *TypeSummary

SetPublisherId sets the PublisherId field's value.

func (*TypeSummary) SetPublisherIdentity added in v1.38.65 

func (s *TypeSummary) SetPublisherIdentity(v string) *TypeSummary

SetPublisherIdentity sets the PublisherIdentity field's value.

func (*TypeSummary) SetPublisherName added in v1.38.65 

func (s *TypeSummary) SetPublisherName(v string) *TypeSummary

SetPublisherName sets the PublisherName field's value.

func (*TypeSummary) SetType added in v1.25.37 

func (s *TypeSummary) SetType(v string) *TypeSummary

SetType sets the Type field's value.

func (*TypeSummary) SetTypeArn added in v1.25.37 

func (s *TypeSummary) SetTypeArn(v string) *TypeSummary

SetTypeArn sets the TypeArn field's value.

func (*TypeSummary) SetTypeName added in v1.25.37 

func (s *TypeSummary) SetTypeName(v string) *TypeSummary

SetTypeName sets the TypeName field's value.

func (TypeSummary) String added in v1.25.37 

func (s TypeSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TypeVersionSummary added in v1.25.37 

type TypeVersionSummary struct {

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

	// The description of the extension version.
	Description *string `min:"1" type:"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 `type:"boolean"`

	// 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-arty
	// 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 Setting CloudFormation
	// to automatically use new versions of extensions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto)
	// in the CloudFormation User Guide.
	PublicVersionNumber *string `min:"5" type:"string"`

	// When the version was registered.
	TimeCreated *time.Time `type:"timestamp"`

	// The kind of extension.
	Type *string `type:"string" enum:"RegistryType"`

	// The name of the extension.
	TypeName *string `min:"10" type:"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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (TypeVersionSummary) GoString added in v1.25.37 

func (s TypeVersionSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TypeVersionSummary) SetArn added in v1.25.37 

func (s *TypeVersionSummary) SetArn(v string) *TypeVersionSummary

SetArn sets the Arn field's value.

func (*TypeVersionSummary) SetDescription added in v1.25.37 

func (s *TypeVersionSummary) SetDescription(v string) *TypeVersionSummary

SetDescription sets the Description field's value.

func (*TypeVersionSummary) SetIsDefaultVersion added in v1.30.29 

func (s *TypeVersionSummary) SetIsDefaultVersion(v bool) *TypeVersionSummary

SetIsDefaultVersion sets the IsDefaultVersion field's value.

func (*TypeVersionSummary) SetPublicVersionNumber added in v1.38.65 

func (s *TypeVersionSummary) SetPublicVersionNumber(v string) *TypeVersionSummary

SetPublicVersionNumber sets the PublicVersionNumber field's value.

func (*TypeVersionSummary) SetTimeCreated added in v1.25.37 

func (s *TypeVersionSummary) SetTimeCreated(v time.Time) *TypeVersionSummary

SetTimeCreated sets the TimeCreated field's value.

func (*TypeVersionSummary) SetType added in v1.25.37 

func (s *TypeVersionSummary) SetType(v string) *TypeVersionSummary

SetType sets the Type field's value.

func (*TypeVersionSummary) SetTypeName added in v1.25.37 

func (s *TypeVersionSummary) SetTypeName(v string) *TypeVersionSummary

SetTypeName sets the TypeName field's value.

func (*TypeVersionSummary) SetVersionId added in v1.25.37 

func (s *TypeVersionSummary) SetVersionId(v string) *TypeVersionSummary

SetVersionId sets the VersionId field's value.

func (TypeVersionSummary) String added in v1.25.37 

func (s TypeVersionSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateStackInput 

type UpdateStackInput struct {

	// In some cases, you must explicitly acknowledge that your stack template contains
	// certain capabilities in order for CloudFormation to update the stack.
	//
	//    * CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack 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 those stacks, you must explicitly acknowledge this by specifying one
	//    of these capabilities. The following IAM resources require you to specify
	//    either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability. If you have
	//    IAM resources, you can specify either capability. If you have IAM resources
	//    with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't
	//    specify either of these capabilities, CloudFormation returns an InsufficientCapabilities
	//    error. If your stack template contains these resources, we suggest that
	//    you review all permissions associated with them and edit their permissions
	//    if necessary. AWS::IAM::AccessKey (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html)
	//    AWS::IAM::Group (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html)
	//    AWS::IAM::InstanceProfile (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html)
	//    AWS::IAM::Policy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html)
	//    AWS::IAM::Role (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html)
	//    AWS::IAM::User (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html)
	//    AWS::IAM::UserToGroupAddition (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html)
	//    For more information, see Acknowledging IAM Resources in CloudFormation
	//    Templates (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities).
	//
	//    * CAPABILITY_AUTO_EXPAND Some template contain macros. Macros perform
	//    custom processing on templates; this can include simple actions like find-and-replace
	//    operations, all the way to extensive transformations of entire templates.
	//    Because of this, users typically create a change set from the processed
	//    template, so that they can review the changes resulting from the macros
	//    before actually updating the stack. If your stack template contains one
	//    or more macros, and you choose to update a stack directly from the processed
	//    template, without first reviewing the resulting changes in a change set,
	//    you must acknowledge this capability. This includes the AWS::Include (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html)
	//    and AWS::Serverless (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html)
	//    transforms, which are macros hosted by CloudFormation. If you want to
	//    update a stack from a stack template that contains macros and nested stacks,
	//    you must update the stack directly from the template using this capability.
	//    You should only update stacks directly from a stack template that contains
	//    macros if you know what processing the macro performs. Each macro relies
	//    on an underlying Lambda service function for processing stack templates.
	//    Be aware that the Lambda function owner can update the function operation
	//    without CloudFormation being notified. For more information, see Using
	//    CloudFormation Macros to Perform Custom Processing on Templates (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html).
	Capabilities []*string `type:"list" enum:"Capability"`

	// A unique identifier for this UpdateStack request. Specify this token if you
	// plan to retry requests so that CloudFormation knows that you're not attempting
	// to update a stack with the same name. You might retry UpdateStack requests
	// to ensure that CloudFormation successfully received them.
	//
	// All events triggered by a given stack operation are assigned the same client
	// request token, which you can use to track operations. For example, if you
	// execute a CreateStack operation with the token token1, then all the StackEvents
	// generated by that operation will have ClientRequestToken set as token1.
	//
	// In the console, stack operations display the client request token on the
	// Events tab. Stack operations that are initiated from the console use the
	// token format Console-StackOperation-ID, which helps you easily identify the
	// stack operation . For example, if you create a stack using the console, each
	// stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
	ClientRequestToken *string `min:"1" type:"string"`

	// Preserve the state of previously provisioned resources when an operation
	// fails.
	//
	// Default: False
	DisableRollback *bool `type:"boolean"`

	// Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that
	// CloudFormation associates with the stack. Specify an empty list to remove
	// all notification topics.
	NotificationARNs []*string `type:"list"`

	// A list of Parameter structures that specify input parameters for the stack.
	// For more information, see the Parameter (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html)
	// data type.
	Parameters []*Parameter `type:"list"`

	// The template resource types that you have permissions to work with for this
	// update stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
	//
	// If the list of resource types doesn't include a resource that you're updating,
	// the stack update fails. By default, CloudFormation grants permissions to
	// all resource types. Identity and Access Management (IAM) uses this parameter
	// for CloudFormation-specific condition keys in IAM policies. For more information,
	// see Controlling Access with Identity and Access Management (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html).
	ResourceTypes []*string `type:"list"`

	// 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 `type:"boolean"`

	// The Amazon Resource Name (ARN) of an Identity and Access Management (IAM)
	// role that CloudFormation assumes to update the stack. CloudFormation uses
	// the role's credentials to make calls on your behalf. CloudFormation always
	// uses this role for all future operations on the stack. Provided that users
	// have permission to operate on the stack, CloudFormation uses this role even
	// if the users don't have permission to pass it. Ensure that the role grants
	// least privilege.
	//
	// If you don't specify a value, CloudFormation uses the role that was previously
	// associated with the stack. If no role is available, CloudFormation uses a
	// temporary session that is generated from your user credentials.
	RoleARN *string `min:"20" type:"string"`

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

	// The name or unique stack ID of the stack to update.
	//
	// StackName is a required field
	StackName *string `type:"string" required:"true"`

	// Structure containing a new stack policy body. You can specify either the
	// StackPolicyBody or the StackPolicyURL parameter, but not both.
	//
	// You might update the stack policy, for example, in order to protect a new
	// resource that you created during a stack update. If you don't specify a stack
	// policy, the current policy that is associated with the stack is unchanged.
	StackPolicyBody *string `min:"1" type:"string"`

	// Structure containing the temporary overriding stack policy body. You can
	// specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL
	// parameter, but not both.
	//
	// If you want to update protected resources, specify a temporary overriding
	// stack policy during this update. If you don't specify a stack policy, the
	// current policy that is associated with the stack will be used.
	StackPolicyDuringUpdateBody *string `min:"1" type:"string"`

	// Location of a file containing the temporary overriding stack policy. The
	// URL must point to a policy (max size: 16KB) located in an S3 bucket in the
	// same Region as the stack. You can specify either the StackPolicyDuringUpdateBody
	// or the StackPolicyDuringUpdateURL parameter, but not both.
	//
	// If you want to update protected resources, specify a temporary overriding
	// stack policy during this update. If you don't specify a stack policy, the
	// current policy that is associated with the stack will be used.
	StackPolicyDuringUpdateURL *string `min:"1" type:"string"`

	// Location of a file containing the updated stack policy. The URL must point
	// to a policy (max size: 16KB) located in an S3 bucket in the same Region as
	// the stack. You can specify either the StackPolicyBody or the StackPolicyURL
	// parameter, but not both.
	//
	// You might update the stack policy, for example, in order to protect a new
	// resource that you created during a stack update. If you don't specify a stack
	// policy, the current policy that is associated with the stack is unchanged.
	StackPolicyURL *string `min:"1" type:"string"`

	// Key-value pairs to associate with this stack. CloudFormation also propagates
	// these tags to supported resources in the stack. You can specify a maximum
	// number of 50 tags.
	//
	// If you don't specify this parameter, CloudFormation doesn't modify the stack's
	// tags. If you specify an empty value, CloudFormation removes all associated
	// tags.
	Tags []*Tag `type:"list"`

	// Structure containing the template body with a minimum length of 1 byte and
	// a maximum length of 51,200 bytes. (For more information, go to Template Anatomy
	// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
	// in the CloudFormation User Guide.)
	//
	// Conditional: You must specify only one of the following parameters: TemplateBody,
	// TemplateURL, or set the UsePreviousTemplate to true.
	TemplateBody *string `min:"1" type:"string"`

	// Location of file containing the template body. The URL must point to a template
	// that's located in an Amazon S3 bucket or a Systems Manager document. For
	// more information, go to Template Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
	// in the CloudFormation User Guide.
	//
	// Conditional: You must specify only one of the following parameters: TemplateBody,
	// TemplateURL, or set the UsePreviousTemplate to true.
	TemplateURL *string `min:"1" type:"string"`

	// Reuse the existing template that is associated with the stack that you are
	// updating.
	//
	// Conditional: You must specify only one of the following parameters: TemplateBody,
	// TemplateURL, or set the UsePreviousTemplate to true.
	UsePreviousTemplate *bool `type:"boolean"`
	// contains filtered or unexported fields
}

The input for an UpdateStack action.

func (UpdateStackInput) GoString added in v0.6.5 

func (s UpdateStackInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateStackInput) SetCapabilities added in v1.5.0 

func (s *UpdateStackInput) SetCapabilities(v []*string) *UpdateStackInput

SetCapabilities sets the Capabilities field's value.

func (*UpdateStackInput) SetClientRequestToken added in v1.8.18 

func (s *UpdateStackInput) SetClientRequestToken(v string) *UpdateStackInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*UpdateStackInput) SetDisableRollback added in v1.40.33 

func (s *UpdateStackInput) SetDisableRollback(v bool) *UpdateStackInput

SetDisableRollback sets the DisableRollback field's value.

func (*UpdateStackInput) SetNotificationARNs added in v1.5.0 

func (s *UpdateStackInput) SetNotificationARNs(v []*string) *UpdateStackInput

SetNotificationARNs sets the NotificationARNs field's value.

func (*UpdateStackInput) SetParameters added in v1.5.0 

func (s *UpdateStackInput) SetParameters(v []*Parameter) *UpdateStackInput

SetParameters sets the Parameters field's value.

func (*UpdateStackInput) SetResourceTypes added in v1.5.0 

func (s *UpdateStackInput) SetResourceTypes(v []*string) *UpdateStackInput

SetResourceTypes sets the ResourceTypes field's value.

func (*UpdateStackInput) SetRetainExceptOnCreate added in v1.44.312 

func (s *UpdateStackInput) SetRetainExceptOnCreate(v bool) *UpdateStackInput

SetRetainExceptOnCreate sets the RetainExceptOnCreate field's value.

func (*UpdateStackInput) SetRoleARN added in v1.5.0 

func (s *UpdateStackInput) SetRoleARN(v string) *UpdateStackInput

SetRoleARN sets the RoleARN field's value.

func (*UpdateStackInput) SetRollbackConfiguration added in v1.10.33 

func (s *UpdateStackInput) SetRollbackConfiguration(v *RollbackConfiguration) *UpdateStackInput

SetRollbackConfiguration sets the RollbackConfiguration field's value.

func (*UpdateStackInput) SetStackName added in v1.5.0 

func (s *UpdateStackInput) SetStackName(v string) *UpdateStackInput

SetStackName sets the StackName field's value.

func (*UpdateStackInput) SetStackPolicyBody added in v1.5.0 

func (s *UpdateStackInput) SetStackPolicyBody(v string) *UpdateStackInput

SetStackPolicyBody sets the StackPolicyBody field's value.

func (*UpdateStackInput) SetStackPolicyDuringUpdateBody added in v1.5.0 

func (s *UpdateStackInput) SetStackPolicyDuringUpdateBody(v string) *UpdateStackInput

SetStackPolicyDuringUpdateBody sets the StackPolicyDuringUpdateBody field's value.

func (*UpdateStackInput) SetStackPolicyDuringUpdateURL added in v1.5.0 

func (s *UpdateStackInput) SetStackPolicyDuringUpdateURL(v string) *UpdateStackInput

SetStackPolicyDuringUpdateURL sets the StackPolicyDuringUpdateURL field's value.

func (*UpdateStackInput) SetStackPolicyURL added in v1.5.0 

func (s *UpdateStackInput) SetStackPolicyURL(v string) *UpdateStackInput

SetStackPolicyURL sets the StackPolicyURL field's value.

func (*UpdateStackInput) SetTags added in v1.5.0 

func (s *UpdateStackInput) SetTags(v []*Tag) *UpdateStackInput

SetTags sets the Tags field's value.

func (*UpdateStackInput) SetTemplateBody added in v1.5.0 

func (s *UpdateStackInput) SetTemplateBody(v string) *UpdateStackInput

SetTemplateBody sets the TemplateBody field's value.

func (*UpdateStackInput) SetTemplateURL added in v1.5.0 

func (s *UpdateStackInput) SetTemplateURL(v string) *UpdateStackInput

SetTemplateURL sets the TemplateURL field's value.

func (*UpdateStackInput) SetUsePreviousTemplate added in v1.5.0 

func (s *UpdateStackInput) SetUsePreviousTemplate(v bool) *UpdateStackInput

SetUsePreviousTemplate sets the UsePreviousTemplate field's value.

func (UpdateStackInput) String added in v0.6.5 

func (s UpdateStackInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateStackInput) Validate added in v1.1.21 

func (s *UpdateStackInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateStackInstancesInput added in v1.12.32 

type UpdateStackInstancesInput struct {

	// [Self-managed permissions] The names of one or more Amazon Web Services accounts
	// for which you want to update parameter values for stack instances. The overridden
	// parameter values will be applied to all stack instances in the specified
	// accounts and Amazon Web Services Regions.
	//
	// You can specify Accounts or DeploymentTargets, but not both.
	Accounts []*string `type:"list"`

	// [Service-managed permissions] Specifies whether you are acting as an account
	// administrator in the organization's management account or as a delegated
	// administrator in a member account.
	//
	// By default, SELF is specified. Use SELF for stack sets with self-managed
	// permissions.
	//
	//    * If you are signed in to the management account, specify SELF.
	//
	//    * If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
	//    Your Amazon Web Services account must be registered as a delegated administrator
	//    in the management account. For more information, see Register a delegated
	//    administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html)
	//    in the CloudFormation User Guide.
	CallAs *string `type:"string" enum:"CallAs"`

	// [Service-managed permissions] The Organizations accounts for which you want
	// to update parameter values for stack instances. If your update targets OUs,
	// the overridden parameter values only apply to the accounts that are currently
	// in the target OUs and their child OUs. Accounts added to the target OUs and
	// their child OUs in the future won't use the overridden values.
	//
	// You can specify Accounts or DeploymentTargets, but not both.
	DeploymentTargets *DeploymentTargets `type:"structure"`

	// The unique identifier for this stack set operation.
	//
	// The operation ID also functions as an idempotency token, to ensure that CloudFormation
	// performs the stack set operation only once, even if you retry the request
	// multiple times. You might retry stack set operation requests to ensure that
	// CloudFormation successfully received them.
	//
	// If you don't specify an operation ID, the SDK generates one automatically.
	OperationId *string `min:"1" type:"string" idempotencyToken:"true"`

	// Preferences for how CloudFormation performs this stack set operation.
	OperationPreferences *StackSetOperationPreferences `type:"structure"`

	// A list of input parameters whose values you want to update for the specified
	// stack instances.
	//
	// Any overridden parameter values will be applied to all stack instances in
	// the specified accounts and Amazon Web Services Regions. When specifying parameters
	// and their values, be aware of how CloudFormation sets parameter values during
	// stack instance update operations:
	//
	//    * To override the current value for a parameter, include the parameter
	//    and specify its value.
	//
	//    * To leave an overridden parameter set to its present value, include the
	//    parameter and specify UsePreviousValue as true. (You can't specify both
	//    a value and set UsePreviousValue to true.)
	//
	//    * To set an overridden parameter back to the value specified in the stack
	//    set, specify a parameter list but don't include the parameter in the list.
	//
	//    * To leave all parameters set to their present values, don't specify this
	//    property at all.
	//
	// During stack set updates, any parameter values overridden for a stack instance
	// aren't updated, but retain their overridden value.
	//
	// You can only override the parameter values that are specified in the stack
	// set; to add or delete a parameter itself, use UpdateStackSet to update the
	// stack set template. If you add a parameter to a template, before you can
	// override the parameter value specified in the stack set you must first use
	// UpdateStackSet (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html)
	// to update all stack instances with the updated template and parameter value
	// specified in the stack set. Once a stack instance has been updated with the
	// new parameter, you can then override the parameter value using UpdateStackInstances.
	ParameterOverrides []*Parameter `type:"list"`

	// The names of one or more Amazon Web Services Regions in which you want to
	// update parameter values for stack instances. The overridden parameter values
	// will be applied to all stack instances in the specified accounts and Amazon
	// Web Services Regions.
	//
	// Regions is a required field
	Regions []*string `type:"list" required:"true"`

	// The name or unique ID of the stack set associated with the stack instances.
	//
	// StackSetName is a required field
	StackSetName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateStackInstancesInput) GoString added in v1.12.32 

func (s UpdateStackInstancesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateStackInstancesInput) SetAccounts added in v1.12.32 

func (s *UpdateStackInstancesInput) SetAccounts(v []*string) *UpdateStackInstancesInput

SetAccounts sets the Accounts field's value.

func (*UpdateStackInstancesInput) SetCallAs added in v1.37.14 

func (s *UpdateStackInstancesInput) SetCallAs(v string) *UpdateStackInstancesInput

SetCallAs sets the CallAs field's value.

func (*UpdateStackInstancesInput) SetDeploymentTargets added in v1.29.0 

func (s *UpdateStackInstancesInput) SetDeploymentTargets(v *DeploymentTargets) *UpdateStackInstancesInput

SetDeploymentTargets sets the DeploymentTargets field's value.

func (*UpdateStackInstancesInput) SetOperationId added in v1.12.32 

func (s *UpdateStackInstancesInput) SetOperationId(v string) *UpdateStackInstancesInput

SetOperationId sets the OperationId field's value.

func (*UpdateStackInstancesInput) SetOperationPreferences added in v1.12.32 

func (s *UpdateStackInstancesInput) SetOperationPreferences(v *StackSetOperationPreferences) *UpdateStackInstancesInput

SetOperationPreferences sets the OperationPreferences field's value.

func (*UpdateStackInstancesInput) SetParameterOverrides added in v1.12.32 

func (s *UpdateStackInstancesInput) SetParameterOverrides(v []*Parameter) *UpdateStackInstancesInput

SetParameterOverrides sets the ParameterOverrides field's value.

func (*UpdateStackInstancesInput) SetRegions added in v1.12.32 

func (s *UpdateStackInstancesInput) SetRegions(v []*string) *UpdateStackInstancesInput

SetRegions sets the Regions field's value.

func (*UpdateStackInstancesInput) SetStackSetName added in v1.12.32 

func (s *UpdateStackInstancesInput) SetStackSetName(v string) *UpdateStackInstancesInput

SetStackSetName sets the StackSetName field's value.

func (UpdateStackInstancesInput) String added in v1.12.32 

func (s UpdateStackInstancesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateStackInstancesInput) Validate added in v1.12.32 

func (s *UpdateStackInstancesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateStackInstancesOutput added in v1.12.32 

type UpdateStackInstancesOutput struct {

	// The unique identifier for this stack set operation.
	OperationId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateStackInstancesOutput) GoString added in v1.12.32 

func (s UpdateStackInstancesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateStackInstancesOutput) SetOperationId added in v1.12.32 

func (s *UpdateStackInstancesOutput) SetOperationId(v string) *UpdateStackInstancesOutput

SetOperationId sets the OperationId field's value.

func (UpdateStackInstancesOutput) String added in v1.12.32 

func (s UpdateStackInstancesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateStackOutput 

type UpdateStackOutput struct {

	// Unique identifier of the stack.
	StackId *string `type:"string"`
	// contains filtered or unexported fields
}

The output for an UpdateStack action.

func (UpdateStackOutput) GoString added in v0.6.5 

func (s UpdateStackOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateStackOutput) SetStackId added in v1.5.0 

func (s *UpdateStackOutput) SetStackId(v string) *UpdateStackOutput

SetStackId sets the StackId field's value.

func (UpdateStackOutput) String added in v0.6.5 

func (s UpdateStackOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateStackSetInput added in v1.10.16 

type UpdateStackSetInput struct {

	// [Self-managed permissions] The accounts in which to update associated stack
	// instances. If you specify accounts, you must also specify the Amazon Web
	// Services Regions in which to update stack set instances.
	//
	// To update all the stack instances associated with this stack set, don't specify
	// the Accounts or Regions properties.
	//
	// If the stack set update includes changes to the template (that is, if the
	// TemplateBody or TemplateURL properties are specified), or the Parameters
	// property, CloudFormation marks all stack instances with a status of OUTDATED
	// prior to updating the stack instances in the specified accounts and Amazon
	// Web Services Regions. If the stack set update does not include changes to
	// the template or parameters, CloudFormation updates the stack instances in
	// the specified accounts and Amazon Web Services Regions, while leaving all
	// other stack instances with their existing stack instance status.
	Accounts []*string `type:"list"`

	// The Amazon Resource Name (ARN) of the IAM role to use to update this stack
	// set.
	//
	// Specify an IAM role only if you are using customized administrator roles
	// to control which users or groups can manage specific stack sets within the
	// same administrator account. For more information, see Granting Permissions
	// for Stack Set Operations (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html)
	// in the CloudFormation User Guide.
	//
	// If you specified a customized administrator role when you created the stack
	// set, you must specify a customized administrator role, even if it is the
	// same customized administrator role used with this stack set previously.
	AdministrationRoleARN *string `min:"20" type:"string"`

	// [Service-managed permissions] Describes whether StackSets automatically deploys
	// to Organizations accounts that are added to a target organization or organizational
	// unit (OU).
	//
	// If you specify AutoDeployment, don't specify DeploymentTargets or Regions.
	AutoDeployment *AutoDeployment `type:"structure"`

	// [Service-managed permissions] Specifies whether you are acting as an account
	// administrator in the organization's management account or as a delegated
	// administrator in a member account.
	//
	// By default, SELF is specified. Use SELF for stack sets with self-managed
	// permissions.
	//
	//    * If you are signed in to the management account, specify SELF.
	//
	//    * If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
	//    Your Amazon Web Services account must be registered as a delegated administrator
	//    in the management account. For more information, see Register a delegated
	//    administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html)
	//    in the CloudFormation User Guide.
	CallAs *string `type:"string" enum:"CallAs"`

	// In some cases, you must explicitly acknowledge that your stack template contains
	// certain capabilities in order for CloudFormation to update the stack set
	// and its associated stack instances.
	//
	//    * CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include
	//    resources that can affect permissions in your Amazon Web Services account;
	//    for example, by creating new Identity and Access Management (IAM) users.
	//    For those stacks sets, you must explicitly acknowledge this by specifying
	//    one of these capabilities. The following IAM resources require you to
	//    specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
	//    If you have IAM resources, you can specify either capability. If you have
	//    IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
	//    If you don't specify either of these capabilities, CloudFormation returns
	//    an InsufficientCapabilities error. If your stack template contains these
	//    resources, we recommend that you review all permissions associated with
	//    them and edit their permissions if necessary. AWS::IAM::AccessKey (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html)
	//    AWS::IAM::Group (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html)
	//    AWS::IAM::InstanceProfile (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html)
	//    AWS::IAM::Policy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html)
	//    AWS::IAM::Role (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html)
	//    AWS::IAM::User (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html)
	//    AWS::IAM::UserToGroupAddition (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html)
	//    For more information, see Acknowledging IAM Resources in CloudFormation
	//    Templates (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities).
	//
	//    * CAPABILITY_AUTO_EXPAND Some templates reference macros. If your stack
	//    set template references one or more macros, you must update the stack
	//    set directly from the processed template, without first reviewing the
	//    resulting changes in a change set. To update the stack set directly, you
	//    must acknowledge this capability. For more information, see Using CloudFormation
	//    Macros to Perform Custom Processing on Templates (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html).
	//    Stack sets with service-managed permissions do not currently support the
	//    use of macros in templates. (This includes the AWS::Include (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html)
	//    and AWS::Serverless (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html)
	//    transforms, which are macros hosted by CloudFormation.) Even if you specify
	//    this capability for a stack set with service-managed permissions, if you
	//    reference a macro in your template the stack set operation will fail.
	Capabilities []*string `type:"list" enum:"Capability"`

	// [Service-managed permissions] The Organizations accounts in which to update
	// associated stack instances.
	//
	// To update all the stack instances associated with this stack set, do not
	// specify DeploymentTargets or Regions.
	//
	// If the stack set update includes changes to the template (that is, if TemplateBody
	// or TemplateURL is specified), or the Parameters, CloudFormation marks all
	// stack instances with a status of OUTDATED prior to updating the stack instances
	// in the specified accounts and Amazon Web Services Regions. If the stack set
	// update doesn't include changes to the template or parameters, CloudFormation
	// updates the stack instances in the specified accounts and Regions, while
	// leaving all other stack instances with their existing stack instance status.
	DeploymentTargets *DeploymentTargets `type:"structure"`

	// A brief description of updates that you are making.
	Description *string `min:"1" type:"string"`

	// The name of the IAM execution role to use to update the stack set. If you
	// do not specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole
	// role for the stack set operation.
	//
	// Specify an IAM role only if you are using customized execution roles to control
	// which stack resources users and groups can include in their stack sets.
	//
	// If you specify a customized execution role, CloudFormation uses that role
	// to update the stack. If you do not specify a customized execution role, CloudFormation
	// performs the update using the role previously associated with the stack set,
	// so long as you have permissions to perform operations on the stack set.
	ExecutionRoleName *string `min:"1" type:"string"`

	// Describes whether StackSets performs non-conflicting operations concurrently
	// and queues conflicting operations.
	ManagedExecution *ManagedExecution `type:"structure"`

	// The unique ID for this stack set operation.
	//
	// The operation ID also functions as an idempotency token, to ensure that CloudFormation
	// performs the stack set operation only once, even if you retry the request
	// multiple times. You might retry stack set operation requests to ensure that
	// CloudFormation successfully received them.
	//
	// If you don't specify an operation ID, CloudFormation generates one automatically.
	//
	// Repeating this stack set operation with a new operation ID retries all stack
	// instances whose status is OUTDATED.
	OperationId *string `min:"1" type:"string" idempotencyToken:"true"`

	// Preferences for how CloudFormation performs this stack set operation.
	OperationPreferences *StackSetOperationPreferences `type:"structure"`

	// A list of input parameters for the stack set template.
	Parameters []*Parameter `type:"list"`

	// Describes how the IAM roles required for stack set operations are created.
	// You cannot modify PermissionModel if there are stack instances associated
	// with your stack set.
	//
	//    * With self-managed permissions, you must create the administrator and
	//    execution roles required to deploy to target accounts. For more information,
	//    see Grant Self-Managed Stack Set Permissions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html).
	//
	//    * With service-managed permissions, StackSets automatically creates the
	//    IAM roles required to deploy to accounts managed by Organizations. For
	//    more information, see Grant Service-Managed Stack Set Permissions (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html).
	PermissionModel *string `type:"string" enum:"PermissionModels"`

	// The Amazon Web Services Regions in which to update associated stack instances.
	// If you specify Regions, you must also specify accounts in which to update
	// stack set instances.
	//
	// To update all the stack instances associated with this stack set, do not
	// specify the Accounts or Regions properties.
	//
	// If the stack set update includes changes to the template (that is, if the
	// TemplateBody or TemplateURL properties are specified), or the Parameters
	// property, CloudFormation marks all stack instances with a status of OUTDATED
	// prior to updating the stack instances in the specified accounts and Regions.
	// If the stack set update does not include changes to the template or parameters,
	// CloudFormation updates the stack instances in the specified accounts and
	// Regions, while leaving all other stack instances with their existing stack
	// instance status.
	Regions []*string `type:"list"`

	// The name or unique ID of the stack set that you want to update.
	//
	// StackSetName is a required field
	StackSetName *string `type:"string" required:"true"`

	// The key-value pairs to associate with this stack set and the stacks created
	// from it. CloudFormation also propagates these tags to supported resources
	// that are created in the stacks. You can specify a maximum number of 50 tags.
	//
	// If you specify tags for this parameter, those tags replace any list of tags
	// that are currently associated with this stack set. This means:
	//
	//    * If you don't specify this parameter, CloudFormation doesn't modify the
	//    stack's tags.
	//
	//    * If you specify any tags using this parameter, you must specify all the
	//    tags that you want associated with this stack set, even tags you've specified
	//    before (for example, when creating the stack set or during a previous
	//    update of the stack set.). Any tags that you don't include in the updated
	//    list of tags are removed from the stack set, and therefore from the stacks
	//    and resources as well.
	//
	//    * If you specify an empty value, CloudFormation removes all currently
	//    associated tags.
	//
	// If you specify new tags as part of an UpdateStackSet action, CloudFormation
	// checks to see if you have the required IAM permission to tag resources. If
	// you omit tags that are currently associated with the stack set from the list
	// of tags you specify, CloudFormation assumes that you want to remove those
	// tags from the stack set, and checks to see if you have permission to untag
	// resources. If you don't have the necessary permission(s), the entire UpdateStackSet
	// action fails with an access denied error, and the stack set is not updated.
	Tags []*Tag `type:"list"`

	// The structure that contains the template body, with a minimum length of 1
	// byte and a maximum length of 51,200 bytes. For more information, see Template
	// Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
	// in the CloudFormation User Guide.
	//
	// Conditional: You must specify only one of the following parameters: TemplateBody
	// or TemplateURL—or set UsePreviousTemplate to true.
	TemplateBody *string `min:"1" type:"string"`

	// The location of the file that contains the template body. The URL must point
	// to a template (maximum size: 460,800 bytes) that is located in an Amazon
	// S3 bucket or a Systems Manager document. For more information, see Template
	// Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
	// in the CloudFormation User Guide.
	//
	// Conditional: You must specify only one of the following parameters: TemplateBody
	// or TemplateURL—or set UsePreviousTemplate to true.
	TemplateURL *string `min:"1" type:"string"`

	// Use the existing template that's associated with the stack set that you're
	// updating.
	//
	// Conditional: You must specify only one of the following parameters: TemplateBody
	// or TemplateURL—or set UsePreviousTemplate to true.
	UsePreviousTemplate *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (UpdateStackSetInput) GoString added in v1.10.16 

func (s UpdateStackSetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateStackSetInput) SetAccounts added in v1.13.53 

func (s *UpdateStackSetInput) SetAccounts(v []*string) *UpdateStackSetInput

SetAccounts sets the Accounts field's value.

func (*UpdateStackSetInput) SetAdministrationRoleARN added in v1.13.24 

func (s *UpdateStackSetInput) SetAdministrationRoleARN(v string) *UpdateStackSetInput

SetAdministrationRoleARN sets the AdministrationRoleARN field's value.

func (*UpdateStackSetInput) SetAutoDeployment added in v1.29.0 

func (s *UpdateStackSetInput) SetAutoDeployment(v *AutoDeployment) *UpdateStackSetInput

SetAutoDeployment sets the AutoDeployment field's value.

func (*UpdateStackSetInput) SetCallAs added in v1.37.14 

func (s *UpdateStackSetInput) SetCallAs(v string) *UpdateStackSetInput

SetCallAs sets the CallAs field's value.

func (*UpdateStackSetInput) SetCapabilities added in v1.10.16 

func (s *UpdateStackSetInput) SetCapabilities(v []*string) *UpdateStackSetInput

SetCapabilities sets the Capabilities field's value.

func (*UpdateStackSetInput) SetDeploymentTargets added in v1.29.0 

func (s *UpdateStackSetInput) SetDeploymentTargets(v *DeploymentTargets) *UpdateStackSetInput

SetDeploymentTargets sets the DeploymentTargets field's value.

func (*UpdateStackSetInput) SetDescription added in v1.10.16 

func (s *UpdateStackSetInput) SetDescription(v string) *UpdateStackSetInput

SetDescription sets the Description field's value.

func (*UpdateStackSetInput) SetExecutionRoleName added in v1.13.53 

func (s *UpdateStackSetInput) SetExecutionRoleName(v string) *UpdateStackSetInput

SetExecutionRoleName sets the ExecutionRoleName field's value.

func (*UpdateStackSetInput) SetManagedExecution added in v1.42.9 

func (s *UpdateStackSetInput) SetManagedExecution(v *ManagedExecution) *UpdateStackSetInput

SetManagedExecution sets the ManagedExecution field's value.

func (*UpdateStackSetInput) SetOperationId added in v1.10.16 

func (s *UpdateStackSetInput) SetOperationId(v string) *UpdateStackSetInput

SetOperationId sets the OperationId field's value.

func (*UpdateStackSetInput) SetOperationPreferences added in v1.10.16 

func (s *UpdateStackSetInput) SetOperationPreferences(v *StackSetOperationPreferences) *UpdateStackSetInput

SetOperationPreferences sets the OperationPreferences field's value.

func (*UpdateStackSetInput) SetParameters added in v1.10.16 

func (s *UpdateStackSetInput) SetParameters(v []*Parameter) *UpdateStackSetInput

SetParameters sets the Parameters field's value.

func (*UpdateStackSetInput) SetPermissionModel added in v1.29.0 

func (s *UpdateStackSetInput) SetPermissionModel(v string) *UpdateStackSetInput

SetPermissionModel sets the PermissionModel field's value.

func (*UpdateStackSetInput) SetRegions added in v1.13.53 

func (s *UpdateStackSetInput) SetRegions(v []*string) *UpdateStackSetInput

SetRegions sets the Regions field's value.

func (*UpdateStackSetInput) SetStackSetName added in v1.10.16 

func (s *UpdateStackSetInput) SetStackSetName(v string) *UpdateStackSetInput

SetStackSetName sets the StackSetName field's value.

func (*UpdateStackSetInput) SetTags added in v1.10.16 

func (s *UpdateStackSetInput) SetTags(v []*Tag) *UpdateStackSetInput

SetTags sets the Tags field's value.

func (*UpdateStackSetInput) SetTemplateBody added in v1.10.16 

func (s *UpdateStackSetInput) SetTemplateBody(v string) *UpdateStackSetInput

SetTemplateBody sets the TemplateBody field's value.

func (*UpdateStackSetInput) SetTemplateURL added in v1.10.16 

func (s *UpdateStackSetInput) SetTemplateURL(v string) *UpdateStackSetInput

SetTemplateURL sets the TemplateURL field's value.

func (*UpdateStackSetInput) SetUsePreviousTemplate added in v1.10.16 

func (s *UpdateStackSetInput) SetUsePreviousTemplate(v bool) *UpdateStackSetInput

SetUsePreviousTemplate sets the UsePreviousTemplate field's value.

func (UpdateStackSetInput) String added in v1.10.16 

func (s UpdateStackSetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateStackSetInput) Validate added in v1.10.16 

func (s *UpdateStackSetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateStackSetOutput added in v1.10.16 

type UpdateStackSetOutput struct {

	// The unique ID for this stack set operation.
	OperationId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateStackSetOutput) GoString added in v1.10.16 

func (s UpdateStackSetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateStackSetOutput) SetOperationId added in v1.10.16 

func (s *UpdateStackSetOutput) SetOperationId(v string) *UpdateStackSetOutput

SetOperationId sets the OperationId field's value.

func (UpdateStackSetOutput) String added in v1.10.16 

func (s UpdateStackSetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateTerminationProtectionInput added in v1.11.0 

type UpdateTerminationProtectionInput struct {

	// Whether to enable termination protection on the specified stack.
	//
	// EnableTerminationProtection is a required field
	EnableTerminationProtection *bool `type:"boolean" required:"true"`

	// The name or unique ID of the stack for which you want to set termination
	// protection.
	//
	// StackName is a required field
	StackName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateTerminationProtectionInput) GoString added in v1.11.0 

func (s UpdateTerminationProtectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateTerminationProtectionInput) SetEnableTerminationProtection added in v1.11.0 

func (s *UpdateTerminationProtectionInput) SetEnableTerminationProtection(v bool) *UpdateTerminationProtectionInput

SetEnableTerminationProtection sets the EnableTerminationProtection field's value.

func (*UpdateTerminationProtectionInput) SetStackName added in v1.11.0 

func (s *UpdateTerminationProtectionInput) SetStackName(v string) *UpdateTerminationProtectionInput

SetStackName sets the StackName field's value.

func (UpdateTerminationProtectionInput) String added in v1.11.0 

func (s UpdateTerminationProtectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateTerminationProtectionInput) Validate added in v1.11.0 

func (s *UpdateTerminationProtectionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateTerminationProtectionOutput added in v1.11.0 

type UpdateTerminationProtectionOutput struct {

	// The unique ID of the stack.
	StackId *string `type:"string"`
	// contains filtered or unexported fields
}

func (UpdateTerminationProtectionOutput) GoString added in v1.11.0 

func (s UpdateTerminationProtectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateTerminationProtectionOutput) SetStackId added in v1.11.0 

func (s *UpdateTerminationProtectionOutput) SetStackId(v string) *UpdateTerminationProtectionOutput

SetStackId sets the StackId field's value.

func (UpdateTerminationProtectionOutput) String added in v1.11.0 

func (s UpdateTerminationProtectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidateTemplateInput 

type ValidateTemplateInput struct {

	// Structure containing the template body with a minimum length of 1 byte and
	// a maximum length of 51,200 bytes. For more information, go to Template Anatomy
	// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
	// in the CloudFormation User Guide.
	//
	// Conditional: You must pass TemplateURL or TemplateBody. If both are passed,
	// only TemplateBody is used.
	TemplateBody *string `min:"1" type:"string"`

	// Location of file containing the template body. The URL must point to a template
	// (max size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems
	// Manager document. For more information, go to Template Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
	// in the CloudFormation User Guide.
	//
	// Conditional: You must pass TemplateURL or TemplateBody. If both are passed,
	// only TemplateBody is used.
	TemplateURL *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The input for ValidateTemplate action.

func (ValidateTemplateInput) GoString added in v0.6.5 

func (s ValidateTemplateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidateTemplateInput) SetTemplateBody added in v1.5.0 

func (s *ValidateTemplateInput) SetTemplateBody(v string) *ValidateTemplateInput

SetTemplateBody sets the TemplateBody field's value.

func (*ValidateTemplateInput) SetTemplateURL added in v1.5.0 

func (s *ValidateTemplateInput) SetTemplateURL(v string) *ValidateTemplateInput

SetTemplateURL sets the TemplateURL field's value.

func (ValidateTemplateInput) String added in v0.6.5 

func (s ValidateTemplateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidateTemplateInput) Validate added in v1.1.21 

func (s *ValidateTemplateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ValidateTemplateOutput 

type ValidateTemplateOutput struct {

	// The capabilities found within the template. If your template contains IAM
	// resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value
	// for this parameter when you use the CreateStack or UpdateStack actions with
	// your template; otherwise, those actions return an InsufficientCapabilities
	// error.
	//
	// For more information, see Acknowledging IAM Resources in CloudFormation Templates
	// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities).
	Capabilities []*string `type:"list" enum:"Capability"`

	// The list of resources that generated the values in the Capabilities response
	// element.
	CapabilitiesReason *string `type:"string"`

	// A list of the transforms that are declared in the template.
	DeclaredTransforms []*string `type:"list"`

	// The description found within the template.
	Description *string `min:"1" type:"string"`

	// A list of TemplateParameter structures.
	Parameters []*TemplateParameter `type:"list"`
	// contains filtered or unexported fields
}

The output for ValidateTemplate action.

func (ValidateTemplateOutput) GoString added in v0.6.5 

func (s ValidateTemplateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidateTemplateOutput) SetCapabilities added in v1.5.0 

func (s *ValidateTemplateOutput) SetCapabilities(v []*string) *ValidateTemplateOutput

SetCapabilities sets the Capabilities field's value.

func (*ValidateTemplateOutput) SetCapabilitiesReason added in v1.5.0 

func (s *ValidateTemplateOutput) SetCapabilitiesReason(v string) *ValidateTemplateOutput

SetCapabilitiesReason sets the CapabilitiesReason field's value.

func (*ValidateTemplateOutput) SetDeclaredTransforms added in v1.5.0 

func (s *ValidateTemplateOutput) SetDeclaredTransforms(v []*string) *ValidateTemplateOutput

SetDeclaredTransforms sets the DeclaredTransforms field's value.

func (*ValidateTemplateOutput) SetDescription added in v1.5.0 

func (s *ValidateTemplateOutput) SetDescription(v string) *ValidateTemplateOutput

SetDescription sets the Description field's value.

func (*ValidateTemplateOutput) SetParameters added in v1.5.0 

func (s *ValidateTemplateOutput) SetParameters(v []*TemplateParameter) *ValidateTemplateOutput

SetParameters sets the Parameters field's value.

func (ValidateTemplateOutput) String added in v0.6.5 

func (s ValidateTemplateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Warnings added in v1.44.303 

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 `type:"list"`
	// contains filtered or unexported fields
}

Contains any warnings returned by the GetTemplateSummary API action.

func (Warnings) GoString added in v1.44.303 

func (s Warnings) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Warnings) SetUnrecognizedResourceTypes added in v1.44.303 

func (s *Warnings) SetUnrecognizedResourceTypes(v []*string) *Warnings

SetUnrecognizedResourceTypes sets the UnrecognizedResourceTypes field's value.

func (Warnings) String added in v1.44.303 

func (s Warnings) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

Directories

Path Synopsis
Package cloudformationiface provides an interface to enable mocking the AWS CloudFormation service client for testing your code.
 Package cloudformationiface provides an interface to enable mocking the AWS CloudFormation service client for testing your code.

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.