Interface CloudFormationAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly reliable, highly scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services infrastructure.
With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.
For more information about CloudFormation, see the CloudFormation product page.
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionactivateOrganizationsAccess
(Consumer<ActivateOrganizationsAccessRequest.Builder> activateOrganizationsAccessRequest) Activate trusted access with Organizations.activateOrganizationsAccess
(ActivateOrganizationsAccessRequest activateOrganizationsAccessRequest) Activate trusted access with Organizations.default CompletableFuture
<ActivateTypeResponse> activateType
(Consumer<ActivateTypeRequest.Builder> activateTypeRequest) Activates a public third-party extension, making it available for use in stack templates.default CompletableFuture
<ActivateTypeResponse> activateType
(ActivateTypeRequest activateTypeRequest) Activates a public third-party extension, making it available for use in stack templates.batchDescribeTypeConfigurations
(Consumer<BatchDescribeTypeConfigurationsRequest.Builder> batchDescribeTypeConfigurationsRequest) Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region.batchDescribeTypeConfigurations
(BatchDescribeTypeConfigurationsRequest batchDescribeTypeConfigurationsRequest) Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region.builder()
Create a builder that can be used to configure and create aCloudFormationAsyncClient
.cancelUpdateStack
(Consumer<CancelUpdateStackRequest.Builder> cancelUpdateStackRequest) Cancels an update on the specified stack.cancelUpdateStack
(CancelUpdateStackRequest cancelUpdateStackRequest) Cancels an update on the specified stack.continueUpdateRollback
(Consumer<ContinueUpdateRollbackRequest.Builder> continueUpdateRollbackRequest) For a specified stack that's in theUPDATE_ROLLBACK_FAILED
state, continues rolling it back to theUPDATE_ROLLBACK_COMPLETE
state.continueUpdateRollback
(ContinueUpdateRollbackRequest continueUpdateRollbackRequest) For a specified stack that's in theUPDATE_ROLLBACK_FAILED
state, continues rolling it back to theUPDATE_ROLLBACK_COMPLETE
state.static CloudFormationAsyncClient
create()
Create aCloudFormationAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<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 CompletableFuture
<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.createGeneratedTemplate
(Consumer<CreateGeneratedTemplateRequest.Builder> createGeneratedTemplateRequest) Creates a template from existing resources that are not already managed with CloudFormation.createGeneratedTemplate
(CreateGeneratedTemplateRequest createGeneratedTemplateRequest) Creates a template from existing resources that are not already managed with CloudFormation.default CompletableFuture
<CreateStackResponse> createStack
(Consumer<CreateStackRequest.Builder> createStackRequest) Creates a stack as specified in the template.default CompletableFuture
<CreateStackResponse> createStack
(CreateStackRequest createStackRequest) Creates a stack as specified in the template.createStackInstances
(Consumer<CreateStackInstancesRequest.Builder> createStackInstancesRequest) Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions.createStackInstances
(CreateStackInstancesRequest createStackInstancesRequest) Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions.default CompletableFuture
<CreateStackSetResponse> createStackSet
(Consumer<CreateStackSetRequest.Builder> createStackSetRequest) Creates a stack set.default CompletableFuture
<CreateStackSetResponse> createStackSet
(CreateStackSetRequest createStackSetRequest) Creates a stack set.deactivateOrganizationsAccess
(Consumer<DeactivateOrganizationsAccessRequest.Builder> deactivateOrganizationsAccessRequest) Deactivates trusted access with Organizations.deactivateOrganizationsAccess
(DeactivateOrganizationsAccessRequest deactivateOrganizationsAccessRequest) Deactivates trusted access with Organizations.default CompletableFuture
<DeactivateTypeResponse> deactivateType
(Consumer<DeactivateTypeRequest.Builder> deactivateTypeRequest) Deactivates a public extension that was previously activated in this account and Region.default CompletableFuture
<DeactivateTypeResponse> deactivateType
(DeactivateTypeRequest deactivateTypeRequest) Deactivates a public extension that was previously activated in this account and Region.default CompletableFuture
<DeleteChangeSetResponse> deleteChangeSet
(Consumer<DeleteChangeSetRequest.Builder> deleteChangeSetRequest) Deletes the specified change set.default CompletableFuture
<DeleteChangeSetResponse> deleteChangeSet
(DeleteChangeSetRequest deleteChangeSetRequest) Deletes the specified change set.deleteGeneratedTemplate
(Consumer<DeleteGeneratedTemplateRequest.Builder> deleteGeneratedTemplateRequest) Deleted a generated template.deleteGeneratedTemplate
(DeleteGeneratedTemplateRequest deleteGeneratedTemplateRequest) Deleted a generated template.default CompletableFuture
<DeleteStackResponse> deleteStack
(Consumer<DeleteStackRequest.Builder> deleteStackRequest) Deletes a specified stack.default CompletableFuture
<DeleteStackResponse> deleteStack
(DeleteStackRequest deleteStackRequest) Deletes a specified stack.deleteStackInstances
(Consumer<DeleteStackInstancesRequest.Builder> deleteStackInstancesRequest) Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.deleteStackInstances
(DeleteStackInstancesRequest deleteStackInstancesRequest) Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.default CompletableFuture
<DeleteStackSetResponse> deleteStackSet
(Consumer<DeleteStackSetRequest.Builder> deleteStackSetRequest) Deletes a stack set.default CompletableFuture
<DeleteStackSetResponse> deleteStackSet
(DeleteStackSetRequest deleteStackSetRequest) Deletes a stack set.default CompletableFuture
<DeregisterTypeResponse> deregisterType
(Consumer<DeregisterTypeRequest.Builder> deregisterTypeRequest) Marks an extension or extension version asDEPRECATED
in the CloudFormation registry, removing it from active use.default CompletableFuture
<DeregisterTypeResponse> deregisterType
(DeregisterTypeRequest deregisterTypeRequest) Marks an extension or extension version asDEPRECATED
in the CloudFormation registry, removing it from active use.Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account.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.describeAccountLimits
(DescribeAccountLimitsRequest describeAccountLimitsRequest) Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account.default DescribeAccountLimitsPublisher
This is a variant ofdescribeAccountLimits(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsRequest)
operation.default DescribeAccountLimitsPublisher
describeAccountLimitsPaginator
(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest) This is a variant ofdescribeAccountLimits(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsRequest)
operation.default DescribeAccountLimitsPublisher
describeAccountLimitsPaginator
(DescribeAccountLimitsRequest describeAccountLimitsRequest) This is a variant ofdescribeAccountLimits(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsRequest)
operation.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.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.describeChangeSetHooks
(Consumer<DescribeChangeSetHooksRequest.Builder> describeChangeSetHooksRequest) Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.describeChangeSetHooks
(DescribeChangeSetHooksRequest describeChangeSetHooksRequest) Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.describeGeneratedTemplate
(Consumer<DescribeGeneratedTemplateRequest.Builder> describeGeneratedTemplateRequest) Describes a generated template.describeGeneratedTemplate
(DescribeGeneratedTemplateRequest describeGeneratedTemplateRequest) Describes a generated template.describeOrganizationsAccess
(Consumer<DescribeOrganizationsAccessRequest.Builder> describeOrganizationsAccessRequest) Retrieves information about the account'sOrganizationAccess
status.describeOrganizationsAccess
(DescribeOrganizationsAccessRequest describeOrganizationsAccessRequest) Retrieves information about the account'sOrganizationAccess
status.describePublisher
(Consumer<DescribePublisherRequest.Builder> describePublisherRequest) Returns information about a CloudFormation extension publisher.describePublisher
(DescribePublisherRequest describePublisherRequest) Returns information about a CloudFormation extension publisher.describeResourceScan
(Consumer<DescribeResourceScanRequest.Builder> describeResourceScanRequest) Describes details of a resource scan.describeResourceScan
(DescribeResourceScanRequest describeResourceScanRequest) Describes details of a resource scan.describeStackDriftDetectionStatus
(Consumer<DescribeStackDriftDetectionStatusRequest.Builder> describeStackDriftDetectionStatusRequest) Returns information about a stack drift detection operation.describeStackDriftDetectionStatus
(DescribeStackDriftDetectionStatusRequest describeStackDriftDetectionStatusRequest) Returns information about a stack drift detection operation.describeStackEvents
(Consumer<DescribeStackEventsRequest.Builder> describeStackEventsRequest) Returns all stack related events for a specified stack in reverse chronological order.describeStackEvents
(DescribeStackEventsRequest describeStackEventsRequest) Returns all stack related events for a specified stack in reverse chronological order.default DescribeStackEventsPublisher
describeStackEventsPaginator
(Consumer<DescribeStackEventsRequest.Builder> describeStackEventsRequest) This is a variant ofdescribeStackEvents(software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsRequest)
operation.default DescribeStackEventsPublisher
describeStackEventsPaginator
(DescribeStackEventsRequest describeStackEventsRequest) This is a variant ofdescribeStackEvents(software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsRequest)
operation.describeStackInstance
(Consumer<DescribeStackInstanceRequest.Builder> describeStackInstanceRequest) Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region.describeStackInstance
(DescribeStackInstanceRequest describeStackInstanceRequest) Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region.describeStackResource
(Consumer<DescribeStackResourceRequest.Builder> describeStackResourceRequest) Returns a description of the specified resource in the specified stack.describeStackResource
(DescribeStackResourceRequest describeStackResourceRequest) Returns a description of the specified resource in the specified stack.describeStackResourceDrifts
(Consumer<DescribeStackResourceDriftsRequest.Builder> describeStackResourceDriftsRequest) Returns drift information for the resources that have been checked for drift in the specified stack.describeStackResourceDrifts
(DescribeStackResourceDriftsRequest describeStackResourceDriftsRequest) Returns drift information for the resources that have been checked for drift in the specified stack.describeStackResourceDriftsPaginator
(Consumer<DescribeStackResourceDriftsRequest.Builder> describeStackResourceDriftsRequest) This is a variant ofdescribeStackResourceDrifts(software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsRequest)
operation.describeStackResourceDriftsPaginator
(DescribeStackResourceDriftsRequest describeStackResourceDriftsRequest) This is a variant ofdescribeStackResourceDrifts(software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsRequest)
operation.describeStackResources
(Consumer<DescribeStackResourcesRequest.Builder> describeStackResourcesRequest) Returns Amazon Web Services resource descriptions for running and deleted stacks.describeStackResources
(DescribeStackResourcesRequest describeStackResourcesRequest) Returns Amazon Web Services resource descriptions for running and deleted stacks.default CompletableFuture
<DescribeStacksResponse> Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.default CompletableFuture
<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 CompletableFuture
<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.describeStackSet
(Consumer<DescribeStackSetRequest.Builder> describeStackSetRequest) Returns the description of the specified StackSet.describeStackSet
(DescribeStackSetRequest describeStackSetRequest) Returns the description of the specified StackSet.describeStackSetOperation
(Consumer<DescribeStackSetOperationRequest.Builder> describeStackSetOperationRequest) Returns the description of the specified StackSet operation.describeStackSetOperation
(DescribeStackSetOperationRequest describeStackSetOperationRequest) Returns the description of the specified StackSet operation.default DescribeStacksPublisher
This is a variant ofdescribeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest)
operation.default DescribeStacksPublisher
describeStacksPaginator
(Consumer<DescribeStacksRequest.Builder> describeStacksRequest) This is a variant ofdescribeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest)
operation.default DescribeStacksPublisher
describeStacksPaginator
(DescribeStacksRequest describeStacksRequest) This is a variant ofdescribeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest)
operation.default CompletableFuture
<DescribeTypeResponse> describeType
(Consumer<DescribeTypeRequest.Builder> describeTypeRequest) Returns detailed information about an extension that has been registered.default CompletableFuture
<DescribeTypeResponse> describeType
(DescribeTypeRequest describeTypeRequest) Returns detailed information about an extension that has been registered.describeTypeRegistration
(Consumer<DescribeTypeRegistrationRequest.Builder> describeTypeRegistrationRequest) Returns information about an extension's registration, including its current status and type and version identifiers.describeTypeRegistration
(DescribeTypeRegistrationRequest describeTypeRegistrationRequest) Returns information about an extension's registration, including its current status and type and version identifiers.detectStackDrift
(Consumer<DetectStackDriftRequest.Builder> detectStackDriftRequest) Detects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters.detectStackDrift
(DetectStackDriftRequest detectStackDriftRequest) Detects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters.detectStackResourceDrift
(Consumer<DetectStackResourceDriftRequest.Builder> detectStackResourceDriftRequest) Returns information about whether a resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters.detectStackResourceDrift
(DetectStackResourceDriftRequest detectStackResourceDriftRequest) Returns information about whether a resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters.detectStackSetDrift
(Consumer<DetectStackSetDriftRequest.Builder> detectStackSetDriftRequest) Detect drift on a stack set.detectStackSetDrift
(DetectStackSetDriftRequest detectStackSetDriftRequest) Detect drift on a stack set.estimateTemplateCost
(Consumer<EstimateTemplateCostRequest.Builder> estimateTemplateCostRequest) Returns the estimated monthly cost of a template.estimateTemplateCost
(EstimateTemplateCostRequest estimateTemplateCostRequest) Returns the estimated monthly cost of a template.executeChangeSet
(Consumer<ExecuteChangeSetRequest.Builder> executeChangeSetRequest) Updates a stack using the input information that was provided when the specified change set was created.executeChangeSet
(ExecuteChangeSetRequest executeChangeSetRequest) Updates a stack using the input information that was provided when the specified change set was created.getGeneratedTemplate
(Consumer<GetGeneratedTemplateRequest.Builder> getGeneratedTemplateRequest) Retrieves a generated template.getGeneratedTemplate
(GetGeneratedTemplateRequest getGeneratedTemplateRequest) Retrieves a generated template.default CompletableFuture
<GetStackPolicyResponse> getStackPolicy
(Consumer<GetStackPolicyRequest.Builder> getStackPolicyRequest) Returns the stack policy for a specified stack.default CompletableFuture
<GetStackPolicyResponse> getStackPolicy
(GetStackPolicyRequest getStackPolicyRequest) Returns the stack policy for a specified stack.default CompletableFuture
<GetTemplateResponse> getTemplate
(Consumer<GetTemplateRequest.Builder> getTemplateRequest) Returns the template body for a specified stack.default CompletableFuture
<GetTemplateResponse> getTemplate
(GetTemplateRequest getTemplateRequest) Returns the template body for a specified stack.getTemplateSummary
(Consumer<GetTemplateSummaryRequest.Builder> getTemplateSummaryRequest) Returns information about a new or existing template.getTemplateSummary
(GetTemplateSummaryRequest getTemplateSummaryRequest) Returns information about a new or existing template.importStacksToStackSet
(Consumer<ImportStacksToStackSetRequest.Builder> importStacksToStackSetRequest) Import existing stacks into a new stack sets.importStacksToStackSet
(ImportStacksToStackSetRequest importStacksToStackSetRequest) Import existing stacks into a new stack sets.default CompletableFuture
<ListChangeSetsResponse> listChangeSets
(Consumer<ListChangeSetsRequest.Builder> listChangeSetsRequest) Returns the ID and status of each active change set for a stack.default CompletableFuture
<ListChangeSetsResponse> listChangeSets
(ListChangeSetsRequest listChangeSetsRequest) Returns the ID and status of each active change set for a stack.default ListChangeSetsPublisher
listChangeSetsPaginator
(Consumer<ListChangeSetsRequest.Builder> listChangeSetsRequest) This is a variant oflistChangeSets(software.amazon.awssdk.services.cloudformation.model.ListChangeSetsRequest)
operation.default ListChangeSetsPublisher
listChangeSetsPaginator
(ListChangeSetsRequest listChangeSetsRequest) This is a variant oflistChangeSets(software.amazon.awssdk.services.cloudformation.model.ListChangeSetsRequest)
operation.default CompletableFuture
<ListExportsResponse> Lists all exported output values in the account and Region in which you call this action.default CompletableFuture
<ListExportsResponse> listExports
(Consumer<ListExportsRequest.Builder> listExportsRequest) Lists all exported output values in the account and Region in which you call this action.default CompletableFuture
<ListExportsResponse> listExports
(ListExportsRequest listExportsRequest) Lists all exported output values in the account and Region in which you call this action.default ListExportsPublisher
This is a variant oflistExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest)
operation.default ListExportsPublisher
listExportsPaginator
(Consumer<ListExportsRequest.Builder> listExportsRequest) This is a variant oflistExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest)
operation.default ListExportsPublisher
listExportsPaginator
(ListExportsRequest listExportsRequest) This is a variant oflistExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest)
operation.listGeneratedTemplates
(Consumer<ListGeneratedTemplatesRequest.Builder> listGeneratedTemplatesRequest) Lists your generated templates in this Region.listGeneratedTemplates
(ListGeneratedTemplatesRequest listGeneratedTemplatesRequest) Lists your generated templates in this Region.default ListGeneratedTemplatesPublisher
listGeneratedTemplatesPaginator
(Consumer<ListGeneratedTemplatesRequest.Builder> listGeneratedTemplatesRequest) This is a variant oflistGeneratedTemplates(software.amazon.awssdk.services.cloudformation.model.ListGeneratedTemplatesRequest)
operation.default ListGeneratedTemplatesPublisher
listGeneratedTemplatesPaginator
(ListGeneratedTemplatesRequest listGeneratedTemplatesRequest) This is a variant oflistGeneratedTemplates(software.amazon.awssdk.services.cloudformation.model.ListGeneratedTemplatesRequest)
operation.default CompletableFuture
<ListImportsResponse> listImports
(Consumer<ListImportsRequest.Builder> listImportsRequest) Lists all stacks that are importing an exported output value.default CompletableFuture
<ListImportsResponse> listImports
(ListImportsRequest listImportsRequest) Lists all stacks that are importing an exported output value.default ListImportsPublisher
listImportsPaginator
(Consumer<ListImportsRequest.Builder> listImportsRequest) This is a variant oflistImports(software.amazon.awssdk.services.cloudformation.model.ListImportsRequest)
operation.default ListImportsPublisher
listImportsPaginator
(ListImportsRequest listImportsRequest) This is a variant oflistImports(software.amazon.awssdk.services.cloudformation.model.ListImportsRequest)
operation.listResourceScanRelatedResources
(Consumer<ListResourceScanRelatedResourcesRequest.Builder> listResourceScanRelatedResourcesRequest) Lists the related resources for a list of resources from a resource scan.listResourceScanRelatedResources
(ListResourceScanRelatedResourcesRequest listResourceScanRelatedResourcesRequest) Lists the related resources for a list of resources from a resource scan.listResourceScanRelatedResourcesPaginator
(Consumer<ListResourceScanRelatedResourcesRequest.Builder> listResourceScanRelatedResourcesRequest) This is a variant oflistResourceScanRelatedResources(software.amazon.awssdk.services.cloudformation.model.ListResourceScanRelatedResourcesRequest)
operation.listResourceScanRelatedResourcesPaginator
(ListResourceScanRelatedResourcesRequest listResourceScanRelatedResourcesRequest) This is a variant oflistResourceScanRelatedResources(software.amazon.awssdk.services.cloudformation.model.ListResourceScanRelatedResourcesRequest)
operation.listResourceScanResources
(Consumer<ListResourceScanResourcesRequest.Builder> listResourceScanResourcesRequest) Lists the resources from a resource scan.listResourceScanResources
(ListResourceScanResourcesRequest listResourceScanResourcesRequest) Lists the resources from a resource scan.listResourceScanResourcesPaginator
(Consumer<ListResourceScanResourcesRequest.Builder> listResourceScanResourcesRequest) This is a variant oflistResourceScanResources(software.amazon.awssdk.services.cloudformation.model.ListResourceScanResourcesRequest)
operation.listResourceScanResourcesPaginator
(ListResourceScanResourcesRequest listResourceScanResourcesRequest) This is a variant oflistResourceScanResources(software.amazon.awssdk.services.cloudformation.model.ListResourceScanResourcesRequest)
operation.listResourceScans
(Consumer<ListResourceScansRequest.Builder> listResourceScansRequest) List the resource scans from newest to oldest.listResourceScans
(ListResourceScansRequest listResourceScansRequest) List the resource scans from newest to oldest.default ListResourceScansPublisher
listResourceScansPaginator
(Consumer<ListResourceScansRequest.Builder> listResourceScansRequest) This is a variant oflistResourceScans(software.amazon.awssdk.services.cloudformation.model.ListResourceScansRequest)
operation.default ListResourceScansPublisher
listResourceScansPaginator
(ListResourceScansRequest listResourceScansRequest) This is a variant oflistResourceScans(software.amazon.awssdk.services.cloudformation.model.ListResourceScansRequest)
operation.listStackInstanceResourceDrifts
(Consumer<ListStackInstanceResourceDriftsRequest.Builder> listStackInstanceResourceDriftsRequest) Returns drift information for resources in a stack instance.listStackInstanceResourceDrifts
(ListStackInstanceResourceDriftsRequest listStackInstanceResourceDriftsRequest) Returns drift information for resources in a stack instance.listStackInstances
(Consumer<ListStackInstancesRequest.Builder> listStackInstancesRequest) Returns summary information about stack instances that are associated with the specified stack set.listStackInstances
(ListStackInstancesRequest listStackInstancesRequest) Returns summary information about stack instances that are associated with the specified stack set.default ListStackInstancesPublisher
listStackInstancesPaginator
(Consumer<ListStackInstancesRequest.Builder> listStackInstancesRequest) This is a variant oflistStackInstances(software.amazon.awssdk.services.cloudformation.model.ListStackInstancesRequest)
operation.default ListStackInstancesPublisher
listStackInstancesPaginator
(ListStackInstancesRequest listStackInstancesRequest) This is a variant oflistStackInstances(software.amazon.awssdk.services.cloudformation.model.ListStackInstancesRequest)
operation.listStackResources
(Consumer<ListStackResourcesRequest.Builder> listStackResourcesRequest) Returns descriptions of all resources of the specified stack.listStackResources
(ListStackResourcesRequest listStackResourcesRequest) Returns descriptions of all resources of the specified stack.default ListStackResourcesPublisher
listStackResourcesPaginator
(Consumer<ListStackResourcesRequest.Builder> listStackResourcesRequest) This is a variant oflistStackResources(software.amazon.awssdk.services.cloudformation.model.ListStackResourcesRequest)
operation.default ListStackResourcesPublisher
listStackResourcesPaginator
(ListStackResourcesRequest listStackResourcesRequest) This is a variant oflistStackResources(software.amazon.awssdk.services.cloudformation.model.ListStackResourcesRequest)
operation.default CompletableFuture
<ListStacksResponse> Returns the summary information for stacks whose status matches the specified StackStatusFilter.default CompletableFuture
<ListStacksResponse> listStacks
(Consumer<ListStacksRequest.Builder> listStacksRequest) Returns the summary information for stacks whose status matches the specified StackStatusFilter.default CompletableFuture
<ListStacksResponse> listStacks
(ListStacksRequest listStacksRequest) Returns the summary information for stacks whose status matches the specified StackStatusFilter.listStackSetAutoDeploymentTargets
(Consumer<ListStackSetAutoDeploymentTargetsRequest.Builder> listStackSetAutoDeploymentTargetsRequest) Returns summary information about deployment targets for a stack set.listStackSetAutoDeploymentTargets
(ListStackSetAutoDeploymentTargetsRequest listStackSetAutoDeploymentTargetsRequest) Returns summary information about deployment targets for a stack set.listStackSetOperationResults
(Consumer<ListStackSetOperationResultsRequest.Builder> listStackSetOperationResultsRequest) Returns summary information about the results of a stack set operation.listStackSetOperationResults
(ListStackSetOperationResultsRequest listStackSetOperationResultsRequest) Returns summary information about the results of a stack set operation.listStackSetOperationResultsPaginator
(Consumer<ListStackSetOperationResultsRequest.Builder> listStackSetOperationResultsRequest) This is a variant oflistStackSetOperationResults(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsRequest)
operation.listStackSetOperationResultsPaginator
(ListStackSetOperationResultsRequest listStackSetOperationResultsRequest) This is a variant oflistStackSetOperationResults(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsRequest)
operation.listStackSetOperations
(Consumer<ListStackSetOperationsRequest.Builder> listStackSetOperationsRequest) Returns summary information about operations performed on a stack set.listStackSetOperations
(ListStackSetOperationsRequest listStackSetOperationsRequest) Returns summary information about operations performed on a stack set.default ListStackSetOperationsPublisher
listStackSetOperationsPaginator
(Consumer<ListStackSetOperationsRequest.Builder> listStackSetOperationsRequest) This is a variant oflistStackSetOperations(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsRequest)
operation.default ListStackSetOperationsPublisher
listStackSetOperationsPaginator
(ListStackSetOperationsRequest listStackSetOperationsRequest) This is a variant oflistStackSetOperations(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsRequest)
operation.default CompletableFuture
<ListStackSetsResponse> Returns summary information about stack sets that are associated with the user.default CompletableFuture
<ListStackSetsResponse> listStackSets
(Consumer<ListStackSetsRequest.Builder> listStackSetsRequest) Returns summary information about stack sets that are associated with the user.default CompletableFuture
<ListStackSetsResponse> listStackSets
(ListStackSetsRequest listStackSetsRequest) Returns summary information about stack sets that are associated with the user.default ListStackSetsPublisher
This is a variant oflistStackSets(software.amazon.awssdk.services.cloudformation.model.ListStackSetsRequest)
operation.default ListStackSetsPublisher
listStackSetsPaginator
(Consumer<ListStackSetsRequest.Builder> listStackSetsRequest) This is a variant oflistStackSets(software.amazon.awssdk.services.cloudformation.model.ListStackSetsRequest)
operation.default ListStackSetsPublisher
listStackSetsPaginator
(ListStackSetsRequest listStackSetsRequest) This is a variant oflistStackSets(software.amazon.awssdk.services.cloudformation.model.ListStackSetsRequest)
operation.default ListStacksPublisher
This is a variant oflistStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest)
operation.default ListStacksPublisher
listStacksPaginator
(Consumer<ListStacksRequest.Builder> listStacksRequest) This is a variant oflistStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest)
operation.default ListStacksPublisher
listStacksPaginator
(ListStacksRequest listStacksRequest) This is a variant oflistStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest)
operation.listTypeRegistrations
(Consumer<ListTypeRegistrationsRequest.Builder> listTypeRegistrationsRequest) Returns a list of registration tokens for the specified extension(s).listTypeRegistrations
(ListTypeRegistrationsRequest listTypeRegistrationsRequest) Returns a list of registration tokens for the specified extension(s).default ListTypeRegistrationsPublisher
listTypeRegistrationsPaginator
(Consumer<ListTypeRegistrationsRequest.Builder> listTypeRegistrationsRequest) This is a variant oflistTypeRegistrations(software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsRequest)
operation.default ListTypeRegistrationsPublisher
listTypeRegistrationsPaginator
(ListTypeRegistrationsRequest listTypeRegistrationsRequest) This is a variant oflistTypeRegistrations(software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsRequest)
operation.default CompletableFuture
<ListTypesResponse> listTypes
(Consumer<ListTypesRequest.Builder> listTypesRequest) Returns summary information about extension that have been registered with CloudFormation.default CompletableFuture
<ListTypesResponse> listTypes
(ListTypesRequest listTypesRequest) Returns summary information about extension that have been registered with CloudFormation.default ListTypesPublisher
listTypesPaginator
(Consumer<ListTypesRequest.Builder> listTypesRequest) This is a variant oflistTypes(software.amazon.awssdk.services.cloudformation.model.ListTypesRequest)
operation.default ListTypesPublisher
listTypesPaginator
(ListTypesRequest listTypesRequest) This is a variant oflistTypes(software.amazon.awssdk.services.cloudformation.model.ListTypesRequest)
operation.listTypeVersions
(Consumer<ListTypeVersionsRequest.Builder> listTypeVersionsRequest) Returns summary information about the versions of an extension.listTypeVersions
(ListTypeVersionsRequest listTypeVersionsRequest) Returns summary information about the versions of an extension.default ListTypeVersionsPublisher
listTypeVersionsPaginator
(Consumer<ListTypeVersionsRequest.Builder> listTypeVersionsRequest) This is a variant oflistTypeVersions(software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsRequest)
operation.default ListTypeVersionsPublisher
listTypeVersionsPaginator
(ListTypeVersionsRequest listTypeVersionsRequest) This is a variant oflistTypeVersions(software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsRequest)
operation.default CompletableFuture
<PublishTypeResponse> publishType
(Consumer<PublishTypeRequest.Builder> publishTypeRequest) Publishes the specified extension to the CloudFormation registry as a public extension in this Region.default CompletableFuture
<PublishTypeResponse> publishType
(PublishTypeRequest publishTypeRequest) Publishes the specified extension to the CloudFormation registry as a public extension in this Region.recordHandlerProgress
(Consumer<RecordHandlerProgressRequest.Builder> recordHandlerProgressRequest) Reports progress of a resource handler to CloudFormation.recordHandlerProgress
(RecordHandlerProgressRequest recordHandlerProgressRequest) Reports progress of a resource handler to CloudFormation.registerPublisher
(Consumer<RegisterPublisherRequest.Builder> registerPublisherRequest) Registers your account as a publisher of public extensions in the CloudFormation registry.registerPublisher
(RegisterPublisherRequest registerPublisherRequest) Registers your account as a publisher of public extensions in the CloudFormation registry.default CompletableFuture
<RegisterTypeResponse> registerType
(Consumer<RegisterTypeRequest.Builder> registerTypeRequest) Registers an extension with the CloudFormation service.default CompletableFuture
<RegisterTypeResponse> registerType
(RegisterTypeRequest registerTypeRequest) Registers an extension with the CloudFormation service.default CompletableFuture
<RollbackStackResponse> rollbackStack
(Consumer<RollbackStackRequest.Builder> rollbackStackRequest) When specifyingRollbackStack
, you preserve the state of previously provisioned resources when an operation fails.default CompletableFuture
<RollbackStackResponse> rollbackStack
(RollbackStackRequest rollbackStackRequest) When specifyingRollbackStack
, you preserve the state of previously provisioned resources when an operation fails.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<SetStackPolicyResponse> setStackPolicy
(Consumer<SetStackPolicyRequest.Builder> setStackPolicyRequest) Sets a stack policy for a specified stack.default CompletableFuture
<SetStackPolicyResponse> setStackPolicy
(SetStackPolicyRequest setStackPolicyRequest) Sets a stack policy for a specified stack.setTypeConfiguration
(Consumer<SetTypeConfigurationRequest.Builder> setTypeConfigurationRequest) Specifies the configuration data for a registered CloudFormation extension, in the given account and Region.setTypeConfiguration
(SetTypeConfigurationRequest setTypeConfigurationRequest) Specifies the configuration data for a registered CloudFormation extension, in the given account and Region.setTypeDefaultVersion
(Consumer<SetTypeDefaultVersionRequest.Builder> setTypeDefaultVersionRequest) Specify the default version of an extension.setTypeDefaultVersion
(SetTypeDefaultVersionRequest setTypeDefaultVersionRequest) Specify the default version of an extension.default CompletableFuture
<SignalResourceResponse> signalResource
(Consumer<SignalResourceRequest.Builder> signalResourceRequest) Sends a signal to the specified resource with a success or failure status.default CompletableFuture
<SignalResourceResponse> signalResource
(SignalResourceRequest signalResourceRequest) Sends a signal to the specified resource with a success or failure status.startResourceScan
(Consumer<StartResourceScanRequest.Builder> startResourceScanRequest) Starts a scan of the resources in this account in this Region.startResourceScan
(StartResourceScanRequest startResourceScanRequest) Starts a scan of the resources in this account in this Region.stopStackSetOperation
(Consumer<StopStackSetOperationRequest.Builder> stopStackSetOperationRequest) Stops an in-progress operation on a stack set and its associated stack instances.stopStackSetOperation
(StopStackSetOperationRequest stopStackSetOperationRequest) Stops an in-progress operation on a stack set and its associated stack instances.default CompletableFuture
<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 CompletableFuture
<TestTypeResponse> testType
(TestTypeRequest testTypeRequest) Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.updateGeneratedTemplate
(Consumer<UpdateGeneratedTemplateRequest.Builder> updateGeneratedTemplateRequest) Updates a generated template.updateGeneratedTemplate
(UpdateGeneratedTemplateRequest updateGeneratedTemplateRequest) Updates a generated template.default CompletableFuture
<UpdateStackResponse> updateStack
(Consumer<UpdateStackRequest.Builder> updateStackRequest) Updates a stack as specified in the template.default CompletableFuture
<UpdateStackResponse> updateStack
(UpdateStackRequest updateStackRequest) Updates a stack as specified in the template.updateStackInstances
(Consumer<UpdateStackInstancesRequest.Builder> updateStackInstancesRequest) Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions.updateStackInstances
(UpdateStackInstancesRequest updateStackInstancesRequest) Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions.default CompletableFuture
<UpdateStackSetResponse> updateStackSet
(Consumer<UpdateStackSetRequest.Builder> updateStackSetRequest) Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.default CompletableFuture
<UpdateStackSetResponse> updateStackSet
(UpdateStackSetRequest updateStackSetRequest) Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.updateTerminationProtection
(Consumer<UpdateTerminationProtectionRequest.Builder> updateTerminationProtectionRequest) Updates termination protection for the specified stack.updateTerminationProtection
(UpdateTerminationProtectionRequest updateTerminationProtectionRequest) Updates termination protection for the specified stack.validateTemplate
(Consumer<ValidateTemplateRequest.Builder> validateTemplateRequest) Validates a specified template.validateTemplate
(ValidateTemplateRequest validateTemplateRequest) Validates a specified template.default CloudFormationAsyncWaiter
waiter()
Create an instance ofCloudFormationAsyncWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
activateOrganizationsAccess
default CompletableFuture<ActivateOrganizationsAccessResponse> activateOrganizationsAccess(ActivateOrganizationsAccessRequest activateOrganizationsAccessRequest) Activate trusted access with Organizations. With trusted access between StackSets and Organizations activated, the management account has permissions to create and manage StackSets for your organization.
- Parameters:
activateOrganizationsAccessRequest
-- Returns:
- A Java Future containing the result of the ActivateOrganizationsAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidOperationException The specified operation isn't valid.
- 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.
- See Also:
-
activateOrganizationsAccess
default CompletableFuture<ActivateOrganizationsAccessResponse> activateOrganizationsAccess(Consumer<ActivateOrganizationsAccessRequest.Builder> activateOrganizationsAccessRequest) Activate trusted access with Organizations. With trusted access between StackSets and Organizations activated, the management account has permissions to create and manage StackSets for your organization.
This is a convenience which creates an instance of the
ActivateOrganizationsAccessRequest.Builder
avoiding the need to create one manually viaActivateOrganizationsAccessRequest.builder()
- Parameters:
activateOrganizationsAccessRequest
- AConsumer
that will call methods onActivateOrganizationsAccessRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ActivateOrganizationsAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidOperationException The specified operation isn't valid.
- 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.
- See Also:
-
activateType
default CompletableFuture<ActivateTypeResponse> activateType(ActivateTypeRequest activateTypeRequest) 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.
- Parameters:
activateTypeRequest
-- Returns:
- A Java Future containing the result of the ActivateType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CfnRegistryException An error occurred during a CloudFormation registry operation.
- TypeNotFoundException The specified extension doesn't 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.
- See Also:
-
activateType
default CompletableFuture<ActivateTypeResponse> activateType(Consumer<ActivateTypeRequest.Builder> activateTypeRequest) 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 viaActivateTypeRequest.builder()
- Parameters:
activateTypeRequest
- AConsumer
that will call methods onActivateTypeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ActivateType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CfnRegistryException An error occurred during a CloudFormation registry operation.
- TypeNotFoundException The specified extension doesn't 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.
- See Also:
-
batchDescribeTypeConfigurations
default CompletableFuture<BatchDescribeTypeConfigurationsResponse> batchDescribeTypeConfigurations(BatchDescribeTypeConfigurationsRequest batchDescribeTypeConfigurationsRequest) 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.
- Parameters:
batchDescribeTypeConfigurationsRequest
-- Returns:
- A Java Future containing the result of the BatchDescribeTypeConfigurations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TypeConfigurationNotFoundException The specified extension configuration can't 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.
- See Also:
-
batchDescribeTypeConfigurations
default CompletableFuture<BatchDescribeTypeConfigurationsResponse> batchDescribeTypeConfigurations(Consumer<BatchDescribeTypeConfigurationsRequest.Builder> batchDescribeTypeConfigurationsRequest) 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 viaBatchDescribeTypeConfigurationsRequest.builder()
- Parameters:
batchDescribeTypeConfigurationsRequest
- AConsumer
that will call methods onBatchDescribeTypeConfigurationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchDescribeTypeConfigurations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TypeConfigurationNotFoundException The specified extension configuration can't 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.
- See Also:
-
cancelUpdateStack
default CompletableFuture<CancelUpdateStackResponse> cancelUpdateStack(CancelUpdateStackRequest cancelUpdateStackRequest) 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.- Parameters:
cancelUpdateStackRequest
- The input for the CancelUpdateStack action.- Returns:
- A Java Future containing the result of the CancelUpdateStack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
cancelUpdateStack
default CompletableFuture<CancelUpdateStackResponse> cancelUpdateStack(Consumer<CancelUpdateStackRequest.Builder> cancelUpdateStackRequest) 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 viaCancelUpdateStackRequest.builder()
- Parameters:
cancelUpdateStackRequest
- AConsumer
that will call methods onCancelUpdateStackRequest.Builder
to create a request. The input for the CancelUpdateStack action.- Returns:
- A Java Future containing the result of the CancelUpdateStack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
continueUpdateRollback
default CompletableFuture<ContinueUpdateRollbackResponse> continueUpdateRollback(ContinueUpdateRollbackRequest continueUpdateRollbackRequest) For a specified stack that's in the
UPDATE_ROLLBACK_FAILED
state, continues rolling it back to theUPDATE_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 (theUPDATE_ROLLBACK_COMPLETE
state), and then try to update the stack again.A stack goes into the
UPDATE_ROLLBACK_FAILED
state when CloudFormation can't roll back all changes after a failed stack update. For example, you might have a stack that's rolling back to an old database instance that was deleted outside of CloudFormation. Because CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail.- Parameters:
continueUpdateRollbackRequest
- The input for the ContinueUpdateRollback action.- Returns:
- A Java Future containing the result of the ContinueUpdateRollback operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
continueUpdateRollback
default CompletableFuture<ContinueUpdateRollbackResponse> continueUpdateRollback(Consumer<ContinueUpdateRollbackRequest.Builder> continueUpdateRollbackRequest) For a specified stack that's in the
UPDATE_ROLLBACK_FAILED
state, continues rolling it back to theUPDATE_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 (theUPDATE_ROLLBACK_COMPLETE
state), and then try to update the stack again.A stack goes into the
UPDATE_ROLLBACK_FAILED
state when CloudFormation can't roll back all changes after a failed stack update. For example, you might have a stack that's rolling back to an old database instance that was deleted outside of CloudFormation. Because CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail.
This is a convenience which creates an instance of the
ContinueUpdateRollbackRequest.Builder
avoiding the need to create one manually viaContinueUpdateRollbackRequest.builder()
- Parameters:
continueUpdateRollbackRequest
- AConsumer
that will call methods onContinueUpdateRollbackRequest.Builder
to create a request. The input for the ContinueUpdateRollback action.- Returns:
- A Java Future containing the result of the ContinueUpdateRollback operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
createChangeSet
default CompletableFuture<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. 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, specifyCREATE
. To create a change set for an existing stack, specifyUPDATE
for theChangeSetType
parameter. To create a change set for an import operation, specifyIMPORT
for theChangeSetType
parameter. After theCreateChangeSet
call successfully completes, CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet action.When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. CloudFormation doesn't make changes until you execute the change set.
To create a change set for the entire stack hierarchy, set
IncludeNestedStacks
toTrue
.- Parameters:
createChangeSetRequest
- The input for the CreateChangeSet action.- Returns:
- A Java Future containing the result of the CreateChangeSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 about resource and stack limitations, see CloudFormation quotas 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.
- See Also:
-
createChangeSet
default CompletableFuture<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. 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, specifyCREATE
. To create a change set for an existing stack, specifyUPDATE
for theChangeSetType
parameter. To create a change set for an import operation, specifyIMPORT
for theChangeSetType
parameter. After theCreateChangeSet
call successfully completes, CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet action.When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. CloudFormation doesn't make changes until you execute the change set.
To create a change set for the entire stack hierarchy, set
IncludeNestedStacks
toTrue
.
This is a convenience which creates an instance of the
CreateChangeSetRequest.Builder
avoiding the need to create one manually viaCreateChangeSetRequest.builder()
- Parameters:
createChangeSetRequest
- AConsumer
that will call methods onCreateChangeSetRequest.Builder
to create a request. The input for the CreateChangeSet action.- Returns:
- A Java Future containing the result of the CreateChangeSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 about resource and stack limitations, see CloudFormation quotas 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.
- See Also:
-
createGeneratedTemplate
default CompletableFuture<CreateGeneratedTemplateResponse> createGeneratedTemplate(CreateGeneratedTemplateRequest createGeneratedTemplateRequest) Creates a template from existing resources that are not already managed with CloudFormation. You can check the status of the template generation using the
DescribeGeneratedTemplate
API action.- Parameters:
createGeneratedTemplateRequest
-- Returns:
- A Java Future containing the result of the CreateGeneratedTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AlreadyExistsException The resource with the name requested already exists.
- LimitExceededException The quota for the resource has already been reached.
For information about resource and stack limitations, see CloudFormation quotas in the CloudFormation User Guide.
- ConcurrentResourcesLimitExceededException No more than 5 generated templates can be in an
InProgress
orPending
status at one time. This error is also returned if a generated template that is in anInProgress
orPending
status is attempted to be updated or 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.
- See Also:
-
createGeneratedTemplate
default CompletableFuture<CreateGeneratedTemplateResponse> createGeneratedTemplate(Consumer<CreateGeneratedTemplateRequest.Builder> createGeneratedTemplateRequest) Creates a template from existing resources that are not already managed with CloudFormation. You can check the status of the template generation using the
DescribeGeneratedTemplate
API action.
This is a convenience which creates an instance of the
CreateGeneratedTemplateRequest.Builder
avoiding the need to create one manually viaCreateGeneratedTemplateRequest.builder()
- Parameters:
createGeneratedTemplateRequest
- AConsumer
that will call methods onCreateGeneratedTemplateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateGeneratedTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AlreadyExistsException The resource with the name requested already exists.
- LimitExceededException The quota for the resource has already been reached.
For information about resource and stack limitations, see CloudFormation quotas in the CloudFormation User Guide.
- ConcurrentResourcesLimitExceededException No more than 5 generated templates can be in an
InProgress
orPending
status at one time. This error is also returned if a generated template that is in anInProgress
orPending
status is attempted to be updated or 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.
- See Also:
-
createStack
Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack through the DescribeStacks operation.
- Parameters:
createStackRequest
- The input for CreateStack action.- Returns:
- A Java Future containing the result of the CreateStack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- LimitExceededException The quota for the resource has already been reached.
For information about resource and stack limitations, see CloudFormation quotas 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.
- LimitExceededException The quota for the resource has already been reached.
- See Also:
-
createStack
default CompletableFuture<CreateStackResponse> createStack(Consumer<CreateStackRequest.Builder> createStackRequest) Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack through the DescribeStacks operation.
This is a convenience which creates an instance of the
CreateStackRequest.Builder
avoiding the need to create one manually viaCreateStackRequest.builder()
- Parameters:
createStackRequest
- AConsumer
that will call methods onCreateStackRequest.Builder
to create a request. The input for CreateStack action.- Returns:
- A Java Future containing the result of the CreateStack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- LimitExceededException The quota for the resource has already been reached.
For information about resource and stack limitations, see CloudFormation quotas 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.
- LimitExceededException The quota for the resource has already been reached.
- See Also:
-
createStackInstances
default CompletableFuture<CreateStackInstancesResponse> createStackInstances(CreateStackInstancesRequest createStackInstancesRequest) Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region. You must specify at least one value for either
Accounts
orDeploymentTargets
, and you must specify at least one value forRegions
.- Parameters:
createStackInstancesRequest
-- Returns:
- A Java Future containing the result of the CreateStackInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 about resource and stack limitations, see CloudFormation quotas 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.
- See Also:
-
createStackInstances
default CompletableFuture<CreateStackInstancesResponse> createStackInstances(Consumer<CreateStackInstancesRequest.Builder> createStackInstancesRequest) Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region. You must specify at least one value for either
Accounts
orDeploymentTargets
, and you must specify at least one value forRegions
.
This is a convenience which creates an instance of the
CreateStackInstancesRequest.Builder
avoiding the need to create one manually viaCreateStackInstancesRequest.builder()
- Parameters:
createStackInstancesRequest
- AConsumer
that will call methods onCreateStackInstancesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateStackInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 about resource and stack limitations, see CloudFormation quotas 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.
- See Also:
-
createStackSet
default CompletableFuture<CreateStackSetResponse> createStackSet(CreateStackSetRequest createStackSetRequest) Creates a stack set.
- Parameters:
createStackSetRequest
-- Returns:
- A Java Future containing the result of the CreateStackSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 about resource and stack limitations, see CloudFormation quotas 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.
- See Also:
-
createStackSet
default CompletableFuture<CreateStackSetResponse> createStackSet(Consumer<CreateStackSetRequest.Builder> createStackSetRequest) Creates a stack set.
This is a convenience which creates an instance of the
CreateStackSetRequest.Builder
avoiding the need to create one manually viaCreateStackSetRequest.builder()
- Parameters:
createStackSetRequest
- AConsumer
that will call methods onCreateStackSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateStackSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 about resource and stack limitations, see CloudFormation quotas 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.
- See Also:
-
deactivateOrganizationsAccess
default CompletableFuture<DeactivateOrganizationsAccessResponse> deactivateOrganizationsAccess(DeactivateOrganizationsAccessRequest deactivateOrganizationsAccessRequest) Deactivates trusted access with Organizations. If trusted access is deactivated, the management account does not have permissions to create and manage service-managed StackSets for your organization.
- Parameters:
deactivateOrganizationsAccessRequest
-- Returns:
- A Java Future containing the result of the DeactivateOrganizationsAccess operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidOperationException The specified operation isn't valid.
- 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.
- See Also:
-
deactivateOrganizationsAccess
default CompletableFuture<DeactivateOrganizationsAccessResponse> deactivateOrganizationsAccess(Consumer<DeactivateOrganizationsAccessRequest.Builder> deactivateOrganizationsAccessRequest) Deactivates trusted access with Organizations. If trusted access is deactivated, the management account does not have permissions to create and manage service-managed StackSets for your organization.
This is a convenience which creates an instance of the
DeactivateOrganizationsAccessRequest.Builder
avoiding the need to create one manually viaDeactivateOrganizationsAccessRequest.builder()
- Parameters:
deactivateOrganizationsAccessRequest
- AConsumer
that will call methods onDeactivateOrganizationsAccessRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeactivateOrganizationsAccess operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidOperationException The specified operation isn't valid.
- 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.
- See Also:
-
deactivateType
default CompletableFuture<DeactivateTypeResponse> deactivateType(DeactivateTypeRequest deactivateTypeRequest) Deactivates a public extension that was previously activated in this account and Region.
Once deactivated, an extension can't be used in any CloudFormation operation. This includes stack update operations where the stack template includes the extension, even if no updates are being made to the extension. In addition, deactivated extensions aren't automatically updated if a new version of the extension is released.
- Parameters:
deactivateTypeRequest
-- Returns:
- A Java Future containing the result of the DeactivateType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CfnRegistryException An error occurred during a CloudFormation registry operation.
- TypeNotFoundException The specified extension doesn't 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.
- See Also:
-
deactivateType
default CompletableFuture<DeactivateTypeResponse> deactivateType(Consumer<DeactivateTypeRequest.Builder> deactivateTypeRequest) Deactivates a public extension that was previously activated in this account and Region.
Once deactivated, an extension can't be used in any CloudFormation operation. This includes stack update operations where the stack template includes the extension, even if no updates are being made to the extension. In addition, deactivated extensions aren't automatically updated if a new version of the extension is released.
This is a convenience which creates an instance of the
DeactivateTypeRequest.Builder
avoiding the need to create one manually viaDeactivateTypeRequest.builder()
- Parameters:
deactivateTypeRequest
- AConsumer
that will call methods onDeactivateTypeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeactivateType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CfnRegistryException An error occurred during a CloudFormation registry operation.
- TypeNotFoundException The specified extension doesn't 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.
- See Also:
-
deleteChangeSet
default CompletableFuture<DeleteChangeSetResponse> deleteChangeSet(DeleteChangeSetRequest deleteChangeSetRequest) 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
specifiesTrue
during the creation of the nested change set, thenDeleteChangeSet
will delete all change sets that belong to the stacks hierarchy and will also delete all change sets for nested stacks with the status ofREVIEW_IN_PROGRESS
.- Parameters:
deleteChangeSetRequest
- The input for the DeleteChangeSet action.- Returns:
- A Java Future containing the result of the DeleteChangeSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 beUPDATE_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.
- InvalidChangeSetStatusException The specified change set can't be used to update the stack. For
example, the change set status might be
- See Also:
-
deleteChangeSet
default CompletableFuture<DeleteChangeSetResponse> deleteChangeSet(Consumer<DeleteChangeSetRequest.Builder> deleteChangeSetRequest) 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
specifiesTrue
during the creation of the nested change set, thenDeleteChangeSet
will delete all change sets that belong to the stacks hierarchy and will also delete all change sets for nested stacks with the status ofREVIEW_IN_PROGRESS
.
This is a convenience which creates an instance of the
DeleteChangeSetRequest.Builder
avoiding the need to create one manually viaDeleteChangeSetRequest.builder()
- Parameters:
deleteChangeSetRequest
- AConsumer
that will call methods onDeleteChangeSetRequest.Builder
to create a request. The input for the DeleteChangeSet action.- Returns:
- A Java Future containing the result of the DeleteChangeSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 beUPDATE_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.
- InvalidChangeSetStatusException The specified change set can't be used to update the stack. For
example, the change set status might be
- See Also:
-
deleteGeneratedTemplate
default CompletableFuture<DeleteGeneratedTemplateResponse> deleteGeneratedTemplate(DeleteGeneratedTemplateRequest deleteGeneratedTemplateRequest) Deleted a generated template.
- Parameters:
deleteGeneratedTemplateRequest
-- Returns:
- A Java Future containing the result of the DeleteGeneratedTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- GeneratedTemplateNotFoundException The generated template was not found.
- ConcurrentResourcesLimitExceededException No more than 5 generated templates can be in an
InProgress
orPending
status at one time. This error is also returned if a generated template that is in anInProgress
orPending
status is attempted to be updated or 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.
- See Also:
-
deleteGeneratedTemplate
default CompletableFuture<DeleteGeneratedTemplateResponse> deleteGeneratedTemplate(Consumer<DeleteGeneratedTemplateRequest.Builder> deleteGeneratedTemplateRequest) Deleted a generated template.
This is a convenience which creates an instance of the
DeleteGeneratedTemplateRequest.Builder
avoiding the need to create one manually viaDeleteGeneratedTemplateRequest.builder()
- Parameters:
deleteGeneratedTemplateRequest
- AConsumer
that will call methods onDeleteGeneratedTemplateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteGeneratedTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- GeneratedTemplateNotFoundException The generated template was not found.
- ConcurrentResourcesLimitExceededException No more than 5 generated templates can be in an
InProgress
orPending
status at one time. This error is also returned if a generated template that is in anInProgress
orPending
status is attempted to be updated or 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.
- See Also:
-
deleteStack
Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't show up in the DescribeStacks operation if the deletion has been completed successfully.
- Parameters:
deleteStackRequest
- The input for DeleteStack action.- Returns:
- A Java Future containing the result of the DeleteStack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
deleteStack
default CompletableFuture<DeleteStackResponse> deleteStack(Consumer<DeleteStackRequest.Builder> deleteStackRequest) Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't show up in the DescribeStacks operation if the deletion has been completed successfully.
This is a convenience which creates an instance of the
DeleteStackRequest.Builder
avoiding the need to create one manually viaDeleteStackRequest.builder()
- Parameters:
deleteStackRequest
- AConsumer
that will call methods onDeleteStackRequest.Builder
to create a request. The input for DeleteStack action.- Returns:
- A Java Future containing the result of the DeleteStack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
deleteStackInstances
default CompletableFuture<DeleteStackInstancesResponse> deleteStackInstances(DeleteStackInstancesRequest deleteStackInstancesRequest) Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
- Parameters:
deleteStackInstancesRequest
-- Returns:
- A Java Future containing the result of the DeleteStackInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
deleteStackInstances
default CompletableFuture<DeleteStackInstancesResponse> deleteStackInstances(Consumer<DeleteStackInstancesRequest.Builder> deleteStackInstancesRequest) Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
This is a convenience which creates an instance of the
DeleteStackInstancesRequest.Builder
avoiding the need to create one manually viaDeleteStackInstancesRequest.builder()
- Parameters:
deleteStackInstancesRequest
- AConsumer
that will call methods onDeleteStackInstancesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteStackInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
deleteStackSet
default CompletableFuture<DeleteStackSetResponse> deleteStackSet(DeleteStackSetRequest deleteStackSetRequest) Deletes a stack set. Before you can delete a stack set, all its member stack instances must be deleted. For more information about how to complete this, see DeleteStackInstances.
- Parameters:
deleteStackSetRequest
-- Returns:
- A Java Future containing the result of the DeleteStackSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
deleteStackSet
default CompletableFuture<DeleteStackSetResponse> deleteStackSet(Consumer<DeleteStackSetRequest.Builder> deleteStackSetRequest) Deletes a stack set. Before you can delete a stack set, all its member stack instances must be deleted. For more information about how to complete this, see DeleteStackInstances.
This is a convenience which creates an instance of the
DeleteStackSetRequest.Builder
avoiding the need to create one manually viaDeleteStackSetRequest.builder()
- Parameters:
deleteStackSetRequest
- AConsumer
that will call methods onDeleteStackSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteStackSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
deregisterType
default CompletableFuture<DeregisterTypeResponse> deregisterType(DeregisterTypeRequest deregisterTypeRequest) Marks an extension or extension version as
DEPRECATED
in the CloudFormation registry, removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations.To deregister an entire extension, you must individually deregister all active versions of that extension. If an extension has only a single active version, deregistering that version results in the extension itself being deregistered and marked as deprecated in the registry.
You can't deregister the default version of an extension if there are other active version of that extension. If you do deregister the default version of an extension, the extension type itself is deregistered as well and marked as deprecated.
To view the deprecation status of an extension or extension version, use DescribeType.
- Parameters:
deregisterTypeRequest
-- Returns:
- A Java Future containing the result of the DeregisterType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CfnRegistryException An error occurred during a CloudFormation registry operation.
- TypeNotFoundException The specified extension doesn't 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.
- See Also:
-
deregisterType
default CompletableFuture<DeregisterTypeResponse> deregisterType(Consumer<DeregisterTypeRequest.Builder> deregisterTypeRequest) Marks an extension or extension version as
DEPRECATED
in the CloudFormation registry, removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations.To deregister an entire extension, you must individually deregister all active versions of that extension. If an extension has only a single active version, deregistering that version results in the extension itself being deregistered and marked as deprecated in the registry.
You can't deregister the default version of an extension if there are other active version of that extension. If you do deregister the default version of an extension, the extension type itself is deregistered as well and marked as deprecated.
To view the deprecation status of an extension or extension version, use DescribeType.
This is a convenience which creates an instance of the
DeregisterTypeRequest.Builder
avoiding the need to create one manually viaDeregisterTypeRequest.builder()
- Parameters:
deregisterTypeRequest
- AConsumer
that will call methods onDeregisterTypeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeregisterType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CfnRegistryException An error occurred during a CloudFormation registry operation.
- TypeNotFoundException The specified extension doesn't 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.
- See Also:
-
describeAccountLimits
default CompletableFuture<DescribeAccountLimitsResponse> describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest) Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see CloudFormation Quotas in the CloudFormation User Guide.
- Parameters:
describeAccountLimitsRequest
- The input for the DescribeAccountLimits action.- Returns:
- A Java Future containing the result of the DescribeAccountLimits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeAccountLimits
default CompletableFuture<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. For more information about account limits, see CloudFormation Quotas in the CloudFormation User Guide.
This is a convenience which creates an instance of the
DescribeAccountLimitsRequest.Builder
avoiding the need to create one manually viaDescribeAccountLimitsRequest.builder()
- Parameters:
describeAccountLimitsRequest
- AConsumer
that will call methods onDescribeAccountLimitsRequest.Builder
to create a request. The input for the DescribeAccountLimits action.- Returns:
- A Java Future containing the result of the DescribeAccountLimits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeAccountLimits
Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see CloudFormation Quotas in the CloudFormation User Guide.
- Returns:
- A Java Future containing the result of the DescribeAccountLimits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeAccountLimitsPaginator
This is a variant of
describeAccountLimits(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsPublisher publisher = client.describeAccountLimitsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsPublisher publisher = client.describeAccountLimitsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsResponse response) { //... }; });
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.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeAccountLimitsPaginator
default DescribeAccountLimitsPublisher describeAccountLimitsPaginator(DescribeAccountLimitsRequest describeAccountLimitsRequest) This is a variant of
describeAccountLimits(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsPublisher publisher = client.describeAccountLimitsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsPublisher publisher = client.describeAccountLimitsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsResponse response) { //... }; });
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.- Parameters:
describeAccountLimitsRequest
- The input for the DescribeAccountLimits action.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeAccountLimitsPaginator
default DescribeAccountLimitsPublisher describeAccountLimitsPaginator(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest) This is a variant of
describeAccountLimits(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsPublisher publisher = client.describeAccountLimitsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsPublisher publisher = client.describeAccountLimitsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsResponse response) { //... }; });
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 viaDescribeAccountLimitsRequest.builder()
- Parameters:
describeAccountLimitsRequest
- AConsumer
that will call methods onDescribeAccountLimitsRequest.Builder
to create a request. The input for the DescribeAccountLimits action.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeChangeSet
default CompletableFuture<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. For more information, see Updating Stacks Using Change Sets in the CloudFormation User Guide.
- Parameters:
describeChangeSetRequest
- The input for the DescribeChangeSet action.- Returns:
- A Java Future containing the result of the DescribeChangeSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ChangeSetNotFoundException The specified change set name or ID doesn't exit. To view valid change
sets for a stack, use the
ListChangeSets
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.
- ChangeSetNotFoundException The specified change set name or ID doesn't exit. To view valid change
sets for a stack, use the
- See Also:
-
describeChangeSet
default CompletableFuture<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. 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 viaDescribeChangeSetRequest.builder()
- Parameters:
describeChangeSetRequest
- AConsumer
that will call methods onDescribeChangeSetRequest.Builder
to create a request. The input for the DescribeChangeSet action.- Returns:
- A Java Future containing the result of the DescribeChangeSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ChangeSetNotFoundException The specified change set name or ID doesn't exit. To view valid change
sets for a stack, use the
ListChangeSets
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.
- ChangeSetNotFoundException The specified change set name or ID doesn't exit. To view valid change
sets for a stack, use the
- See Also:
-
describeChangeSetHooks
default CompletableFuture<DescribeChangeSetHooksResponse> describeChangeSetHooks(DescribeChangeSetHooksRequest describeChangeSetHooksRequest) Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.
- Parameters:
describeChangeSetHooksRequest
-- Returns:
- A Java Future containing the result of the DescribeChangeSetHooks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ChangeSetNotFoundException The specified change set name or ID doesn't exit. To view valid change
sets for a stack, use the
ListChangeSets
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.
- ChangeSetNotFoundException The specified change set name or ID doesn't exit. To view valid change
sets for a stack, use the
- See Also:
-
describeChangeSetHooks
default CompletableFuture<DescribeChangeSetHooksResponse> describeChangeSetHooks(Consumer<DescribeChangeSetHooksRequest.Builder> describeChangeSetHooksRequest) Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.
This is a convenience which creates an instance of the
DescribeChangeSetHooksRequest.Builder
avoiding the need to create one manually viaDescribeChangeSetHooksRequest.builder()
- Parameters:
describeChangeSetHooksRequest
- AConsumer
that will call methods onDescribeChangeSetHooksRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeChangeSetHooks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ChangeSetNotFoundException The specified change set name or ID doesn't exit. To view valid change
sets for a stack, use the
ListChangeSets
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.
- ChangeSetNotFoundException The specified change set name or ID doesn't exit. To view valid change
sets for a stack, use the
- See Also:
-
describeGeneratedTemplate
default CompletableFuture<DescribeGeneratedTemplateResponse> describeGeneratedTemplate(DescribeGeneratedTemplateRequest describeGeneratedTemplateRequest) Describes a generated template. The output includes details about the progress of the creation of a generated template started by a
CreateGeneratedTemplate
API action or the update of a generated template started with anUpdateGeneratedTemplate
API action.- Parameters:
describeGeneratedTemplateRequest
-- Returns:
- A Java Future containing the result of the DescribeGeneratedTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- GeneratedTemplateNotFoundException The generated template was not found.
- 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.
- See Also:
-
describeGeneratedTemplate
default CompletableFuture<DescribeGeneratedTemplateResponse> describeGeneratedTemplate(Consumer<DescribeGeneratedTemplateRequest.Builder> describeGeneratedTemplateRequest) Describes a generated template. The output includes details about the progress of the creation of a generated template started by a
CreateGeneratedTemplate
API action or the update of a generated template started with anUpdateGeneratedTemplate
API action.
This is a convenience which creates an instance of the
DescribeGeneratedTemplateRequest.Builder
avoiding the need to create one manually viaDescribeGeneratedTemplateRequest.builder()
- Parameters:
describeGeneratedTemplateRequest
- AConsumer
that will call methods onDescribeGeneratedTemplateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeGeneratedTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- GeneratedTemplateNotFoundException The generated template was not found.
- 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.
- See Also:
-
describeOrganizationsAccess
default CompletableFuture<DescribeOrganizationsAccessResponse> describeOrganizationsAccess(DescribeOrganizationsAccessRequest describeOrganizationsAccessRequest) Retrieves information about the account's
OrganizationAccess
status. This API can be called either by the management account or the delegated administrator by using theCallAs
parameter. This API can also be called without theCallAs
parameter by the management account.- Parameters:
describeOrganizationsAccessRequest
-- Returns:
- A Java Future containing the result of the DescribeOrganizationsAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidOperationException The specified operation isn't valid.
- 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.
- See Also:
-
describeOrganizationsAccess
default CompletableFuture<DescribeOrganizationsAccessResponse> describeOrganizationsAccess(Consumer<DescribeOrganizationsAccessRequest.Builder> describeOrganizationsAccessRequest) Retrieves information about the account's
OrganizationAccess
status. This API can be called either by the management account or the delegated administrator by using theCallAs
parameter. This API can also be called without theCallAs
parameter by the management account.
This is a convenience which creates an instance of the
DescribeOrganizationsAccessRequest.Builder
avoiding the need to create one manually viaDescribeOrganizationsAccessRequest.builder()
- Parameters:
describeOrganizationsAccessRequest
- AConsumer
that will call methods onDescribeOrganizationsAccessRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeOrganizationsAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidOperationException The specified operation isn't valid.
- 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.
- See Also:
-
describePublisher
default CompletableFuture<DescribePublisherResponse> describePublisher(DescribePublisherRequest describePublisherRequest) Returns information about a CloudFormation extension publisher.
If you don't supply a
PublisherId
, and you have registered as an extension publisher,DescribePublisher
returns information about your own publisher account.For more information about registering as a publisher, see:
-
Publishing extensions to make them available for public use in the CloudFormation CLI User Guide
- Parameters:
describePublisherRequest
-- Returns:
- A Java Future containing the result of the DescribePublisher operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describePublisher
default CompletableFuture<DescribePublisherResponse> describePublisher(Consumer<DescribePublisherRequest.Builder> describePublisherRequest) Returns information about a CloudFormation extension publisher.
If you don't supply a
PublisherId
, and you have registered as an extension publisher,DescribePublisher
returns information about your own publisher account.For more information about registering as a publisher, see:
-
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 viaDescribePublisherRequest.builder()
- Parameters:
describePublisherRequest
- AConsumer
that will call methods onDescribePublisherRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribePublisher operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeResourceScan
default CompletableFuture<DescribeResourceScanResponse> describeResourceScan(DescribeResourceScanRequest describeResourceScanRequest) Describes details of a resource scan.
- Parameters:
describeResourceScanRequest
-- Returns:
- A Java Future containing the result of the DescribeResourceScan operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceScanNotFoundException The resource scan was not found.
- 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.
- See Also:
-
describeResourceScan
default CompletableFuture<DescribeResourceScanResponse> describeResourceScan(Consumer<DescribeResourceScanRequest.Builder> describeResourceScanRequest) Describes details of a resource scan.
This is a convenience which creates an instance of the
DescribeResourceScanRequest.Builder
avoiding the need to create one manually viaDescribeResourceScanRequest.builder()
- Parameters:
describeResourceScanRequest
- AConsumer
that will call methods onDescribeResourceScanRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeResourceScan operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceScanNotFoundException The resource scan was not found.
- 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.
- See Also:
-
describeStackDriftDetectionStatus
default CompletableFuture<DescribeStackDriftDetectionStatusResponse> describeStackDriftDetectionStatus(DescribeStackDriftDetectionStatusRequest describeStackDriftDetectionStatusRequest) Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Use DetectStackDrift to initiate a stack drift detection operation.
DetectStackDrift
returns aStackDriftDetectionId
you can use to monitor the progress of the operation usingDescribeStackDriftDetectionStatus
. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.- Parameters:
describeStackDriftDetectionStatusRequest
-- Returns:
- A Java Future containing the result of the DescribeStackDriftDetectionStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeStackDriftDetectionStatus
default CompletableFuture<DescribeStackDriftDetectionStatusResponse> describeStackDriftDetectionStatus(Consumer<DescribeStackDriftDetectionStatusRequest.Builder> describeStackDriftDetectionStatusRequest) Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Use DetectStackDrift to initiate a stack drift detection operation.
DetectStackDrift
returns aStackDriftDetectionId
you can use to monitor the progress of the operation usingDescribeStackDriftDetectionStatus
. 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 viaDescribeStackDriftDetectionStatusRequest.builder()
- Parameters:
describeStackDriftDetectionStatusRequest
- AConsumer
that will call methods onDescribeStackDriftDetectionStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeStackDriftDetectionStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeStackEvents
default CompletableFuture<DescribeStackEventsResponse> describeStackEvents(DescribeStackEventsRequest describeStackEventsRequest) Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, see CloudFormation stack creation events 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).
- Parameters:
describeStackEventsRequest
- The input for DescribeStackEvents action.- Returns:
- A Java Future containing the result of the DescribeStackEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeStackEvents
default CompletableFuture<DescribeStackEventsResponse> describeStackEvents(Consumer<DescribeStackEventsRequest.Builder> describeStackEventsRequest) Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, see CloudFormation stack creation events 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 viaDescribeStackEventsRequest.builder()
- Parameters:
describeStackEventsRequest
- AConsumer
that will call methods onDescribeStackEventsRequest.Builder
to create a request. The input for DescribeStackEvents action.- Returns:
- A Java Future containing the result of the DescribeStackEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeStackEventsPaginator
default DescribeStackEventsPublisher describeStackEventsPaginator(DescribeStackEventsRequest describeStackEventsRequest) This is a variant of
describeStackEvents(software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.DescribeStackEventsPublisher publisher = client.describeStackEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.DescribeStackEventsPublisher publisher = client.describeStackEventsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsResponse response) { //... }; });
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.- Parameters:
describeStackEventsRequest
- The input for DescribeStackEvents action.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeStackEventsPaginator
default DescribeStackEventsPublisher describeStackEventsPaginator(Consumer<DescribeStackEventsRequest.Builder> describeStackEventsRequest) This is a variant of
describeStackEvents(software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.DescribeStackEventsPublisher publisher = client.describeStackEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.DescribeStackEventsPublisher publisher = client.describeStackEventsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsResponse response) { //... }; });
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 viaDescribeStackEventsRequest.builder()
- Parameters:
describeStackEventsRequest
- AConsumer
that will call methods onDescribeStackEventsRequest.Builder
to create a request. The input for DescribeStackEvents action.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeStackInstance
default CompletableFuture<DescribeStackInstanceResponse> describeStackInstance(DescribeStackInstanceRequest describeStackInstanceRequest) Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region.
For a list of stack instances that are associated with a specific StackSet, use ListStackInstances.
- Parameters:
describeStackInstanceRequest
-- Returns:
- A Java Future containing the result of the DescribeStackInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeStackInstance
default CompletableFuture<DescribeStackInstanceResponse> describeStackInstance(Consumer<DescribeStackInstanceRequest.Builder> describeStackInstanceRequest) Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region.
For a list of stack instances that are associated with a specific StackSet, use ListStackInstances.
This is a convenience which creates an instance of the
DescribeStackInstanceRequest.Builder
avoiding the need to create one manually viaDescribeStackInstanceRequest.builder()
- Parameters:
describeStackInstanceRequest
- AConsumer
that will call methods onDescribeStackInstanceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeStackInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeStackResource
default CompletableFuture<DescribeStackResourceResponse> describeStackResource(DescribeStackResourceRequest describeStackResourceRequest) 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.
- Parameters:
describeStackResourceRequest
- The input for DescribeStackResource action.- Returns:
- A Java Future containing the result of the DescribeStackResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeStackResource
default CompletableFuture<DescribeStackResourceResponse> describeStackResource(Consumer<DescribeStackResourceRequest.Builder> describeStackResourceRequest) 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 viaDescribeStackResourceRequest.builder()
- Parameters:
describeStackResourceRequest
- AConsumer
that will call methods onDescribeStackResourceRequest.Builder
to create a request. The input for DescribeStackResource action.- Returns:
- A Java Future containing the result of the DescribeStackResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeStackResourceDrifts
default CompletableFuture<DescribeStackResourceDriftsResponse> describeStackResourceDrifts(DescribeStackResourceDriftsRequest describeStackResourceDriftsRequest) Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects configuration drift.
For a given stack, there will be one
StackResourceDrift
for each stack resource that has been checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that don't currently support drift detection aren't checked, and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection.Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.
- Parameters:
describeStackResourceDriftsRequest
-- Returns:
- A Java Future containing the result of the DescribeStackResourceDrifts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeStackResourceDrifts
default CompletableFuture<DescribeStackResourceDriftsResponse> describeStackResourceDrifts(Consumer<DescribeStackResourceDriftsRequest.Builder> describeStackResourceDriftsRequest) Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects configuration drift.
For a given stack, there will be one
StackResourceDrift
for each stack resource that has been checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that don't currently support drift detection aren't checked, and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection.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 viaDescribeStackResourceDriftsRequest.builder()
- Parameters:
describeStackResourceDriftsRequest
- AConsumer
that will call methods onDescribeStackResourceDriftsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeStackResourceDrifts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeStackResourceDriftsPaginator
default DescribeStackResourceDriftsPublisher describeStackResourceDriftsPaginator(DescribeStackResourceDriftsRequest describeStackResourceDriftsRequest) This is a variant of
describeStackResourceDrifts(software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.DescribeStackResourceDriftsPublisher publisher = client.describeStackResourceDriftsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.DescribeStackResourceDriftsPublisher publisher = client.describeStackResourceDriftsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsResponse response) { //... }; });
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.- Parameters:
describeStackResourceDriftsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeStackResourceDriftsPaginator
default DescribeStackResourceDriftsPublisher describeStackResourceDriftsPaginator(Consumer<DescribeStackResourceDriftsRequest.Builder> describeStackResourceDriftsRequest) This is a variant of
describeStackResourceDrifts(software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.DescribeStackResourceDriftsPublisher publisher = client.describeStackResourceDriftsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.DescribeStackResourceDriftsPublisher publisher = client.describeStackResourceDriftsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsResponse response) { //... }; });
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 viaDescribeStackResourceDriftsRequest.builder()
- Parameters:
describeStackResourceDriftsRequest
- AConsumer
that will call methods onDescribeStackResourceDriftsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeStackResources
default CompletableFuture<DescribeStackResourcesResponse> describeStackResources(DescribeStackResourcesRequest describeStackResourcesRequest) 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. IfPhysicalResourceId
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
orPhysicalResourceId
, but not both. In addition, you can specifyLogicalResourceId
to filter the returned result. For more information about resources, theLogicalResourceId
andPhysicalResourceId
, go to the CloudFormation User Guide.A
ValidationError
is returned if you specify bothStackName
andPhysicalResourceId
in the same request.- Parameters:
describeStackResourcesRequest
- The input for DescribeStackResources action.- Returns:
- A Java Future containing the result of the DescribeStackResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeStackResources
default CompletableFuture<DescribeStackResourcesResponse> describeStackResources(Consumer<DescribeStackResourcesRequest.Builder> describeStackResourcesRequest) 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. IfPhysicalResourceId
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
orPhysicalResourceId
, but not both. In addition, you can specifyLogicalResourceId
to filter the returned result. For more information about resources, theLogicalResourceId
andPhysicalResourceId
, go to the CloudFormation User Guide.A
ValidationError
is returned if you specify bothStackName
andPhysicalResourceId
in the same request.
This is a convenience which creates an instance of the
DescribeStackResourcesRequest.Builder
avoiding the need to create one manually viaDescribeStackResourcesRequest.builder()
- Parameters:
describeStackResourcesRequest
- AConsumer
that will call methods onDescribeStackResourcesRequest.Builder
to create a request. The input for DescribeStackResources action.- Returns:
- A Java Future containing the result of the DescribeStackResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeStackSet
default CompletableFuture<DescribeStackSetResponse> describeStackSet(DescribeStackSetRequest describeStackSetRequest) Returns the description of the specified StackSet.
- Parameters:
describeStackSetRequest
-- Returns:
- A Java Future containing the result of the DescribeStackSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeStackSet
default CompletableFuture<DescribeStackSetResponse> describeStackSet(Consumer<DescribeStackSetRequest.Builder> describeStackSetRequest) Returns the description of the specified StackSet.
This is a convenience which creates an instance of the
DescribeStackSetRequest.Builder
avoiding the need to create one manually viaDescribeStackSetRequest.builder()
- Parameters:
describeStackSetRequest
- AConsumer
that will call methods onDescribeStackSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeStackSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeStackSetOperation
default CompletableFuture<DescribeStackSetOperationResponse> describeStackSetOperation(DescribeStackSetOperationRequest describeStackSetOperationRequest) Returns the description of the specified StackSet operation.
- Parameters:
describeStackSetOperationRequest
-- Returns:
- A Java Future containing the result of the DescribeStackSetOperation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeStackSetOperation
default CompletableFuture<DescribeStackSetOperationResponse> describeStackSetOperation(Consumer<DescribeStackSetOperationRequest.Builder> describeStackSetOperationRequest) Returns the description of the specified StackSet operation.
This is a convenience which creates an instance of the
DescribeStackSetOperationRequest.Builder
avoiding the need to create one manually viaDescribeStackSetOperationRequest.builder()
- Parameters:
describeStackSetOperationRequest
- AConsumer
that will call methods onDescribeStackSetOperationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeStackSetOperation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeStacks
default CompletableFuture<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. For more information about a stack's event history, see CloudFormation stack creation events in the CloudFormation User Guide.
If the stack doesn't exist, a
ValidationError
is returned.- Parameters:
describeStacksRequest
- The input for DescribeStacks action.- Returns:
- A Java Future containing the result of the DescribeStacks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeStacks
default CompletableFuture<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. For more information about a stack's event history, see CloudFormation stack creation events in the CloudFormation User Guide.
If the stack doesn't exist, a
ValidationError
is returned.
This is a convenience which creates an instance of the
DescribeStacksRequest.Builder
avoiding the need to create one manually viaDescribeStacksRequest.builder()
- Parameters:
describeStacksRequest
- AConsumer
that will call methods onDescribeStacksRequest.Builder
to create a request. The input for DescribeStacks action.- Returns:
- A Java Future containing the result of the DescribeStacks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeStacks
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. For more information about a stack's event history, see CloudFormation stack creation events in the CloudFormation User Guide.
If the stack doesn't exist, a
ValidationError
is returned.- Returns:
- A Java Future containing the result of the DescribeStacks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeStacksPaginator
This is a variant of
describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.DescribeStacksPublisher publisher = client.describeStacksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksPublisher publisher = client.describeStacksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.DescribeStacksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.DescribeStacksResponse response) { //... }; });
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.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeStacksPaginator
default DescribeStacksPublisher describeStacksPaginator(DescribeStacksRequest describeStacksRequest) This is a variant of
describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.DescribeStacksPublisher publisher = client.describeStacksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksPublisher publisher = client.describeStacksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.DescribeStacksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.DescribeStacksResponse response) { //... }; });
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.- Parameters:
describeStacksRequest
- The input for DescribeStacks action.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeStacksPaginator
default DescribeStacksPublisher describeStacksPaginator(Consumer<DescribeStacksRequest.Builder> describeStacksRequest) This is a variant of
describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.DescribeStacksPublisher publisher = client.describeStacksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksPublisher publisher = client.describeStacksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.DescribeStacksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.DescribeStacksResponse response) { //... }; });
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 viaDescribeStacksRequest.builder()
- Parameters:
describeStacksRequest
- AConsumer
that will call methods onDescribeStacksRequest.Builder
to create a request. The input for DescribeStacks action.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeType
default CompletableFuture<DescribeTypeResponse> describeType(DescribeTypeRequest describeTypeRequest) 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.- Parameters:
describeTypeRequest
-- Returns:
- A Java Future containing the result of the DescribeType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CfnRegistryException An error occurred during a CloudFormation registry operation.
- TypeNotFoundException The specified extension doesn't 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.
- See Also:
-
describeType
default CompletableFuture<DescribeTypeResponse> describeType(Consumer<DescribeTypeRequest.Builder> describeTypeRequest) 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 viaDescribeTypeRequest.builder()
- Parameters:
describeTypeRequest
- AConsumer
that will call methods onDescribeTypeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CfnRegistryException An error occurred during a CloudFormation registry operation.
- TypeNotFoundException The specified extension doesn't 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.
- See Also:
-
describeTypeRegistration
default CompletableFuture<DescribeTypeRegistrationResponse> describeTypeRegistration(DescribeTypeRegistrationRequest describeTypeRegistrationRequest) 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.
- Parameters:
describeTypeRegistrationRequest
-- Returns:
- A Java Future containing the result of the DescribeTypeRegistration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
describeTypeRegistration
default CompletableFuture<DescribeTypeRegistrationResponse> describeTypeRegistration(Consumer<DescribeTypeRegistrationRequest.Builder> describeTypeRegistrationRequest) 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 viaDescribeTypeRegistrationRequest.builder()
- Parameters:
describeTypeRegistrationRequest
- AConsumer
that will call methods onDescribeTypeRegistrationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeTypeRegistration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
detectStackDrift
default CompletableFuture<DetectStackDriftResponse> detectStackDrift(DetectStackDriftRequest detectStackDriftRequest) Detects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
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 doesn't detect drift on any nested stacks belonging to that stack. Perform
DetectStackDrift
directly on the nested stack itself.- Parameters:
detectStackDriftRequest
-- Returns:
- A Java Future containing the result of the DetectStackDrift operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
detectStackDrift
default CompletableFuture<DetectStackDriftResponse> detectStackDrift(Consumer<DetectStackDriftRequest.Builder> detectStackDriftRequest) Detects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
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 doesn't 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 viaDetectStackDriftRequest.builder()
- Parameters:
detectStackDriftRequest
- AConsumer
that will call methods onDetectStackDriftRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DetectStackDrift operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
detectStackResourceDrift
default CompletableFuture<DetectStackResourceDriftResponse> detectStackResourceDrift(DetectStackResourceDriftRequest detectStackResourceDriftRequest) Returns information about whether a resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Use
DetectStackResourceDrift
to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.Resources that don't currently support drift detection can't be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection.
- Parameters:
detectStackResourceDriftRequest
-- Returns:
- A Java Future containing the result of the DetectStackResourceDrift operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
detectStackResourceDrift
default CompletableFuture<DetectStackResourceDriftResponse> detectStackResourceDrift(Consumer<DetectStackResourceDriftRequest.Builder> detectStackResourceDriftRequest) Returns information about whether a resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Use
DetectStackResourceDrift
to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.Resources that don't currently support drift detection can't be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection.
This is a convenience which creates an instance of the
DetectStackResourceDriftRequest.Builder
avoiding the need to create one manually viaDetectStackResourceDriftRequest.builder()
- Parameters:
detectStackResourceDriftRequest
- AConsumer
that will call methods onDetectStackResourceDriftRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DetectStackResourceDrift operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
detectStackSetDrift
default CompletableFuture<DetectStackSetDriftResponse> detectStackSetDrift(DetectStackSetDriftRequest detectStackSetDriftRequest) 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 theOperationId
of the stack set drift detection operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection operation. The drift detection operation may take some time, depending on the number of stack instances included in the stack set, in addition to the number of resources included in each stack.Once the operation has completed, use the following actions to return drift information:
-
Use DescribeStackSet to return detailed information about the stack set, including detailed information about the last completed drift operation performed on the stack set. (Information about drift operations that are in progress isn't included.)
-
Use ListStackInstances to return a list of stack instances belonging to the stack set, including the drift status and last drift time checked of each instance.
-
Use DescribeStackInstance to return detailed information about a specific stack instance, including its drift status and last drift time checked.
For more information about performing a drift detection operation on a stack set, see Detecting unmanaged changes in stack sets.
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.
- Parameters:
detectStackSetDriftRequest
-- Returns:
- A Java Future containing the result of the DetectStackSetDrift operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
-
detectStackSetDrift
default CompletableFuture<DetectStackSetDriftResponse> detectStackSetDrift(Consumer<DetectStackSetDriftRequest.Builder> detectStackSetDriftRequest) 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 theOperationId
of the stack set drift detection operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection operation. The drift detection operation may take some time, depending on the number of stack instances included in the stack set, in addition to the number of resources included in each stack.Once the operation has completed, use the following actions to return drift information:
-
Use DescribeStackSet to return detailed information about the stack set, including detailed information about the last completed drift operation performed on the stack set. (Information about drift operations that are in progress isn't included.)
-
Use ListStackInstances to return a list of stack instances belonging to the stack set, including the drift status and last drift time checked of each instance.
-
Use DescribeStackInstance to return detailed information about a specific stack instance, including its drift status and last drift time checked.
For more information about performing a drift detection operation on a stack set, see Detecting unmanaged changes in stack sets.
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 viaDetectStackSetDriftRequest.builder()
- Parameters:
detectStackSetDriftRequest
- AConsumer
that will call methods onDetectStackSetDriftRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DetectStackSetDrift operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
-
estimateTemplateCost
default CompletableFuture<EstimateTemplateCostResponse> estimateTemplateCost(EstimateTemplateCostRequest estimateTemplateCostRequest) 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.
- Parameters:
estimateTemplateCostRequest
- The input for an EstimateTemplateCost action.- Returns:
- A Java Future containing the result of the EstimateTemplateCost operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
estimateTemplateCost
default CompletableFuture<EstimateTemplateCostResponse> estimateTemplateCost(Consumer<EstimateTemplateCostRequest.Builder> estimateTemplateCostRequest) 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 viaEstimateTemplateCostRequest.builder()
- Parameters:
estimateTemplateCostRequest
- AConsumer
that will call methods onEstimateTemplateCostRequest.Builder
to create a request. The input for an EstimateTemplateCost action.- Returns:
- A Java Future containing the result of the EstimateTemplateCost operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
executeChangeSet
default CompletableFuture<ExecuteChangeSetResponse> executeChangeSet(ExecuteChangeSetRequest executeChangeSetRequest) Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.
When you execute a change set, CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.
If a stack policy is associated with the stack, CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.
To create a change set for the entire stack hierarchy,
IncludeNestedStacks
must have been set toTrue
.- Parameters:
executeChangeSetRequest
- The input for the ExecuteChangeSet action.- Returns:
- A Java Future containing the result of the ExecuteChangeSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 beUPDATE_IN_PROGRESS
. - ChangeSetNotFoundException The specified change set name or ID doesn't exit. To view valid change
sets for a stack, use the
ListChangeSets
operation. - 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.
- InvalidChangeSetStatusException The specified change set can't be used to update the stack. For
example, the change set status might be
- See Also:
-
executeChangeSet
default CompletableFuture<ExecuteChangeSetResponse> executeChangeSet(Consumer<ExecuteChangeSetRequest.Builder> executeChangeSetRequest) Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.
When you execute a change set, CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.
If a stack policy is associated with the stack, CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.
To create a change set for the entire stack hierarchy,
IncludeNestedStacks
must have been set toTrue
.
This is a convenience which creates an instance of the
ExecuteChangeSetRequest.Builder
avoiding the need to create one manually viaExecuteChangeSetRequest.builder()
- Parameters:
executeChangeSetRequest
- AConsumer
that will call methods onExecuteChangeSetRequest.Builder
to create a request. The input for the ExecuteChangeSet action.- Returns:
- A Java Future containing the result of the ExecuteChangeSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 beUPDATE_IN_PROGRESS
. - ChangeSetNotFoundException The specified change set name or ID doesn't exit. To view valid change
sets for a stack, use the
ListChangeSets
operation. - 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.
- InvalidChangeSetStatusException The specified change set can't be used to update the stack. For
example, the change set status might be
- See Also:
-
getGeneratedTemplate
default CompletableFuture<GetGeneratedTemplateResponse> getGeneratedTemplate(GetGeneratedTemplateRequest getGeneratedTemplateRequest) Retrieves a generated template. If the template is in an
InProgress
orPending
status then the template returned will be the template when the template was last in aComplete
status. If the template has not yet been in aComplete
status then an empty template will be returned.- Parameters:
getGeneratedTemplateRequest
-- Returns:
- A Java Future containing the result of the GetGeneratedTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- GeneratedTemplateNotFoundException The generated template was not found.
- 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.
- See Also:
-
getGeneratedTemplate
default CompletableFuture<GetGeneratedTemplateResponse> getGeneratedTemplate(Consumer<GetGeneratedTemplateRequest.Builder> getGeneratedTemplateRequest) Retrieves a generated template. If the template is in an
InProgress
orPending
status then the template returned will be the template when the template was last in aComplete
status. If the template has not yet been in aComplete
status then an empty template will be returned.
This is a convenience which creates an instance of the
GetGeneratedTemplateRequest.Builder
avoiding the need to create one manually viaGetGeneratedTemplateRequest.builder()
- Parameters:
getGeneratedTemplateRequest
- AConsumer
that will call methods onGetGeneratedTemplateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetGeneratedTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- GeneratedTemplateNotFoundException The generated template was not found.
- 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.
- See Also:
-
getStackPolicy
default CompletableFuture<GetStackPolicyResponse> getStackPolicy(GetStackPolicyRequest getStackPolicyRequest) Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
- Parameters:
getStackPolicyRequest
- The input for the GetStackPolicy action.- Returns:
- A Java Future containing the result of the GetStackPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
getStackPolicy
default CompletableFuture<GetStackPolicyResponse> getStackPolicy(Consumer<GetStackPolicyRequest.Builder> getStackPolicyRequest) 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 viaGetStackPolicyRequest.builder()
- Parameters:
getStackPolicyRequest
- AConsumer
that will call methods onGetStackPolicyRequest.Builder
to create a request. The input for the GetStackPolicy action.- Returns:
- A Java Future containing the result of the GetStackPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
getTemplate
Returns the template body for a specified stack. You can get the template for running or deleted stacks.
For deleted stacks,
GetTemplate
returns the template for up to 90 days after the stack has been deleted.If the template doesn't exist, a
ValidationError
is returned.- Parameters:
getTemplateRequest
- The input for a GetTemplate action.- Returns:
- A Java Future containing the result of the GetTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ChangeSetNotFoundException The specified change set name or ID doesn't exit. To view valid change
sets for a stack, use the
ListChangeSets
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.
- ChangeSetNotFoundException The specified change set name or ID doesn't exit. To view valid change
sets for a stack, use the
- See Also:
-
getTemplate
default CompletableFuture<GetTemplateResponse> getTemplate(Consumer<GetTemplateRequest.Builder> getTemplateRequest) Returns the template body for a specified stack. You can get the template for running or deleted stacks.
For deleted stacks,
GetTemplate
returns the template for up to 90 days after the stack has been deleted.If the template doesn't exist, a
ValidationError
is returned.
This is a convenience which creates an instance of the
GetTemplateRequest.Builder
avoiding the need to create one manually viaGetTemplateRequest.builder()
- Parameters:
getTemplateRequest
- AConsumer
that will call methods onGetTemplateRequest.Builder
to create a request. The input for a GetTemplate action.- Returns:
- A Java Future containing the result of the GetTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ChangeSetNotFoundException The specified change set name or ID doesn't exit. To view valid change
sets for a stack, use the
ListChangeSets
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.
- ChangeSetNotFoundException The specified change set name or ID doesn't exit. To view valid change
sets for a stack, use the
- See Also:
-
getTemplateSummary
default CompletableFuture<GetTemplateSummaryResponse> getTemplateSummary(GetTemplateSummaryRequest getTemplateSummaryRequest) Returns information about a new or existing template. The
GetTemplateSummary
action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or stack set.You can use the
GetTemplateSummary
action when you submit a template, or you can get template information for a stack set, or a running or deleted stack.For deleted stacks,
GetTemplateSummary
returns the template information for up to 90 days after the stack has been deleted. If the template doesn't exist, aValidationError
is returned.- Parameters:
getTemplateSummaryRequest
- The input for the GetTemplateSummary action.- Returns:
- A Java Future containing the result of the GetTemplateSummary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
getTemplateSummary
default CompletableFuture<GetTemplateSummaryResponse> getTemplateSummary(Consumer<GetTemplateSummaryRequest.Builder> getTemplateSummaryRequest) Returns information about a new or existing template. The
GetTemplateSummary
action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or stack set.You can use the
GetTemplateSummary
action when you submit a template, or you can get template information for a stack set, or a running or deleted stack.For deleted stacks,
GetTemplateSummary
returns the template information for up to 90 days after the stack has been deleted. If the template doesn't exist, aValidationError
is returned.
This is a convenience which creates an instance of the
GetTemplateSummaryRequest.Builder
avoiding the need to create one manually viaGetTemplateSummaryRequest.builder()
- Parameters:
getTemplateSummaryRequest
- AConsumer
that will call methods onGetTemplateSummaryRequest.Builder
to create a request. The input for the GetTemplateSummary action.- Returns:
- A Java Future containing the result of the GetTemplateSummary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
importStacksToStackSet
default CompletableFuture<ImportStacksToStackSetResponse> importStacksToStackSet(ImportStacksToStackSetRequest importStacksToStackSetRequest) Import existing stacks into a new stack sets. Use the stack import operation to import up to 10 stacks into a new stack set in the same account as the source stack or in a different administrator account and Region, by specifying the stack ID of the stack you intend to import.
- Parameters:
importStacksToStackSetRequest
-- Returns:
- A Java Future containing the result of the ImportStacksToStackSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- LimitExceededException The quota for the resource has already been reached.
For information about resource and stack limitations, see CloudFormation quotas 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.
- LimitExceededException The quota for the resource has already been reached.
- See Also:
-
importStacksToStackSet
default CompletableFuture<ImportStacksToStackSetResponse> importStacksToStackSet(Consumer<ImportStacksToStackSetRequest.Builder> importStacksToStackSetRequest) Import existing stacks into a new stack sets. Use the stack import operation to import up to 10 stacks into a new stack set in the same account as the source stack or in a different administrator account and Region, by specifying the stack ID of the stack you intend to import.
This is a convenience which creates an instance of the
ImportStacksToStackSetRequest.Builder
avoiding the need to create one manually viaImportStacksToStackSetRequest.builder()
- Parameters:
importStacksToStackSetRequest
- AConsumer
that will call methods onImportStacksToStackSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ImportStacksToStackSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- LimitExceededException The quota for the resource has already been reached.
For information about resource and stack limitations, see CloudFormation quotas 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.
- LimitExceededException The quota for the resource has already been reached.
- See Also:
-
listChangeSets
default CompletableFuture<ListChangeSetsResponse> listChangeSets(ListChangeSetsRequest listChangeSetsRequest) 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
orCREATE_PENDING
state.- Parameters:
listChangeSetsRequest
- The input for the ListChangeSets action.- Returns:
- A Java Future containing the result of the ListChangeSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listChangeSets
default CompletableFuture<ListChangeSetsResponse> listChangeSets(Consumer<ListChangeSetsRequest.Builder> listChangeSetsRequest) 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
orCREATE_PENDING
state.
This is a convenience which creates an instance of the
ListChangeSetsRequest.Builder
avoiding the need to create one manually viaListChangeSetsRequest.builder()
- Parameters:
listChangeSetsRequest
- AConsumer
that will call methods onListChangeSetsRequest.Builder
to create a request. The input for the ListChangeSets action.- Returns:
- A Java Future containing the result of the ListChangeSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listChangeSetsPaginator
default ListChangeSetsPublisher listChangeSetsPaginator(ListChangeSetsRequest listChangeSetsRequest) This is a variant of
listChangeSets(software.amazon.awssdk.services.cloudformation.model.ListChangeSetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListChangeSetsPublisher publisher = client.listChangeSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListChangeSetsPublisher publisher = client.listChangeSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListChangeSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListChangeSetsResponse response) { //... }; });
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.- Parameters:
listChangeSetsRequest
- The input for the ListChangeSets action.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listChangeSetsPaginator
default ListChangeSetsPublisher listChangeSetsPaginator(Consumer<ListChangeSetsRequest.Builder> listChangeSetsRequest) This is a variant of
listChangeSets(software.amazon.awssdk.services.cloudformation.model.ListChangeSetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListChangeSetsPublisher publisher = client.listChangeSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListChangeSetsPublisher publisher = client.listChangeSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListChangeSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListChangeSetsResponse response) { //... }; });
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 viaListChangeSetsRequest.builder()
- Parameters:
listChangeSetsRequest
- AConsumer
that will call methods onListChangeSetsRequest.Builder
to create a request. The input for the ListChangeSets action.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listExports
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.
- Parameters:
listExportsRequest
-- Returns:
- A Java Future containing the result of the ListExports operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listExports
default CompletableFuture<ListExportsResponse> listExports(Consumer<ListExportsRequest.Builder> listExportsRequest) 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 viaListExportsRequest.builder()
- Parameters:
listExportsRequest
- AConsumer
that will call methods onListExportsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListExports operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listExports
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.
- Returns:
- A Java Future containing the result of the ListExports operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listExportsPaginator
This is a variant of
listExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListExportsPublisher publisher = client.listExportsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListExportsPublisher publisher = client.listExportsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListExportsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListExportsResponse response) { //... }; });
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.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listExportsPaginator
This is a variant of
listExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListExportsPublisher publisher = client.listExportsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListExportsPublisher publisher = client.listExportsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListExportsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListExportsResponse response) { //... }; });
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.- Parameters:
listExportsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listExportsPaginator
default ListExportsPublisher listExportsPaginator(Consumer<ListExportsRequest.Builder> listExportsRequest) This is a variant of
listExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListExportsPublisher publisher = client.listExportsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListExportsPublisher publisher = client.listExportsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListExportsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListExportsResponse response) { //... }; });
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 viaListExportsRequest.builder()
- Parameters:
listExportsRequest
- AConsumer
that will call methods onListExportsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listGeneratedTemplates
default CompletableFuture<ListGeneratedTemplatesResponse> listGeneratedTemplates(ListGeneratedTemplatesRequest listGeneratedTemplatesRequest) Lists your generated templates in this Region.
- Parameters:
listGeneratedTemplatesRequest
-- Returns:
- A Java Future containing the result of the ListGeneratedTemplates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listGeneratedTemplates
default CompletableFuture<ListGeneratedTemplatesResponse> listGeneratedTemplates(Consumer<ListGeneratedTemplatesRequest.Builder> listGeneratedTemplatesRequest) Lists your generated templates in this Region.
This is a convenience which creates an instance of the
ListGeneratedTemplatesRequest.Builder
avoiding the need to create one manually viaListGeneratedTemplatesRequest.builder()
- Parameters:
listGeneratedTemplatesRequest
- AConsumer
that will call methods onListGeneratedTemplatesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListGeneratedTemplates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listGeneratedTemplatesPaginator
default ListGeneratedTemplatesPublisher listGeneratedTemplatesPaginator(ListGeneratedTemplatesRequest listGeneratedTemplatesRequest) This is a variant of
listGeneratedTemplates(software.amazon.awssdk.services.cloudformation.model.ListGeneratedTemplatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListGeneratedTemplatesPublisher publisher = client.listGeneratedTemplatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListGeneratedTemplatesPublisher publisher = client.listGeneratedTemplatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListGeneratedTemplatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListGeneratedTemplatesResponse response) { //... }; });
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
listGeneratedTemplates(software.amazon.awssdk.services.cloudformation.model.ListGeneratedTemplatesRequest)
operation.- Parameters:
listGeneratedTemplatesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listGeneratedTemplatesPaginator
default ListGeneratedTemplatesPublisher listGeneratedTemplatesPaginator(Consumer<ListGeneratedTemplatesRequest.Builder> listGeneratedTemplatesRequest) This is a variant of
listGeneratedTemplates(software.amazon.awssdk.services.cloudformation.model.ListGeneratedTemplatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListGeneratedTemplatesPublisher publisher = client.listGeneratedTemplatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListGeneratedTemplatesPublisher publisher = client.listGeneratedTemplatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListGeneratedTemplatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListGeneratedTemplatesResponse response) { //... }; });
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
listGeneratedTemplates(software.amazon.awssdk.services.cloudformation.model.ListGeneratedTemplatesRequest)
operation.
This is a convenience which creates an instance of the
ListGeneratedTemplatesRequest.Builder
avoiding the need to create one manually viaListGeneratedTemplatesRequest.builder()
- Parameters:
listGeneratedTemplatesRequest
- AConsumer
that will call methods onListGeneratedTemplatesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listImports
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.
- Parameters:
listImportsRequest
-- Returns:
- A Java Future containing the result of the ListImports operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listImports
default CompletableFuture<ListImportsResponse> listImports(Consumer<ListImportsRequest.Builder> listImportsRequest) 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 viaListImportsRequest.builder()
- Parameters:
listImportsRequest
- AConsumer
that will call methods onListImportsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListImports operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listImportsPaginator
This is a variant of
listImports(software.amazon.awssdk.services.cloudformation.model.ListImportsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListImportsPublisher publisher = client.listImportsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListImportsPublisher publisher = client.listImportsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListImportsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListImportsResponse response) { //... }; });
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.- Parameters:
listImportsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listImportsPaginator
default ListImportsPublisher listImportsPaginator(Consumer<ListImportsRequest.Builder> listImportsRequest) This is a variant of
listImports(software.amazon.awssdk.services.cloudformation.model.ListImportsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListImportsPublisher publisher = client.listImportsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListImportsPublisher publisher = client.listImportsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListImportsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListImportsResponse response) { //... }; });
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 viaListImportsRequest.builder()
- Parameters:
listImportsRequest
- AConsumer
that will call methods onListImportsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listResourceScanRelatedResources
default CompletableFuture<ListResourceScanRelatedResourcesResponse> listResourceScanRelatedResources(ListResourceScanRelatedResourcesRequest listResourceScanRelatedResourcesRequest) Lists the related resources for a list of resources from a resource scan. The response indicates whether each returned resource is already managed by CloudFormation.
- Parameters:
listResourceScanRelatedResourcesRequest
-- Returns:
- A Java Future containing the result of the ListResourceScanRelatedResources operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceScanNotFoundException The resource scan was not found.
- ResourceScanInProgressException A resource scan is currently in progress. Only one can be run at a time for an account in a Region.
- 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.
- See Also:
-
listResourceScanRelatedResources
default CompletableFuture<ListResourceScanRelatedResourcesResponse> listResourceScanRelatedResources(Consumer<ListResourceScanRelatedResourcesRequest.Builder> listResourceScanRelatedResourcesRequest) Lists the related resources for a list of resources from a resource scan. The response indicates whether each returned resource is already managed by CloudFormation.
This is a convenience which creates an instance of the
ListResourceScanRelatedResourcesRequest.Builder
avoiding the need to create one manually viaListResourceScanRelatedResourcesRequest.builder()
- Parameters:
listResourceScanRelatedResourcesRequest
- AConsumer
that will call methods onListResourceScanRelatedResourcesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListResourceScanRelatedResources operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceScanNotFoundException The resource scan was not found.
- ResourceScanInProgressException A resource scan is currently in progress. Only one can be run at a time for an account in a Region.
- 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.
- See Also:
-
listResourceScanRelatedResourcesPaginator
default ListResourceScanRelatedResourcesPublisher listResourceScanRelatedResourcesPaginator(ListResourceScanRelatedResourcesRequest listResourceScanRelatedResourcesRequest) This is a variant of
listResourceScanRelatedResources(software.amazon.awssdk.services.cloudformation.model.ListResourceScanRelatedResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListResourceScanRelatedResourcesPublisher publisher = client.listResourceScanRelatedResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListResourceScanRelatedResourcesPublisher publisher = client.listResourceScanRelatedResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListResourceScanRelatedResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListResourceScanRelatedResourcesResponse response) { //... }; });
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
listResourceScanRelatedResources(software.amazon.awssdk.services.cloudformation.model.ListResourceScanRelatedResourcesRequest)
operation.- Parameters:
listResourceScanRelatedResourcesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceScanNotFoundException The resource scan was not found.
- ResourceScanInProgressException A resource scan is currently in progress. Only one can be run at a time for an account in a Region.
- 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.
- See Also:
-
listResourceScanRelatedResourcesPaginator
default ListResourceScanRelatedResourcesPublisher listResourceScanRelatedResourcesPaginator(Consumer<ListResourceScanRelatedResourcesRequest.Builder> listResourceScanRelatedResourcesRequest) This is a variant of
listResourceScanRelatedResources(software.amazon.awssdk.services.cloudformation.model.ListResourceScanRelatedResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListResourceScanRelatedResourcesPublisher publisher = client.listResourceScanRelatedResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListResourceScanRelatedResourcesPublisher publisher = client.listResourceScanRelatedResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListResourceScanRelatedResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListResourceScanRelatedResourcesResponse response) { //... }; });
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
listResourceScanRelatedResources(software.amazon.awssdk.services.cloudformation.model.ListResourceScanRelatedResourcesRequest)
operation.
This is a convenience which creates an instance of the
ListResourceScanRelatedResourcesRequest.Builder
avoiding the need to create one manually viaListResourceScanRelatedResourcesRequest.builder()
- Parameters:
listResourceScanRelatedResourcesRequest
- AConsumer
that will call methods onListResourceScanRelatedResourcesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceScanNotFoundException The resource scan was not found.
- ResourceScanInProgressException A resource scan is currently in progress. Only one can be run at a time for an account in a Region.
- 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.
- See Also:
-
listResourceScanResources
default CompletableFuture<ListResourceScanResourcesResponse> listResourceScanResources(ListResourceScanResourcesRequest listResourceScanResourcesRequest) Lists the resources from a resource scan. The results can be filtered by resource identifier, resource type prefix, tag key, and tag value. Only resources that match all specified filters are returned. The response indicates whether each returned resource is already managed by CloudFormation.
- Parameters:
listResourceScanResourcesRequest
-- Returns:
- A Java Future containing the result of the ListResourceScanResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceScanNotFoundException The resource scan was not found.
- ResourceScanInProgressException A resource scan is currently in progress. Only one can be run at a time for an account in a Region.
- 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.
- See Also:
-
listResourceScanResources
default CompletableFuture<ListResourceScanResourcesResponse> listResourceScanResources(Consumer<ListResourceScanResourcesRequest.Builder> listResourceScanResourcesRequest) Lists the resources from a resource scan. The results can be filtered by resource identifier, resource type prefix, tag key, and tag value. Only resources that match all specified filters are returned. The response indicates whether each returned resource is already managed by CloudFormation.
This is a convenience which creates an instance of the
ListResourceScanResourcesRequest.Builder
avoiding the need to create one manually viaListResourceScanResourcesRequest.builder()
- Parameters:
listResourceScanResourcesRequest
- AConsumer
that will call methods onListResourceScanResourcesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListResourceScanResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceScanNotFoundException The resource scan was not found.
- ResourceScanInProgressException A resource scan is currently in progress. Only one can be run at a time for an account in a Region.
- 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.
- See Also:
-
listResourceScanResourcesPaginator
default ListResourceScanResourcesPublisher listResourceScanResourcesPaginator(ListResourceScanResourcesRequest listResourceScanResourcesRequest) This is a variant of
listResourceScanResources(software.amazon.awssdk.services.cloudformation.model.ListResourceScanResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListResourceScanResourcesPublisher publisher = client.listResourceScanResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListResourceScanResourcesPublisher publisher = client.listResourceScanResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListResourceScanResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListResourceScanResourcesResponse response) { //... }; });
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
listResourceScanResources(software.amazon.awssdk.services.cloudformation.model.ListResourceScanResourcesRequest)
operation.- Parameters:
listResourceScanResourcesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceScanNotFoundException The resource scan was not found.
- ResourceScanInProgressException A resource scan is currently in progress. Only one can be run at a time for an account in a Region.
- 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.
- See Also:
-
listResourceScanResourcesPaginator
default ListResourceScanResourcesPublisher listResourceScanResourcesPaginator(Consumer<ListResourceScanResourcesRequest.Builder> listResourceScanResourcesRequest) This is a variant of
listResourceScanResources(software.amazon.awssdk.services.cloudformation.model.ListResourceScanResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListResourceScanResourcesPublisher publisher = client.listResourceScanResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListResourceScanResourcesPublisher publisher = client.listResourceScanResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListResourceScanResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListResourceScanResourcesResponse response) { //... }; });
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
listResourceScanResources(software.amazon.awssdk.services.cloudformation.model.ListResourceScanResourcesRequest)
operation.
This is a convenience which creates an instance of the
ListResourceScanResourcesRequest.Builder
avoiding the need to create one manually viaListResourceScanResourcesRequest.builder()
- Parameters:
listResourceScanResourcesRequest
- AConsumer
that will call methods onListResourceScanResourcesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceScanNotFoundException The resource scan was not found.
- ResourceScanInProgressException A resource scan is currently in progress. Only one can be run at a time for an account in a Region.
- 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.
- See Also:
-
listResourceScans
default CompletableFuture<ListResourceScansResponse> listResourceScans(ListResourceScansRequest listResourceScansRequest) List the resource scans from newest to oldest. By default it will return up to 10 resource scans.
- Parameters:
listResourceScansRequest
-- Returns:
- A Java Future containing the result of the ListResourceScans operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listResourceScans
default CompletableFuture<ListResourceScansResponse> listResourceScans(Consumer<ListResourceScansRequest.Builder> listResourceScansRequest) List the resource scans from newest to oldest. By default it will return up to 10 resource scans.
This is a convenience which creates an instance of the
ListResourceScansRequest.Builder
avoiding the need to create one manually viaListResourceScansRequest.builder()
- Parameters:
listResourceScansRequest
- AConsumer
that will call methods onListResourceScansRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListResourceScans operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listResourceScansPaginator
default ListResourceScansPublisher listResourceScansPaginator(ListResourceScansRequest listResourceScansRequest) This is a variant of
listResourceScans(software.amazon.awssdk.services.cloudformation.model.ListResourceScansRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListResourceScansPublisher publisher = client.listResourceScansPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListResourceScansPublisher publisher = client.listResourceScansPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListResourceScansResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListResourceScansResponse response) { //... }; });
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
listResourceScans(software.amazon.awssdk.services.cloudformation.model.ListResourceScansRequest)
operation.- Parameters:
listResourceScansRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listResourceScansPaginator
default ListResourceScansPublisher listResourceScansPaginator(Consumer<ListResourceScansRequest.Builder> listResourceScansRequest) This is a variant of
listResourceScans(software.amazon.awssdk.services.cloudformation.model.ListResourceScansRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListResourceScansPublisher publisher = client.listResourceScansPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListResourceScansPublisher publisher = client.listResourceScansPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListResourceScansResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListResourceScansResponse response) { //... }; });
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
listResourceScans(software.amazon.awssdk.services.cloudformation.model.ListResourceScansRequest)
operation.
This is a convenience which creates an instance of the
ListResourceScansRequest.Builder
avoiding the need to create one manually viaListResourceScansRequest.builder()
- Parameters:
listResourceScansRequest
- AConsumer
that will call methods onListResourceScansRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listStackInstanceResourceDrifts
default CompletableFuture<ListStackInstanceResourceDriftsResponse> listStackInstanceResourceDrifts(ListStackInstanceResourceDriftsRequest listStackInstanceResourceDriftsRequest) Returns drift information for resources in a stack instance.
ListStackInstanceResourceDrifts
returns drift information for the most recent drift detection operation. If an operation is in progress, it may only return partial results.- Parameters:
listStackInstanceResourceDriftsRequest
-- Returns:
- A Java Future containing the result of the ListStackInstanceResourceDrifts operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- StackSetNotFoundException The specified stack set doesn't exist.
- StackInstanceNotFoundException The specified stack instance 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.
- See Also:
-
listStackInstanceResourceDrifts
default CompletableFuture<ListStackInstanceResourceDriftsResponse> listStackInstanceResourceDrifts(Consumer<ListStackInstanceResourceDriftsRequest.Builder> listStackInstanceResourceDriftsRequest) Returns drift information for resources in a stack instance.
ListStackInstanceResourceDrifts
returns drift information for the most recent drift detection operation. If an operation is in progress, it may only return partial results.
This is a convenience which creates an instance of the
ListStackInstanceResourceDriftsRequest.Builder
avoiding the need to create one manually viaListStackInstanceResourceDriftsRequest.builder()
- Parameters:
listStackInstanceResourceDriftsRequest
- AConsumer
that will call methods onListStackInstanceResourceDriftsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListStackInstanceResourceDrifts operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- StackSetNotFoundException The specified stack set doesn't exist.
- StackInstanceNotFoundException The specified stack instance 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.
- See Also:
-
listStackInstances
default CompletableFuture<ListStackInstancesResponse> listStackInstances(ListStackInstancesRequest listStackInstancesRequest) 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.
- Parameters:
listStackInstancesRequest
-- Returns:
- A Java Future containing the result of the ListStackInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listStackInstances
default CompletableFuture<ListStackInstancesResponse> listStackInstances(Consumer<ListStackInstancesRequest.Builder> listStackInstancesRequest) 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 viaListStackInstancesRequest.builder()
- Parameters:
listStackInstancesRequest
- AConsumer
that will call methods onListStackInstancesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListStackInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listStackInstancesPaginator
default ListStackInstancesPublisher listStackInstancesPaginator(ListStackInstancesRequest listStackInstancesRequest) This is a variant of
listStackInstances(software.amazon.awssdk.services.cloudformation.model.ListStackInstancesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListStackInstancesPublisher publisher = client.listStackInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListStackInstancesPublisher publisher = client.listStackInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListStackInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStackInstancesResponse response) { //... }; });
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.- Parameters:
listStackInstancesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listStackInstancesPaginator
default ListStackInstancesPublisher listStackInstancesPaginator(Consumer<ListStackInstancesRequest.Builder> listStackInstancesRequest) This is a variant of
listStackInstances(software.amazon.awssdk.services.cloudformation.model.ListStackInstancesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListStackInstancesPublisher publisher = client.listStackInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListStackInstancesPublisher publisher = client.listStackInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListStackInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStackInstancesResponse response) { //... }; });
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 viaListStackInstancesRequest.builder()
- Parameters:
listStackInstancesRequest
- AConsumer
that will call methods onListStackInstancesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listStackResources
default CompletableFuture<ListStackResourcesResponse> listStackResources(ListStackResourcesRequest listStackResourcesRequest) 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.
- Parameters:
listStackResourcesRequest
- The input for the ListStackResource action.- Returns:
- A Java Future containing the result of the ListStackResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listStackResources
default CompletableFuture<ListStackResourcesResponse> listStackResources(Consumer<ListStackResourcesRequest.Builder> listStackResourcesRequest) 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 viaListStackResourcesRequest.builder()
- Parameters:
listStackResourcesRequest
- AConsumer
that will call methods onListStackResourcesRequest.Builder
to create a request. The input for the ListStackResource action.- Returns:
- A Java Future containing the result of the ListStackResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listStackResourcesPaginator
default ListStackResourcesPublisher listStackResourcesPaginator(ListStackResourcesRequest listStackResourcesRequest) This is a variant of
listStackResources(software.amazon.awssdk.services.cloudformation.model.ListStackResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListStackResourcesPublisher publisher = client.listStackResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListStackResourcesPublisher publisher = client.listStackResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListStackResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStackResourcesResponse response) { //... }; });
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.- Parameters:
listStackResourcesRequest
- The input for the ListStackResource action.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listStackResourcesPaginator
default ListStackResourcesPublisher listStackResourcesPaginator(Consumer<ListStackResourcesRequest.Builder> listStackResourcesRequest) This is a variant of
listStackResources(software.amazon.awssdk.services.cloudformation.model.ListStackResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListStackResourcesPublisher publisher = client.listStackResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListStackResourcesPublisher publisher = client.listStackResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListStackResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStackResourcesResponse response) { //... }; });
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 viaListStackResourcesRequest.builder()
- Parameters:
listStackResourcesRequest
- AConsumer
that will call methods onListStackResourcesRequest.Builder
to create a request. The input for the ListStackResource action.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listStackSetAutoDeploymentTargets
default CompletableFuture<ListStackSetAutoDeploymentTargetsResponse> listStackSetAutoDeploymentTargets(ListStackSetAutoDeploymentTargetsRequest listStackSetAutoDeploymentTargetsRequest) Returns summary information about deployment targets for a stack set.
- Parameters:
listStackSetAutoDeploymentTargetsRequest
-- Returns:
- A Java Future containing the result of the ListStackSetAutoDeploymentTargets operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listStackSetAutoDeploymentTargets
default CompletableFuture<ListStackSetAutoDeploymentTargetsResponse> listStackSetAutoDeploymentTargets(Consumer<ListStackSetAutoDeploymentTargetsRequest.Builder> listStackSetAutoDeploymentTargetsRequest) Returns summary information about deployment targets for a stack set.
This is a convenience which creates an instance of the
ListStackSetAutoDeploymentTargetsRequest.Builder
avoiding the need to create one manually viaListStackSetAutoDeploymentTargetsRequest.builder()
- Parameters:
listStackSetAutoDeploymentTargetsRequest
- AConsumer
that will call methods onListStackSetAutoDeploymentTargetsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListStackSetAutoDeploymentTargets operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listStackSetOperationResults
default CompletableFuture<ListStackSetOperationResultsResponse> listStackSetOperationResults(ListStackSetOperationResultsRequest listStackSetOperationResultsRequest) Returns summary information about the results of a stack set operation.
- Parameters:
listStackSetOperationResultsRequest
-- Returns:
- A Java Future containing the result of the ListStackSetOperationResults operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listStackSetOperationResults
default CompletableFuture<ListStackSetOperationResultsResponse> listStackSetOperationResults(Consumer<ListStackSetOperationResultsRequest.Builder> listStackSetOperationResultsRequest) 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 viaListStackSetOperationResultsRequest.builder()
- Parameters:
listStackSetOperationResultsRequest
- AConsumer
that will call methods onListStackSetOperationResultsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListStackSetOperationResults operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listStackSetOperationResultsPaginator
default ListStackSetOperationResultsPublisher listStackSetOperationResultsPaginator(ListStackSetOperationResultsRequest listStackSetOperationResultsRequest) This is a variant of
listStackSetOperationResults(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationResultsPublisher publisher = client.listStackSetOperationResultsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationResultsPublisher publisher = client.listStackSetOperationResultsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsResponse response) { //... }; });
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.- Parameters:
listStackSetOperationResultsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listStackSetOperationResultsPaginator
default ListStackSetOperationResultsPublisher listStackSetOperationResultsPaginator(Consumer<ListStackSetOperationResultsRequest.Builder> listStackSetOperationResultsRequest) This is a variant of
listStackSetOperationResults(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationResultsPublisher publisher = client.listStackSetOperationResultsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationResultsPublisher publisher = client.listStackSetOperationResultsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsResponse response) { //... }; });
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 viaListStackSetOperationResultsRequest.builder()
- Parameters:
listStackSetOperationResultsRequest
- AConsumer
that will call methods onListStackSetOperationResultsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listStackSetOperations
default CompletableFuture<ListStackSetOperationsResponse> listStackSetOperations(ListStackSetOperationsRequest listStackSetOperationsRequest) Returns summary information about operations performed on a stack set.
- Parameters:
listStackSetOperationsRequest
-- Returns:
- A Java Future containing the result of the ListStackSetOperations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listStackSetOperations
default CompletableFuture<ListStackSetOperationsResponse> listStackSetOperations(Consumer<ListStackSetOperationsRequest.Builder> listStackSetOperationsRequest) 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 viaListStackSetOperationsRequest.builder()
- Parameters:
listStackSetOperationsRequest
- AConsumer
that will call methods onListStackSetOperationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListStackSetOperations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listStackSetOperationsPaginator
default ListStackSetOperationsPublisher listStackSetOperationsPaginator(ListStackSetOperationsRequest listStackSetOperationsRequest) This is a variant of
listStackSetOperations(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationsPublisher publisher = client.listStackSetOperationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationsPublisher publisher = client.listStackSetOperationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsResponse response) { //... }; });
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.- Parameters:
listStackSetOperationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listStackSetOperationsPaginator
default ListStackSetOperationsPublisher listStackSetOperationsPaginator(Consumer<ListStackSetOperationsRequest.Builder> listStackSetOperationsRequest) This is a variant of
listStackSetOperations(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationsPublisher publisher = client.listStackSetOperationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationsPublisher publisher = client.listStackSetOperationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsResponse response) { //... }; });
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 viaListStackSetOperationsRequest.builder()
- Parameters:
listStackSetOperationsRequest
- AConsumer
that will call methods onListStackSetOperationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listStackSets
default CompletableFuture<ListStackSetsResponse> listStackSets(ListStackSetsRequest listStackSetsRequest) Returns summary information about stack sets that are associated with the user.
-
[Self-managed permissions] If you set the
CallAs
parameter toSELF
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 toSELF
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 toDELEGATED_ADMIN
while signed in to your member account,ListStackSets
returns all stack sets with service-managed permissions in the management account.
- Parameters:
listStackSetsRequest
-- Returns:
- A Java Future containing the result of the ListStackSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
-
listStackSets
default CompletableFuture<ListStackSetsResponse> listStackSets(Consumer<ListStackSetsRequest.Builder> listStackSetsRequest) Returns summary information about stack sets that are associated with the user.
-
[Self-managed permissions] If you set the
CallAs
parameter toSELF
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 toSELF
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 toDELEGATED_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 viaListStackSetsRequest.builder()
- Parameters:
listStackSetsRequest
- AConsumer
that will call methods onListStackSetsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListStackSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
-
listStackSets
Returns summary information about stack sets that are associated with the user.
-
[Self-managed permissions] If you set the
CallAs
parameter toSELF
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 toSELF
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 toDELEGATED_ADMIN
while signed in to your member account,ListStackSets
returns all stack sets with service-managed permissions in the management account.
- Returns:
- A Java Future containing the result of the ListStackSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
-
listStackSetsPaginator
This is a variant of
listStackSets(software.amazon.awssdk.services.cloudformation.model.ListStackSetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListStackSetsPublisher publisher = client.listStackSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListStackSetsPublisher publisher = client.listStackSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListStackSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStackSetsResponse response) { //... }; });
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.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listStackSetsPaginator
This is a variant of
listStackSets(software.amazon.awssdk.services.cloudformation.model.ListStackSetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListStackSetsPublisher publisher = client.listStackSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListStackSetsPublisher publisher = client.listStackSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListStackSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStackSetsResponse response) { //... }; });
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.- Parameters:
listStackSetsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listStackSetsPaginator
default ListStackSetsPublisher listStackSetsPaginator(Consumer<ListStackSetsRequest.Builder> listStackSetsRequest) This is a variant of
listStackSets(software.amazon.awssdk.services.cloudformation.model.ListStackSetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListStackSetsPublisher publisher = client.listStackSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListStackSetsPublisher publisher = client.listStackSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListStackSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStackSetsResponse response) { //... }; });
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 viaListStackSetsRequest.builder()
- Parameters:
listStackSetsRequest
- AConsumer
that will call methods onListStackSetsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listStacks
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).
- Parameters:
listStacksRequest
- The input for ListStacks action.- Returns:
- A Java Future containing the result of the ListStacks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listStacks
default CompletableFuture<ListStacksResponse> listStacks(Consumer<ListStacksRequest.Builder> listStacksRequest) 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 viaListStacksRequest.builder()
- Parameters:
listStacksRequest
- AConsumer
that will call methods onListStacksRequest.Builder
to create a request. The input for ListStacks action.- Returns:
- A Java Future containing the result of the ListStacks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listStacks
Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).
- Returns:
- A Java Future containing the result of the ListStacks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listStacksPaginator
This is a variant of
listStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListStacksPublisher publisher = client.listStacksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListStacksPublisher publisher = client.listStacksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListStacksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStacksResponse response) { //... }; });
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.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listStacksPaginator
This is a variant of
listStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListStacksPublisher publisher = client.listStacksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListStacksPublisher publisher = client.listStacksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListStacksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStacksResponse response) { //... }; });
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.- Parameters:
listStacksRequest
- The input for ListStacks action.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listStacksPaginator
default ListStacksPublisher listStacksPaginator(Consumer<ListStacksRequest.Builder> listStacksRequest) This is a variant of
listStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListStacksPublisher publisher = client.listStacksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListStacksPublisher publisher = client.listStacksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListStacksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStacksResponse response) { //... }; });
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 viaListStacksRequest.builder()
- Parameters:
listStacksRequest
- AConsumer
that will call methods onListStacksRequest.Builder
to create a request. The input for ListStacks action.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listTypeRegistrations
default CompletableFuture<ListTypeRegistrationsResponse> listTypeRegistrations(ListTypeRegistrationsRequest listTypeRegistrationsRequest) Returns a list of registration tokens for the specified extension(s).
- Parameters:
listTypeRegistrationsRequest
-- Returns:
- A Java Future containing the result of the ListTypeRegistrations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listTypeRegistrations
default CompletableFuture<ListTypeRegistrationsResponse> listTypeRegistrations(Consumer<ListTypeRegistrationsRequest.Builder> listTypeRegistrationsRequest) 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 viaListTypeRegistrationsRequest.builder()
- Parameters:
listTypeRegistrationsRequest
- AConsumer
that will call methods onListTypeRegistrationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTypeRegistrations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listTypeRegistrationsPaginator
default ListTypeRegistrationsPublisher listTypeRegistrationsPaginator(ListTypeRegistrationsRequest listTypeRegistrationsRequest) This is a variant of
listTypeRegistrations(software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListTypeRegistrationsPublisher publisher = client.listTypeRegistrationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListTypeRegistrationsPublisher publisher = client.listTypeRegistrationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsResponse response) { //... }; });
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.- Parameters:
listTypeRegistrationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listTypeRegistrationsPaginator
default ListTypeRegistrationsPublisher listTypeRegistrationsPaginator(Consumer<ListTypeRegistrationsRequest.Builder> listTypeRegistrationsRequest) This is a variant of
listTypeRegistrations(software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListTypeRegistrationsPublisher publisher = client.listTypeRegistrationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListTypeRegistrationsPublisher publisher = client.listTypeRegistrationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsResponse response) { //... }; });
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 viaListTypeRegistrationsRequest.builder()
- Parameters:
listTypeRegistrationsRequest
- AConsumer
that will call methods onListTypeRegistrationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listTypeVersions
default CompletableFuture<ListTypeVersionsResponse> listTypeVersions(ListTypeVersionsRequest listTypeVersionsRequest) Returns summary information about the versions of an extension.
- Parameters:
listTypeVersionsRequest
-- Returns:
- A Java Future containing the result of the ListTypeVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listTypeVersions
default CompletableFuture<ListTypeVersionsResponse> listTypeVersions(Consumer<ListTypeVersionsRequest.Builder> listTypeVersionsRequest) 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 viaListTypeVersionsRequest.builder()
- Parameters:
listTypeVersionsRequest
- AConsumer
that will call methods onListTypeVersionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTypeVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listTypeVersionsPaginator
default ListTypeVersionsPublisher listTypeVersionsPaginator(ListTypeVersionsRequest listTypeVersionsRequest) This is a variant of
listTypeVersions(software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListTypeVersionsPublisher publisher = client.listTypeVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListTypeVersionsPublisher publisher = client.listTypeVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsResponse response) { //... }; });
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.- Parameters:
listTypeVersionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listTypeVersionsPaginator
default ListTypeVersionsPublisher listTypeVersionsPaginator(Consumer<ListTypeVersionsRequest.Builder> listTypeVersionsRequest) This is a variant of
listTypeVersions(software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListTypeVersionsPublisher publisher = client.listTypeVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListTypeVersionsPublisher publisher = client.listTypeVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsResponse response) { //... }; });
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 viaListTypeVersionsRequest.builder()
- Parameters:
listTypeVersionsRequest
- AConsumer
that will call methods onListTypeVersionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listTypes
Returns summary information about extension that have been registered with CloudFormation.
- Parameters:
listTypesRequest
-- Returns:
- A Java Future containing the result of the ListTypes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listTypes
default CompletableFuture<ListTypesResponse> listTypes(Consumer<ListTypesRequest.Builder> listTypesRequest) 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 viaListTypesRequest.builder()
- Parameters:
listTypesRequest
- AConsumer
that will call methods onListTypesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTypes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listTypesPaginator
This is a variant of
listTypes(software.amazon.awssdk.services.cloudformation.model.ListTypesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListTypesPublisher publisher = client.listTypesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListTypesPublisher publisher = client.listTypesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListTypesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListTypesResponse response) { //... }; });
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.- Parameters:
listTypesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
listTypesPaginator
This is a variant of
listTypes(software.amazon.awssdk.services.cloudformation.model.ListTypesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudformation.paginators.ListTypesPublisher publisher = client.listTypesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudformation.paginators.ListTypesPublisher publisher = client.listTypesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudformation.model.ListTypesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudformation.model.ListTypesResponse response) { //... }; });
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 viaListTypesRequest.builder()
- Parameters:
listTypesRequest
- AConsumer
that will call methods onListTypesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
publishType
Publishes the specified extension to the CloudFormation registry as a public extension in this Region. Public extensions are available for use by all CloudFormation users. For more information about publishing extensions, see Publishing extensions to make them available for public use in the CloudFormation CLI User Guide.
To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.
- Parameters:
publishTypeRequest
-- Returns:
- A Java Future containing the result of the PublishType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CfnRegistryException An error occurred during a CloudFormation registry operation.
- TypeNotFoundException The specified extension doesn't 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.
- See Also:
-
publishType
default CompletableFuture<PublishTypeResponse> publishType(Consumer<PublishTypeRequest.Builder> publishTypeRequest) Publishes the specified extension to the CloudFormation registry as a public extension in this Region. Public extensions are available for use by all CloudFormation users. For more information about publishing extensions, see Publishing extensions to make them available for public use 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 viaPublishTypeRequest.builder()
- Parameters:
publishTypeRequest
- AConsumer
that will call methods onPublishTypeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PublishType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CfnRegistryException An error occurred during a CloudFormation registry operation.
- TypeNotFoundException The specified extension doesn't 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.
- See Also:
-
recordHandlerProgress
default CompletableFuture<RecordHandlerProgressResponse> recordHandlerProgress(RecordHandlerProgressRequest recordHandlerProgressRequest) Reports progress of a resource handler to CloudFormation.
Reserved for use by the CloudFormation CLI. Don't use this API in your code.
- Parameters:
recordHandlerProgressRequest
-- Returns:
- A Java Future containing the result of the RecordHandlerProgress operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidStateTransitionException Error reserved for use by the CloudFormation CLI. CloudFormation doesn't return this error to users.
- OperationStatusCheckFailedException Error reserved for use by the CloudFormation CLI. CloudFormation doesn't 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.
- See Also:
-
recordHandlerProgress
default CompletableFuture<RecordHandlerProgressResponse> recordHandlerProgress(Consumer<RecordHandlerProgressRequest.Builder> recordHandlerProgressRequest) Reports progress of a resource handler to CloudFormation.
Reserved for use by the CloudFormation CLI. Don't 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 viaRecordHandlerProgressRequest.builder()
- Parameters:
recordHandlerProgressRequest
- AConsumer
that will call methods onRecordHandlerProgressRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RecordHandlerProgress operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidStateTransitionException Error reserved for use by the CloudFormation CLI. CloudFormation doesn't return this error to users.
- OperationStatusCheckFailedException Error reserved for use by the CloudFormation CLI. CloudFormation doesn't 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.
- See Also:
-
registerPublisher
default CompletableFuture<RegisterPublisherResponse> registerPublisher(RegisterPublisherRequest registerPublisherRequest) Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users. This publisher ID applies to your account in all Amazon Web Services Regions.
For information about requirements for registering as a public extension publisher, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide.
- Parameters:
registerPublisherRequest
-- Returns:
- A Java Future containing the result of the RegisterPublisher operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
registerPublisher
default CompletableFuture<RegisterPublisherResponse> registerPublisher(Consumer<RegisterPublisherRequest.Builder> registerPublisherRequest) Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users. This publisher ID applies to your account in all Amazon Web Services Regions.
For information about requirements for registering as a public extension publisher, see Registering your account to publish CloudFormation extensions 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 viaRegisterPublisherRequest.builder()
- Parameters:
registerPublisherRequest
- AConsumer
that will call methods onRegisterPublisherRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RegisterPublisher operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
registerType
default CompletableFuture<RegisterTypeResponse> registerType(RegisterTypeRequest registerTypeRequest) Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:
-
Validating the extension schema.
-
Determining which handlers, if any, have been specified for the extension.
-
Making the extension available for use in your account.
For more information about how to develop extensions and ready them for registration, see Creating Resource Providers 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.
- Parameters:
registerTypeRequest
-- Returns:
- A Java Future containing the result of the RegisterType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
-
registerType
default CompletableFuture<RegisterTypeResponse> registerType(Consumer<RegisterTypeRequest.Builder> registerTypeRequest) Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:
-
Validating the extension schema.
-
Determining which handlers, if any, have been specified for the extension.
-
Making the extension available for use in your account.
For more information about how to develop extensions and ready them for registration, see Creating Resource Providers 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 viaRegisterTypeRequest.builder()
- Parameters:
registerTypeRequest
- AConsumer
that will call methods onRegisterTypeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RegisterType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
-
rollbackStack
default CompletableFuture<RollbackStackResponse> rollbackStack(RollbackStackRequest rollbackStackRequest) When specifying
RollbackStack
, you preserve the state of previously provisioned resources when an operation fails. You can check the status of the stack through the DescribeStacks operation.Rolls back the specified stack to the last known stable state from
CREATE_FAILED
orUPDATE_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
- Parameters:
rollbackStackRequest
-- Returns:
- A Java Future containing the result of the RollbackStack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
-
rollbackStack
default CompletableFuture<RollbackStackResponse> rollbackStack(Consumer<RollbackStackRequest.Builder> rollbackStackRequest) When specifying
RollbackStack
, you preserve the state of previously provisioned resources when an operation fails. You can check the status of the stack through the DescribeStacks operation.Rolls back the specified stack to the last known stable state from
CREATE_FAILED
orUPDATE_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 viaRollbackStackRequest.builder()
- Parameters:
rollbackStackRequest
- AConsumer
that will call methods onRollbackStackRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RollbackStack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
-
setStackPolicy
default CompletableFuture<SetStackPolicyResponse> setStackPolicy(SetStackPolicyRequest setStackPolicyRequest) Sets a stack policy for a specified stack.
- Parameters:
setStackPolicyRequest
- The input for the SetStackPolicy action.- Returns:
- A Java Future containing the result of the SetStackPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
setStackPolicy
default CompletableFuture<SetStackPolicyResponse> setStackPolicy(Consumer<SetStackPolicyRequest.Builder> setStackPolicyRequest) 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 viaSetStackPolicyRequest.builder()
- Parameters:
setStackPolicyRequest
- AConsumer
that will call methods onSetStackPolicyRequest.Builder
to create a request. The input for the SetStackPolicy action.- Returns:
- A Java Future containing the result of the SetStackPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
setTypeConfiguration
default CompletableFuture<SetTypeConfigurationResponse> setTypeConfiguration(SetTypeConfigurationRequest setTypeConfigurationRequest) 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's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more details on dynamic references, see Using dynamic references to specify template values in the CloudFormation User Guide.
- Parameters:
setTypeConfigurationRequest
-- Returns:
- A Java Future containing the result of the SetTypeConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CfnRegistryException An error occurred during a CloudFormation registry operation.
- TypeNotFoundException The specified extension doesn't 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.
- See Also:
-
setTypeConfiguration
default CompletableFuture<SetTypeConfigurationResponse> setTypeConfiguration(Consumer<SetTypeConfigurationRequest.Builder> setTypeConfigurationRequest) 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's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more details on dynamic references, see Using dynamic references to specify template values in the CloudFormation User Guide.
This is a convenience which creates an instance of the
SetTypeConfigurationRequest.Builder
avoiding the need to create one manually viaSetTypeConfigurationRequest.builder()
- Parameters:
setTypeConfigurationRequest
- AConsumer
that will call methods onSetTypeConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SetTypeConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CfnRegistryException An error occurred during a CloudFormation registry operation.
- TypeNotFoundException The specified extension doesn't 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.
- See Also:
-
setTypeDefaultVersion
default CompletableFuture<SetTypeDefaultVersionResponse> setTypeDefaultVersion(SetTypeDefaultVersionRequest setTypeDefaultVersionRequest) Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.
- Parameters:
setTypeDefaultVersionRequest
-- Returns:
- A Java Future containing the result of the SetTypeDefaultVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CfnRegistryException An error occurred during a CloudFormation registry operation.
- TypeNotFoundException The specified extension doesn't 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.
- See Also:
-
setTypeDefaultVersion
default CompletableFuture<SetTypeDefaultVersionResponse> setTypeDefaultVersion(Consumer<SetTypeDefaultVersionRequest.Builder> setTypeDefaultVersionRequest) 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 viaSetTypeDefaultVersionRequest.builder()
- Parameters:
setTypeDefaultVersionRequest
- AConsumer
that will call methods onSetTypeDefaultVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SetTypeDefaultVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CfnRegistryException An error occurred during a CloudFormation registry operation.
- TypeNotFoundException The specified extension doesn't 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.
- See Also:
-
signalResource
default CompletableFuture<SignalResourceResponse> signalResource(SignalResourceRequest signalResourceRequest) Sends a signal to the specified resource with a success or failure status. You can use the
SignalResource
operation in conjunction with a creation policy or update policy. CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. TheSignalResource
operation is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.- Parameters:
signalResourceRequest
- The input for the SignalResource action.- Returns:
- A Java Future containing the result of the SignalResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
signalResource
default CompletableFuture<SignalResourceResponse> signalResource(Consumer<SignalResourceRequest.Builder> signalResourceRequest) Sends a signal to the specified resource with a success or failure status. You can use the
SignalResource
operation in conjunction with a creation policy or update policy. CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. TheSignalResource
operation 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 viaSignalResourceRequest.builder()
- Parameters:
signalResourceRequest
- AConsumer
that will call methods onSignalResourceRequest.Builder
to create a request. The input for the SignalResource action.- Returns:
- A Java Future containing the result of the SignalResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
startResourceScan
default CompletableFuture<StartResourceScanResponse> startResourceScan(StartResourceScanRequest startResourceScanRequest) Starts a scan of the resources in this account in this Region. You can the status of a scan using the
ListResourceScans
API action.- Parameters:
startResourceScanRequest
-- Returns:
- A Java Future containing the result of the StartResourceScan operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceScanInProgressException A resource scan is currently in progress. Only one can be run at a time for an account in a Region.
- ResourceScanLimitExceededException The limit on resource scans has been exceeded. Reasons
include:
-
Exceeded the daily quota for resource scans.
-
A resource scan recently failed. You must wait 10 minutes before starting a new resource scan.
-
The last resource scan failed after exceeding 100,000 resources. When this happens, you must wait 24 hours before starting a new resource scan.
-
- 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.
- See Also:
-
startResourceScan
default CompletableFuture<StartResourceScanResponse> startResourceScan(Consumer<StartResourceScanRequest.Builder> startResourceScanRequest) Starts a scan of the resources in this account in this Region. You can the status of a scan using the
ListResourceScans
API action.
This is a convenience which creates an instance of the
StartResourceScanRequest.Builder
avoiding the need to create one manually viaStartResourceScanRequest.builder()
- Parameters:
startResourceScanRequest
- AConsumer
that will call methods onStartResourceScanRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartResourceScan operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceScanInProgressException A resource scan is currently in progress. Only one can be run at a time for an account in a Region.
- ResourceScanLimitExceededException The limit on resource scans has been exceeded. Reasons
include:
-
Exceeded the daily quota for resource scans.
-
A resource scan recently failed. You must wait 10 minutes before starting a new resource scan.
-
The last resource scan failed after exceeding 100,000 resources. When this happens, you must wait 24 hours before starting a new resource scan.
-
- 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.
- See Also:
-
stopStackSetOperation
default CompletableFuture<StopStackSetOperationResponse> stopStackSetOperation(StopStackSetOperationRequest stopStackSetOperationRequest) Stops an in-progress operation on a stack set and its associated stack instances. StackSets will cancel all the unstarted stack instance deployments and wait for those are in-progress to complete.
- Parameters:
stopStackSetOperationRequest
-- Returns:
- A Java Future containing the result of the StopStackSetOperation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
stopStackSetOperation
default CompletableFuture<StopStackSetOperationResponse> stopStackSetOperation(Consumer<StopStackSetOperationRequest.Builder> stopStackSetOperationRequest) Stops an in-progress operation on a stack set and its associated stack instances. StackSets will cancel all the unstarted stack instance deployments and wait for those are in-progress to complete.
This is a convenience which creates an instance of the
StopStackSetOperationRequest.Builder
avoiding the need to create one manually viaStopStackSetOperationRequest.builder()
- Parameters:
stopStackSetOperationRequest
- AConsumer
that will call methods onStopStackSetOperationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopStackSetOperation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
testType
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 don't specify a version, CloudFormation uses the default version of the extension in your account and Region for testing.
To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more information, see RegisterType.
Once you've initiated testing on an extension using
TestType
, you can pass the returnedTypeVersionArn
into 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.- Parameters:
testTypeRequest
-- Returns:
- A Java Future containing the result of the TestType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CfnRegistryException An error occurred during a CloudFormation registry operation.
- TypeNotFoundException The specified extension doesn't 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.
- See Also:
-
-
testType
default CompletableFuture<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.
-
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 don't specify a version, CloudFormation uses the default version of the extension in your account and Region for testing.
To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more information, see RegisterType.
Once you've initiated testing on an extension using
TestType
, you can pass the returnedTypeVersionArn
into 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 viaTestTypeRequest.builder()
- Parameters:
testTypeRequest
- AConsumer
that will call methods onTestTypeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TestType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- CfnRegistryException An error occurred during a CloudFormation registry operation.
- TypeNotFoundException The specified extension doesn't 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.
- See Also:
-
-
updateGeneratedTemplate
default CompletableFuture<UpdateGeneratedTemplateResponse> updateGeneratedTemplate(UpdateGeneratedTemplateRequest updateGeneratedTemplateRequest) Updates a generated template. This can be used to change the name, add and remove resources, refresh resources, and change the
DeletionPolicy
andUpdateReplacePolicy
settings. You can check the status of the update to the generated template using theDescribeGeneratedTemplate
API action.- Parameters:
updateGeneratedTemplateRequest
-- Returns:
- A Java Future containing the result of the UpdateGeneratedTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AlreadyExistsException The resource with the name requested already exists.
- GeneratedTemplateNotFoundException The generated template was not found.
- LimitExceededException The quota for the resource has already been reached.
For information about resource and stack limitations, see CloudFormation quotas 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.
- See Also:
-
updateGeneratedTemplate
default CompletableFuture<UpdateGeneratedTemplateResponse> updateGeneratedTemplate(Consumer<UpdateGeneratedTemplateRequest.Builder> updateGeneratedTemplateRequest) Updates a generated template. This can be used to change the name, add and remove resources, refresh resources, and change the
DeletionPolicy
andUpdateReplacePolicy
settings. You can check the status of the update to the generated template using theDescribeGeneratedTemplate
API action.
This is a convenience which creates an instance of the
UpdateGeneratedTemplateRequest.Builder
avoiding the need to create one manually viaUpdateGeneratedTemplateRequest.builder()
- Parameters:
updateGeneratedTemplateRequest
- AConsumer
that will call methods onUpdateGeneratedTemplateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateGeneratedTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- AlreadyExistsException The resource with the name requested already exists.
- GeneratedTemplateNotFoundException The generated template was not found.
- LimitExceededException The quota for the resource has already been reached.
For information about resource and stack limitations, see CloudFormation quotas 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.
- See Also:
-
updateStack
Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack through the DescribeStacks action.
To get a copy of the template for an existing stack, you can use the GetTemplate action.
For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack.
- Parameters:
updateStackRequest
- The input for an UpdateStack action.- Returns:
- A Java Future containing the result of the UpdateStack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
updateStack
default CompletableFuture<UpdateStackResponse> updateStack(Consumer<UpdateStackRequest.Builder> updateStackRequest) Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack through the DescribeStacks action.
To get a copy of the template for an existing stack, you can use the GetTemplate action.
For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack.
This is a convenience which creates an instance of the
UpdateStackRequest.Builder
avoiding the need to create one manually viaUpdateStackRequest.builder()
- Parameters:
updateStackRequest
- AConsumer
that will call methods onUpdateStackRequest.Builder
to create a request. The input for an UpdateStack action.- Returns:
- A Java Future containing the result of the UpdateStack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
updateStackInstances
default CompletableFuture<UpdateStackInstancesResponse> updateStackInstances(UpdateStackInstancesRequest updateStackInstancesRequest) Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.
You can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances.
During stack set updates, any parameters overridden for a stack instance aren't updated, but retain their overridden value.
You can only update the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet 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
.- Parameters:
updateStackInstancesRequest
-- Returns:
- A Java Future containing the result of the UpdateStackInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
updateStackInstances
default CompletableFuture<UpdateStackInstancesResponse> updateStackInstances(Consumer<UpdateStackInstancesRequest.Builder> updateStackInstancesRequest) Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.
You can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances.
During stack set updates, any parameters overridden for a stack instance aren't updated, but retain their overridden value.
You can only update the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet 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 viaUpdateStackInstancesRequest.builder()
- Parameters:
updateStackInstancesRequest
- AConsumer
that will call methods onUpdateStackInstancesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateStackInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
updateStackSet
default CompletableFuture<UpdateStackSetResponse> updateStackSet(UpdateStackSetRequest updateStackSetRequest) Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.
Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.
- Parameters:
updateStackSetRequest
-- Returns:
- A Java Future containing the result of the UpdateStackSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
updateStackSet
default CompletableFuture<UpdateStackSetResponse> updateStackSet(Consumer<UpdateStackSetRequest.Builder> updateStackSetRequest) Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.
Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.
This is a convenience which creates an instance of the
UpdateStackSetRequest.Builder
avoiding the need to create one manually viaUpdateStackSetRequest.builder()
- Parameters:
updateStackSetRequest
- AConsumer
that will call methods onUpdateStackSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateStackSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
updateTerminationProtection
default CompletableFuture<UpdateTerminationProtectionResponse> updateTerminationProtection(UpdateTerminationProtectionRequest updateTerminationProtectionRequest) 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 can't be changed directly on the nested stack.
- Parameters:
updateTerminationProtectionRequest
-- Returns:
- A Java Future containing the result of the UpdateTerminationProtection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
updateTerminationProtection
default CompletableFuture<UpdateTerminationProtectionResponse> updateTerminationProtection(Consumer<UpdateTerminationProtectionRequest.Builder> updateTerminationProtectionRequest) 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 can't 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 viaUpdateTerminationProtectionRequest.builder()
- Parameters:
updateTerminationProtectionRequest
- AConsumer
that will call methods onUpdateTerminationProtectionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateTerminationProtection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
validateTemplate
default CompletableFuture<ValidateTemplateResponse> validateTemplate(ValidateTemplateRequest validateTemplateRequest) 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.
- Parameters:
validateTemplateRequest
- The input for ValidateTemplate action.- Returns:
- A Java Future containing the result of the ValidateTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
validateTemplate
default CompletableFuture<ValidateTemplateResponse> validateTemplate(Consumer<ValidateTemplateRequest.Builder> validateTemplateRequest) 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 viaValidateTemplateRequest.builder()
- Parameters:
validateTemplateRequest
- AConsumer
that will call methods onValidateTemplateRequest.Builder
to create a request. The input for ValidateTemplate action.- Returns:
- A Java Future containing the result of the ValidateTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- See Also:
-
waiter
Create an instance ofCloudFormationAsyncWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
CloudFormationAsyncWaiter
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aCloudFormationAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aCloudFormationAsyncClient
.
-