cloudformation

package
Version: v1.44.43 Latest Latest
Warning

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

 Go to latest Published: Jun 27, 2022 License: Apache-2.0 Imports: 10 Imported by: 761

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 (
	// 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"
)
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 (
	// 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 (
	// 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"

	// 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"
)
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 (
	// StackInstanceFilterNameDetailedStatus is a StackInstanceFilterName enum value
	StackInstanceFilterNameDetailedStatus = "DETAILED_STATUS"
)

Variables

This section is empty.

Functions

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 OperationStatus_Values added in v1.34.3 

func OperationStatus_Values() []string

OperationStatus_Values returns all elements of the OperationStatus 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 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"`

	// 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) 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 (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