@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface CloudFormationClient extends SdkClient
builder() method.
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 of 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.
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 .
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default ActivateTypeResponse |
activateType(ActivateTypeRequest activateTypeRequest)
Activates a public third-party extension, making it available for use in stack templates.
|
default ActivateTypeResponse |
activateType(Consumer<ActivateTypeRequest.Builder> activateTypeRequest)
Activates a public third-party extension, making it available for use in stack templates.
|
default BatchDescribeTypeConfigurationsResponse |
batchDescribeTypeConfigurations(BatchDescribeTypeConfigurationsRequest batchDescribeTypeConfigurationsRequest)
Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the
account and region.
|
default BatchDescribeTypeConfigurationsResponse |
batchDescribeTypeConfigurations(Consumer<BatchDescribeTypeConfigurationsRequest.Builder> batchDescribeTypeConfigurationsRequest)
Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the
account and region.
|
static CloudFormationClientBuilder |
builder()
Create a builder that can be used to configure and create a
CloudFormationClient. |
default CancelUpdateStackResponse |
cancelUpdateStack(CancelUpdateStackRequest cancelUpdateStackRequest)
Cancels an update on the specified stack.
|
default CancelUpdateStackResponse |
cancelUpdateStack(Consumer<CancelUpdateStackRequest.Builder> cancelUpdateStackRequest)
Cancels an update on the specified stack.
|
default ContinueUpdateRollbackResponse |
continueUpdateRollback(Consumer<ContinueUpdateRollbackRequest.Builder> continueUpdateRollbackRequest)
For a specified stack that is in the
UPDATE_ROLLBACK_FAILED state, continues rolling it back to the
UPDATE_ROLLBACK_COMPLETE state. |
default ContinueUpdateRollbackResponse |
continueUpdateRollback(ContinueUpdateRollbackRequest continueUpdateRollbackRequest)
For a specified stack that is in the
UPDATE_ROLLBACK_FAILED state, continues rolling it back to the
UPDATE_ROLLBACK_COMPLETE state. |
static CloudFormationClient |
create()
Create a
CloudFormationClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateChangeSetResponse |
createChangeSet(Consumer<CreateChangeSetRequest.Builder> createChangeSetRequest)
Creates a list of changes that will be applied to a stack so that you can review the changes before executing
them.
|
default CreateChangeSetResponse |
createChangeSet(CreateChangeSetRequest createChangeSetRequest)
Creates a list of changes that will be applied to a stack so that you can review the changes before executing
them.
|
default CreateStackResponse |
createStack(Consumer<CreateStackRequest.Builder> createStackRequest)
Creates a stack as specified in the template.
|
default CreateStackResponse |
createStack(CreateStackRequest createStackRequest)
Creates a stack as specified in the template.
|
default CreateStackInstancesResponse |
createStackInstances(Consumer<CreateStackInstancesRequest.Builder> createStackInstancesRequest)
Creates stack instances for the specified accounts, within the specified Regions.
|
default CreateStackInstancesResponse |
createStackInstances(CreateStackInstancesRequest createStackInstancesRequest)
Creates stack instances for the specified accounts, within the specified Regions.
|
default CreateStackSetResponse |
createStackSet(Consumer<CreateStackSetRequest.Builder> createStackSetRequest)
Creates a stack set.
|
default CreateStackSetResponse |
createStackSet(CreateStackSetRequest createStackSetRequest)
Creates a stack set.
|
default DeactivateTypeResponse |
deactivateType(Consumer<DeactivateTypeRequest.Builder> deactivateTypeRequest)
Deactivates a public extension that was previously activated in this account and region.
|
default DeactivateTypeResponse |
deactivateType(DeactivateTypeRequest deactivateTypeRequest)
Deactivates a public extension that was previously activated in this account and region.
|
default DeleteChangeSetResponse |
deleteChangeSet(Consumer<DeleteChangeSetRequest.Builder> deleteChangeSetRequest)
Deletes the specified change set.
|
default DeleteChangeSetResponse |
deleteChangeSet(DeleteChangeSetRequest deleteChangeSetRequest)
Deletes the specified change set.
|
default DeleteStackResponse |
deleteStack(Consumer<DeleteStackRequest.Builder> deleteStackRequest)
Deletes a specified stack.
|
default DeleteStackResponse |
deleteStack(DeleteStackRequest deleteStackRequest)
Deletes a specified stack.
|
default DeleteStackInstancesResponse |
deleteStackInstances(Consumer<DeleteStackInstancesRequest.Builder> deleteStackInstancesRequest)
Deletes stack instances for the specified accounts, in the specified Regions.
|
default DeleteStackInstancesResponse |
deleteStackInstances(DeleteStackInstancesRequest deleteStackInstancesRequest)
Deletes stack instances for the specified accounts, in the specified Regions.
|
default DeleteStackSetResponse |
deleteStackSet(Consumer<DeleteStackSetRequest.Builder> deleteStackSetRequest)
Deletes a stack set.
|
default DeleteStackSetResponse |
deleteStackSet(DeleteStackSetRequest deleteStackSetRequest)
Deletes a stack set.
|
default DeregisterTypeResponse |
deregisterType(Consumer<DeregisterTypeRequest.Builder> deregisterTypeRequest)
Marks an extension or extension version as
DEPRECATED in the CloudFormation registry, removing it
from active use. |
default DeregisterTypeResponse |
deregisterType(DeregisterTypeRequest deregisterTypeRequest)
Marks an extension or extension version as
DEPRECATED in the CloudFormation registry, removing it
from active use. |
default DescribeAccountLimitsResponse |
describeAccountLimits()
Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your
account.
|
default DescribeAccountLimitsResponse |
describeAccountLimits(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest)
Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your
account.
|
default DescribeAccountLimitsResponse |
describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest)
Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your
account.
|
default DescribeAccountLimitsIterable |
describeAccountLimitsPaginator()
Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your
account.
|
default DescribeAccountLimitsIterable |
describeAccountLimitsPaginator(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest)
Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your
account.
|
default DescribeAccountLimitsIterable |
describeAccountLimitsPaginator(DescribeAccountLimitsRequest describeAccountLimitsRequest)
Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your
account.
|
default DescribeChangeSetResponse |
describeChangeSet(Consumer<DescribeChangeSetRequest.Builder> describeChangeSetRequest)
Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the
change set.
|
default DescribeChangeSetResponse |
describeChangeSet(DescribeChangeSetRequest describeChangeSetRequest)
Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the
change set.
|
default DescribePublisherResponse |
describePublisher(Consumer<DescribePublisherRequest.Builder> describePublisherRequest)
Returns information about a CloudFormation extension publisher.
|
default DescribePublisherResponse |
describePublisher(DescribePublisherRequest describePublisherRequest)
Returns information about a CloudFormation extension publisher.
|
default DescribeStackDriftDetectionStatusResponse |
describeStackDriftDetectionStatus(Consumer<DescribeStackDriftDetectionStatusRequest.Builder> describeStackDriftDetectionStatusRequest)
Returns information about a stack drift detection operation.
|
default DescribeStackDriftDetectionStatusResponse |
describeStackDriftDetectionStatus(DescribeStackDriftDetectionStatusRequest describeStackDriftDetectionStatusRequest)
Returns information about a stack drift detection operation.
|
default DescribeStackEventsResponse |
describeStackEvents(Consumer<DescribeStackEventsRequest.Builder> describeStackEventsRequest)
Returns all stack related events for a specified stack in reverse chronological order.
|
default DescribeStackEventsResponse |
describeStackEvents(DescribeStackEventsRequest describeStackEventsRequest)
Returns all stack related events for a specified stack in reverse chronological order.
|
default DescribeStackEventsIterable |
describeStackEventsPaginator(Consumer<DescribeStackEventsRequest.Builder> describeStackEventsRequest)
Returns all stack related events for a specified stack in reverse chronological order.
|
default DescribeStackEventsIterable |
describeStackEventsPaginator(DescribeStackEventsRequest describeStackEventsRequest)
Returns all stack related events for a specified stack in reverse chronological order.
|
default DescribeStackInstanceResponse |
describeStackInstance(Consumer<DescribeStackInstanceRequest.Builder> describeStackInstanceRequest)
Returns the stack instance that's associated with the specified stack set, Amazon Web Services account, and
Region.
|
default DescribeStackInstanceResponse |
describeStackInstance(DescribeStackInstanceRequest describeStackInstanceRequest)
Returns the stack instance that's associated with the specified stack set, Amazon Web Services account, and
Region.
|
default DescribeStackResourceResponse |
describeStackResource(Consumer<DescribeStackResourceRequest.Builder> describeStackResourceRequest)
Returns a description of the specified resource in the specified stack.
|
default DescribeStackResourceResponse |
describeStackResource(DescribeStackResourceRequest describeStackResourceRequest)
Returns a description of the specified resource in the specified stack.
|
default DescribeStackResourceDriftsResponse |
describeStackResourceDrifts(Consumer<DescribeStackResourceDriftsRequest.Builder> describeStackResourceDriftsRequest)
Returns drift information for the resources that have been checked for drift in the specified stack.
|
default DescribeStackResourceDriftsResponse |
describeStackResourceDrifts(DescribeStackResourceDriftsRequest describeStackResourceDriftsRequest)
Returns drift information for the resources that have been checked for drift in the specified stack.
|
default DescribeStackResourceDriftsIterable |
describeStackResourceDriftsPaginator(Consumer<DescribeStackResourceDriftsRequest.Builder> describeStackResourceDriftsRequest)
Returns drift information for the resources that have been checked for drift in the specified stack.
|
default DescribeStackResourceDriftsIterable |
describeStackResourceDriftsPaginator(DescribeStackResourceDriftsRequest describeStackResourceDriftsRequest)
Returns drift information for the resources that have been checked for drift in the specified stack.
|
default DescribeStackResourcesResponse |
describeStackResources(Consumer<DescribeStackResourcesRequest.Builder> describeStackResourcesRequest)
Returns Amazon Web Services resource descriptions for running and deleted stacks.
|
default DescribeStackResourcesResponse |
describeStackResources(DescribeStackResourcesRequest describeStackResourcesRequest)
Returns Amazon Web Services resource descriptions for running and deleted stacks.
|
default DescribeStacksResponse |
describeStacks()
Returns the description for the specified stack; if no stack name was specified, then it returns the description
for all the stacks created.
|
default DescribeStacksResponse |
describeStacks(Consumer<DescribeStacksRequest.Builder> describeStacksRequest)
Returns the description for the specified stack; if no stack name was specified, then it returns the description
for all the stacks created.
|
default DescribeStacksResponse |
describeStacks(DescribeStacksRequest describeStacksRequest)
Returns the description for the specified stack; if no stack name was specified, then it returns the description
for all the stacks created.
|
default DescribeStackSetResponse |
describeStackSet(Consumer<DescribeStackSetRequest.Builder> describeStackSetRequest)
Returns the description of the specified stack set.
|
default DescribeStackSetResponse |
describeStackSet(DescribeStackSetRequest describeStackSetRequest)
Returns the description of the specified stack set.
|
default DescribeStackSetOperationResponse |
describeStackSetOperation(Consumer<DescribeStackSetOperationRequest.Builder> describeStackSetOperationRequest)
Returns the description of the specified stack set operation.
|
default DescribeStackSetOperationResponse |
describeStackSetOperation(DescribeStackSetOperationRequest describeStackSetOperationRequest)
Returns the description of the specified stack set operation.
|
default DescribeStacksIterable |
describeStacksPaginator()
Returns the description for the specified stack; if no stack name was specified, then it returns the description
for all the stacks created.
|
default DescribeStacksIterable |
describeStacksPaginator(Consumer<DescribeStacksRequest.Builder> describeStacksRequest)
Returns the description for the specified stack; if no stack name was specified, then it returns the description
for all the stacks created.
|
default DescribeStacksIterable |
describeStacksPaginator(DescribeStacksRequest describeStacksRequest)
Returns the description for the specified stack; if no stack name was specified, then it returns the description
for all the stacks created.
|
default DescribeTypeResponse |
describeType(Consumer<DescribeTypeRequest.Builder> describeTypeRequest)
Returns detailed information about an extension that has been registered.
|
default DescribeTypeResponse |
describeType(DescribeTypeRequest describeTypeRequest)
Returns detailed information about an extension that has been registered.
|
default DescribeTypeRegistrationResponse |
describeTypeRegistration(Consumer<DescribeTypeRegistrationRequest.Builder> describeTypeRegistrationRequest)
Returns information about an extension's registration, including its current status and type and version
identifiers.
|
default DescribeTypeRegistrationResponse |
describeTypeRegistration(DescribeTypeRegistrationRequest describeTypeRegistrationRequest)
Returns information about an extension's registration, including its current status and type and version
identifiers.
|
default DetectStackDriftResponse |
detectStackDrift(Consumer<DetectStackDriftRequest.Builder> detectStackDriftRequest)
Detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration,
as defined in the stack template and any values specified as template parameters.
|
default DetectStackDriftResponse |
detectStackDrift(DetectStackDriftRequest detectStackDriftRequest)
Detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration,
as defined in the stack template and any values specified as template parameters.
|
default DetectStackResourceDriftResponse |
detectStackResourceDrift(Consumer<DetectStackResourceDriftRequest.Builder> detectStackResourceDriftRequest)
Returns information about whether a resource's actual configuration differs, or has drifted, from it's
expected configuration, as defined in the stack template and any values specified as template parameters.
|
default DetectStackResourceDriftResponse |
detectStackResourceDrift(DetectStackResourceDriftRequest detectStackResourceDriftRequest)
Returns information about whether a resource's actual configuration differs, or has drifted, from it's
expected configuration, as defined in the stack template and any values specified as template parameters.
|
default DetectStackSetDriftResponse |
detectStackSetDrift(Consumer<DetectStackSetDriftRequest.Builder> detectStackSetDriftRequest)
Detect drift on a stack set.
|
default DetectStackSetDriftResponse |
detectStackSetDrift(DetectStackSetDriftRequest detectStackSetDriftRequest)
Detect drift on a stack set.
|
default EstimateTemplateCostResponse |
estimateTemplateCost(Consumer<EstimateTemplateCostRequest.Builder> estimateTemplateCostRequest)
Returns the estimated monthly cost of a template.
|
default EstimateTemplateCostResponse |
estimateTemplateCost(EstimateTemplateCostRequest estimateTemplateCostRequest)
Returns the estimated monthly cost of a template.
|
default ExecuteChangeSetResponse |
executeChangeSet(Consumer<ExecuteChangeSetRequest.Builder> executeChangeSetRequest)
Updates a stack using the input information that was provided when the specified change set was created.
|
default ExecuteChangeSetResponse |
executeChangeSet(ExecuteChangeSetRequest executeChangeSetRequest)
Updates a stack using the input information that was provided when the specified change set was created.
|
default GetStackPolicyResponse |
getStackPolicy(Consumer<GetStackPolicyRequest.Builder> getStackPolicyRequest)
Returns the stack policy for a specified stack.
|
default GetStackPolicyResponse |
getStackPolicy(GetStackPolicyRequest getStackPolicyRequest)
Returns the stack policy for a specified stack.
|
default GetTemplateResponse |
getTemplate(Consumer<GetTemplateRequest.Builder> getTemplateRequest)
Returns the template body for a specified stack.
|
default GetTemplateResponse |
getTemplate(GetTemplateRequest getTemplateRequest)
Returns the template body for a specified stack.
|
default GetTemplateSummaryResponse |
getTemplateSummary(Consumer<GetTemplateSummaryRequest.Builder> getTemplateSummaryRequest)
Returns information about a new or existing template.
|
default GetTemplateSummaryResponse |
getTemplateSummary(GetTemplateSummaryRequest getTemplateSummaryRequest)
Returns information about a new or existing template.
|
default ImportStacksToStackSetResponse |
importStacksToStackSet(Consumer<ImportStacksToStackSetRequest.Builder> importStacksToStackSetRequest)
Use the stack import operations for self-managed or service-managed StackSets.
|
default ImportStacksToStackSetResponse |
importStacksToStackSet(ImportStacksToStackSetRequest importStacksToStackSetRequest)
Use the stack import operations for self-managed or service-managed StackSets.
|
default ListChangeSetsResponse |
listChangeSets(Consumer<ListChangeSetsRequest.Builder> listChangeSetsRequest)
Returns the ID and status of each active change set for a stack.
|
default ListChangeSetsResponse |
listChangeSets(ListChangeSetsRequest listChangeSetsRequest)
Returns the ID and status of each active change set for a stack.
|
default ListChangeSetsIterable |
listChangeSetsPaginator(Consumer<ListChangeSetsRequest.Builder> listChangeSetsRequest)
Returns the ID and status of each active change set for a stack.
|
default ListChangeSetsIterable |
listChangeSetsPaginator(ListChangeSetsRequest listChangeSetsRequest)
Returns the ID and status of each active change set for a stack.
|
default ListExportsResponse |
listExports()
Lists all exported output values in the account and Region in which you call this action.
|
default ListExportsResponse |
listExports(Consumer<ListExportsRequest.Builder> listExportsRequest)
Lists all exported output values in the account and Region in which you call this action.
|
default ListExportsResponse |
listExports(ListExportsRequest listExportsRequest)
Lists all exported output values in the account and Region in which you call this action.
|
default ListExportsIterable |
listExportsPaginator()
Lists all exported output values in the account and Region in which you call this action.
|
default ListExportsIterable |
listExportsPaginator(Consumer<ListExportsRequest.Builder> listExportsRequest)
Lists all exported output values in the account and Region in which you call this action.
|
default ListExportsIterable |
listExportsPaginator(ListExportsRequest listExportsRequest)
Lists all exported output values in the account and Region in which you call this action.
|
default ListImportsResponse |
listImports(Consumer<ListImportsRequest.Builder> listImportsRequest)
Lists all stacks that are importing an exported output value.
|
default ListImportsResponse |
listImports(ListImportsRequest listImportsRequest)
Lists all stacks that are importing an exported output value.
|
default ListImportsIterable |
listImportsPaginator(Consumer<ListImportsRequest.Builder> listImportsRequest)
Lists all stacks that are importing an exported output value.
|
default ListImportsIterable |
listImportsPaginator(ListImportsRequest listImportsRequest)
Lists all stacks that are importing an exported output value.
|
default ListStackInstancesResponse |
listStackInstances(Consumer<ListStackInstancesRequest.Builder> listStackInstancesRequest)
Returns summary information about stack instances that are associated with the specified stack set.
|
default ListStackInstancesResponse |
listStackInstances(ListStackInstancesRequest listStackInstancesRequest)
Returns summary information about stack instances that are associated with the specified stack set.
|
default ListStackInstancesIterable |
listStackInstancesPaginator(Consumer<ListStackInstancesRequest.Builder> listStackInstancesRequest)
Returns summary information about stack instances that are associated with the specified stack set.
|
default ListStackInstancesIterable |
listStackInstancesPaginator(ListStackInstancesRequest listStackInstancesRequest)
Returns summary information about stack instances that are associated with the specified stack set.
|
default ListStackResourcesResponse |
listStackResources(Consumer<ListStackResourcesRequest.Builder> listStackResourcesRequest)
Returns descriptions of all resources of the specified stack.
|
default ListStackResourcesResponse |
listStackResources(ListStackResourcesRequest listStackResourcesRequest)
Returns descriptions of all resources of the specified stack.
|
default ListStackResourcesIterable |
listStackResourcesPaginator(Consumer<ListStackResourcesRequest.Builder> listStackResourcesRequest)
Returns descriptions of all resources of the specified stack.
|
default ListStackResourcesIterable |
listStackResourcesPaginator(ListStackResourcesRequest listStackResourcesRequest)
Returns descriptions of all resources of the specified stack.
|
default ListStacksResponse |
listStacks()
Returns the summary information for stacks whose status matches the specified StackStatusFilter.
|
default ListStacksResponse |
listStacks(Consumer<ListStacksRequest.Builder> listStacksRequest)
Returns the summary information for stacks whose status matches the specified StackStatusFilter.
|
default ListStacksResponse |
listStacks(ListStacksRequest listStacksRequest)
Returns the summary information for stacks whose status matches the specified StackStatusFilter.
|
default ListStackSetOperationResultsResponse |
listStackSetOperationResults(Consumer<ListStackSetOperationResultsRequest.Builder> listStackSetOperationResultsRequest)
Returns summary information about the results of a stack set operation.
|
default ListStackSetOperationResultsResponse |
listStackSetOperationResults(ListStackSetOperationResultsRequest listStackSetOperationResultsRequest)
Returns summary information about the results of a stack set operation.
|
default ListStackSetOperationResultsIterable |
listStackSetOperationResultsPaginator(Consumer<ListStackSetOperationResultsRequest.Builder> listStackSetOperationResultsRequest)
Returns summary information about the results of a stack set operation.
|
default ListStackSetOperationResultsIterable |
listStackSetOperationResultsPaginator(ListStackSetOperationResultsRequest listStackSetOperationResultsRequest)
Returns summary information about the results of a stack set operation.
|
default ListStackSetOperationsResponse |
listStackSetOperations(Consumer<ListStackSetOperationsRequest.Builder> listStackSetOperationsRequest)
Returns summary information about operations performed on a stack set.
|
default ListStackSetOperationsResponse |
listStackSetOperations(ListStackSetOperationsRequest listStackSetOperationsRequest)
Returns summary information about operations performed on a stack set.
|
default ListStackSetOperationsIterable |
listStackSetOperationsPaginator(Consumer<ListStackSetOperationsRequest.Builder> listStackSetOperationsRequest)
Returns summary information about operations performed on a stack set.
|
default ListStackSetOperationsIterable |
listStackSetOperationsPaginator(ListStackSetOperationsRequest listStackSetOperationsRequest)
Returns summary information about operations performed on a stack set.
|
default ListStackSetsResponse |
listStackSets()
Returns summary information about stack sets that are associated with the user.
|
default ListStackSetsResponse |
listStackSets(Consumer<ListStackSetsRequest.Builder> listStackSetsRequest)
Returns summary information about stack sets that are associated with the user.
|
default ListStackSetsResponse |
listStackSets(ListStackSetsRequest listStackSetsRequest)
Returns summary information about stack sets that are associated with the user.
|
default ListStackSetsIterable |
listStackSetsPaginator()
Returns summary information about stack sets that are associated with the user.
|
default ListStackSetsIterable |
listStackSetsPaginator(Consumer<ListStackSetsRequest.Builder> listStackSetsRequest)
Returns summary information about stack sets that are associated with the user.
|
default ListStackSetsIterable |
listStackSetsPaginator(ListStackSetsRequest listStackSetsRequest)
Returns summary information about stack sets that are associated with the user.
|
default ListStacksIterable |
listStacksPaginator()
Returns the summary information for stacks whose status matches the specified StackStatusFilter.
|
default ListStacksIterable |
listStacksPaginator(Consumer<ListStacksRequest.Builder> listStacksRequest)
Returns the summary information for stacks whose status matches the specified StackStatusFilter.
|
default ListStacksIterable |
listStacksPaginator(ListStacksRequest listStacksRequest)
Returns the summary information for stacks whose status matches the specified StackStatusFilter.
|
default ListTypeRegistrationsResponse |
listTypeRegistrations(Consumer<ListTypeRegistrationsRequest.Builder> listTypeRegistrationsRequest)
Returns a list of registration tokens for the specified extension(s).
|
default ListTypeRegistrationsResponse |
listTypeRegistrations(ListTypeRegistrationsRequest listTypeRegistrationsRequest)
Returns a list of registration tokens for the specified extension(s).
|
default ListTypeRegistrationsIterable |
listTypeRegistrationsPaginator(Consumer<ListTypeRegistrationsRequest.Builder> listTypeRegistrationsRequest)
Returns a list of registration tokens for the specified extension(s).
|
default ListTypeRegistrationsIterable |
listTypeRegistrationsPaginator(ListTypeRegistrationsRequest listTypeRegistrationsRequest)
Returns a list of registration tokens for the specified extension(s).
|
default ListTypesResponse |
listTypes(Consumer<ListTypesRequest.Builder> listTypesRequest)
Returns summary information about extension that have been registered with CloudFormation.
|
default ListTypesResponse |
listTypes(ListTypesRequest listTypesRequest)
Returns summary information about extension that have been registered with CloudFormation.
|
default ListTypesIterable |
listTypesPaginator(Consumer<ListTypesRequest.Builder> listTypesRequest)
Returns summary information about extension that have been registered with CloudFormation.
|
default ListTypesIterable |
listTypesPaginator(ListTypesRequest listTypesRequest)
Returns summary information about extension that have been registered with CloudFormation.
|
default ListTypeVersionsResponse |
listTypeVersions(Consumer<ListTypeVersionsRequest.Builder> listTypeVersionsRequest)
Returns summary information about the versions of an extension.
|
default ListTypeVersionsResponse |
listTypeVersions(ListTypeVersionsRequest listTypeVersionsRequest)
Returns summary information about the versions of an extension.
|
default ListTypeVersionsIterable |
listTypeVersionsPaginator(Consumer<ListTypeVersionsRequest.Builder> listTypeVersionsRequest)
Returns summary information about the versions of an extension.
|
default ListTypeVersionsIterable |
listTypeVersionsPaginator(ListTypeVersionsRequest listTypeVersionsRequest)
Returns summary information about the versions of an extension.
|
default PublishTypeResponse |
publishType(Consumer<PublishTypeRequest.Builder> publishTypeRequest)
Publishes the specified extension to the CloudFormation registry as a public extension in this region.
|
default PublishTypeResponse |
publishType(PublishTypeRequest publishTypeRequest)
Publishes the specified extension to the CloudFormation registry as a public extension in this region.
|
default RecordHandlerProgressResponse |
recordHandlerProgress(Consumer<RecordHandlerProgressRequest.Builder> recordHandlerProgressRequest)
Reports progress of a resource handler to CloudFormation.
|
default RecordHandlerProgressResponse |
recordHandlerProgress(RecordHandlerProgressRequest recordHandlerProgressRequest)
Reports progress of a resource handler to CloudFormation.
|
default RegisterPublisherResponse |
registerPublisher(Consumer<RegisterPublisherRequest.Builder> registerPublisherRequest)
Registers your account as a publisher of public extensions in the CloudFormation registry.
|
default RegisterPublisherResponse |
registerPublisher(RegisterPublisherRequest registerPublisherRequest)
Registers your account as a publisher of public extensions in the CloudFormation registry.
|
default RegisterTypeResponse |
registerType(Consumer<RegisterTypeRequest.Builder> registerTypeRequest)
Registers an extension with the CloudFormation service.
|
default RegisterTypeResponse |
registerType(RegisterTypeRequest registerTypeRequest)
Registers an extension with the CloudFormation service.
|
default RollbackStackResponse |
rollbackStack(Consumer<RollbackStackRequest.Builder> rollbackStackRequest)
When specifying
RollbackStack, you preserve the state of previously provisioned resources when an
operation fails. |
default RollbackStackResponse |
rollbackStack(RollbackStackRequest rollbackStackRequest)
When specifying
RollbackStack, you preserve the state of previously provisioned resources when an
operation fails. |
static ServiceMetadata |
serviceMetadata() |
default SetStackPolicyResponse |
setStackPolicy(Consumer<SetStackPolicyRequest.Builder> setStackPolicyRequest)
Sets a stack policy for a specified stack.
|
default SetStackPolicyResponse |
setStackPolicy(SetStackPolicyRequest setStackPolicyRequest)
Sets a stack policy for a specified stack.
|
default SetTypeConfigurationResponse |
setTypeConfiguration(Consumer<SetTypeConfigurationRequest.Builder> setTypeConfigurationRequest)
Specifies the configuration data for a registered CloudFormation extension, in the given account and region.
|
default SetTypeConfigurationResponse |
setTypeConfiguration(SetTypeConfigurationRequest setTypeConfigurationRequest)
Specifies the configuration data for a registered CloudFormation extension, in the given account and region.
|
default SetTypeDefaultVersionResponse |
setTypeDefaultVersion(Consumer<SetTypeDefaultVersionRequest.Builder> setTypeDefaultVersionRequest)
Specify the default version of an extension.
|
default SetTypeDefaultVersionResponse |
setTypeDefaultVersion(SetTypeDefaultVersionRequest setTypeDefaultVersionRequest)
Specify the default version of an extension.
|
default SignalResourceResponse |
signalResource(Consumer<SignalResourceRequest.Builder> signalResourceRequest)
Sends a signal to the specified resource with a success or failure status.
|
default SignalResourceResponse |
signalResource(SignalResourceRequest signalResourceRequest)
Sends a signal to the specified resource with a success or failure status.
|
default StopStackSetOperationResponse |
stopStackSetOperation(Consumer<StopStackSetOperationRequest.Builder> stopStackSetOperationRequest)
Stops an in-progress operation on a stack set and its associated stack instances.
|
default StopStackSetOperationResponse |
stopStackSetOperation(StopStackSetOperationRequest stopStackSetOperationRequest)
Stops an in-progress operation on a stack set and its associated stack instances.
|
default TestTypeResponse |
testType(Consumer<TestTypeRequest.Builder> testTypeRequest)
Tests a registered extension to make sure it meets all necessary requirements for being published in the
CloudFormation registry.
|
default TestTypeResponse |
testType(TestTypeRequest testTypeRequest)
Tests a registered extension to make sure it meets all necessary requirements for being published in the
CloudFormation registry.
|
default UpdateStackResponse |
updateStack(Consumer<UpdateStackRequest.Builder> updateStackRequest)
Updates a stack as specified in the template.
|
default UpdateStackResponse |
updateStack(UpdateStackRequest updateStackRequest)
Updates a stack as specified in the template.
|
default UpdateStackInstancesResponse |
updateStackInstances(Consumer<UpdateStackInstancesRequest.Builder> updateStackInstancesRequest)
Updates the parameter values for stack instances for the specified accounts, within the specified Regions.
|
default UpdateStackInstancesResponse |
updateStackInstances(UpdateStackInstancesRequest updateStackInstancesRequest)
Updates the parameter values for stack instances for the specified accounts, within the specified Regions.
|
default UpdateStackSetResponse |
updateStackSet(Consumer<UpdateStackSetRequest.Builder> updateStackSetRequest)
Updates the stack set, and associated stack instances in the specified accounts and Regions.
|
default UpdateStackSetResponse |
updateStackSet(UpdateStackSetRequest updateStackSetRequest)
Updates the stack set, and associated stack instances in the specified accounts and Regions.
|
default UpdateTerminationProtectionResponse |
updateTerminationProtection(Consumer<UpdateTerminationProtectionRequest.Builder> updateTerminationProtectionRequest)
Updates termination protection for the specified stack.
|
default UpdateTerminationProtectionResponse |
updateTerminationProtection(UpdateTerminationProtectionRequest updateTerminationProtectionRequest)
Updates termination protection for the specified stack.
|
default ValidateTemplateResponse |
validateTemplate(Consumer<ValidateTemplateRequest.Builder> validateTemplateRequest)
Validates a specified template.
|
default ValidateTemplateResponse |
validateTemplate(ValidateTemplateRequest validateTemplateRequest)
Validates a specified template.
|
default CloudFormationWaiter |
waiter()
Create an instance of
CloudFormationWaiter using this client. |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static CloudFormationClient create()
CloudFormationClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static CloudFormationClientBuilder builder()
CloudFormationClient.default ActivateTypeResponse activateType(ActivateTypeRequest activateTypeRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Activates a public third-party extension, making it available for use in stack templates. For more information, see Using public extensions in the CloudFormation User Guide.
Once you have activated a public third-party extension in your account and region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
activateTypeRequest - CfnRegistryException - An error occurred during a CloudFormation registry operation.TypeNotFoundException - The specified extension does not exist in the CloudFormation registry.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ActivateTypeResponse activateType(Consumer<ActivateTypeRequest.Builder> activateTypeRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Activates a public third-party extension, making it available for use in stack templates. For more information, see Using public extensions in the CloudFormation User Guide.
Once you have activated a public third-party extension in your account and region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
This is a convenience which creates an instance of the ActivateTypeRequest.Builder avoiding the need to
create one manually via ActivateTypeRequest.builder()
activateTypeRequest - A Consumer that will call methods on ActivateTypeInput.Builder to create a request.CfnRegistryException - An error occurred during a CloudFormation registry operation.TypeNotFoundException - The specified extension does not exist in the CloudFormation registry.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchDescribeTypeConfigurationsResponse batchDescribeTypeConfigurations(BatchDescribeTypeConfigurationsRequest batchDescribeTypeConfigurationsRequest) throws TypeConfigurationNotFoundException, CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException
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 in the CloudFormation User Guide.
batchDescribeTypeConfigurationsRequest - TypeConfigurationNotFoundException - The specified extension configuration cannot be found.CfnRegistryException - An error occurred during a CloudFormation registry operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchDescribeTypeConfigurationsResponse batchDescribeTypeConfigurations(Consumer<BatchDescribeTypeConfigurationsRequest.Builder> batchDescribeTypeConfigurationsRequest) throws TypeConfigurationNotFoundException, CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException
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 in the CloudFormation User Guide.
This is a convenience which creates an instance of the BatchDescribeTypeConfigurationsRequest.Builder
avoiding the need to create one manually via BatchDescribeTypeConfigurationsRequest.builder()
batchDescribeTypeConfigurationsRequest - A Consumer that will call methods on BatchDescribeTypeConfigurationsInput.Builder to
create a request.TypeConfigurationNotFoundException - The specified extension configuration cannot be found.CfnRegistryException - An error occurred during a CloudFormation registry operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CancelUpdateStackResponse cancelUpdateStack(CancelUpdateStackRequest cancelUpdateStackRequest) throws TokenAlreadyExistsException, AwsServiceException, SdkClientException, CloudFormationException
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.
cancelUpdateStackRequest - The input for the CancelUpdateStack action.TokenAlreadyExistsException - A client request token already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CancelUpdateStackResponse cancelUpdateStack(Consumer<CancelUpdateStackRequest.Builder> cancelUpdateStackRequest) throws TokenAlreadyExistsException, AwsServiceException, SdkClientException, CloudFormationException
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.
This is a convenience which creates an instance of the CancelUpdateStackRequest.Builder avoiding the need
to create one manually via CancelUpdateStackRequest.builder()
cancelUpdateStackRequest - A Consumer that will call methods on CancelUpdateStackInput.Builder to create a request.
The input for the CancelUpdateStack action.TokenAlreadyExistsException - A client request token already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ContinueUpdateRollbackResponse continueUpdateRollback(ContinueUpdateRollbackRequest continueUpdateRollbackRequest) throws TokenAlreadyExistsException, AwsServiceException, SdkClientException, CloudFormationException
For a specified stack that is in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the
UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the error 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 cannot roll back all changes
after a failed stack update. For example, you might have a stack that is rolling back to an old database instance
that was deleted outside of 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.
continueUpdateRollbackRequest - The input for the ContinueUpdateRollback action.TokenAlreadyExistsException - A client request token already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ContinueUpdateRollbackResponse continueUpdateRollback(Consumer<ContinueUpdateRollbackRequest.Builder> continueUpdateRollbackRequest) throws TokenAlreadyExistsException, AwsServiceException, SdkClientException, CloudFormationException
For a specified stack that is in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the
UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the error 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 cannot roll back all changes
after a failed stack update. For example, you might have a stack that is rolling back to an old database instance
that was deleted outside of 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.
This is a convenience which creates an instance of the ContinueUpdateRollbackRequest.Builder avoiding the
need to create one manually via ContinueUpdateRollbackRequest.builder()
continueUpdateRollbackRequest - A Consumer that will call methods on ContinueUpdateRollbackInput.Builder to create a
request. The input for the ContinueUpdateRollback action.TokenAlreadyExistsException - A client request token already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateChangeSetResponse createChangeSet(CreateChangeSetRequest createChangeSetRequest) throws AlreadyExistsException, InsufficientCapabilitiesException, LimitExceededException, AwsServiceException, SdkClientException, CloudFormationException
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 hierachy, set IncludeNestedStacks to True.
createChangeSetRequest - The input for the CreateChangeSet action.AlreadyExistsException - The resource with the name requested already exists.InsufficientCapabilitiesException - The template contains resources with capabilities that weren't specified in the Capabilities parameter.LimitExceededException - The quota for the resource has already been reached.
For information on resource and stack limitations, see Limits in the CloudFormation User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateChangeSetResponse createChangeSet(Consumer<CreateChangeSetRequest.Builder> createChangeSetRequest) throws AlreadyExistsException, InsufficientCapabilitiesException, LimitExceededException, AwsServiceException, SdkClientException, CloudFormationException
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 hierachy, set IncludeNestedStacks to True.
This is a convenience which creates an instance of the CreateChangeSetRequest.Builder avoiding the need
to create one manually via CreateChangeSetRequest.builder()
createChangeSetRequest - A Consumer that will call methods on CreateChangeSetInput.Builder to create a request. The
input for the CreateChangeSet action.AlreadyExistsException - The resource with the name requested already exists.InsufficientCapabilitiesException - The template contains resources with capabilities that weren't specified in the Capabilities parameter.LimitExceededException - The quota for the resource has already been reached.
For information on resource and stack limitations, see Limits in the CloudFormation User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateStackResponse createStack(CreateStackRequest createStackRequest) throws LimitExceededException, AlreadyExistsException, TokenAlreadyExistsException, InsufficientCapabilitiesException, AwsServiceException, SdkClientException, CloudFormationException
Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the DescribeStacks API.
createStackRequest - The input for CreateStack action.LimitExceededException - The quota for the resource has already been reached.
For information on resource and stack limitations, see Limits in the CloudFormation User Guide.
AlreadyExistsException - The resource with the name requested already exists.TokenAlreadyExistsException - A client request token already exists.InsufficientCapabilitiesException - The template contains resources with capabilities that weren't specified in the Capabilities parameter.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateStackResponse createStack(Consumer<CreateStackRequest.Builder> createStackRequest) throws LimitExceededException, AlreadyExistsException, TokenAlreadyExistsException, InsufficientCapabilitiesException, AwsServiceException, SdkClientException, CloudFormationException
Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the DescribeStacks API.
This is a convenience which creates an instance of the CreateStackRequest.Builder avoiding the need to
create one manually via CreateStackRequest.builder()
createStackRequest - A Consumer that will call methods on CreateStackInput.Builder to create a request. The
input for CreateStack action.LimitExceededException - The quota for the resource has already been reached.
For information on resource and stack limitations, see Limits in the CloudFormation User Guide.
AlreadyExistsException - The resource with the name requested already exists.TokenAlreadyExistsException - A client request token already exists.InsufficientCapabilitiesException - The template contains resources with capabilities that weren't specified in the Capabilities parameter.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateStackInstancesResponse createStackInstances(CreateStackInstancesRequest createStackInstancesRequest) throws StackSetNotFoundException, OperationInProgressException, OperationIdAlreadyExistsException, StaleRequestException, InvalidOperationException, LimitExceededException, AwsServiceException, SdkClientException, CloudFormationException
Creates stack instances for the specified accounts, within the specified Regions. A stack instance refers to a
stack in a specific account and Region. You must specify at least one value for either Accounts or
DeploymentTargets, and you must specify at least one value for Regions.
createStackInstancesRequest - StackSetNotFoundException - The specified stack set doesn't exist.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.OperationIdAlreadyExistsException - The specified operation ID already exists.StaleRequestException - Another operation has been performed on this stack set since the specified operation was performed.InvalidOperationException - The specified operation isn't valid.LimitExceededException - The quota for the resource has already been reached.
For information on resource and stack limitations, see Limits in the CloudFormation User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateStackInstancesResponse createStackInstances(Consumer<CreateStackInstancesRequest.Builder> createStackInstancesRequest) throws StackSetNotFoundException, OperationInProgressException, OperationIdAlreadyExistsException, StaleRequestException, InvalidOperationException, LimitExceededException, AwsServiceException, SdkClientException, CloudFormationException
Creates stack instances for the specified accounts, within the specified Regions. A stack instance refers to a
stack in a specific account and Region. You must specify at least one value for either Accounts or
DeploymentTargets, and you must specify at least one value for Regions.
This is a convenience which creates an instance of the CreateStackInstancesRequest.Builder avoiding the
need to create one manually via CreateStackInstancesRequest.builder()
createStackInstancesRequest - A Consumer that will call methods on CreateStackInstancesInput.Builder to create a
request.StackSetNotFoundException - The specified stack set doesn't exist.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.OperationIdAlreadyExistsException - The specified operation ID already exists.StaleRequestException - Another operation has been performed on this stack set since the specified operation was performed.InvalidOperationException - The specified operation isn't valid.LimitExceededException - The quota for the resource has already been reached.
For information on resource and stack limitations, see Limits in the CloudFormation User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateStackSetResponse createStackSet(CreateStackSetRequest createStackSetRequest) throws NameAlreadyExistsException, CreatedButModifiedException, LimitExceededException, AwsServiceException, SdkClientException, CloudFormationException
Creates a stack set.
createStackSetRequest - NameAlreadyExistsException - The specified name is already in use.CreatedButModifiedException - The specified resource exists, but has been changed.LimitExceededException - The quota for the resource has already been reached.
For information on resource and stack limitations, see Limits in the CloudFormation User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateStackSetResponse createStackSet(Consumer<CreateStackSetRequest.Builder> createStackSetRequest) throws NameAlreadyExistsException, CreatedButModifiedException, LimitExceededException, AwsServiceException, SdkClientException, CloudFormationException
Creates a stack set.
This is a convenience which creates an instance of the CreateStackSetRequest.Builder avoiding the need to
create one manually via CreateStackSetRequest.builder()
createStackSetRequest - A Consumer that will call methods on CreateStackSetInput.Builder to create a request.NameAlreadyExistsException - The specified name is already in use.CreatedButModifiedException - The specified resource exists, but has been changed.LimitExceededException - The quota for the resource has already been reached.
For information on resource and stack limitations, see Limits in the CloudFormation User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeactivateTypeResponse deactivateType(DeactivateTypeRequest deactivateTypeRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Deactivates a public extension that was previously activated in this account and region.
Once deactivated, an extension cannot be used in any CloudFormation operation. This includes stack update operations where the stack template includes the extension, even if no updates are being made to the extension. In addition, deactivated extensions are not automatically updated if a new version of the extension is released.
deactivateTypeRequest - CfnRegistryException - An error occurred during a CloudFormation registry operation.TypeNotFoundException - The specified extension does not exist in the CloudFormation registry.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeactivateTypeResponse deactivateType(Consumer<DeactivateTypeRequest.Builder> deactivateTypeRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Deactivates a public extension that was previously activated in this account and region.
Once deactivated, an extension cannot be used in any CloudFormation operation. This includes stack update operations where the stack template includes the extension, even if no updates are being made to the extension. In addition, deactivated extensions are not automatically updated if a new version of the extension is released.
This is a convenience which creates an instance of the DeactivateTypeRequest.Builder avoiding the need to
create one manually via DeactivateTypeRequest.builder()
deactivateTypeRequest - A Consumer that will call methods on DeactivateTypeInput.Builder to create a request.CfnRegistryException - An error occurred during a CloudFormation registry operation.TypeNotFoundException - The specified extension does not exist in the CloudFormation registry.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteChangeSetResponse deleteChangeSet(DeleteChangeSetRequest deleteChangeSetRequest) throws InvalidChangeSetStatusException, AwsServiceException, SdkClientException, CloudFormationException
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.
deleteChangeSetRequest - The input for the DeleteChangeSet action.InvalidChangeSetStatusException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteChangeSetResponse deleteChangeSet(Consumer<DeleteChangeSetRequest.Builder> deleteChangeSetRequest) throws InvalidChangeSetStatusException, AwsServiceException, SdkClientException, CloudFormationException
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.
This is a convenience which creates an instance of the DeleteChangeSetRequest.Builder avoiding the need
to create one manually via DeleteChangeSetRequest.builder()
deleteChangeSetRequest - A Consumer that will call methods on DeleteChangeSetInput.Builder to create a request. The
input for the DeleteChangeSet action.InvalidChangeSetStatusException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteStackResponse deleteStack(DeleteStackRequest deleteStackRequest) throws TokenAlreadyExistsException, AwsServiceException, SdkClientException, CloudFormationException
Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the DescribeStacks API if the deletion has been completed successfully.
deleteStackRequest - The input for DeleteStack action.TokenAlreadyExistsException - A client request token already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteStackResponse deleteStack(Consumer<DeleteStackRequest.Builder> deleteStackRequest) throws TokenAlreadyExistsException, AwsServiceException, SdkClientException, CloudFormationException
Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the DescribeStacks API if the deletion has been completed successfully.
This is a convenience which creates an instance of the DeleteStackRequest.Builder avoiding the need to
create one manually via DeleteStackRequest.builder()
deleteStackRequest - A Consumer that will call methods on DeleteStackInput.Builder to create a request. The
input for DeleteStack action.TokenAlreadyExistsException - A client request token already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteStackInstancesResponse deleteStackInstances(DeleteStackInstancesRequest deleteStackInstancesRequest) throws StackSetNotFoundException, OperationInProgressException, OperationIdAlreadyExistsException, StaleRequestException, InvalidOperationException, AwsServiceException, SdkClientException, CloudFormationException
Deletes stack instances for the specified accounts, in the specified Regions.
deleteStackInstancesRequest - StackSetNotFoundException - The specified stack set doesn't exist.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.OperationIdAlreadyExistsException - The specified operation ID already exists.StaleRequestException - Another operation has been performed on this stack set since the specified operation was performed.InvalidOperationException - The specified operation isn't valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteStackInstancesResponse deleteStackInstances(Consumer<DeleteStackInstancesRequest.Builder> deleteStackInstancesRequest) throws StackSetNotFoundException, OperationInProgressException, OperationIdAlreadyExistsException, StaleRequestException, InvalidOperationException, AwsServiceException, SdkClientException, CloudFormationException
Deletes stack instances for the specified accounts, in the specified Regions.
This is a convenience which creates an instance of the DeleteStackInstancesRequest.Builder avoiding the
need to create one manually via DeleteStackInstancesRequest.builder()
deleteStackInstancesRequest - A Consumer that will call methods on DeleteStackInstancesInput.Builder to create a
request.StackSetNotFoundException - The specified stack set doesn't exist.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.OperationIdAlreadyExistsException - The specified operation ID already exists.StaleRequestException - Another operation has been performed on this stack set since the specified operation was performed.InvalidOperationException - The specified operation isn't valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteStackSetResponse deleteStackSet(DeleteStackSetRequest deleteStackSetRequest) throws StackSetNotEmptyException, OperationInProgressException, AwsServiceException, SdkClientException, CloudFormationException
Deletes a stack set. Before you can delete a stack set, all of its member stack instances must be deleted. For more information about how to do this, see DeleteStackInstances.
deleteStackSetRequest - 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.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteStackSetResponse deleteStackSet(Consumer<DeleteStackSetRequest.Builder> deleteStackSetRequest) throws StackSetNotEmptyException, OperationInProgressException, AwsServiceException, SdkClientException, CloudFormationException
Deletes a stack set. Before you can delete a stack set, all of its member stack instances must be deleted. For more information about how to do this, see DeleteStackInstances.
This is a convenience which creates an instance of the DeleteStackSetRequest.Builder avoiding the need to
create one manually via DeleteStackSetRequest.builder()
deleteStackSetRequest - A Consumer that will call methods on DeleteStackSetInput.Builder to create a request.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.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeregisterTypeResponse deregisterType(DeregisterTypeRequest deregisterTypeRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it
from active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations.
To deregister an entire extension, you must individually deregister all active versions of that extension. If an extension has only a single active version, deregistering that version results in the extension itself being deregistered and marked as deprecated in the registry.
You cannot deregister the default version of an extension if there are other active version of that extension. If you do deregister the default version of an extension, the textensionype itself is deregistered as well and marked as deprecated.
To view the deprecation status of an extension or extension version, use DescribeType.
deregisterTypeRequest - CfnRegistryException - An error occurred during a CloudFormation registry operation.TypeNotFoundException - The specified extension does not exist in the CloudFormation registry.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeregisterTypeResponse deregisterType(Consumer<DeregisterTypeRequest.Builder> deregisterTypeRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it
from active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations.
To deregister an entire extension, you must individually deregister all active versions of that extension. If an extension has only a single active version, deregistering that version results in the extension itself being deregistered and marked as deprecated in the registry.
You cannot deregister the default version of an extension if there are other active version of that extension. If you do deregister the default version of an extension, the textensionype itself is deregistered as well and marked as deprecated.
To view the deprecation status of an extension or extension version, use DescribeType.
This is a convenience which creates an instance of the DeregisterTypeRequest.Builder avoiding the need to
create one manually via DeregisterTypeRequest.builder()
deregisterTypeRequest - A Consumer that will call methods on DeregisterTypeInput.Builder to create a request.CfnRegistryException - An error occurred during a CloudFormation registry operation.TypeNotFoundException - The specified extension does not exist in the CloudFormation registry.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeAccountLimitsResponse describeAccountLimits() throws AwsServiceException, SdkClientException, CloudFormationException
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 Limits in the CloudFormation User Guide.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeAccountLimits(DescribeAccountLimitsRequest),
AWS API Documentationdefault DescribeAccountLimitsResponse describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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 Limits in the CloudFormation User Guide.
describeAccountLimitsRequest - The input for the DescribeAccountLimits action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeAccountLimitsResponse describeAccountLimits(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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 Limits in the CloudFormation User Guide.
This is a convenience which creates an instance of the DescribeAccountLimitsRequest.Builder avoiding the
need to create one manually via DescribeAccountLimitsRequest.builder()
describeAccountLimitsRequest - A Consumer that will call methods on DescribeAccountLimitsInput.Builder to create a
request. The input for the DescribeAccountLimits action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeAccountLimitsIterable describeAccountLimitsPaginator() throws AwsServiceException, SdkClientException, CloudFormationException
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 Limits in the CloudFormation User Guide.
This is a variant of
describeAccountLimits(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsIterable responses = client.describeAccountLimitsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsIterable responses = client
.describeAccountLimitsPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsIterable responses = client.describeAccountLimitsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAccountLimits(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsRequest)
operation.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeAccountLimitsPaginator(DescribeAccountLimitsRequest),
AWS API Documentationdefault DescribeAccountLimitsIterable describeAccountLimitsPaginator(DescribeAccountLimitsRequest describeAccountLimitsRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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 Limits in the CloudFormation User Guide.
This is a variant of
describeAccountLimits(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsIterable responses = client.describeAccountLimitsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsIterable responses = client
.describeAccountLimitsPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsIterable responses = client.describeAccountLimitsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAccountLimits(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsRequest)
operation.
describeAccountLimitsRequest - The input for the DescribeAccountLimits action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeAccountLimitsIterable describeAccountLimitsPaginator(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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 Limits in the CloudFormation User Guide.
This is a variant of
describeAccountLimits(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsIterable responses = client.describeAccountLimitsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsIterable responses = client
.describeAccountLimitsPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsIterable responses = client.describeAccountLimitsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAccountLimits(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsRequest)
operation.
This is a convenience which creates an instance of the DescribeAccountLimitsRequest.Builder avoiding the
need to create one manually via DescribeAccountLimitsRequest.builder()
describeAccountLimitsRequest - A Consumer that will call methods on DescribeAccountLimitsInput.Builder to create a
request. The input for the DescribeAccountLimits action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeChangeSetResponse describeChangeSet(DescribeChangeSetRequest describeChangeSetRequest) throws ChangeSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
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 in the CloudFormation User Guide.
describeChangeSetRequest - The input for the DescribeChangeSet action.ChangeSetNotFoundException - The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the
ListChangeSets action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeChangeSetResponse describeChangeSet(Consumer<DescribeChangeSetRequest.Builder> describeChangeSetRequest) throws ChangeSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
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 in the CloudFormation User Guide.
This is a convenience which creates an instance of the DescribeChangeSetRequest.Builder avoiding the need
to create one manually via DescribeChangeSetRequest.builder()
describeChangeSetRequest - A Consumer that will call methods on DescribeChangeSetInput.Builder to create a request.
The input for the DescribeChangeSet action.ChangeSetNotFoundException - The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the
ListChangeSets action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePublisherResponse describePublisher(DescribePublisherRequest describePublisherRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException
Returns information about a CloudFormation extension publisher.
If you do not supply a PublisherId, and you have registered as an extension publisher,
DescribePublisher returns information about your own publisher account.
For more information on registering as a publisher, see:
Publishing extensions to make them available for public use in the CloudFormation CLI User Guide
describePublisherRequest - CfnRegistryException - An error occurred during a CloudFormation registry operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePublisherResponse describePublisher(Consumer<DescribePublisherRequest.Builder> describePublisherRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException
Returns information about a CloudFormation extension publisher.
If you do not supply a PublisherId, and you have registered as an extension publisher,
DescribePublisher returns information about your own publisher account.
For more information on registering as a publisher, see:
Publishing extensions to make them available for public use in the CloudFormation CLI User Guide
This is a convenience which creates an instance of the DescribePublisherRequest.Builder avoiding the need
to create one manually via DescribePublisherRequest.builder()
describePublisherRequest - A Consumer that will call methods on DescribePublisherInput.Builder to create a request.CfnRegistryException - An error occurred during a CloudFormation registry operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStackDriftDetectionStatusResponse describeStackDriftDetectionStatus(DescribeStackDriftDetectionStatusRequest describeStackDriftDetectionStatusRequest) throws AwsServiceException, SdkClientException, CloudFormationException
Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information on stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources.
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.
describeStackDriftDetectionStatusRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStackDriftDetectionStatusResponse describeStackDriftDetectionStatus(Consumer<DescribeStackDriftDetectionStatusRequest.Builder> describeStackDriftDetectionStatusRequest) throws AwsServiceException, SdkClientException, CloudFormationException
Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information on stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources.
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.
This is a convenience which creates an instance of the DescribeStackDriftDetectionStatusRequest.Builder
avoiding the need to create one manually via DescribeStackDriftDetectionStatusRequest.builder()
describeStackDriftDetectionStatusRequest - A Consumer that will call methods on DescribeStackDriftDetectionStatusInput.Builder to
create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStackEventsResponse describeStackEvents(DescribeStackEventsRequest describeStackEventsRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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 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).
describeStackEventsRequest - The input for DescribeStackEvents action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStackEventsResponse describeStackEvents(Consumer<DescribeStackEventsRequest.Builder> describeStackEventsRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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 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).
This is a convenience which creates an instance of the DescribeStackEventsRequest.Builder avoiding the
need to create one manually via DescribeStackEventsRequest.builder()
describeStackEventsRequest - A Consumer that will call methods on DescribeStackEventsInput.Builder to create a request.
The input for DescribeStackEvents action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStackEventsIterable describeStackEventsPaginator(DescribeStackEventsRequest describeStackEventsRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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 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).
This is a variant of
describeStackEvents(software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.DescribeStackEventsIterable responses = client.describeStackEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.DescribeStackEventsIterable responses = client
.describeStackEventsPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.DescribeStackEventsIterable responses = client.describeStackEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeStackEvents(software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsRequest)
operation.
describeStackEventsRequest - The input for DescribeStackEvents action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStackEventsIterable describeStackEventsPaginator(Consumer<DescribeStackEventsRequest.Builder> describeStackEventsRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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 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).
This is a variant of
describeStackEvents(software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.DescribeStackEventsIterable responses = client.describeStackEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.DescribeStackEventsIterable responses = client
.describeStackEventsPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.DescribeStackEventsIterable responses = client.describeStackEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeStackEvents(software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsRequest)
operation.
This is a convenience which creates an instance of the DescribeStackEventsRequest.Builder avoiding the
need to create one manually via DescribeStackEventsRequest.builder()
describeStackEventsRequest - A Consumer that will call methods on DescribeStackEventsInput.Builder to create a request.
The input for DescribeStackEvents action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStackInstanceResponse describeStackInstance(DescribeStackInstanceRequest describeStackInstanceRequest) throws StackSetNotFoundException, StackInstanceNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Returns the stack instance that's associated with the specified stack set, Amazon Web Services account, and Region.
For a list of stack instances that are associated with a specific stack set, use ListStackInstances.
describeStackInstanceRequest - StackSetNotFoundException - The specified stack set doesn't exist.StackInstanceNotFoundException - The specified stack instance doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStackInstanceResponse describeStackInstance(Consumer<DescribeStackInstanceRequest.Builder> describeStackInstanceRequest) throws StackSetNotFoundException, StackInstanceNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Returns the stack instance that's associated with the specified stack set, Amazon Web Services account, and Region.
For a list of stack instances that are associated with a specific stack set, use ListStackInstances.
This is a convenience which creates an instance of the DescribeStackInstanceRequest.Builder avoiding the
need to create one manually via DescribeStackInstanceRequest.builder()
describeStackInstanceRequest - A Consumer that will call methods on DescribeStackInstanceInput.Builder to create a
request.StackSetNotFoundException - The specified stack set doesn't exist.StackInstanceNotFoundException - The specified stack instance doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStackResourceResponse describeStackResource(DescribeStackResourceRequest describeStackResourceRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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.
describeStackResourceRequest - The input for DescribeStackResource action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStackResourceResponse describeStackResource(Consumer<DescribeStackResourceRequest.Builder> describeStackResourceRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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.
This is a convenience which creates an instance of the DescribeStackResourceRequest.Builder avoiding the
need to create one manually via DescribeStackResourceRequest.builder()
describeStackResourceRequest - A Consumer that will call methods on DescribeStackResourceInput.Builder to create a
request. The input for DescribeStackResource action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStackResourceDriftsResponse describeStackResourceDrifts(DescribeStackResourceDriftsRequest describeStackResourceDriftsRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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 are not included. Resources that do not
currently support drift detection are not checked, and so not included. For a list of resources that support
drift detection, see Resources that Support Drift Detection.
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.
describeStackResourceDriftsRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStackResourceDriftsResponse describeStackResourceDrifts(Consumer<DescribeStackResourceDriftsRequest.Builder> describeStackResourceDriftsRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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 are not included. Resources that do not
currently support drift detection are not checked, and so not included. For a list of resources that support
drift detection, see Resources that Support Drift Detection.
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.
This is a convenience which creates an instance of the DescribeStackResourceDriftsRequest.Builder
avoiding the need to create one manually via DescribeStackResourceDriftsRequest.builder()
describeStackResourceDriftsRequest - A Consumer that will call methods on DescribeStackResourceDriftsInput.Builder to create a
request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStackResourceDriftsIterable describeStackResourceDriftsPaginator(DescribeStackResourceDriftsRequest describeStackResourceDriftsRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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 are not included. Resources that do not
currently support drift detection are not checked, and so not included. For a list of resources that support
drift detection, see Resources that Support Drift Detection.
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.
This is a variant of
describeStackResourceDrifts(software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.DescribeStackResourceDriftsIterable responses = client.describeStackResourceDriftsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.DescribeStackResourceDriftsIterable responses = client
.describeStackResourceDriftsPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.DescribeStackResourceDriftsIterable responses = client.describeStackResourceDriftsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeStackResourceDrifts(software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsRequest)
operation.
describeStackResourceDriftsRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStackResourceDriftsIterable describeStackResourceDriftsPaginator(Consumer<DescribeStackResourceDriftsRequest.Builder> describeStackResourceDriftsRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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 are not included. Resources that do not
currently support drift detection are not checked, and so not included. For a list of resources that support
drift detection, see Resources that Support Drift Detection.
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.
This is a variant of
describeStackResourceDrifts(software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.DescribeStackResourceDriftsIterable responses = client.describeStackResourceDriftsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.DescribeStackResourceDriftsIterable responses = client
.describeStackResourceDriftsPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.DescribeStackResourceDriftsIterable responses = client.describeStackResourceDriftsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeStackResourceDrifts(software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsRequest)
operation.
This is a convenience which creates an instance of the DescribeStackResourceDriftsRequest.Builder
avoiding the need to create one manually via DescribeStackResourceDriftsRequest.builder()
describeStackResourceDriftsRequest - A Consumer that will call methods on DescribeStackResourceDriftsInput.Builder to create a
request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStackResourcesResponse describeStackResources(DescribeStackResourcesRequest describeStackResourcesRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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.
A ValidationError is returned if you specify both StackName and
PhysicalResourceId in the same request.
describeStackResourcesRequest - The input for DescribeStackResources action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStackResourcesResponse describeStackResources(Consumer<DescribeStackResourcesRequest.Builder> describeStackResourcesRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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.
A ValidationError is returned if you specify both StackName and
PhysicalResourceId in the same request.
This is a convenience which creates an instance of the DescribeStackResourcesRequest.Builder avoiding the
need to create one manually via DescribeStackResourcesRequest.builder()
describeStackResourcesRequest - A Consumer that will call methods on DescribeStackResourcesInput.Builder to create a
request. The input for DescribeStackResources action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStackSetResponse describeStackSet(DescribeStackSetRequest describeStackSetRequest) throws StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Returns the description of the specified stack set.
describeStackSetRequest - StackSetNotFoundException - The specified stack set doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStackSetResponse describeStackSet(Consumer<DescribeStackSetRequest.Builder> describeStackSetRequest) throws StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Returns the description of the specified stack set.
This is a convenience which creates an instance of the DescribeStackSetRequest.Builder avoiding the need
to create one manually via DescribeStackSetRequest.builder()
describeStackSetRequest - A Consumer that will call methods on DescribeStackSetInput.Builder to create a request.StackSetNotFoundException - The specified stack set doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStackSetOperationResponse describeStackSetOperation(DescribeStackSetOperationRequest describeStackSetOperationRequest) throws StackSetNotFoundException, OperationNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Returns the description of the specified stack set operation.
describeStackSetOperationRequest - StackSetNotFoundException - The specified stack set doesn't exist.OperationNotFoundException - The specified ID refers to an operation that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStackSetOperationResponse describeStackSetOperation(Consumer<DescribeStackSetOperationRequest.Builder> describeStackSetOperationRequest) throws StackSetNotFoundException, OperationNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Returns the description of the specified stack set operation.
This is a convenience which creates an instance of the DescribeStackSetOperationRequest.Builder avoiding
the need to create one manually via DescribeStackSetOperationRequest.builder()
describeStackSetOperationRequest - A Consumer that will call methods on DescribeStackSetOperationInput.Builder to create a
request.StackSetNotFoundException - The specified stack set doesn't exist.OperationNotFoundException - The specified ID refers to an operation that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStacksResponse describeStacks() throws AwsServiceException, SdkClientException, CloudFormationException
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
If the stack does not exist, an ValidationError is returned.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeStacks(DescribeStacksRequest),
AWS
API Documentationdefault DescribeStacksResponse describeStacks(DescribeStacksRequest describeStacksRequest) throws AwsServiceException, SdkClientException, CloudFormationException
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
If the stack does not exist, an ValidationError is returned.
describeStacksRequest - The input for DescribeStacks action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStacksResponse describeStacks(Consumer<DescribeStacksRequest.Builder> describeStacksRequest) throws AwsServiceException, SdkClientException, CloudFormationException
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
If the stack does not exist, an ValidationError is returned.
This is a convenience which creates an instance of the DescribeStacksRequest.Builder avoiding the need to
create one manually via DescribeStacksRequest.builder()
describeStacksRequest - A Consumer that will call methods on DescribeStacksInput.Builder to create a request. The
input for DescribeStacks action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStacksIterable describeStacksPaginator() throws AwsServiceException, SdkClientException, CloudFormationException
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
If the stack does not exist, an ValidationError is returned.
This is a variant of
describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksIterable responses = client.describeStacksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksIterable responses = client
.describeStacksPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.DescribeStacksResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksIterable responses = client.describeStacksPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest)
operation.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeStacksPaginator(DescribeStacksRequest),
AWS
API Documentationdefault DescribeStacksIterable describeStacksPaginator(DescribeStacksRequest describeStacksRequest) throws AwsServiceException, SdkClientException, CloudFormationException
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
If the stack does not exist, an ValidationError is returned.
This is a variant of
describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksIterable responses = client.describeStacksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksIterable responses = client
.describeStacksPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.DescribeStacksResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksIterable responses = client.describeStacksPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest)
operation.
describeStacksRequest - The input for DescribeStacks action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStacksIterable describeStacksPaginator(Consumer<DescribeStacksRequest.Builder> describeStacksRequest) throws AwsServiceException, SdkClientException, CloudFormationException
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
If the stack does not exist, an ValidationError is returned.
This is a variant of
describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksIterable responses = client.describeStacksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksIterable responses = client
.describeStacksPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.DescribeStacksResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksIterable responses = client.describeStacksPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest)
operation.
This is a convenience which creates an instance of the DescribeStacksRequest.Builder avoiding the need to
create one manually via DescribeStacksRequest.builder()
describeStacksRequest - A Consumer that will call methods on DescribeStacksInput.Builder to create a request. The
input for DescribeStacks action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTypeResponse describeType(DescribeTypeRequest describeTypeRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
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.
describeTypeRequest - CfnRegistryException - An error occurred during a CloudFormation registry operation.TypeNotFoundException - The specified extension does not exist in the CloudFormation registry.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTypeResponse describeType(Consumer<DescribeTypeRequest.Builder> describeTypeRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
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.
This is a convenience which creates an instance of the DescribeTypeRequest.Builder avoiding the need to
create one manually via DescribeTypeRequest.builder()
describeTypeRequest - A Consumer that will call methods on DescribeTypeInput.Builder to create a request.CfnRegistryException - An error occurred during a CloudFormation registry operation.TypeNotFoundException - The specified extension does not exist in the CloudFormation registry.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTypeRegistrationResponse describeTypeRegistration(DescribeTypeRegistrationRequest describeTypeRegistrationRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException
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.
describeTypeRegistrationRequest - CfnRegistryException - An error occurred during a CloudFormation registry operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeTypeRegistrationResponse describeTypeRegistration(Consumer<DescribeTypeRegistrationRequest.Builder> describeTypeRegistrationRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException
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.
This is a convenience which creates an instance of the DescribeTypeRegistrationRequest.Builder avoiding
the need to create one manually via DescribeTypeRegistrationRequest.builder()
describeTypeRegistrationRequest - A Consumer that will call methods on DescribeTypeRegistrationInput.Builder to create a
request.CfnRegistryException - An error occurred during a CloudFormation registry operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DetectStackDriftResponse detectStackDrift(DetectStackDriftRequest detectStackDriftRequest) throws AwsServiceException, SdkClientException, CloudFormationException
Detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, 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.
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.
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 does not detect drift on any nested stacks belonging to that
stack. Perform DetectStackDrift directly on the nested stack itself.
detectStackDriftRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DetectStackDriftResponse detectStackDrift(Consumer<DetectStackDriftRequest.Builder> detectStackDriftRequest) throws AwsServiceException, SdkClientException, CloudFormationException
Detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, 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.
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.
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 does not detect drift on any nested stacks belonging to that
stack. Perform DetectStackDrift directly on the nested stack itself.
This is a convenience which creates an instance of the DetectStackDriftRequest.Builder avoiding the need
to create one manually via DetectStackDriftRequest.builder()
detectStackDriftRequest - A Consumer that will call methods on DetectStackDriftInput.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DetectStackResourceDriftResponse detectStackResourceDrift(DetectStackResourceDriftRequest detectStackResourceDriftRequest) throws AwsServiceException, SdkClientException, CloudFormationException
Returns information about whether a resource's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which 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.
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to
detect drift on all resources in a given stack that support drift detection.
Resources that do not currently support drift detection cannot be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection.
detectStackResourceDriftRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DetectStackResourceDriftResponse detectStackResourceDrift(Consumer<DetectStackResourceDriftRequest.Builder> detectStackResourceDriftRequest) throws AwsServiceException, SdkClientException, CloudFormationException
Returns information about whether a resource's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which 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.
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to
detect drift on all resources in a given stack that support drift detection.
Resources that do not currently support drift detection cannot be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection.
This is a convenience which creates an instance of the DetectStackResourceDriftRequest.Builder avoiding
the need to create one manually via DetectStackResourceDriftRequest.builder()
detectStackResourceDriftRequest - A Consumer that will call methods on DetectStackResourceDriftInput.Builder to create a
request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DetectStackSetDriftResponse detectStackSetDrift(DetectStackSetDriftRequest detectStackSetDriftRequest) throws InvalidOperationException, OperationInProgressException, StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
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.
DetectStackSetDrift returns the OperationId of the stack set drift detection operation.
Use this operation id with DescribeStackSetOperation to monitor the progress of the drift
detection operation. The drift detection operation may take some time, depending on the number of stack instances
included in the stack set, as well as the number of resources included in each stack.
Once the operation has completed, use the following actions to return drift information:
Use DescribeStackSet to return detailed information about the stack set, including detailed
information about the last completed drift operation performed on the stack set. (Information about drift
operations that are in progress is not included.)
Use ListStackInstances to return a list of stack instances belonging to the stack set,
including the drift status and last drift time checked of each instance.
Use DescribeStackInstance to return detailed information about a specific stack instance,
including its drift status and last drift time checked.
For more information on performing a drift detection operation on a stack set, see Detecting Unmanaged Changes in Stack Sets.
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 .
detectStackSetDriftRequest - InvalidOperationException - The specified operation isn't valid.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.StackSetNotFoundException - The specified stack set doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DetectStackSetDriftResponse detectStackSetDrift(Consumer<DetectStackSetDriftRequest.Builder> detectStackSetDriftRequest) throws InvalidOperationException, OperationInProgressException, StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
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.
DetectStackSetDrift returns the OperationId of the stack set drift detection operation.
Use this operation id with DescribeStackSetOperation to monitor the progress of the drift
detection operation. The drift detection operation may take some time, depending on the number of stack instances
included in the stack set, as well as the number of resources included in each stack.
Once the operation has completed, use the following actions to return drift information:
Use DescribeStackSet to return detailed information about the stack set, including detailed
information about the last completed drift operation performed on the stack set. (Information about drift
operations that are in progress is not included.)
Use ListStackInstances to return a list of stack instances belonging to the stack set,
including the drift status and last drift time checked of each instance.
Use DescribeStackInstance to return detailed information about a specific stack instance,
including its drift status and last drift time checked.
For more information on performing a drift detection operation on a stack set, see Detecting Unmanaged Changes in Stack Sets.
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 .
This is a convenience which creates an instance of the DetectStackSetDriftRequest.Builder avoiding the
need to create one manually via DetectStackSetDriftRequest.builder()
detectStackSetDriftRequest - A Consumer that will call methods on DetectStackSetDriftInput.Builder to create a request.InvalidOperationException - The specified operation isn't valid.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.StackSetNotFoundException - The specified stack set doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault EstimateTemplateCostResponse estimateTemplateCost(EstimateTemplateCostRequest estimateTemplateCostRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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.
estimateTemplateCostRequest - The input for an EstimateTemplateCost action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault EstimateTemplateCostResponse estimateTemplateCost(Consumer<EstimateTemplateCostRequest.Builder> estimateTemplateCostRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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.
This is a convenience which creates an instance of the EstimateTemplateCostRequest.Builder avoiding the
need to create one manually via EstimateTemplateCostRequest.builder()
estimateTemplateCostRequest - A Consumer that will call methods on EstimateTemplateCostInput.Builder to create a
request. The input for an EstimateTemplateCost action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ExecuteChangeSetResponse executeChangeSet(ExecuteChangeSetRequest executeChangeSetRequest) throws InvalidChangeSetStatusException, ChangeSetNotFoundException, InsufficientCapabilitiesException, TokenAlreadyExistsException, AwsServiceException, SdkClientException, CloudFormationException
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 hierachy, IncludeNestedStacks must have been set to
True.
executeChangeSetRequest - The input for the ExecuteChangeSet action.InvalidChangeSetStatusException - 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.ChangeSetNotFoundException - The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the
ListChangeSets action.InsufficientCapabilitiesException - The template contains resources with capabilities that weren't specified in the Capabilities parameter.TokenAlreadyExistsException - A client request token already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ExecuteChangeSetResponse executeChangeSet(Consumer<ExecuteChangeSetRequest.Builder> executeChangeSetRequest) throws InvalidChangeSetStatusException, ChangeSetNotFoundException, InsufficientCapabilitiesException, TokenAlreadyExistsException, AwsServiceException, SdkClientException, CloudFormationException
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 hierachy, IncludeNestedStacks must have been set to
True.
This is a convenience which creates an instance of the ExecuteChangeSetRequest.Builder avoiding the need
to create one manually via ExecuteChangeSetRequest.builder()
executeChangeSetRequest - A Consumer that will call methods on ExecuteChangeSetInput.Builder to create a request.
The input for the ExecuteChangeSet action.InvalidChangeSetStatusException - 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.ChangeSetNotFoundException - The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the
ListChangeSets action.InsufficientCapabilitiesException - The template contains resources with capabilities that weren't specified in the Capabilities parameter.TokenAlreadyExistsException - A client request token already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetStackPolicyResponse getStackPolicy(GetStackPolicyRequest getStackPolicyRequest) throws AwsServiceException, SdkClientException, CloudFormationException
Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
getStackPolicyRequest - The input for the GetStackPolicy action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetStackPolicyResponse getStackPolicy(Consumer<GetStackPolicyRequest.Builder> getStackPolicyRequest) throws AwsServiceException, SdkClientException, CloudFormationException
Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
This is a convenience which creates an instance of the GetStackPolicyRequest.Builder avoiding the need to
create one manually via GetStackPolicyRequest.builder()
getStackPolicyRequest - A Consumer that will call methods on GetStackPolicyInput.Builder to create a request. The
input for the GetStackPolicy action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTemplateResponse getTemplate(GetTemplateRequest getTemplateRequest) throws ChangeSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Returns the template body for a specified stack. You can get the template for running or deleted stacks.
For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.
If the template does not exist, a ValidationError is returned.
getTemplateRequest - The input for a GetTemplate action.ChangeSetNotFoundException - The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the
ListChangeSets action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTemplateResponse getTemplate(Consumer<GetTemplateRequest.Builder> getTemplateRequest) throws ChangeSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Returns the template body for a specified stack. You can get the template for running or deleted stacks.
For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.
If the template does not exist, a ValidationError is returned.
This is a convenience which creates an instance of the GetTemplateRequest.Builder avoiding the need to
create one manually via GetTemplateRequest.builder()
getTemplateRequest - A Consumer that will call methods on GetTemplateInput.Builder to create a request. The
input for a GetTemplate action.ChangeSetNotFoundException - The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the
ListChangeSets action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTemplateSummaryResponse getTemplateSummary(GetTemplateSummaryRequest getTemplateSummaryRequest) throws StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Returns information about a new or existing template. The GetTemplateSummary action is useful for
viewing parameter information, such as default parameter values and parameter types, before you create or update
a stack or stack set.
You can use the GetTemplateSummary action when you submit a template, or you can get template
information for a stack set, or a running or deleted stack.
For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the
stack has been deleted. If the template does not exist, a ValidationError is returned.
getTemplateSummaryRequest - The input for the GetTemplateSummary action.StackSetNotFoundException - The specified stack set doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTemplateSummaryResponse getTemplateSummary(Consumer<GetTemplateSummaryRequest.Builder> getTemplateSummaryRequest) throws StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Returns information about a new or existing template. The GetTemplateSummary action is useful for
viewing parameter information, such as default parameter values and parameter types, before you create or update
a stack or stack set.
You can use the GetTemplateSummary action when you submit a template, or you can get template
information for a stack set, or a running or deleted stack.
For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the
stack has been deleted. If the template does not exist, a ValidationError is returned.
This is a convenience which creates an instance of the GetTemplateSummaryRequest.Builder avoiding the
need to create one manually via GetTemplateSummaryRequest.builder()
getTemplateSummaryRequest - A Consumer that will call methods on GetTemplateSummaryInput.Builder to create a request.
The input for the GetTemplateSummary action.StackSetNotFoundException - The specified stack set doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ImportStacksToStackSetResponse importStacksToStackSet(ImportStacksToStackSetRequest importStacksToStackSetRequest) throws LimitExceededException, StackSetNotFoundException, InvalidOperationException, OperationInProgressException, OperationIdAlreadyExistsException, StackNotFoundException, StaleRequestException, AwsServiceException, SdkClientException, CloudFormationException
Use the stack import operations for self-managed or service-managed StackSets. For self-managed StackSets, the import operation can import stacks in the administrator account or in different target accounts and Amazon Web Services Regions. For service-managed StackSets, the import operation can import any stack in the same AWS Organizations as the management account. The import operation can import up to 10 stacks using inline stack IDs or up to 10,000 stacks using an Amazon S3 object.
importStacksToStackSetRequest - LimitExceededException - The quota for the resource has already been reached.
For information on resource and stack limitations, see Limits in the CloudFormation User Guide.
StackSetNotFoundException - The specified stack set doesn't exist.InvalidOperationException - The specified operation isn't valid.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.OperationIdAlreadyExistsException - The specified operation ID already exists.StackNotFoundException - The specified stack ARN doesn’t exist or stack doesn’t exist corresponding to the ARN in input.StaleRequestException - Another operation has been performed on this stack set since the specified operation was performed.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ImportStacksToStackSetResponse importStacksToStackSet(Consumer<ImportStacksToStackSetRequest.Builder> importStacksToStackSetRequest) throws LimitExceededException, StackSetNotFoundException, InvalidOperationException, OperationInProgressException, OperationIdAlreadyExistsException, StackNotFoundException, StaleRequestException, AwsServiceException, SdkClientException, CloudFormationException
Use the stack import operations for self-managed or service-managed StackSets. For self-managed StackSets, the import operation can import stacks in the administrator account or in different target accounts and Amazon Web Services Regions. For service-managed StackSets, the import operation can import any stack in the same AWS Organizations as the management account. The import operation can import up to 10 stacks using inline stack IDs or up to 10,000 stacks using an Amazon S3 object.
This is a convenience which creates an instance of the ImportStacksToStackSetRequest.Builder avoiding the
need to create one manually via ImportStacksToStackSetRequest.builder()
importStacksToStackSetRequest - A Consumer that will call methods on ImportStacksToStackSetInput.Builder to create a
request.LimitExceededException - The quota for the resource has already been reached.
For information on resource and stack limitations, see Limits in the CloudFormation User Guide.
StackSetNotFoundException - The specified stack set doesn't exist.InvalidOperationException - The specified operation isn't valid.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.OperationIdAlreadyExistsException - The specified operation ID already exists.StackNotFoundException - The specified stack ARN doesn’t exist or stack doesn’t exist corresponding to the ARN in input.StaleRequestException - Another operation has been performed on this stack set since the specified operation was performed.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChangeSetsResponse listChangeSets(ListChangeSetsRequest listChangeSetsRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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.
listChangeSetsRequest - The input for the ListChangeSets action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChangeSetsResponse listChangeSets(Consumer<ListChangeSetsRequest.Builder> listChangeSetsRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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.
This is a convenience which creates an instance of the ListChangeSetsRequest.Builder avoiding the need to
create one manually via ListChangeSetsRequest.builder()
listChangeSetsRequest - A Consumer that will call methods on ListChangeSetsInput.Builder to create a request. The
input for the ListChangeSets action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChangeSetsIterable listChangeSetsPaginator(ListChangeSetsRequest listChangeSetsRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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.
This is a variant of
listChangeSets(software.amazon.awssdk.services.cloudformation.model.ListChangeSetsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListChangeSetsIterable responses = client.listChangeSetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.ListChangeSetsIterable responses = client
.listChangeSetsPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.ListChangeSetsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListChangeSetsIterable responses = client.listChangeSetsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChangeSets(software.amazon.awssdk.services.cloudformation.model.ListChangeSetsRequest)
operation.
listChangeSetsRequest - The input for the ListChangeSets action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChangeSetsIterable listChangeSetsPaginator(Consumer<ListChangeSetsRequest.Builder> listChangeSetsRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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.
This is a variant of
listChangeSets(software.amazon.awssdk.services.cloudformation.model.ListChangeSetsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListChangeSetsIterable responses = client.listChangeSetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.ListChangeSetsIterable responses = client
.listChangeSetsPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.ListChangeSetsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListChangeSetsIterable responses = client.listChangeSetsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChangeSets(software.amazon.awssdk.services.cloudformation.model.ListChangeSetsRequest)
operation.
This is a convenience which creates an instance of the ListChangeSetsRequest.Builder avoiding the need to
create one manually via ListChangeSetsRequest.builder()
listChangeSetsRequest - A Consumer that will call methods on ListChangeSetsInput.Builder to create a request. The
input for the ListChangeSets action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListExportsResponse listExports() throws AwsServiceException, SdkClientException, CloudFormationException
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 function.
For more information, see CloudFormation Export Stack Output Values.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistExports(ListExportsRequest),
AWS
API Documentationdefault ListExportsResponse listExports(ListExportsRequest listExportsRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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 function.
For more information, see CloudFormation Export Stack Output Values.
listExportsRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListExportsResponse listExports(Consumer<ListExportsRequest.Builder> listExportsRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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 function.
For more information, see CloudFormation Export Stack Output Values.
This is a convenience which creates an instance of the ListExportsRequest.Builder avoiding the need to
create one manually via ListExportsRequest.builder()
listExportsRequest - A Consumer that will call methods on ListExportsInput.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListExportsIterable listExportsPaginator() throws AwsServiceException, SdkClientException, CloudFormationException
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 function.
For more information, see CloudFormation Export Stack Output Values.
This is a variant of
listExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListExportsIterable responses = client.listExportsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.ListExportsIterable responses = client
.listExportsPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.ListExportsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListExportsIterable responses = client.listExportsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest) operation.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistExportsPaginator(ListExportsRequest),
AWS
API Documentationdefault ListExportsIterable listExportsPaginator(ListExportsRequest listExportsRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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 function.
For more information, see CloudFormation Export Stack Output Values.
This is a variant of
listExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListExportsIterable responses = client.listExportsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.ListExportsIterable responses = client
.listExportsPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.ListExportsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListExportsIterable responses = client.listExportsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest) operation.
listExportsRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListExportsIterable listExportsPaginator(Consumer<ListExportsRequest.Builder> listExportsRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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 function.
For more information, see CloudFormation Export Stack Output Values.
This is a variant of
listExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListExportsIterable responses = client.listExportsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.ListExportsIterable responses = client
.listExportsPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.ListExportsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListExportsIterable responses = client.listExportsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest) operation.
This is a convenience which creates an instance of the ListExportsRequest.Builder avoiding the need to
create one manually via ListExportsRequest.builder()
listExportsRequest - A Consumer that will call methods on ListExportsInput.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListImportsResponse listImports(ListImportsRequest listImportsRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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 function.
listImportsRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListImportsResponse listImports(Consumer<ListImportsRequest.Builder> listImportsRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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 function.
This is a convenience which creates an instance of the ListImportsRequest.Builder avoiding the need to
create one manually via ListImportsRequest.builder()
listImportsRequest - A Consumer that will call methods on ListImportsInput.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListImportsIterable listImportsPaginator(ListImportsRequest listImportsRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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 function.
This is a variant of
listImports(software.amazon.awssdk.services.cloudformation.model.ListImportsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListImportsIterable responses = client.listImportsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.ListImportsIterable responses = client
.listImportsPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.ListImportsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListImportsIterable responses = client.listImportsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImports(software.amazon.awssdk.services.cloudformation.model.ListImportsRequest) operation.
listImportsRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListImportsIterable listImportsPaginator(Consumer<ListImportsRequest.Builder> listImportsRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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 function.
This is a variant of
listImports(software.amazon.awssdk.services.cloudformation.model.ListImportsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListImportsIterable responses = client.listImportsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.ListImportsIterable responses = client
.listImportsPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.ListImportsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListImportsIterable responses = client.listImportsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImports(software.amazon.awssdk.services.cloudformation.model.ListImportsRequest) operation.
This is a convenience which creates an instance of the ListImportsRequest.Builder avoiding the need to
create one manually via ListImportsRequest.builder()
listImportsRequest - A Consumer that will call methods on ListImportsInput.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStackInstancesResponse listStackInstances(ListStackInstancesRequest listStackInstancesRequest) throws StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
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.
listStackInstancesRequest - StackSetNotFoundException - The specified stack set doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStackInstancesResponse listStackInstances(Consumer<ListStackInstancesRequest.Builder> listStackInstancesRequest) throws StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
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.
This is a convenience which creates an instance of the ListStackInstancesRequest.Builder avoiding the
need to create one manually via ListStackInstancesRequest.builder()
listStackInstancesRequest - A Consumer that will call methods on ListStackInstancesInput.Builder to create a request.StackSetNotFoundException - The specified stack set doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStackInstancesIterable listStackInstancesPaginator(ListStackInstancesRequest listStackInstancesRequest) throws StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
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.
This is a variant of
listStackInstances(software.amazon.awssdk.services.cloudformation.model.ListStackInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListStackInstancesIterable responses = client.listStackInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.ListStackInstancesIterable responses = client
.listStackInstancesPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.ListStackInstancesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListStackInstancesIterable responses = client.listStackInstancesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStackInstances(software.amazon.awssdk.services.cloudformation.model.ListStackInstancesRequest)
operation.
listStackInstancesRequest - StackSetNotFoundException - The specified stack set doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStackInstancesIterable listStackInstancesPaginator(Consumer<ListStackInstancesRequest.Builder> listStackInstancesRequest) throws StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
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.
This is a variant of
listStackInstances(software.amazon.awssdk.services.cloudformation.model.ListStackInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListStackInstancesIterable responses = client.listStackInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.ListStackInstancesIterable responses = client
.listStackInstancesPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.ListStackInstancesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListStackInstancesIterable responses = client.listStackInstancesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStackInstances(software.amazon.awssdk.services.cloudformation.model.ListStackInstancesRequest)
operation.
This is a convenience which creates an instance of the ListStackInstancesRequest.Builder avoiding the
need to create one manually via ListStackInstancesRequest.builder()
listStackInstancesRequest - A Consumer that will call methods on ListStackInstancesInput.Builder to create a request.StackSetNotFoundException - The specified stack set doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStackResourcesResponse listStackResources(ListStackResourcesRequest listStackResourcesRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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.
listStackResourcesRequest - The input for the ListStackResource action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStackResourcesResponse listStackResources(Consumer<ListStackResourcesRequest.Builder> listStackResourcesRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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.
This is a convenience which creates an instance of the ListStackResourcesRequest.Builder avoiding the
need to create one manually via ListStackResourcesRequest.builder()
listStackResourcesRequest - A Consumer that will call methods on ListStackResourcesInput.Builder to create a request.
The input for the ListStackResource action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStackResourcesIterable listStackResourcesPaginator(ListStackResourcesRequest listStackResourcesRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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.
This is a variant of
listStackResources(software.amazon.awssdk.services.cloudformation.model.ListStackResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListStackResourcesIterable responses = client.listStackResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.ListStackResourcesIterable responses = client
.listStackResourcesPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.ListStackResourcesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListStackResourcesIterable responses = client.listStackResourcesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStackResources(software.amazon.awssdk.services.cloudformation.model.ListStackResourcesRequest)
operation.
listStackResourcesRequest - The input for the ListStackResource action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStackResourcesIterable listStackResourcesPaginator(Consumer<ListStackResourcesRequest.Builder> listStackResourcesRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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.
This is a variant of
listStackResources(software.amazon.awssdk.services.cloudformation.model.ListStackResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListStackResourcesIterable responses = client.listStackResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.ListStackResourcesIterable responses = client
.listStackResourcesPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.ListStackResourcesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListStackResourcesIterable responses = client.listStackResourcesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStackResources(software.amazon.awssdk.services.cloudformation.model.ListStackResourcesRequest)
operation.
This is a convenience which creates an instance of the ListStackResourcesRequest.Builder avoiding the
need to create one manually via ListStackResourcesRequest.builder()
listStackResourcesRequest - A Consumer that will call methods on ListStackResourcesInput.Builder to create a request.
The input for the ListStackResource action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStackSetOperationResultsResponse listStackSetOperationResults(ListStackSetOperationResultsRequest listStackSetOperationResultsRequest) throws StackSetNotFoundException, OperationNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Returns summary information about the results of a stack set operation.
listStackSetOperationResultsRequest - StackSetNotFoundException - The specified stack set doesn't exist.OperationNotFoundException - The specified ID refers to an operation that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStackSetOperationResultsResponse listStackSetOperationResults(Consumer<ListStackSetOperationResultsRequest.Builder> listStackSetOperationResultsRequest) throws StackSetNotFoundException, OperationNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Returns summary information about the results of a stack set operation.
This is a convenience which creates an instance of the ListStackSetOperationResultsRequest.Builder
avoiding the need to create one manually via ListStackSetOperationResultsRequest.builder()
listStackSetOperationResultsRequest - A Consumer that will call methods on ListStackSetOperationResultsInput.Builder to create a
request.StackSetNotFoundException - The specified stack set doesn't exist.OperationNotFoundException - The specified ID refers to an operation that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStackSetOperationResultsIterable listStackSetOperationResultsPaginator(ListStackSetOperationResultsRequest listStackSetOperationResultsRequest) throws StackSetNotFoundException, OperationNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Returns summary information about the results of a stack set operation.
This is a variant of
listStackSetOperationResults(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationResultsIterable responses = client.listStackSetOperationResultsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationResultsIterable responses = client
.listStackSetOperationResultsPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationResultsIterable responses = client.listStackSetOperationResultsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStackSetOperationResults(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsRequest)
operation.
listStackSetOperationResultsRequest - StackSetNotFoundException - The specified stack set doesn't exist.OperationNotFoundException - The specified ID refers to an operation that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStackSetOperationResultsIterable listStackSetOperationResultsPaginator(Consumer<ListStackSetOperationResultsRequest.Builder> listStackSetOperationResultsRequest) throws StackSetNotFoundException, OperationNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Returns summary information about the results of a stack set operation.
This is a variant of
listStackSetOperationResults(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationResultsIterable responses = client.listStackSetOperationResultsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationResultsIterable responses = client
.listStackSetOperationResultsPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationResultsIterable responses = client.listStackSetOperationResultsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStackSetOperationResults(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsRequest)
operation.
This is a convenience which creates an instance of the ListStackSetOperationResultsRequest.Builder
avoiding the need to create one manually via ListStackSetOperationResultsRequest.builder()
listStackSetOperationResultsRequest - A Consumer that will call methods on ListStackSetOperationResultsInput.Builder to create a
request.StackSetNotFoundException - The specified stack set doesn't exist.OperationNotFoundException - The specified ID refers to an operation that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStackSetOperationsResponse listStackSetOperations(ListStackSetOperationsRequest listStackSetOperationsRequest) throws StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Returns summary information about operations performed on a stack set.
listStackSetOperationsRequest - StackSetNotFoundException - The specified stack set doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStackSetOperationsResponse listStackSetOperations(Consumer<ListStackSetOperationsRequest.Builder> listStackSetOperationsRequest) throws StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Returns summary information about operations performed on a stack set.
This is a convenience which creates an instance of the ListStackSetOperationsRequest.Builder avoiding the
need to create one manually via ListStackSetOperationsRequest.builder()
listStackSetOperationsRequest - A Consumer that will call methods on ListStackSetOperationsInput.Builder to create a
request.StackSetNotFoundException - The specified stack set doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStackSetOperationsIterable listStackSetOperationsPaginator(ListStackSetOperationsRequest listStackSetOperationsRequest) throws StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Returns summary information about operations performed on a stack set.
This is a variant of
listStackSetOperations(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationsIterable responses = client.listStackSetOperationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationsIterable responses = client
.listStackSetOperationsPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationsIterable responses = client.listStackSetOperationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStackSetOperations(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsRequest)
operation.
listStackSetOperationsRequest - StackSetNotFoundException - The specified stack set doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStackSetOperationsIterable listStackSetOperationsPaginator(Consumer<ListStackSetOperationsRequest.Builder> listStackSetOperationsRequest) throws StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Returns summary information about operations performed on a stack set.
This is a variant of
listStackSetOperations(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationsIterable responses = client.listStackSetOperationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationsIterable responses = client
.listStackSetOperationsPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationsIterable responses = client.listStackSetOperationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStackSetOperations(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsRequest)
operation.
This is a convenience which creates an instance of the ListStackSetOperationsRequest.Builder avoiding the
need to create one manually via ListStackSetOperationsRequest.builder()
listStackSetOperationsRequest - A Consumer that will call methods on ListStackSetOperationsInput.Builder to create a
request.StackSetNotFoundException - The specified stack set doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStackSetsResponse listStackSets() throws AwsServiceException, SdkClientException, CloudFormationException
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.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistStackSets(ListStackSetsRequest),
AWS
API Documentationdefault ListStackSetsResponse listStackSets(ListStackSetsRequest listStackSetsRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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.
listStackSetsRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStackSetsResponse listStackSets(Consumer<ListStackSetsRequest.Builder> listStackSetsRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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.
This is a convenience which creates an instance of the ListStackSetsRequest.Builder avoiding the need to
create one manually via ListStackSetsRequest.builder()
listStackSetsRequest - A Consumer that will call methods on ListStackSetsInput.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStackSetsIterable listStackSetsPaginator() throws AwsServiceException, SdkClientException, CloudFormationException
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.
This is a variant of
listStackSets(software.amazon.awssdk.services.cloudformation.model.ListStackSetsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListStackSetsIterable responses = client.listStackSetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.ListStackSetsIterable responses = client
.listStackSetsPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.ListStackSetsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListStackSetsIterable responses = client.listStackSetsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStackSets(software.amazon.awssdk.services.cloudformation.model.ListStackSetsRequest) operation.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistStackSetsPaginator(ListStackSetsRequest),
AWS
API Documentationdefault ListStackSetsIterable listStackSetsPaginator(ListStackSetsRequest listStackSetsRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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.
This is a variant of
listStackSets(software.amazon.awssdk.services.cloudformation.model.ListStackSetsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListStackSetsIterable responses = client.listStackSetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.ListStackSetsIterable responses = client
.listStackSetsPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.ListStackSetsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListStackSetsIterable responses = client.listStackSetsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStackSets(software.amazon.awssdk.services.cloudformation.model.ListStackSetsRequest) operation.
listStackSetsRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStackSetsIterable listStackSetsPaginator(Consumer<ListStackSetsRequest.Builder> listStackSetsRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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.
This is a variant of
listStackSets(software.amazon.awssdk.services.cloudformation.model.ListStackSetsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListStackSetsIterable responses = client.listStackSetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.ListStackSetsIterable responses = client
.listStackSetsPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.ListStackSetsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListStackSetsIterable responses = client.listStackSetsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStackSets(software.amazon.awssdk.services.cloudformation.model.ListStackSetsRequest) operation.
This is a convenience which creates an instance of the ListStackSetsRequest.Builder avoiding the need to
create one manually via ListStackSetsRequest.builder()
listStackSetsRequest - A Consumer that will call methods on ListStackSetsInput.Builder to create a request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStacksResponse listStacks() throws AwsServiceException, SdkClientException, CloudFormationException
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).
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistStacks(ListStacksRequest),
AWS API
Documentationdefault ListStacksResponse listStacks(ListStacksRequest listStacksRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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).
listStacksRequest - The input for ListStacks action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStacksResponse listStacks(Consumer<ListStacksRequest.Builder> listStacksRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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).
This is a convenience which creates an instance of the ListStacksRequest.Builder avoiding the need to
create one manually via ListStacksRequest.builder()
listStacksRequest - A Consumer that will call methods on ListStacksInput.Builder to create a request. The
input for ListStacks action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStacksIterable listStacksPaginator() throws AwsServiceException, SdkClientException, CloudFormationException
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).
This is a variant of listStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListStacksIterable responses = client.listStacksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.ListStacksIterable responses = client.listStacksPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.ListStacksResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListStacksIterable responses = client.listStacksPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest) operation.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistStacksPaginator(ListStacksRequest),
AWS API
Documentationdefault ListStacksIterable listStacksPaginator(ListStacksRequest listStacksRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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).
This is a variant of listStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListStacksIterable responses = client.listStacksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.ListStacksIterable responses = client.listStacksPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.ListStacksResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListStacksIterable responses = client.listStacksPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest) operation.
listStacksRequest - The input for ListStacks action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStacksIterable listStacksPaginator(Consumer<ListStacksRequest.Builder> listStacksRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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).
This is a variant of listStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListStacksIterable responses = client.listStacksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.ListStacksIterable responses = client.listStacksPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.ListStacksResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListStacksIterable responses = client.listStacksPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest) operation.
This is a convenience which creates an instance of the ListStacksRequest.Builder avoiding the need to
create one manually via ListStacksRequest.builder()
listStacksRequest - A Consumer that will call methods on ListStacksInput.Builder to create a request. The
input for ListStacks action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTypeRegistrationsResponse listTypeRegistrations(ListTypeRegistrationsRequest listTypeRegistrationsRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException
Returns a list of registration tokens for the specified extension(s).
listTypeRegistrationsRequest - CfnRegistryException - An error occurred during a CloudFormation registry operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTypeRegistrationsResponse listTypeRegistrations(Consumer<ListTypeRegistrationsRequest.Builder> listTypeRegistrationsRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException
Returns a list of registration tokens for the specified extension(s).
This is a convenience which creates an instance of the ListTypeRegistrationsRequest.Builder avoiding the
need to create one manually via ListTypeRegistrationsRequest.builder()
listTypeRegistrationsRequest - A Consumer that will call methods on ListTypeRegistrationsInput.Builder to create a
request.CfnRegistryException - An error occurred during a CloudFormation registry operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTypeRegistrationsIterable listTypeRegistrationsPaginator(ListTypeRegistrationsRequest listTypeRegistrationsRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException
Returns a list of registration tokens for the specified extension(s).
This is a variant of
listTypeRegistrations(software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListTypeRegistrationsIterable responses = client.listTypeRegistrationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.ListTypeRegistrationsIterable responses = client
.listTypeRegistrationsPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListTypeRegistrationsIterable responses = client.listTypeRegistrationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTypeRegistrations(software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsRequest)
operation.
listTypeRegistrationsRequest - CfnRegistryException - An error occurred during a CloudFormation registry operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTypeRegistrationsIterable listTypeRegistrationsPaginator(Consumer<ListTypeRegistrationsRequest.Builder> listTypeRegistrationsRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException
Returns a list of registration tokens for the specified extension(s).
This is a variant of
listTypeRegistrations(software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListTypeRegistrationsIterable responses = client.listTypeRegistrationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.ListTypeRegistrationsIterable responses = client
.listTypeRegistrationsPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListTypeRegistrationsIterable responses = client.listTypeRegistrationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTypeRegistrations(software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsRequest)
operation.
This is a convenience which creates an instance of the ListTypeRegistrationsRequest.Builder avoiding the
need to create one manually via ListTypeRegistrationsRequest.builder()
listTypeRegistrationsRequest - A Consumer that will call methods on ListTypeRegistrationsInput.Builder to create a
request.CfnRegistryException - An error occurred during a CloudFormation registry operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTypeVersionsResponse listTypeVersions(ListTypeVersionsRequest listTypeVersionsRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException
Returns summary information about the versions of an extension.
listTypeVersionsRequest - CfnRegistryException - An error occurred during a CloudFormation registry operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTypeVersionsResponse listTypeVersions(Consumer<ListTypeVersionsRequest.Builder> listTypeVersionsRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException
Returns summary information about the versions of an extension.
This is a convenience which creates an instance of the ListTypeVersionsRequest.Builder avoiding the need
to create one manually via ListTypeVersionsRequest.builder()
listTypeVersionsRequest - A Consumer that will call methods on ListTypeVersionsInput.Builder to create a request.CfnRegistryException - An error occurred during a CloudFormation registry operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTypeVersionsIterable listTypeVersionsPaginator(ListTypeVersionsRequest listTypeVersionsRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException
Returns summary information about the versions of an extension.
This is a variant of
listTypeVersions(software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListTypeVersionsIterable responses = client.listTypeVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.ListTypeVersionsIterable responses = client
.listTypeVersionsPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListTypeVersionsIterable responses = client.listTypeVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTypeVersions(software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsRequest)
operation.
listTypeVersionsRequest - CfnRegistryException - An error occurred during a CloudFormation registry operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTypeVersionsIterable listTypeVersionsPaginator(Consumer<ListTypeVersionsRequest.Builder> listTypeVersionsRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException
Returns summary information about the versions of an extension.
This is a variant of
listTypeVersions(software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListTypeVersionsIterable responses = client.listTypeVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.ListTypeVersionsIterable responses = client
.listTypeVersionsPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListTypeVersionsIterable responses = client.listTypeVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTypeVersions(software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsRequest)
operation.
This is a convenience which creates an instance of the ListTypeVersionsRequest.Builder avoiding the need
to create one manually via ListTypeVersionsRequest.builder()
listTypeVersionsRequest - A Consumer that will call methods on ListTypeVersionsInput.Builder to create a request.CfnRegistryException - An error occurred during a CloudFormation registry operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTypesResponse listTypes(ListTypesRequest listTypesRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException
Returns summary information about extension that have been registered with CloudFormation.
listTypesRequest - CfnRegistryException - An error occurred during a CloudFormation registry operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTypesResponse listTypes(Consumer<ListTypesRequest.Builder> listTypesRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException
Returns summary information about extension that have been registered with CloudFormation.
This is a convenience which creates an instance of the ListTypesRequest.Builder avoiding the need to
create one manually via ListTypesRequest.builder()
listTypesRequest - A Consumer that will call methods on ListTypesInput.Builder to create a request.CfnRegistryException - An error occurred during a CloudFormation registry operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTypesIterable listTypesPaginator(ListTypesRequest listTypesRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException
Returns summary information about extension that have been registered with CloudFormation.
This is a variant of listTypes(software.amazon.awssdk.services.cloudformation.model.ListTypesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListTypesIterable responses = client.listTypesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.ListTypesIterable responses = client.listTypesPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.ListTypesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListTypesIterable responses = client.listTypesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTypes(software.amazon.awssdk.services.cloudformation.model.ListTypesRequest) operation.
listTypesRequest - CfnRegistryException - An error occurred during a CloudFormation registry operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTypesIterable listTypesPaginator(Consumer<ListTypesRequest.Builder> listTypesRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException
Returns summary information about extension that have been registered with CloudFormation.
This is a variant of listTypes(software.amazon.awssdk.services.cloudformation.model.ListTypesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudformation.paginators.ListTypesIterable responses = client.listTypesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudformation.paginators.ListTypesIterable responses = client.listTypesPaginator(request);
for (software.amazon.awssdk.services.cloudformation.model.ListTypesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudformation.paginators.ListTypesIterable responses = client.listTypesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTypes(software.amazon.awssdk.services.cloudformation.model.ListTypesRequest) operation.
This is a convenience which creates an instance of the ListTypesRequest.Builder avoiding the need to
create one manually via ListTypesRequest.builder()
listTypesRequest - A Consumer that will call methods on ListTypesInput.Builder to create a request.CfnRegistryException - An error occurred during a CloudFormation registry operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PublishTypeResponse publishType(PublishTypeRequest publishTypeRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Publishes the specified extension to the CloudFormation registry as a public extension in this region. Public extensions are available for use by all CloudFormation users. For more information on publishing extensions, see Publishing extensions to make them available for public use in the CloudFormation CLI User Guide.
To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.
publishTypeRequest - CfnRegistryException - An error occurred during a CloudFormation registry operation.TypeNotFoundException - The specified extension does not exist in the CloudFormation registry.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PublishTypeResponse publishType(Consumer<PublishTypeRequest.Builder> publishTypeRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Publishes the specified extension to the CloudFormation registry as a public extension in this region. Public extensions are available for use by all CloudFormation users. For more information on publishing extensions, see Publishing extensions to make them available for public use in the CloudFormation CLI User Guide.
To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.
This is a convenience which creates an instance of the PublishTypeRequest.Builder avoiding the need to
create one manually via PublishTypeRequest.builder()
publishTypeRequest - A Consumer that will call methods on PublishTypeInput.Builder to create a request.CfnRegistryException - An error occurred during a CloudFormation registry operation.TypeNotFoundException - The specified extension does not exist in the CloudFormation registry.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RecordHandlerProgressResponse recordHandlerProgress(RecordHandlerProgressRequest recordHandlerProgressRequest) throws InvalidStateTransitionException, OperationStatusCheckFailedException, AwsServiceException, SdkClientException, CloudFormationException
Reports progress of a resource handler to CloudFormation.
Reserved for use by the CloudFormation CLI. Do not use this API in your code.
recordHandlerProgressRequest - InvalidStateTransitionException - Error reserved for use by the CloudFormation CLI. CloudFormation does not return this error to users.OperationStatusCheckFailedException - Error reserved for use by the CloudFormation CLI. CloudFormation does not return this error to users.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RecordHandlerProgressResponse recordHandlerProgress(Consumer<RecordHandlerProgressRequest.Builder> recordHandlerProgressRequest) throws InvalidStateTransitionException, OperationStatusCheckFailedException, AwsServiceException, SdkClientException, CloudFormationException
Reports progress of a resource handler to CloudFormation.
Reserved for use by the CloudFormation CLI. Do not use this API in your code.
This is a convenience which creates an instance of the RecordHandlerProgressRequest.Builder avoiding the
need to create one manually via RecordHandlerProgressRequest.builder()
recordHandlerProgressRequest - A Consumer that will call methods on RecordHandlerProgressInput.Builder to create a
request.InvalidStateTransitionException - Error reserved for use by the CloudFormation CLI. CloudFormation does not return this error to users.OperationStatusCheckFailedException - Error reserved for use by the CloudFormation CLI. CloudFormation does not return this error to users.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterPublisherResponse registerPublisher(RegisterPublisherRequest registerPublisherRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException
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 on requirements for registering as a public extension publisher, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide.
registerPublisherRequest - CfnRegistryException - An error occurred during a CloudFormation registry operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterPublisherResponse registerPublisher(Consumer<RegisterPublisherRequest.Builder> registerPublisherRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException
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 on requirements for registering as a public extension publisher, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide.
This is a convenience which creates an instance of the RegisterPublisherRequest.Builder avoiding the need
to create one manually via RegisterPublisherRequest.builder()
registerPublisherRequest - A Consumer that will call methods on RegisterPublisherInput.Builder to create a request.CfnRegistryException - An error occurred during a CloudFormation registry operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterTypeResponse registerType(RegisterTypeRequest registerTypeRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException
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 on how to develop extensions and ready them for registeration, see Creating Resource Providers in the CloudFormation CLI User Guide.
You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and per region. Use DeregisterType to deregister specific extension versions if necessary.
Once you have initiated a registration request using RegisterType , you can use
DescribeTypeRegistration to monitor the progress of the registration request.
Once you have registered a private extension in your account and region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
registerTypeRequest - CfnRegistryException - An error occurred during a CloudFormation registry operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterTypeResponse registerType(Consumer<RegisterTypeRequest.Builder> registerTypeRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException
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 on how to develop extensions and ready them for registeration, see Creating Resource Providers in the CloudFormation CLI User Guide.
You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and per region. Use DeregisterType to deregister specific extension versions if necessary.
Once you have initiated a registration request using RegisterType , you can use
DescribeTypeRegistration to monitor the progress of the registration request.
Once you have registered a private extension in your account and region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
This is a convenience which creates an instance of the RegisterTypeRequest.Builder avoiding the need to
create one manually via RegisterTypeRequest.builder()
registerTypeRequest - A Consumer that will call methods on RegisterTypeInput.Builder to create a request.CfnRegistryException - An error occurred during a CloudFormation registry operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RollbackStackResponse rollbackStack(RollbackStackRequest rollbackStackRequest) throws TokenAlreadyExistsException, AwsServiceException, SdkClientException, CloudFormationException
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 API.
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
rollbackStackRequest - TokenAlreadyExistsException - A client request token already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RollbackStackResponse rollbackStack(Consumer<RollbackStackRequest.Builder> rollbackStackRequest) throws TokenAlreadyExistsException, AwsServiceException, SdkClientException, CloudFormationException
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 API.
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
This is a convenience which creates an instance of the RollbackStackRequest.Builder avoiding the need to
create one manually via RollbackStackRequest.builder()
rollbackStackRequest - A Consumer that will call methods on RollbackStackInput.Builder to create a request.TokenAlreadyExistsException - A client request token already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SetStackPolicyResponse setStackPolicy(SetStackPolicyRequest setStackPolicyRequest) throws AwsServiceException, SdkClientException, CloudFormationException
Sets a stack policy for a specified stack.
setStackPolicyRequest - The input for the SetStackPolicy action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SetStackPolicyResponse setStackPolicy(Consumer<SetStackPolicyRequest.Builder> setStackPolicyRequest) throws AwsServiceException, SdkClientException, CloudFormationException
Sets a stack policy for a specified stack.
This is a convenience which creates an instance of the SetStackPolicyRequest.Builder avoiding the need to
create one manually via SetStackPolicyRequest.builder()
setStackPolicyRequest - A Consumer that will call methods on SetStackPolicyInput.Builder to create a request. The
input for the SetStackPolicy action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SetTypeConfigurationResponse setTypeConfiguration(SetTypeConfigurationRequest setTypeConfigurationRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Specifies the configuration data for a registered CloudFormation extension, in the given account and region.
To view the current configuration data for an extension, refer to the ConfigurationSchema element of
DescribeType. For more information, see
Configuring extensions at the account level in the CloudFormation User Guide.
It is strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more details on dynamic references, see Using dynamic references to specify template values in the CloudFormation User Guide.
setTypeConfigurationRequest - CfnRegistryException - An error occurred during a CloudFormation registry operation.TypeNotFoundException - The specified extension does not exist in the CloudFormation registry.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SetTypeConfigurationResponse setTypeConfiguration(Consumer<SetTypeConfigurationRequest.Builder> setTypeConfigurationRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Specifies the configuration data for a registered CloudFormation extension, in the given account and region.
To view the current configuration data for an extension, refer to the ConfigurationSchema element of
DescribeType. For more information, see
Configuring extensions at the account level in the CloudFormation User Guide.
It is strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more details on dynamic references, see Using dynamic references to specify template values in the CloudFormation User Guide.
This is a convenience which creates an instance of the SetTypeConfigurationRequest.Builder avoiding the
need to create one manually via SetTypeConfigurationRequest.builder()
setTypeConfigurationRequest - A Consumer that will call methods on SetTypeConfigurationInput.Builder to create a
request.CfnRegistryException - An error occurred during a CloudFormation registry operation.TypeNotFoundException - The specified extension does not exist in the CloudFormation registry.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SetTypeDefaultVersionResponse setTypeDefaultVersion(SetTypeDefaultVersionRequest setTypeDefaultVersionRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.
setTypeDefaultVersionRequest - CfnRegistryException - An error occurred during a CloudFormation registry operation.TypeNotFoundException - The specified extension does not exist in the CloudFormation registry.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SetTypeDefaultVersionResponse setTypeDefaultVersion(Consumer<SetTypeDefaultVersionRequest.Builder> setTypeDefaultVersionRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.
This is a convenience which creates an instance of the SetTypeDefaultVersionRequest.Builder avoiding the
need to create one manually via SetTypeDefaultVersionRequest.builder()
setTypeDefaultVersionRequest - A Consumer that will call methods on SetTypeDefaultVersionInput.Builder to create a
request.CfnRegistryException - An error occurred during a CloudFormation registry operation.TypeNotFoundException - The specified extension does not exist in the CloudFormation registry.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SignalResourceResponse signalResource(SignalResourceRequest signalResourceRequest) throws AwsServiceException, SdkClientException, CloudFormationException
Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.
signalResourceRequest - The input for the SignalResource action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SignalResourceResponse signalResource(Consumer<SignalResourceRequest.Builder> signalResourceRequest) throws AwsServiceException, SdkClientException, CloudFormationException
Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.
This is a convenience which creates an instance of the SignalResourceRequest.Builder avoiding the need to
create one manually via SignalResourceRequest.builder()
signalResourceRequest - A Consumer that will call methods on SignalResourceInput.Builder to create a request. The
input for the SignalResource action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopStackSetOperationResponse stopStackSetOperation(StopStackSetOperationRequest stopStackSetOperationRequest) throws StackSetNotFoundException, OperationNotFoundException, InvalidOperationException, AwsServiceException, SdkClientException, CloudFormationException
Stops an in-progress operation on a stack set and its associated stack instances.
stopStackSetOperationRequest - StackSetNotFoundException - The specified stack set doesn't exist.OperationNotFoundException - The specified ID refers to an operation that doesn't exist.InvalidOperationException - The specified operation isn't valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopStackSetOperationResponse stopStackSetOperation(Consumer<StopStackSetOperationRequest.Builder> stopStackSetOperationRequest) throws StackSetNotFoundException, OperationNotFoundException, InvalidOperationException, AwsServiceException, SdkClientException, CloudFormationException
Stops an in-progress operation on a stack set and its associated stack instances.
This is a convenience which creates an instance of the StopStackSetOperationRequest.Builder avoiding the
need to create one manually via StopStackSetOperationRequest.builder()
stopStackSetOperationRequest - A Consumer that will call methods on StopStackSetOperationInput.Builder to create a
request.StackSetNotFoundException - The specified stack set doesn't exist.OperationNotFoundException - The specified ID refers to an operation that doesn't exist.InvalidOperationException - The specified operation isn't valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TestTypeResponse testType(TestTypeRequest testTypeRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
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 in the CloudFormation CLI User Guide.
If you do not specify a version, CloudFormation uses the default version of the extension in your account and region for testing.
To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more information, see RegisterType.
Once you've initiated testing on an extension using TestType, you can use DescribeType
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 in the CloudFormation CLI User Guide.
testTypeRequest - CfnRegistryException - An error occurred during a CloudFormation registry operation.TypeNotFoundException - The specified extension does not exist in the CloudFormation registry.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TestTypeResponse testType(Consumer<TestTypeRequest.Builder> testTypeRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
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 in the CloudFormation CLI User Guide.
If you do not specify a version, CloudFormation uses the default version of the extension in your account and region for testing.
To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more information, see RegisterType.
Once you've initiated testing on an extension using TestType, you can use DescribeType
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 in the CloudFormation CLI User Guide.
This is a convenience which creates an instance of the TestTypeRequest.Builder avoiding the need to
create one manually via TestTypeRequest.builder()
testTypeRequest - A Consumer that will call methods on TestTypeInput.Builder to create a request.CfnRegistryException - An error occurred during a CloudFormation registry operation.TypeNotFoundException - The specified extension does not exist in the CloudFormation registry.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateStackResponse updateStack(UpdateStackRequest updateStackRequest) throws InsufficientCapabilitiesException, TokenAlreadyExistsException, AwsServiceException, SdkClientException, CloudFormationException
Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the DescribeStacks action.
To get a copy of the template for an existing stack, you can use the GetTemplate action.
For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack.
updateStackRequest - The input for an UpdateStack action.InsufficientCapabilitiesException - The template contains resources with capabilities that weren't specified in the Capabilities parameter.TokenAlreadyExistsException - A client request token already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateStackResponse updateStack(Consumer<UpdateStackRequest.Builder> updateStackRequest) throws InsufficientCapabilitiesException, TokenAlreadyExistsException, AwsServiceException, SdkClientException, CloudFormationException
Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the DescribeStacks action.
To get a copy of the template for an existing stack, you can use the GetTemplate action.
For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack.
This is a convenience which creates an instance of the UpdateStackRequest.Builder avoiding the need to
create one manually via UpdateStackRequest.builder()
updateStackRequest - A Consumer that will call methods on UpdateStackInput.Builder to create a request. The
input for an UpdateStack action.InsufficientCapabilitiesException - The template contains resources with capabilities that weren't specified in the Capabilities parameter.TokenAlreadyExistsException - A client request token already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateStackInstancesResponse updateStackInstances(UpdateStackInstancesRequest updateStackInstancesRequest) throws StackSetNotFoundException, StackInstanceNotFoundException, OperationInProgressException, OperationIdAlreadyExistsException, StaleRequestException, InvalidOperationException, AwsServiceException, SdkClientException, CloudFormationException
Updates the parameter values for stack instances for the specified accounts, within the specified Regions. A stack instance refers to a stack in a specific account and Region.
You can only update stack instances in Regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances.
During stack set updates, any parameters overridden for a stack instance are not updated, but retain their overridden value.
You can only update the parameter values that are specified in the stack set; to add or delete a parameter
itself, use UpdateStackSet
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 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.
updateStackInstancesRequest - StackSetNotFoundException - The specified stack set doesn't exist.StackInstanceNotFoundException - The specified stack instance doesn't exist.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.OperationIdAlreadyExistsException - The specified operation ID already exists.StaleRequestException - Another operation has been performed on this stack set since the specified operation was performed.InvalidOperationException - The specified operation isn't valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateStackInstancesResponse updateStackInstances(Consumer<UpdateStackInstancesRequest.Builder> updateStackInstancesRequest) throws StackSetNotFoundException, StackInstanceNotFoundException, OperationInProgressException, OperationIdAlreadyExistsException, StaleRequestException, InvalidOperationException, AwsServiceException, SdkClientException, CloudFormationException
Updates the parameter values for stack instances for the specified accounts, within the specified Regions. A stack instance refers to a stack in a specific account and Region.
You can only update stack instances in Regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances.
During stack set updates, any parameters overridden for a stack instance are not updated, but retain their overridden value.
You can only update the parameter values that are specified in the stack set; to add or delete a parameter
itself, use UpdateStackSet
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 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.
This is a convenience which creates an instance of the UpdateStackInstancesRequest.Builder avoiding the
need to create one manually via UpdateStackInstancesRequest.builder()
updateStackInstancesRequest - A Consumer that will call methods on UpdateStackInstancesInput.Builder to create a
request.StackSetNotFoundException - The specified stack set doesn't exist.StackInstanceNotFoundException - The specified stack instance doesn't exist.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.OperationIdAlreadyExistsException - The specified operation ID already exists.StaleRequestException - Another operation has been performed on this stack set since the specified operation was performed.InvalidOperationException - The specified operation isn't valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateStackSetResponse updateStackSet(UpdateStackSetRequest updateStackSetRequest) throws StackSetNotFoundException, OperationInProgressException, OperationIdAlreadyExistsException, StaleRequestException, InvalidOperationException, StackInstanceNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Updates the stack set, and associated stack instances in the specified accounts and Regions.
Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.
updateStackSetRequest - StackSetNotFoundException - The specified stack set doesn't exist.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.OperationIdAlreadyExistsException - The specified operation ID already exists.StaleRequestException - Another operation has been performed on this stack set since the specified operation was performed.InvalidOperationException - The specified operation isn't valid.StackInstanceNotFoundException - The specified stack instance doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateStackSetResponse updateStackSet(Consumer<UpdateStackSetRequest.Builder> updateStackSetRequest) throws StackSetNotFoundException, OperationInProgressException, OperationIdAlreadyExistsException, StaleRequestException, InvalidOperationException, StackInstanceNotFoundException, AwsServiceException, SdkClientException, CloudFormationException
Updates the stack set, and associated stack instances in the specified accounts and Regions.
Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.
This is a convenience which creates an instance of the UpdateStackSetRequest.Builder avoiding the need to
create one manually via UpdateStackSetRequest.builder()
updateStackSetRequest - A Consumer that will call methods on UpdateStackSetInput.Builder to create a request.StackSetNotFoundException - The specified stack set doesn't exist.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.OperationIdAlreadyExistsException - The specified operation ID already exists.StaleRequestException - Another operation has been performed on this stack set since the specified operation was performed.InvalidOperationException - The specified operation isn't valid.StackInstanceNotFoundException - The specified stack instance doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateTerminationProtectionResponse updateTerminationProtection(UpdateTerminationProtectionRequest updateTerminationProtectionRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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 in the CloudFormation User Guide.
For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
updateTerminationProtectionRequest - SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateTerminationProtectionResponse updateTerminationProtection(Consumer<UpdateTerminationProtectionRequest.Builder> updateTerminationProtectionRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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 in the CloudFormation User Guide.
For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
This is a convenience which creates an instance of the UpdateTerminationProtectionRequest.Builder
avoiding the need to create one manually via UpdateTerminationProtectionRequest.builder()
updateTerminationProtectionRequest - A Consumer that will call methods on UpdateTerminationProtectionInput.Builder to create a
request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ValidateTemplateResponse validateTemplate(ValidateTemplateRequest validateTemplateRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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.
validateTemplateRequest - The input for ValidateTemplate action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ValidateTemplateResponse validateTemplate(Consumer<ValidateTemplateRequest.Builder> validateTemplateRequest) throws AwsServiceException, SdkClientException, CloudFormationException
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.
This is a convenience which creates an instance of the ValidateTemplateRequest.Builder avoiding the need
to create one manually via ValidateTemplateRequest.builder()
validateTemplateRequest - A Consumer that will call methods on ValidateTemplateInput.Builder to create a request.
The input for ValidateTemplate action.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudFormationException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
default CloudFormationWaiter waiter()
CloudFormationWaiter using this client.
Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
CloudFormationWaiterCopyright © 2022. All rights reserved.