software.amazon.awssdk.services.cloudformation.CloudFormationAsyncClient Maven / Gradle / Ivy
Show all versions of cloudformation Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.cloudformation;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
import software.amazon.awssdk.services.cloudformation.model.ActivateOrganizationsAccessRequest;
import software.amazon.awssdk.services.cloudformation.model.ActivateOrganizationsAccessResponse;
import software.amazon.awssdk.services.cloudformation.model.ActivateTypeRequest;
import software.amazon.awssdk.services.cloudformation.model.ActivateTypeResponse;
import software.amazon.awssdk.services.cloudformation.model.BatchDescribeTypeConfigurationsRequest;
import software.amazon.awssdk.services.cloudformation.model.BatchDescribeTypeConfigurationsResponse;
import software.amazon.awssdk.services.cloudformation.model.CancelUpdateStackRequest;
import software.amazon.awssdk.services.cloudformation.model.CancelUpdateStackResponse;
import software.amazon.awssdk.services.cloudformation.model.ContinueUpdateRollbackRequest;
import software.amazon.awssdk.services.cloudformation.model.ContinueUpdateRollbackResponse;
import software.amazon.awssdk.services.cloudformation.model.CreateChangeSetRequest;
import software.amazon.awssdk.services.cloudformation.model.CreateChangeSetResponse;
import software.amazon.awssdk.services.cloudformation.model.CreateGeneratedTemplateRequest;
import software.amazon.awssdk.services.cloudformation.model.CreateGeneratedTemplateResponse;
import software.amazon.awssdk.services.cloudformation.model.CreateStackInstancesRequest;
import software.amazon.awssdk.services.cloudformation.model.CreateStackInstancesResponse;
import software.amazon.awssdk.services.cloudformation.model.CreateStackRequest;
import software.amazon.awssdk.services.cloudformation.model.CreateStackResponse;
import software.amazon.awssdk.services.cloudformation.model.CreateStackSetRequest;
import software.amazon.awssdk.services.cloudformation.model.CreateStackSetResponse;
import software.amazon.awssdk.services.cloudformation.model.DeactivateOrganizationsAccessRequest;
import software.amazon.awssdk.services.cloudformation.model.DeactivateOrganizationsAccessResponse;
import software.amazon.awssdk.services.cloudformation.model.DeactivateTypeRequest;
import software.amazon.awssdk.services.cloudformation.model.DeactivateTypeResponse;
import software.amazon.awssdk.services.cloudformation.model.DeleteChangeSetRequest;
import software.amazon.awssdk.services.cloudformation.model.DeleteChangeSetResponse;
import software.amazon.awssdk.services.cloudformation.model.DeleteGeneratedTemplateRequest;
import software.amazon.awssdk.services.cloudformation.model.DeleteGeneratedTemplateResponse;
import software.amazon.awssdk.services.cloudformation.model.DeleteStackInstancesRequest;
import software.amazon.awssdk.services.cloudformation.model.DeleteStackInstancesResponse;
import software.amazon.awssdk.services.cloudformation.model.DeleteStackRequest;
import software.amazon.awssdk.services.cloudformation.model.DeleteStackResponse;
import software.amazon.awssdk.services.cloudformation.model.DeleteStackSetRequest;
import software.amazon.awssdk.services.cloudformation.model.DeleteStackSetResponse;
import software.amazon.awssdk.services.cloudformation.model.DeregisterTypeRequest;
import software.amazon.awssdk.services.cloudformation.model.DeregisterTypeResponse;
import software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsRequest;
import software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsResponse;
import software.amazon.awssdk.services.cloudformation.model.DescribeChangeSetHooksRequest;
import software.amazon.awssdk.services.cloudformation.model.DescribeChangeSetHooksResponse;
import software.amazon.awssdk.services.cloudformation.model.DescribeChangeSetRequest;
import software.amazon.awssdk.services.cloudformation.model.DescribeChangeSetResponse;
import software.amazon.awssdk.services.cloudformation.model.DescribeGeneratedTemplateRequest;
import software.amazon.awssdk.services.cloudformation.model.DescribeGeneratedTemplateResponse;
import software.amazon.awssdk.services.cloudformation.model.DescribeOrganizationsAccessRequest;
import software.amazon.awssdk.services.cloudformation.model.DescribeOrganizationsAccessResponse;
import software.amazon.awssdk.services.cloudformation.model.DescribePublisherRequest;
import software.amazon.awssdk.services.cloudformation.model.DescribePublisherResponse;
import software.amazon.awssdk.services.cloudformation.model.DescribeResourceScanRequest;
import software.amazon.awssdk.services.cloudformation.model.DescribeResourceScanResponse;
import software.amazon.awssdk.services.cloudformation.model.DescribeStackDriftDetectionStatusRequest;
import software.amazon.awssdk.services.cloudformation.model.DescribeStackDriftDetectionStatusResponse;
import software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsRequest;
import software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsResponse;
import software.amazon.awssdk.services.cloudformation.model.DescribeStackInstanceRequest;
import software.amazon.awssdk.services.cloudformation.model.DescribeStackInstanceResponse;
import software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsRequest;
import software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsResponse;
import software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceRequest;
import software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceResponse;
import software.amazon.awssdk.services.cloudformation.model.DescribeStackResourcesRequest;
import software.amazon.awssdk.services.cloudformation.model.DescribeStackResourcesResponse;
import software.amazon.awssdk.services.cloudformation.model.DescribeStackSetOperationRequest;
import software.amazon.awssdk.services.cloudformation.model.DescribeStackSetOperationResponse;
import software.amazon.awssdk.services.cloudformation.model.DescribeStackSetRequest;
import software.amazon.awssdk.services.cloudformation.model.DescribeStackSetResponse;
import software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest;
import software.amazon.awssdk.services.cloudformation.model.DescribeStacksResponse;
import software.amazon.awssdk.services.cloudformation.model.DescribeTypeRegistrationRequest;
import software.amazon.awssdk.services.cloudformation.model.DescribeTypeRegistrationResponse;
import software.amazon.awssdk.services.cloudformation.model.DescribeTypeRequest;
import software.amazon.awssdk.services.cloudformation.model.DescribeTypeResponse;
import software.amazon.awssdk.services.cloudformation.model.DetectStackDriftRequest;
import software.amazon.awssdk.services.cloudformation.model.DetectStackDriftResponse;
import software.amazon.awssdk.services.cloudformation.model.DetectStackResourceDriftRequest;
import software.amazon.awssdk.services.cloudformation.model.DetectStackResourceDriftResponse;
import software.amazon.awssdk.services.cloudformation.model.DetectStackSetDriftRequest;
import software.amazon.awssdk.services.cloudformation.model.DetectStackSetDriftResponse;
import software.amazon.awssdk.services.cloudformation.model.EstimateTemplateCostRequest;
import software.amazon.awssdk.services.cloudformation.model.EstimateTemplateCostResponse;
import software.amazon.awssdk.services.cloudformation.model.ExecuteChangeSetRequest;
import software.amazon.awssdk.services.cloudformation.model.ExecuteChangeSetResponse;
import software.amazon.awssdk.services.cloudformation.model.GetGeneratedTemplateRequest;
import software.amazon.awssdk.services.cloudformation.model.GetGeneratedTemplateResponse;
import software.amazon.awssdk.services.cloudformation.model.GetStackPolicyRequest;
import software.amazon.awssdk.services.cloudformation.model.GetStackPolicyResponse;
import software.amazon.awssdk.services.cloudformation.model.GetTemplateRequest;
import software.amazon.awssdk.services.cloudformation.model.GetTemplateResponse;
import software.amazon.awssdk.services.cloudformation.model.GetTemplateSummaryRequest;
import software.amazon.awssdk.services.cloudformation.model.GetTemplateSummaryResponse;
import software.amazon.awssdk.services.cloudformation.model.ImportStacksToStackSetRequest;
import software.amazon.awssdk.services.cloudformation.model.ImportStacksToStackSetResponse;
import software.amazon.awssdk.services.cloudformation.model.ListChangeSetsRequest;
import software.amazon.awssdk.services.cloudformation.model.ListChangeSetsResponse;
import software.amazon.awssdk.services.cloudformation.model.ListExportsRequest;
import software.amazon.awssdk.services.cloudformation.model.ListExportsResponse;
import software.amazon.awssdk.services.cloudformation.model.ListGeneratedTemplatesRequest;
import software.amazon.awssdk.services.cloudformation.model.ListGeneratedTemplatesResponse;
import software.amazon.awssdk.services.cloudformation.model.ListImportsRequest;
import software.amazon.awssdk.services.cloudformation.model.ListImportsResponse;
import software.amazon.awssdk.services.cloudformation.model.ListResourceScanRelatedResourcesRequest;
import software.amazon.awssdk.services.cloudformation.model.ListResourceScanRelatedResourcesResponse;
import software.amazon.awssdk.services.cloudformation.model.ListResourceScanResourcesRequest;
import software.amazon.awssdk.services.cloudformation.model.ListResourceScanResourcesResponse;
import software.amazon.awssdk.services.cloudformation.model.ListResourceScansRequest;
import software.amazon.awssdk.services.cloudformation.model.ListResourceScansResponse;
import software.amazon.awssdk.services.cloudformation.model.ListStackInstanceResourceDriftsRequest;
import software.amazon.awssdk.services.cloudformation.model.ListStackInstanceResourceDriftsResponse;
import software.amazon.awssdk.services.cloudformation.model.ListStackInstancesRequest;
import software.amazon.awssdk.services.cloudformation.model.ListStackInstancesResponse;
import software.amazon.awssdk.services.cloudformation.model.ListStackResourcesRequest;
import software.amazon.awssdk.services.cloudformation.model.ListStackResourcesResponse;
import software.amazon.awssdk.services.cloudformation.model.ListStackSetAutoDeploymentTargetsRequest;
import software.amazon.awssdk.services.cloudformation.model.ListStackSetAutoDeploymentTargetsResponse;
import software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsRequest;
import software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsResponse;
import software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsRequest;
import software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsResponse;
import software.amazon.awssdk.services.cloudformation.model.ListStackSetsRequest;
import software.amazon.awssdk.services.cloudformation.model.ListStackSetsResponse;
import software.amazon.awssdk.services.cloudformation.model.ListStacksRequest;
import software.amazon.awssdk.services.cloudformation.model.ListStacksResponse;
import software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsRequest;
import software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsResponse;
import software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsRequest;
import software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsResponse;
import software.amazon.awssdk.services.cloudformation.model.ListTypesRequest;
import software.amazon.awssdk.services.cloudformation.model.ListTypesResponse;
import software.amazon.awssdk.services.cloudformation.model.PublishTypeRequest;
import software.amazon.awssdk.services.cloudformation.model.PublishTypeResponse;
import software.amazon.awssdk.services.cloudformation.model.RecordHandlerProgressRequest;
import software.amazon.awssdk.services.cloudformation.model.RecordHandlerProgressResponse;
import software.amazon.awssdk.services.cloudformation.model.RegisterPublisherRequest;
import software.amazon.awssdk.services.cloudformation.model.RegisterPublisherResponse;
import software.amazon.awssdk.services.cloudformation.model.RegisterTypeRequest;
import software.amazon.awssdk.services.cloudformation.model.RegisterTypeResponse;
import software.amazon.awssdk.services.cloudformation.model.RollbackStackRequest;
import software.amazon.awssdk.services.cloudformation.model.RollbackStackResponse;
import software.amazon.awssdk.services.cloudformation.model.SetStackPolicyRequest;
import software.amazon.awssdk.services.cloudformation.model.SetStackPolicyResponse;
import software.amazon.awssdk.services.cloudformation.model.SetTypeConfigurationRequest;
import software.amazon.awssdk.services.cloudformation.model.SetTypeConfigurationResponse;
import software.amazon.awssdk.services.cloudformation.model.SetTypeDefaultVersionRequest;
import software.amazon.awssdk.services.cloudformation.model.SetTypeDefaultVersionResponse;
import software.amazon.awssdk.services.cloudformation.model.SignalResourceRequest;
import software.amazon.awssdk.services.cloudformation.model.SignalResourceResponse;
import software.amazon.awssdk.services.cloudformation.model.StartResourceScanRequest;
import software.amazon.awssdk.services.cloudformation.model.StartResourceScanResponse;
import software.amazon.awssdk.services.cloudformation.model.StopStackSetOperationRequest;
import software.amazon.awssdk.services.cloudformation.model.StopStackSetOperationResponse;
import software.amazon.awssdk.services.cloudformation.model.TestTypeRequest;
import software.amazon.awssdk.services.cloudformation.model.TestTypeResponse;
import software.amazon.awssdk.services.cloudformation.model.UpdateGeneratedTemplateRequest;
import software.amazon.awssdk.services.cloudformation.model.UpdateGeneratedTemplateResponse;
import software.amazon.awssdk.services.cloudformation.model.UpdateStackInstancesRequest;
import software.amazon.awssdk.services.cloudformation.model.UpdateStackInstancesResponse;
import software.amazon.awssdk.services.cloudformation.model.UpdateStackRequest;
import software.amazon.awssdk.services.cloudformation.model.UpdateStackResponse;
import software.amazon.awssdk.services.cloudformation.model.UpdateStackSetRequest;
import software.amazon.awssdk.services.cloudformation.model.UpdateStackSetResponse;
import software.amazon.awssdk.services.cloudformation.model.UpdateTerminationProtectionRequest;
import software.amazon.awssdk.services.cloudformation.model.UpdateTerminationProtectionResponse;
import software.amazon.awssdk.services.cloudformation.model.ValidateTemplateRequest;
import software.amazon.awssdk.services.cloudformation.model.ValidateTemplateResponse;
import software.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsPublisher;
import software.amazon.awssdk.services.cloudformation.paginators.DescribeStackEventsPublisher;
import software.amazon.awssdk.services.cloudformation.paginators.DescribeStackResourceDriftsPublisher;
import software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksPublisher;
import software.amazon.awssdk.services.cloudformation.paginators.ListChangeSetsPublisher;
import software.amazon.awssdk.services.cloudformation.paginators.ListExportsPublisher;
import software.amazon.awssdk.services.cloudformation.paginators.ListGeneratedTemplatesPublisher;
import software.amazon.awssdk.services.cloudformation.paginators.ListImportsPublisher;
import software.amazon.awssdk.services.cloudformation.paginators.ListResourceScanRelatedResourcesPublisher;
import software.amazon.awssdk.services.cloudformation.paginators.ListResourceScanResourcesPublisher;
import software.amazon.awssdk.services.cloudformation.paginators.ListResourceScansPublisher;
import software.amazon.awssdk.services.cloudformation.paginators.ListStackInstancesPublisher;
import software.amazon.awssdk.services.cloudformation.paginators.ListStackResourcesPublisher;
import software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationResultsPublisher;
import software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationsPublisher;
import software.amazon.awssdk.services.cloudformation.paginators.ListStackSetsPublisher;
import software.amazon.awssdk.services.cloudformation.paginators.ListStacksPublisher;
import software.amazon.awssdk.services.cloudformation.paginators.ListTypeRegistrationsPublisher;
import software.amazon.awssdk.services.cloudformation.paginators.ListTypeVersionsPublisher;
import software.amazon.awssdk.services.cloudformation.paginators.ListTypesPublisher;
import software.amazon.awssdk.services.cloudformation.waiters.CloudFormationAsyncWaiter;
/**
* Service client for accessing AWS CloudFormation asynchronously. This can be created using the static
* {@link #builder()} method.The asynchronous client performs non-blocking I/O when configured with any
* {@code SdkAsyncHttpClient} supported in the SDK. However, full non-blocking is not guaranteed as the async client may
* perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
* call.
*
* CloudFormation
*
* CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and
* repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute
* Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to
* build highly reliable, highly scalable, cost-effective applications without creating or configuring the underlying
* Amazon Web Services infrastructure.
*
*
* With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a
* collection of resources as a single unit called a stack. CloudFormation creates and deletes all member resources of
* the stack together and manages all dependencies between the resources for you.
*
*
* For more information about CloudFormation, see the CloudFormation
* product page.
*
*
* 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.
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface CloudFormationAsyncClient extends AwsClient {
String SERVICE_NAME = "cloudformation";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "cloudformation";
/**
*
* Activate trusted access with Organizations. With trusted access between StackSets and Organizations activated,
* the management account has permissions to create and manage StackSets for your organization.
*
*
* @param activateOrganizationsAccessRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ActivateOrganizationsAccess
* @see AWS API Documentation
*/
default CompletableFuture activateOrganizationsAccess(
ActivateOrganizationsAccessRequest activateOrganizationsAccessRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ActivateOrganizationsAccessRequest.Builder}
* avoiding the need to create one manually via {@link ActivateOrganizationsAccessRequest#builder()}
*
*
* @param activateOrganizationsAccessRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ActivateOrganizationsAccessRequest.Builder} to
* create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ActivateOrganizationsAccess
* @see AWS API Documentation
*/
default CompletableFuture activateOrganizationsAccess(
Consumer activateOrganizationsAccessRequest) {
return activateOrganizationsAccess(ActivateOrganizationsAccessRequest.builder()
.applyMutation(activateOrganizationsAccessRequest).build());
}
/**
*
* 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.
*
*
* @param activateTypeRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ActivateType
* @see AWS
* API Documentation
*/
default CompletableFuture activateType(ActivateTypeRequest activateTypeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ActivateTypeRequest.Builder} avoiding the need to
* create one manually via {@link ActivateTypeRequest#builder()}
*
*
* @param activateTypeRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ActivateTypeRequest.Builder} to create a
* request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ActivateType
* @see AWS
* API Documentation
*/
default CompletableFuture activateType(Consumer activateTypeRequest) {
return activateType(ActivateTypeRequest.builder().applyMutation(activateTypeRequest).build());
}
/**
*
* 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.
*
*
* @param batchDescribeTypeConfigurationsRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.BatchDescribeTypeConfigurations
* @see AWS API Documentation
*/
default CompletableFuture batchDescribeTypeConfigurations(
BatchDescribeTypeConfigurationsRequest batchDescribeTypeConfigurationsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link BatchDescribeTypeConfigurationsRequest.Builder}
* avoiding the need to create one manually via {@link BatchDescribeTypeConfigurationsRequest#builder()}
*
*
* @param batchDescribeTypeConfigurationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.BatchDescribeTypeConfigurationsRequest.Builder}
* to create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.BatchDescribeTypeConfigurations
* @see AWS API Documentation
*/
default CompletableFuture batchDescribeTypeConfigurations(
Consumer batchDescribeTypeConfigurationsRequest) {
return batchDescribeTypeConfigurations(BatchDescribeTypeConfigurationsRequest.builder()
.applyMutation(batchDescribeTypeConfigurationsRequest).build());
}
/**
*
* 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.
*
*
*
* @param cancelUpdateStackRequest
* The input for the CancelUpdateStack action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.CancelUpdateStack
* @see AWS API Documentation
*/
default CompletableFuture cancelUpdateStack(CancelUpdateStackRequest cancelUpdateStackRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CancelUpdateStackRequest.Builder} avoiding the need
* to create one manually via {@link CancelUpdateStackRequest#builder()}
*
*
* @param cancelUpdateStackRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.CancelUpdateStackRequest.Builder} to create a
* request. The input for the CancelUpdateStack action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.CancelUpdateStack
* @see AWS API Documentation
*/
default CompletableFuture cancelUpdateStack(
Consumer cancelUpdateStackRequest) {
return cancelUpdateStack(CancelUpdateStackRequest.builder().applyMutation(cancelUpdateStackRequest).build());
}
/**
*
* For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the
* UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can return your stack to a working
* state (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again.
*
*
* A stack goes into the UPDATE_ROLLBACK_FAILED state when CloudFormation can't roll back all changes
* after a failed stack update. For example, you might have a stack that's rolling back to an old database instance
* that was deleted outside of CloudFormation. Because CloudFormation doesn't know the database was deleted, it
* assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to
* fail.
*
*
* @param continueUpdateRollbackRequest
* The input for the ContinueUpdateRollback action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ContinueUpdateRollback
* @see AWS API Documentation
*/
default CompletableFuture continueUpdateRollback(
ContinueUpdateRollbackRequest continueUpdateRollbackRequest) {
throw new UnsupportedOperationException();
}
/**
*
* For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the
* UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can return your stack to a working
* state (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again.
*
*
* A stack goes into the UPDATE_ROLLBACK_FAILED state when CloudFormation can't roll back all changes
* after a failed stack update. For example, you might have a stack that's rolling back to an old database instance
* that was deleted outside of CloudFormation. Because CloudFormation doesn't know the database was deleted, it
* assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to
* fail.
*
*
*
* This is a convenience which creates an instance of the {@link ContinueUpdateRollbackRequest.Builder} avoiding the
* need to create one manually via {@link ContinueUpdateRollbackRequest#builder()}
*
*
* @param continueUpdateRollbackRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ContinueUpdateRollbackRequest.Builder} to
* create a request. The input for the ContinueUpdateRollback action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ContinueUpdateRollback
* @see AWS API Documentation
*/
default CompletableFuture continueUpdateRollback(
Consumer continueUpdateRollbackRequest) {
return continueUpdateRollback(ContinueUpdateRollbackRequest.builder().applyMutation(continueUpdateRollbackRequest)
.build());
}
/**
*
* Creates a list of changes that will be applied to a stack so that you can review the changes before executing
* them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set
* for a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you
* create a change set for an existing stack, CloudFormation compares the stack's information with the information
* that you submit in the change set and lists the differences. Use change sets to understand which resources
* CloudFormation will create or change, and how it will change resources in an existing stack, before you create or
* update a stack.
*
*
* To create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify
* CREATE. To create a change set for an existing stack, specify UPDATE for the
* ChangeSetType parameter. To create a change set for an import operation, specify IMPORT
* for the ChangeSetType parameter. After the CreateChangeSet call successfully completes,
* CloudFormation starts creating the change set. To check the status of the change set or to review it, use the
* DescribeChangeSet action.
*
*
* When you are satisfied with the changes the change set will make, execute the change set by using the
* ExecuteChangeSet action. CloudFormation doesn't make changes until you execute the change set.
*
*
* To create a change set for the entire stack hierarchy, set IncludeNestedStacks to True.
*
*
* @param createChangeSetRequest
* The input for the CreateChangeSet action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.CreateChangeSet
* @see AWS API Documentation
*/
default CompletableFuture createChangeSet(CreateChangeSetRequest createChangeSetRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a list of changes that will be applied to a stack so that you can review the changes before executing
* them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set
* for a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you
* create a change set for an existing stack, CloudFormation compares the stack's information with the information
* that you submit in the change set and lists the differences. Use change sets to understand which resources
* CloudFormation will create or change, and how it will change resources in an existing stack, before you create or
* update a stack.
*
*
* To create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify
* CREATE. To create a change set for an existing stack, specify UPDATE for the
* ChangeSetType parameter. To create a change set for an import operation, specify IMPORT
* for the ChangeSetType parameter. After the CreateChangeSet call successfully completes,
* CloudFormation starts creating the change set. To check the status of the change set or to review it, use the
* DescribeChangeSet action.
*
*
* When you are satisfied with the changes the change set will make, execute the change set by using the
* ExecuteChangeSet action. CloudFormation doesn't make changes until you execute the change set.
*
*
* To create a change set for the entire stack hierarchy, set IncludeNestedStacks to True.
*
*
*
* This is a convenience which creates an instance of the {@link CreateChangeSetRequest.Builder} avoiding the need
* to create one manually via {@link CreateChangeSetRequest#builder()}
*
*
* @param createChangeSetRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.CreateChangeSetRequest.Builder} to create a
* request. The input for the CreateChangeSet action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.CreateChangeSet
* @see AWS API Documentation
*/
default CompletableFuture createChangeSet(
Consumer createChangeSetRequest) {
return createChangeSet(CreateChangeSetRequest.builder().applyMutation(createChangeSetRequest).build());
}
/**
*
* 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.
*
*
* @param createGeneratedTemplateRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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 or Pending status at one time. This error is also returned if a
* generated template that is in an InProgress or Pending status is attempted to
* be updated or deleted.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.CreateGeneratedTemplate
* @see AWS API Documentation
*/
default CompletableFuture createGeneratedTemplate(
CreateGeneratedTemplateRequest createGeneratedTemplateRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateGeneratedTemplateRequest.Builder} avoiding
* the need to create one manually via {@link CreateGeneratedTemplateRequest#builder()}
*
*
* @param createGeneratedTemplateRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.CreateGeneratedTemplateRequest.Builder} to
* create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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 or Pending status at one time. This error is also returned if a
* generated template that is in an InProgress or Pending status is attempted to
* be updated or deleted.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.CreateGeneratedTemplate
* @see AWS API Documentation
*/
default CompletableFuture createGeneratedTemplate(
Consumer createGeneratedTemplateRequest) {
return createGeneratedTemplate(CreateGeneratedTemplateRequest.builder().applyMutation(createGeneratedTemplateRequest)
.build());
}
/**
*
* 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.
*
*
* @param createStackRequest
* The input for CreateStack action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.CreateStack
* @see AWS
* API Documentation
*/
default CompletableFuture createStack(CreateStackRequest createStackRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateStackRequest.Builder} avoiding the need to
* create one manually via {@link CreateStackRequest#builder()}
*
*
* @param createStackRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.CreateStackRequest.Builder} to create a
* request. The input for CreateStack action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.CreateStack
* @see AWS
* API Documentation
*/
default CompletableFuture createStack(Consumer createStackRequest) {
return createStack(CreateStackRequest.builder().applyMutation(createStackRequest).build());
}
/**
*
* Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack
* instance refers to a stack in a specific account and Region. You must specify at least one value for either
* Accounts or DeploymentTargets, and you must specify at least one value for
* Regions.
*
*
* @param createStackInstancesRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.CreateStackInstances
* @see AWS API Documentation
*/
default CompletableFuture createStackInstances(
CreateStackInstancesRequest createStackInstancesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack
* instance refers to a stack in a specific account and Region. You must specify at least one value for either
* Accounts or DeploymentTargets, and you must specify at least one value for
* Regions.
*
*
*
* This is a convenience which creates an instance of the {@link CreateStackInstancesRequest.Builder} avoiding the
* need to create one manually via {@link CreateStackInstancesRequest#builder()}
*
*
* @param createStackInstancesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.CreateStackInstancesRequest.Builder} to create
* a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.CreateStackInstances
* @see AWS API Documentation
*/
default CompletableFuture createStackInstances(
Consumer createStackInstancesRequest) {
return createStackInstances(CreateStackInstancesRequest.builder().applyMutation(createStackInstancesRequest).build());
}
/**
*
* Creates a stack set.
*
*
* @param createStackSetRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.CreateStackSet
* @see AWS
* API Documentation
*/
default CompletableFuture createStackSet(CreateStackSetRequest createStackSetRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a stack set.
*
*
*
* This is a convenience which creates an instance of the {@link CreateStackSetRequest.Builder} avoiding the need to
* create one manually via {@link CreateStackSetRequest#builder()}
*
*
* @param createStackSetRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.CreateStackSetRequest.Builder} to create a
* request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.CreateStackSet
* @see AWS
* API Documentation
*/
default CompletableFuture createStackSet(Consumer createStackSetRequest) {
return createStackSet(CreateStackSetRequest.builder().applyMutation(createStackSetRequest).build());
}
/**
*
* 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.
*
*
* @param deactivateOrganizationsAccessRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DeactivateOrganizationsAccess
* @see AWS API Documentation
*/
default CompletableFuture deactivateOrganizationsAccess(
DeactivateOrganizationsAccessRequest deactivateOrganizationsAccessRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeactivateOrganizationsAccessRequest.Builder}
* avoiding the need to create one manually via {@link DeactivateOrganizationsAccessRequest#builder()}
*
*
* @param deactivateOrganizationsAccessRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DeactivateOrganizationsAccessRequest.Builder}
* to create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DeactivateOrganizationsAccess
* @see AWS API Documentation
*/
default CompletableFuture deactivateOrganizationsAccess(
Consumer deactivateOrganizationsAccessRequest) {
return deactivateOrganizationsAccess(DeactivateOrganizationsAccessRequest.builder()
.applyMutation(deactivateOrganizationsAccessRequest).build());
}
/**
*
* 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.
*
*
* @param deactivateTypeRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DeactivateType
* @see AWS
* API Documentation
*/
default CompletableFuture deactivateType(DeactivateTypeRequest deactivateTypeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeactivateTypeRequest.Builder} avoiding the need to
* create one manually via {@link DeactivateTypeRequest#builder()}
*
*
* @param deactivateTypeRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DeactivateTypeRequest.Builder} to create a
* request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DeactivateType
* @see AWS
* API Documentation
*/
default CompletableFuture deactivateType(Consumer deactivateTypeRequest) {
return deactivateType(DeactivateTypeRequest.builder().applyMutation(deactivateTypeRequest).build());
}
/**
*
* Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.
*
*
* If the call successfully completes, CloudFormation successfully deleted the change set.
*
*
* If IncludeNestedStacks specifies True during the creation of the nested change set,
* then DeleteChangeSet will delete all change sets that belong to the stacks hierarchy and will also
* delete all change sets for nested stacks with the status of REVIEW_IN_PROGRESS.
*
*
* @param deleteChangeSetRequest
* The input for the DeleteChangeSet action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidChangeSetStatusException The specified change set can't be used to update the stack. For
* example, the change set status might be
CREATE_IN_PROGRESS, or the stack status might be
* UPDATE_IN_PROGRESS.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DeleteChangeSet
* @see AWS API Documentation
*/
default CompletableFuture deleteChangeSet(DeleteChangeSetRequest deleteChangeSetRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.
*
*
* If the call successfully completes, CloudFormation successfully deleted the change set.
*
*
* If IncludeNestedStacks specifies True during the creation of the nested change set,
* then DeleteChangeSet will delete all change sets that belong to the stacks hierarchy and will also
* delete all change sets for nested stacks with the status of REVIEW_IN_PROGRESS.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteChangeSetRequest.Builder} avoiding the need
* to create one manually via {@link DeleteChangeSetRequest#builder()}
*
*
* @param deleteChangeSetRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DeleteChangeSetRequest.Builder} to create a
* request. The input for the DeleteChangeSet action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidChangeSetStatusException The specified change set can't be used to update the stack. For
* example, the change set status might be
CREATE_IN_PROGRESS, or the stack status might be
* UPDATE_IN_PROGRESS.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DeleteChangeSet
* @see AWS API Documentation
*/
default CompletableFuture deleteChangeSet(
Consumer deleteChangeSetRequest) {
return deleteChangeSet(DeleteChangeSetRequest.builder().applyMutation(deleteChangeSetRequest).build());
}
/**
*
* Deleted a generated template.
*
*
* @param deleteGeneratedTemplateRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - GeneratedTemplateNotFoundException The generated template was not found.
* - ConcurrentResourcesLimitExceededException No more than 5 generated templates can be in an
*
InProgress or Pending status at one time. This error is also returned if a
* generated template that is in an InProgress or Pending status is attempted to
* be updated or deleted.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DeleteGeneratedTemplate
* @see AWS API Documentation
*/
default CompletableFuture deleteGeneratedTemplate(
DeleteGeneratedTemplateRequest deleteGeneratedTemplateRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deleted a generated template.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteGeneratedTemplateRequest.Builder} avoiding
* the need to create one manually via {@link DeleteGeneratedTemplateRequest#builder()}
*
*
* @param deleteGeneratedTemplateRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DeleteGeneratedTemplateRequest.Builder} to
* create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - GeneratedTemplateNotFoundException The generated template was not found.
* - ConcurrentResourcesLimitExceededException No more than 5 generated templates can be in an
*
InProgress or Pending status at one time. This error is also returned if a
* generated template that is in an InProgress or Pending status is attempted to
* be updated or deleted.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DeleteGeneratedTemplate
* @see AWS API Documentation
*/
default CompletableFuture deleteGeneratedTemplate(
Consumer deleteGeneratedTemplateRequest) {
return deleteGeneratedTemplate(DeleteGeneratedTemplateRequest.builder().applyMutation(deleteGeneratedTemplateRequest)
.build());
}
/**
*
* 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.
*
*
* @param deleteStackRequest
* The input for DeleteStack action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DeleteStack
* @see AWS
* API Documentation
*/
default CompletableFuture deleteStack(DeleteStackRequest deleteStackRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteStackRequest.Builder} avoiding the need to
* create one manually via {@link DeleteStackRequest#builder()}
*
*
* @param deleteStackRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DeleteStackRequest.Builder} to create a
* request. The input for DeleteStack action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DeleteStack
* @see AWS
* API Documentation
*/
default CompletableFuture deleteStack(Consumer deleteStackRequest) {
return deleteStack(DeleteStackRequest.builder().applyMutation(deleteStackRequest).build());
}
/**
*
* Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
*
*
* @param deleteStackInstancesRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DeleteStackInstances
* @see AWS API Documentation
*/
default CompletableFuture deleteStackInstances(
DeleteStackInstancesRequest deleteStackInstancesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteStackInstancesRequest.Builder} avoiding the
* need to create one manually via {@link DeleteStackInstancesRequest#builder()}
*
*
* @param deleteStackInstancesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DeleteStackInstancesRequest.Builder} to create
* a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DeleteStackInstances
* @see AWS API Documentation
*/
default CompletableFuture deleteStackInstances(
Consumer deleteStackInstancesRequest) {
return deleteStackInstances(DeleteStackInstancesRequest.builder().applyMutation(deleteStackInstancesRequest).build());
}
/**
*
* 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.
*
*
* @param deleteStackSetRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DeleteStackSet
* @see AWS
* API Documentation
*/
default CompletableFuture deleteStackSet(DeleteStackSetRequest deleteStackSetRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteStackSetRequest.Builder} avoiding the need to
* create one manually via {@link DeleteStackSetRequest#builder()}
*
*
* @param deleteStackSetRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DeleteStackSetRequest.Builder} to create a
* request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DeleteStackSet
* @see AWS
* API Documentation
*/
default CompletableFuture deleteStackSet(Consumer deleteStackSetRequest) {
return deleteStackSet(DeleteStackSetRequest.builder().applyMutation(deleteStackSetRequest).build());
}
/**
*
* 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.
*
*
* @param deregisterTypeRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DeregisterType
* @see AWS
* API Documentation
*/
default CompletableFuture deregisterType(DeregisterTypeRequest deregisterTypeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeregisterTypeRequest.Builder} avoiding the need to
* create one manually via {@link DeregisterTypeRequest#builder()}
*
*
* @param deregisterTypeRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DeregisterTypeRequest.Builder} to create a
* request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DeregisterType
* @see AWS
* API Documentation
*/
default CompletableFuture deregisterType(Consumer deregisterTypeRequest) {
return deregisterType(DeregisterTypeRequest.builder().applyMutation(deregisterTypeRequest).build());
}
/**
*
* 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.
*
*
* @param describeAccountLimitsRequest
* The input for the DescribeAccountLimits action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DescribeAccountLimits
* @see AWS API Documentation
*/
default CompletableFuture describeAccountLimits(
DescribeAccountLimitsRequest describeAccountLimitsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeAccountLimitsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeAccountLimitsRequest#builder()}
*
*
* @param describeAccountLimitsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsRequest.Builder} to
* create a request. The input for the DescribeAccountLimits action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DescribeAccountLimits
* @see AWS API Documentation
*/
default CompletableFuture describeAccountLimits(
Consumer describeAccountLimitsRequest) {
return describeAccountLimits(DescribeAccountLimitsRequest.builder().applyMutation(describeAccountLimitsRequest).build());
}
/**
*
* 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.
*
*
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DescribeAccountLimits
* @see AWS API Documentation
*/
default CompletableFuture describeAccountLimits() {
return describeAccountLimits(DescribeAccountLimitsRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsPublisher publisher = client.describeAccountLimitsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsPublisher publisher = client.describeAccountLimitsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #describeAccountLimits(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsRequest)}
* operation.
*
*
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DescribeAccountLimits
* @see AWS API Documentation
*/
default DescribeAccountLimitsPublisher describeAccountLimitsPaginator() {
return describeAccountLimitsPaginator(DescribeAccountLimitsRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsPublisher publisher = client.describeAccountLimitsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsPublisher publisher = client.describeAccountLimitsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #describeAccountLimits(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsRequest)}
* operation.
*
*
* @param describeAccountLimitsRequest
* The input for the DescribeAccountLimits action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DescribeAccountLimits
* @see AWS API Documentation
*/
default DescribeAccountLimitsPublisher describeAccountLimitsPaginator(
DescribeAccountLimitsRequest describeAccountLimitsRequest) {
return new DescribeAccountLimitsPublisher(this, describeAccountLimitsRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsPublisher publisher = client.describeAccountLimitsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsPublisher publisher = client.describeAccountLimitsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #describeAccountLimits(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeAccountLimitsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeAccountLimitsRequest#builder()}
*
*
* @param describeAccountLimitsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsRequest.Builder} to
* create a request. The input for the DescribeAccountLimits action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DescribeAccountLimits
* @see AWS API Documentation
*/
default DescribeAccountLimitsPublisher describeAccountLimitsPaginator(
Consumer describeAccountLimitsRequest) {
return describeAccountLimitsPaginator(DescribeAccountLimitsRequest.builder().applyMutation(describeAccountLimitsRequest)
.build());
}
/**
*
* 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.
*
*
* @param describeChangeSetRequest
* The input for the DescribeChangeSet action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DescribeChangeSet
* @see AWS API Documentation
*/
default CompletableFuture describeChangeSet(DescribeChangeSetRequest describeChangeSetRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeChangeSetRequest.Builder} avoiding the need
* to create one manually via {@link DescribeChangeSetRequest#builder()}
*
*
* @param describeChangeSetRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DescribeChangeSetRequest.Builder} to create a
* request. The input for the DescribeChangeSet action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DescribeChangeSet
* @see AWS API Documentation
*/
default CompletableFuture describeChangeSet(
Consumer describeChangeSetRequest) {
return describeChangeSet(DescribeChangeSetRequest.builder().applyMutation(describeChangeSetRequest).build());
}
/**
*
* Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run
* the change set.
*
*
* @param describeChangeSetHooksRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DescribeChangeSetHooks
* @see AWS API Documentation
*/
default CompletableFuture describeChangeSetHooks(
DescribeChangeSetHooksRequest describeChangeSetHooksRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeChangeSetHooksRequest.Builder} avoiding the
* need to create one manually via {@link DescribeChangeSetHooksRequest#builder()}
*
*
* @param describeChangeSetHooksRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DescribeChangeSetHooksRequest.Builder} to
* create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DescribeChangeSetHooks
* @see AWS API Documentation
*/
default CompletableFuture describeChangeSetHooks(
Consumer describeChangeSetHooksRequest) {
return describeChangeSetHooks(DescribeChangeSetHooksRequest.builder().applyMutation(describeChangeSetHooksRequest)
.build());
}
/**
*
* 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 an UpdateGeneratedTemplate API action.
*
*
* @param describeGeneratedTemplateRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DescribeGeneratedTemplate
* @see AWS API Documentation
*/
default CompletableFuture describeGeneratedTemplate(
DescribeGeneratedTemplateRequest describeGeneratedTemplateRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 an UpdateGeneratedTemplate API action.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeGeneratedTemplateRequest.Builder} avoiding
* the need to create one manually via {@link DescribeGeneratedTemplateRequest#builder()}
*
*
* @param describeGeneratedTemplateRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DescribeGeneratedTemplateRequest.Builder} to
* create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DescribeGeneratedTemplate
* @see AWS API Documentation
*/
default CompletableFuture describeGeneratedTemplate(
Consumer describeGeneratedTemplateRequest) {
return describeGeneratedTemplate(DescribeGeneratedTemplateRequest.builder()
.applyMutation(describeGeneratedTemplateRequest).build());
}
/**
*
* Retrieves information about the account's OrganizationAccess status. This API can be called either
* by the management account or the delegated administrator by using the CallAs parameter. This API can
* also be called without the CallAs parameter by the management account.
*
*
* @param describeOrganizationsAccessRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DescribeOrganizationsAccess
* @see AWS API Documentation
*/
default CompletableFuture describeOrganizationsAccess(
DescribeOrganizationsAccessRequest describeOrganizationsAccessRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves information about the account's OrganizationAccess status. This API can be called either
* by the management account or the delegated administrator by using the CallAs parameter. This API can
* also be called without the CallAs parameter by the management account.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeOrganizationsAccessRequest.Builder}
* avoiding the need to create one manually via {@link DescribeOrganizationsAccessRequest#builder()}
*
*
* @param describeOrganizationsAccessRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DescribeOrganizationsAccessRequest.Builder} to
* create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DescribeOrganizationsAccess
* @see AWS API Documentation
*/
default CompletableFuture describeOrganizationsAccess(
Consumer describeOrganizationsAccessRequest) {
return describeOrganizationsAccess(DescribeOrganizationsAccessRequest.builder()
.applyMutation(describeOrganizationsAccessRequest).build());
}
/**
*
* 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
*
*
*
*
* @param describePublisherRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DescribePublisher
* @see AWS API Documentation
*/
default CompletableFuture describePublisher(DescribePublisherRequest describePublisherRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribePublisherRequest.Builder} avoiding the need
* to create one manually via {@link DescribePublisherRequest#builder()}
*
*
* @param describePublisherRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DescribePublisherRequest.Builder} to create a
* request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DescribePublisher
* @see AWS API Documentation
*/
default CompletableFuture describePublisher(
Consumer describePublisherRequest) {
return describePublisher(DescribePublisherRequest.builder().applyMutation(describePublisherRequest).build());
}
/**
*
* Describes details of a resource scan.
*
*
* @param describeResourceScanRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DescribeResourceScan
* @see AWS API Documentation
*/
default CompletableFuture describeResourceScan(
DescribeResourceScanRequest describeResourceScanRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes details of a resource scan.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeResourceScanRequest.Builder} avoiding the
* need to create one manually via {@link DescribeResourceScanRequest#builder()}
*
*
* @param describeResourceScanRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DescribeResourceScanRequest.Builder} to create
* a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DescribeResourceScan
* @see AWS API Documentation
*/
default CompletableFuture describeResourceScan(
Consumer describeResourceScanRequest) {
return describeResourceScan(DescribeResourceScanRequest.builder().applyMutation(describeResourceScanRequest).build());
}
/**
*
* 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
* a StackDriftDetectionId you can use to monitor the progress of the operation using
* DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use
* DescribeStackResourceDrifts to return drift information about the stack and its resources.
*
*
* @param describeStackDriftDetectionStatusRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DescribeStackDriftDetectionStatus
* @see AWS API Documentation
*/
default CompletableFuture describeStackDriftDetectionStatus(
DescribeStackDriftDetectionStatusRequest describeStackDriftDetectionStatusRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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
* a StackDriftDetectionId you can use to monitor the progress of the operation using
* DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use
* DescribeStackResourceDrifts to return drift information about the stack and its resources.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeStackDriftDetectionStatusRequest.Builder}
* avoiding the need to create one manually via {@link DescribeStackDriftDetectionStatusRequest#builder()}
*
*
* @param describeStackDriftDetectionStatusRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DescribeStackDriftDetectionStatusRequest.Builder}
* to create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DescribeStackDriftDetectionStatus
* @see AWS API Documentation
*/
default CompletableFuture describeStackDriftDetectionStatus(
Consumer describeStackDriftDetectionStatusRequest) {
return describeStackDriftDetectionStatus(DescribeStackDriftDetectionStatusRequest.builder()
.applyMutation(describeStackDriftDetectionStatusRequest).build());
}
/**
*
* 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).
*
*
*
* @param describeStackEventsRequest
* The input for DescribeStackEvents action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DescribeStackEvents
* @see AWS API Documentation
*/
default CompletableFuture describeStackEvents(
DescribeStackEventsRequest describeStackEventsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeStackEventsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeStackEventsRequest#builder()}
*
*
* @param describeStackEventsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsRequest.Builder} to create
* a request. The input for DescribeStackEvents action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DescribeStackEvents
* @see AWS API Documentation
*/
default CompletableFuture describeStackEvents(
Consumer describeStackEventsRequest) {
return describeStackEvents(DescribeStackEventsRequest.builder().applyMutation(describeStackEventsRequest).build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.DescribeStackEventsPublisher publisher = client.describeStackEventsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.DescribeStackEventsPublisher publisher = client.describeStackEventsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #describeStackEvents(software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsRequest)}
* operation.
*
*
* @param describeStackEventsRequest
* The input for DescribeStackEvents action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DescribeStackEvents
* @see AWS API Documentation
*/
default DescribeStackEventsPublisher describeStackEventsPaginator(DescribeStackEventsRequest describeStackEventsRequest) {
return new DescribeStackEventsPublisher(this, describeStackEventsRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.DescribeStackEventsPublisher publisher = client.describeStackEventsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.DescribeStackEventsPublisher publisher = client.describeStackEventsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #describeStackEvents(software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeStackEventsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeStackEventsRequest#builder()}
*
*
* @param describeStackEventsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsRequest.Builder} to create
* a request. The input for DescribeStackEvents action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DescribeStackEvents
* @see AWS API Documentation
*/
default DescribeStackEventsPublisher describeStackEventsPaginator(
Consumer describeStackEventsRequest) {
return describeStackEventsPaginator(DescribeStackEventsRequest.builder().applyMutation(describeStackEventsRequest)
.build());
}
/**
*
* 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.
*
*
* @param describeStackInstanceRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DescribeStackInstance
* @see AWS API Documentation
*/
default CompletableFuture describeStackInstance(
DescribeStackInstanceRequest describeStackInstanceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeStackInstanceRequest.Builder} avoiding the
* need to create one manually via {@link DescribeStackInstanceRequest#builder()}
*
*
* @param describeStackInstanceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DescribeStackInstanceRequest.Builder} to
* create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DescribeStackInstance
* @see AWS API Documentation
*/
default CompletableFuture describeStackInstance(
Consumer describeStackInstanceRequest) {
return describeStackInstance(DescribeStackInstanceRequest.builder().applyMutation(describeStackInstanceRequest).build());
}
/**
*
* 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.
*
*
* @param describeStackResourceRequest
* The input for DescribeStackResource action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DescribeStackResource
* @see AWS API Documentation
*/
default CompletableFuture describeStackResource(
DescribeStackResourceRequest describeStackResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeStackResourceRequest.Builder} avoiding the
* need to create one manually via {@link DescribeStackResourceRequest#builder()}
*
*
* @param describeStackResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceRequest.Builder} to
* create a request. The input for DescribeStackResource action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DescribeStackResource
* @see AWS API Documentation
*/
default CompletableFuture describeStackResource(
Consumer describeStackResourceRequest) {
return describeStackResource(DescribeStackResourceRequest.builder().applyMutation(describeStackResourceRequest).build());
}
/**
*
* 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.
*
*
* @param describeStackResourceDriftsRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DescribeStackResourceDrifts
* @see AWS API Documentation
*/
default CompletableFuture describeStackResourceDrifts(
DescribeStackResourceDriftsRequest describeStackResourceDriftsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeStackResourceDriftsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeStackResourceDriftsRequest#builder()}
*
*
* @param describeStackResourceDriftsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsRequest.Builder} to
* create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DescribeStackResourceDrifts
* @see AWS API Documentation
*/
default CompletableFuture describeStackResourceDrifts(
Consumer describeStackResourceDriftsRequest) {
return describeStackResourceDrifts(DescribeStackResourceDriftsRequest.builder()
.applyMutation(describeStackResourceDriftsRequest).build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.DescribeStackResourceDriftsPublisher publisher = client.describeStackResourceDriftsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.DescribeStackResourceDriftsPublisher publisher = client.describeStackResourceDriftsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #describeStackResourceDrifts(software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsRequest)}
* operation.
*
*
* @param describeStackResourceDriftsRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DescribeStackResourceDrifts
* @see AWS API Documentation
*/
default DescribeStackResourceDriftsPublisher describeStackResourceDriftsPaginator(
DescribeStackResourceDriftsRequest describeStackResourceDriftsRequest) {
return new DescribeStackResourceDriftsPublisher(this, describeStackResourceDriftsRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.DescribeStackResourceDriftsPublisher publisher = client.describeStackResourceDriftsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.DescribeStackResourceDriftsPublisher publisher = client.describeStackResourceDriftsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #describeStackResourceDrifts(software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeStackResourceDriftsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeStackResourceDriftsRequest#builder()}
*
*
* @param describeStackResourceDriftsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsRequest.Builder} to
* create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DescribeStackResourceDrifts
* @see AWS API Documentation
*/
default DescribeStackResourceDriftsPublisher describeStackResourceDriftsPaginator(
Consumer describeStackResourceDriftsRequest) {
return describeStackResourceDriftsPaginator(DescribeStackResourceDriftsRequest.builder()
.applyMutation(describeStackResourceDriftsRequest).build());
}
/**
*
* Returns Amazon Web Services resource descriptions for running and deleted stacks. If StackName is
* specified, all the associated resources that are part of the stack are returned. If
* PhysicalResourceId is specified, the associated resources of the stack that the resource belongs to
* are returned.
*
*
*
* Only the first 100 resources will be returned. If your stack has more resources than this, you should use
* ListStackResources instead.
*
*
*
* For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the
* stack has been deleted.
*
*
* You must specify either StackName or PhysicalResourceId, but not both. In addition, you
* can specify LogicalResourceId to filter the returned result. For more information about resources,
* the LogicalResourceId and PhysicalResourceId, go to the CloudFormation User Guide.
*
*
*
* A ValidationError is returned if you specify both StackName and
* PhysicalResourceId in the same request.
*
*
*
* @param describeStackResourcesRequest
* The input for DescribeStackResources action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DescribeStackResources
* @see AWS API Documentation
*/
default CompletableFuture describeStackResources(
DescribeStackResourcesRequest describeStackResourcesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns Amazon Web Services resource descriptions for running and deleted stacks. If StackName is
* specified, all the associated resources that are part of the stack are returned. If
* PhysicalResourceId is specified, the associated resources of the stack that the resource belongs to
* are returned.
*
*
*
* Only the first 100 resources will be returned. If your stack has more resources than this, you should use
* ListStackResources instead.
*
*
*
* For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the
* stack has been deleted.
*
*
* You must specify either StackName or PhysicalResourceId, but not both. In addition, you
* can specify LogicalResourceId to filter the returned result. For more information about resources,
* the LogicalResourceId and PhysicalResourceId, go to the CloudFormation User Guide.
*
*
*
* A ValidationError is returned if you specify both StackName and
* PhysicalResourceId in the same request.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeStackResourcesRequest.Builder} avoiding the
* need to create one manually via {@link DescribeStackResourcesRequest#builder()}
*
*
* @param describeStackResourcesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DescribeStackResourcesRequest.Builder} to
* create a request. The input for DescribeStackResources action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DescribeStackResources
* @see AWS API Documentation
*/
default CompletableFuture describeStackResources(
Consumer describeStackResourcesRequest) {
return describeStackResources(DescribeStackResourcesRequest.builder().applyMutation(describeStackResourcesRequest)
.build());
}
/**
*
* Returns the description of the specified StackSet.
*
*
* @param describeStackSetRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DescribeStackSet
* @see AWS API Documentation
*/
default CompletableFuture describeStackSet(DescribeStackSetRequest describeStackSetRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the description of the specified StackSet.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeStackSetRequest.Builder} avoiding the need
* to create one manually via {@link DescribeStackSetRequest#builder()}
*
*
* @param describeStackSetRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DescribeStackSetRequest.Builder} to create a
* request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DescribeStackSet
* @see AWS API Documentation
*/
default CompletableFuture describeStackSet(
Consumer describeStackSetRequest) {
return describeStackSet(DescribeStackSetRequest.builder().applyMutation(describeStackSetRequest).build());
}
/**
*
* Returns the description of the specified StackSet operation.
*
*
* @param describeStackSetOperationRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DescribeStackSetOperation
* @see AWS API Documentation
*/
default CompletableFuture describeStackSetOperation(
DescribeStackSetOperationRequest describeStackSetOperationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the description of the specified StackSet operation.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeStackSetOperationRequest.Builder} avoiding
* the need to create one manually via {@link DescribeStackSetOperationRequest#builder()}
*
*
* @param describeStackSetOperationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DescribeStackSetOperationRequest.Builder} to
* create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DescribeStackSetOperation
* @see AWS API Documentation
*/
default CompletableFuture describeStackSetOperation(
Consumer describeStackSetOperationRequest) {
return describeStackSetOperation(DescribeStackSetOperationRequest.builder()
.applyMutation(describeStackSetOperationRequest).build());
}
/**
*
* 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.
*
*
*
* @param describeStacksRequest
* The input for DescribeStacks action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DescribeStacks
* @see AWS
* API Documentation
*/
default CompletableFuture describeStacks(DescribeStacksRequest describeStacksRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeStacksRequest.Builder} avoiding the need to
* create one manually via {@link DescribeStacksRequest#builder()}
*
*
* @param describeStacksRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest.Builder} to create a
* request. The input for DescribeStacks action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DescribeStacks
* @see AWS
* API Documentation
*/
default CompletableFuture describeStacks(Consumer describeStacksRequest) {
return describeStacks(DescribeStacksRequest.builder().applyMutation(describeStacksRequest).build());
}
/**
*
* 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.
*
*
*
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DescribeStacks
* @see AWS
* API Documentation
*/
default CompletableFuture describeStacks() {
return describeStacks(DescribeStacksRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksPublisher publisher = client.describeStacksPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksPublisher publisher = client.describeStacksPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.DescribeStacksResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest)}
* operation.
*
*
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DescribeStacks
* @see AWS
* API Documentation
*/
default DescribeStacksPublisher describeStacksPaginator() {
return describeStacksPaginator(DescribeStacksRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksPublisher publisher = client.describeStacksPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksPublisher publisher = client.describeStacksPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.DescribeStacksResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest)}
* operation.
*
*
* @param describeStacksRequest
* The input for DescribeStacks action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DescribeStacks
* @see AWS
* API Documentation
*/
default DescribeStacksPublisher describeStacksPaginator(DescribeStacksRequest describeStacksRequest) {
return new DescribeStacksPublisher(this, describeStacksRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksPublisher publisher = client.describeStacksPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksPublisher publisher = client.describeStacksPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.DescribeStacksResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeStacksRequest.Builder} avoiding the need to
* create one manually via {@link DescribeStacksRequest#builder()}
*
*
* @param describeStacksRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest.Builder} to create a
* request. The input for DescribeStacks action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DescribeStacks
* @see AWS
* API Documentation
*/
default DescribeStacksPublisher describeStacksPaginator(Consumer describeStacksRequest) {
return describeStacksPaginator(DescribeStacksRequest.builder().applyMutation(describeStacksRequest).build());
}
/**
*
* 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.
*
*
* @param describeTypeRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DescribeType
* @see AWS
* API Documentation
*/
default CompletableFuture describeType(DescribeTypeRequest describeTypeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeTypeRequest.Builder} avoiding the need to
* create one manually via {@link DescribeTypeRequest#builder()}
*
*
* @param describeTypeRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DescribeTypeRequest.Builder} to create a
* request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DescribeType
* @see AWS
* API Documentation
*/
default CompletableFuture describeType(Consumer describeTypeRequest) {
return describeType(DescribeTypeRequest.builder().applyMutation(describeTypeRequest).build());
}
/**
*
* 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.
*
*
* @param describeTypeRegistrationRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DescribeTypeRegistration
* @see AWS API Documentation
*/
default CompletableFuture describeTypeRegistration(
DescribeTypeRegistrationRequest describeTypeRegistrationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeTypeRegistrationRequest.Builder} avoiding
* the need to create one manually via {@link DescribeTypeRegistrationRequest#builder()}
*
*
* @param describeTypeRegistrationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DescribeTypeRegistrationRequest.Builder} to
* create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DescribeTypeRegistration
* @see AWS API Documentation
*/
default CompletableFuture describeTypeRegistration(
Consumer describeTypeRegistrationRequest) {
return describeTypeRegistration(DescribeTypeRegistrationRequest.builder().applyMutation(describeTypeRegistrationRequest)
.build());
}
/**
*
* 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.
*
*
* @param detectStackDriftRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DetectStackDrift
* @see AWS API Documentation
*/
default CompletableFuture detectStackDrift(DetectStackDriftRequest detectStackDriftRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DetectStackDriftRequest.Builder} avoiding the need
* to create one manually via {@link DetectStackDriftRequest#builder()}
*
*
* @param detectStackDriftRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DetectStackDriftRequest.Builder} to create a
* request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DetectStackDrift
* @see AWS API Documentation
*/
default CompletableFuture detectStackDrift(
Consumer detectStackDriftRequest) {
return detectStackDrift(DetectStackDriftRequest.builder().applyMutation(detectStackDriftRequest).build());
}
/**
*
* 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.
*
*
* @param detectStackResourceDriftRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DetectStackResourceDrift
* @see AWS API Documentation
*/
default CompletableFuture detectStackResourceDrift(
DetectStackResourceDriftRequest detectStackResourceDriftRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DetectStackResourceDriftRequest.Builder} avoiding
* the need to create one manually via {@link DetectStackResourceDriftRequest#builder()}
*
*
* @param detectStackResourceDriftRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DetectStackResourceDriftRequest.Builder} to
* create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.DetectStackResourceDrift
* @see AWS API Documentation
*/
default CompletableFuture detectStackResourceDrift(
Consumer detectStackResourceDriftRequest) {
return detectStackResourceDrift(DetectStackResourceDriftRequest.builder().applyMutation(detectStackResourceDriftRequest)
.build());
}
/**
*
* Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift
* detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation
* performs drift detection on a stack set.
*
*
* DetectStackSetDrift returns the OperationId of the stack set drift detection operation.
* Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection
* operation. The drift detection operation may take some time, depending on the number of stack instances included
* in the stack set, 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.
*
*
* @param detectStackSetDriftRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DetectStackSetDrift
* @see AWS API Documentation
*/
default CompletableFuture detectStackSetDrift(
DetectStackSetDriftRequest detectStackSetDriftRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift
* detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation
* performs drift detection on a stack set.
*
*
* DetectStackSetDrift returns the OperationId of the stack set drift detection operation.
* Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection
* operation. The drift detection operation may take some time, depending on the number of stack instances included
* in the stack set, 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 {@link DetectStackSetDriftRequest.Builder} avoiding the
* need to create one manually via {@link DetectStackSetDriftRequest#builder()}
*
*
* @param detectStackSetDriftRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.DetectStackSetDriftRequest.Builder} to create
* a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.DetectStackSetDrift
* @see AWS API Documentation
*/
default CompletableFuture detectStackSetDrift(
Consumer detectStackSetDriftRequest) {
return detectStackSetDrift(DetectStackSetDriftRequest.builder().applyMutation(detectStackSetDriftRequest).build());
}
/**
*
* 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.
*
*
* @param estimateTemplateCostRequest
* The input for an EstimateTemplateCost action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.EstimateTemplateCost
* @see AWS API Documentation
*/
default CompletableFuture estimateTemplateCost(
EstimateTemplateCostRequest estimateTemplateCostRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link EstimateTemplateCostRequest.Builder} avoiding the
* need to create one manually via {@link EstimateTemplateCostRequest#builder()}
*
*
* @param estimateTemplateCostRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.EstimateTemplateCostRequest.Builder} to create
* a request. The input for an EstimateTemplateCost action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.EstimateTemplateCost
* @see AWS API Documentation
*/
default CompletableFuture estimateTemplateCost(
Consumer estimateTemplateCostRequest) {
return estimateTemplateCost(EstimateTemplateCostRequest.builder().applyMutation(estimateTemplateCostRequest).build());
}
/**
*
* Updates a stack using the input information that was provided when the specified change set was created. After
* the call successfully completes, CloudFormation starts updating the stack. Use the DescribeStacks action
* to view the status of the update.
*
*
* When you execute a change set, CloudFormation deletes all other change sets associated with the stack because
* they aren't valid for the updated stack.
*
*
* If a stack policy is associated with the stack, CloudFormation enforces the policy during the update. You can't
* specify a temporary stack policy that overrides the current policy.
*
*
* To create a change set for the entire stack hierarchy, IncludeNestedStacks must have been set to
* True.
*
*
* @param executeChangeSetRequest
* The input for the ExecuteChangeSet action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidChangeSetStatusException The specified change set can't be used to update the stack. For
* example, the change set status might be
CREATE_IN_PROGRESS, or the stack status might be
* UPDATE_IN_PROGRESS.
* - ChangeSetNotFoundException The specified change set name or ID doesn't exit. To view valid change
* sets for a stack, use the
ListChangeSets 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.
*
* @sample CloudFormationAsyncClient.ExecuteChangeSet
* @see AWS API Documentation
*/
default CompletableFuture executeChangeSet(ExecuteChangeSetRequest executeChangeSetRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates a stack using the input information that was provided when the specified change set was created. After
* the call successfully completes, CloudFormation starts updating the stack. Use the DescribeStacks action
* to view the status of the update.
*
*
* When you execute a change set, CloudFormation deletes all other change sets associated with the stack because
* they aren't valid for the updated stack.
*
*
* If a stack policy is associated with the stack, CloudFormation enforces the policy during the update. You can't
* specify a temporary stack policy that overrides the current policy.
*
*
* To create a change set for the entire stack hierarchy, IncludeNestedStacks must have been set to
* True.
*
*
*
* This is a convenience which creates an instance of the {@link ExecuteChangeSetRequest.Builder} avoiding the need
* to create one manually via {@link ExecuteChangeSetRequest#builder()}
*
*
* @param executeChangeSetRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ExecuteChangeSetRequest.Builder} to create a
* request. The input for the ExecuteChangeSet action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidChangeSetStatusException The specified change set can't be used to update the stack. For
* example, the change set status might be
CREATE_IN_PROGRESS, or the stack status might be
* UPDATE_IN_PROGRESS.
* - ChangeSetNotFoundException The specified change set name or ID doesn't exit. To view valid change
* sets for a stack, use the
ListChangeSets 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.
*
* @sample CloudFormationAsyncClient.ExecuteChangeSet
* @see AWS API Documentation
*/
default CompletableFuture executeChangeSet(
Consumer executeChangeSetRequest) {
return executeChangeSet(ExecuteChangeSetRequest.builder().applyMutation(executeChangeSetRequest).build());
}
/**
*
* Retrieves a generated template. If the template is in an InProgress or Pending status
* then the template returned will be the template when the template was last in a Complete status. If
* the template has not yet been in a Complete status then an empty template will be returned.
*
*
* @param getGeneratedTemplateRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.GetGeneratedTemplate
* @see AWS API Documentation
*/
default CompletableFuture getGeneratedTemplate(
GetGeneratedTemplateRequest getGeneratedTemplateRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a generated template. If the template is in an InProgress or Pending status
* then the template returned will be the template when the template was last in a Complete status. If
* the template has not yet been in a Complete status then an empty template will be returned.
*
*
*
* This is a convenience which creates an instance of the {@link GetGeneratedTemplateRequest.Builder} avoiding the
* need to create one manually via {@link GetGeneratedTemplateRequest#builder()}
*
*
* @param getGeneratedTemplateRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.GetGeneratedTemplateRequest.Builder} to create
* a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.GetGeneratedTemplate
* @see AWS API Documentation
*/
default CompletableFuture getGeneratedTemplate(
Consumer getGeneratedTemplateRequest) {
return getGeneratedTemplate(GetGeneratedTemplateRequest.builder().applyMutation(getGeneratedTemplateRequest).build());
}
/**
*
* Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
*
*
* @param getStackPolicyRequest
* The input for the GetStackPolicy action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.GetStackPolicy
* @see AWS
* API Documentation
*/
default CompletableFuture getStackPolicy(GetStackPolicyRequest getStackPolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetStackPolicyRequest.Builder} avoiding the need to
* create one manually via {@link GetStackPolicyRequest#builder()}
*
*
* @param getStackPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.GetStackPolicyRequest.Builder} to create a
* request. The input for the GetStackPolicy action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.GetStackPolicy
* @see AWS
* API Documentation
*/
default CompletableFuture getStackPolicy(Consumer getStackPolicyRequest) {
return getStackPolicy(GetStackPolicyRequest.builder().applyMutation(getStackPolicyRequest).build());
}
/**
*
* 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.
*
*
*
* @param getTemplateRequest
* The input for a GetTemplate action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.GetTemplate
* @see AWS
* API Documentation
*/
default CompletableFuture getTemplate(GetTemplateRequest getTemplateRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetTemplateRequest.Builder} avoiding the need to
* create one manually via {@link GetTemplateRequest#builder()}
*
*
* @param getTemplateRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.GetTemplateRequest.Builder} to create a
* request. The input for a GetTemplate action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.GetTemplate
* @see AWS
* API Documentation
*/
default CompletableFuture getTemplate(Consumer getTemplateRequest) {
return getTemplate(GetTemplateRequest.builder().applyMutation(getTemplateRequest).build());
}
/**
*
* Returns information about a new or existing template. The GetTemplateSummary action is useful for
* viewing parameter information, such as default parameter values and parameter types, before you create or update
* a stack or stack set.
*
*
* You can use the GetTemplateSummary action when you submit a template, or you can get template
* information for a stack set, or a running or deleted stack.
*
*
* For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the
* stack has been deleted. If the template doesn't exist, a ValidationError is returned.
*
*
* @param getTemplateSummaryRequest
* The input for the GetTemplateSummary action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.GetTemplateSummary
* @see AWS API Documentation
*/
default CompletableFuture getTemplateSummary(GetTemplateSummaryRequest getTemplateSummaryRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about a new or existing template. The GetTemplateSummary action is useful for
* viewing parameter information, such as default parameter values and parameter types, before you create or update
* a stack or stack set.
*
*
* You can use the GetTemplateSummary action when you submit a template, or you can get template
* information for a stack set, or a running or deleted stack.
*
*
* For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the
* stack has been deleted. If the template doesn't exist, a ValidationError is returned.
*
*
*
* This is a convenience which creates an instance of the {@link GetTemplateSummaryRequest.Builder} avoiding the
* need to create one manually via {@link GetTemplateSummaryRequest#builder()}
*
*
* @param getTemplateSummaryRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.GetTemplateSummaryRequest.Builder} to create a
* request. The input for the GetTemplateSummary action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.GetTemplateSummary
* @see AWS API Documentation
*/
default CompletableFuture getTemplateSummary(
Consumer getTemplateSummaryRequest) {
return getTemplateSummary(GetTemplateSummaryRequest.builder().applyMutation(getTemplateSummaryRequest).build());
}
/**
*
* 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.
*
*
* @param importStacksToStackSetRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ImportStacksToStackSet
* @see AWS API Documentation
*/
default CompletableFuture importStacksToStackSet(
ImportStacksToStackSetRequest importStacksToStackSetRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ImportStacksToStackSetRequest.Builder} avoiding the
* need to create one manually via {@link ImportStacksToStackSetRequest#builder()}
*
*
* @param importStacksToStackSetRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ImportStacksToStackSetRequest.Builder} to
* create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ImportStacksToStackSet
* @see AWS API Documentation
*/
default CompletableFuture importStacksToStackSet(
Consumer importStacksToStackSetRequest) {
return importStacksToStackSet(ImportStacksToStackSetRequest.builder().applyMutation(importStacksToStackSetRequest)
.build());
}
/**
*
* Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets
* that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.
*
*
* @param listChangeSetsRequest
* The input for the ListChangeSets action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListChangeSets
* @see AWS
* API Documentation
*/
default CompletableFuture listChangeSets(ListChangeSetsRequest listChangeSetsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets
* that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.
*
*
*
* This is a convenience which creates an instance of the {@link ListChangeSetsRequest.Builder} avoiding the need to
* create one manually via {@link ListChangeSetsRequest#builder()}
*
*
* @param listChangeSetsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListChangeSetsRequest.Builder} to create a
* request. The input for the ListChangeSets action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListChangeSets
* @see AWS
* API Documentation
*/
default CompletableFuture listChangeSets(Consumer listChangeSetsRequest) {
return listChangeSets(ListChangeSetsRequest.builder().applyMutation(listChangeSetsRequest).build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListChangeSetsPublisher publisher = client.listChangeSetsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListChangeSetsPublisher publisher = client.listChangeSetsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListChangeSetsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listChangeSets(software.amazon.awssdk.services.cloudformation.model.ListChangeSetsRequest)}
* operation.
*
*
* @param listChangeSetsRequest
* The input for the ListChangeSets action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListChangeSets
* @see AWS
* API Documentation
*/
default ListChangeSetsPublisher listChangeSetsPaginator(ListChangeSetsRequest listChangeSetsRequest) {
return new ListChangeSetsPublisher(this, listChangeSetsRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListChangeSetsPublisher publisher = client.listChangeSetsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListChangeSetsPublisher publisher = client.listChangeSetsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListChangeSetsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listChangeSets(software.amazon.awssdk.services.cloudformation.model.ListChangeSetsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListChangeSetsRequest.Builder} avoiding the need to
* create one manually via {@link ListChangeSetsRequest#builder()}
*
*
* @param listChangeSetsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListChangeSetsRequest.Builder} to create a
* request. The input for the ListChangeSets action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListChangeSets
* @see AWS
* API Documentation
*/
default ListChangeSetsPublisher listChangeSetsPaginator(Consumer listChangeSetsRequest) {
return listChangeSetsPaginator(ListChangeSetsRequest.builder().applyMutation(listChangeSetsRequest).build());
}
/**
*
* 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.
*
*
* @param listExportsRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListExports
* @see AWS
* API Documentation
*/
default CompletableFuture listExports(ListExportsRequest listExportsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListExportsRequest.Builder} avoiding the need to
* create one manually via {@link ListExportsRequest#builder()}
*
*
* @param listExportsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListExportsRequest.Builder} to create a
* request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListExports
* @see AWS
* API Documentation
*/
default CompletableFuture listExports(Consumer listExportsRequest) {
return listExports(ListExportsRequest.builder().applyMutation(listExportsRequest).build());
}
/**
*
* 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.
*
*
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListExports
* @see AWS
* API Documentation
*/
default CompletableFuture listExports() {
return listExports(ListExportsRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListExportsPublisher publisher = client.listExportsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListExportsPublisher publisher = client.listExportsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListExportsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest)} operation.
*
*
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListExports
* @see AWS
* API Documentation
*/
default ListExportsPublisher listExportsPaginator() {
return listExportsPaginator(ListExportsRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListExportsPublisher publisher = client.listExportsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListExportsPublisher publisher = client.listExportsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListExportsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest)} operation.
*
*
* @param listExportsRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListExports
* @see AWS
* API Documentation
*/
default ListExportsPublisher listExportsPaginator(ListExportsRequest listExportsRequest) {
return new ListExportsPublisher(this, listExportsRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListExportsPublisher publisher = client.listExportsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListExportsPublisher publisher = client.listExportsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListExportsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListExportsRequest.Builder} avoiding the need to
* create one manually via {@link ListExportsRequest#builder()}
*
*
* @param listExportsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListExportsRequest.Builder} to create a
* request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListExports
* @see AWS
* API Documentation
*/
default ListExportsPublisher listExportsPaginator(Consumer listExportsRequest) {
return listExportsPaginator(ListExportsRequest.builder().applyMutation(listExportsRequest).build());
}
/**
*
* Lists your generated templates in this Region.
*
*
* @param listGeneratedTemplatesRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListGeneratedTemplates
* @see AWS API Documentation
*/
default CompletableFuture listGeneratedTemplates(
ListGeneratedTemplatesRequest listGeneratedTemplatesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists your generated templates in this Region.
*
*
*
* This is a convenience which creates an instance of the {@link ListGeneratedTemplatesRequest.Builder} avoiding the
* need to create one manually via {@link ListGeneratedTemplatesRequest#builder()}
*
*
* @param listGeneratedTemplatesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListGeneratedTemplatesRequest.Builder} to
* create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListGeneratedTemplates
* @see AWS API Documentation
*/
default CompletableFuture listGeneratedTemplates(
Consumer listGeneratedTemplatesRequest) {
return listGeneratedTemplates(ListGeneratedTemplatesRequest.builder().applyMutation(listGeneratedTemplatesRequest)
.build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListGeneratedTemplatesPublisher publisher = client.listGeneratedTemplatesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListGeneratedTemplatesPublisher publisher = client.listGeneratedTemplatesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListGeneratedTemplatesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listGeneratedTemplates(software.amazon.awssdk.services.cloudformation.model.ListGeneratedTemplatesRequest)}
* operation.
*
*
* @param listGeneratedTemplatesRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListGeneratedTemplates
* @see AWS API Documentation
*/
default ListGeneratedTemplatesPublisher listGeneratedTemplatesPaginator(
ListGeneratedTemplatesRequest listGeneratedTemplatesRequest) {
return new ListGeneratedTemplatesPublisher(this, listGeneratedTemplatesRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListGeneratedTemplatesPublisher publisher = client.listGeneratedTemplatesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListGeneratedTemplatesPublisher publisher = client.listGeneratedTemplatesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListGeneratedTemplatesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listGeneratedTemplates(software.amazon.awssdk.services.cloudformation.model.ListGeneratedTemplatesRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListGeneratedTemplatesRequest.Builder} avoiding the
* need to create one manually via {@link ListGeneratedTemplatesRequest#builder()}
*
*
* @param listGeneratedTemplatesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListGeneratedTemplatesRequest.Builder} to
* create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListGeneratedTemplates
* @see AWS API Documentation
*/
default ListGeneratedTemplatesPublisher listGeneratedTemplatesPaginator(
Consumer listGeneratedTemplatesRequest) {
return listGeneratedTemplatesPaginator(ListGeneratedTemplatesRequest.builder()
.applyMutation(listGeneratedTemplatesRequest).build());
}
/**
*
* 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.
*
*
* @param listImportsRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListImports
* @see AWS
* API Documentation
*/
default CompletableFuture listImports(ListImportsRequest listImportsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListImportsRequest.Builder} avoiding the need to
* create one manually via {@link ListImportsRequest#builder()}
*
*
* @param listImportsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListImportsRequest.Builder} to create a
* request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListImports
* @see AWS
* API Documentation
*/
default CompletableFuture listImports(Consumer listImportsRequest) {
return listImports(ListImportsRequest.builder().applyMutation(listImportsRequest).build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListImportsPublisher publisher = client.listImportsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListImportsPublisher publisher = client.listImportsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListImportsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listImports(software.amazon.awssdk.services.cloudformation.model.ListImportsRequest)} operation.
*
*
* @param listImportsRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListImports
* @see AWS
* API Documentation
*/
default ListImportsPublisher listImportsPaginator(ListImportsRequest listImportsRequest) {
return new ListImportsPublisher(this, listImportsRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListImportsPublisher publisher = client.listImportsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListImportsPublisher publisher = client.listImportsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListImportsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listImports(software.amazon.awssdk.services.cloudformation.model.ListImportsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListImportsRequest.Builder} avoiding the need to
* create one manually via {@link ListImportsRequest#builder()}
*
*
* @param listImportsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListImportsRequest.Builder} to create a
* request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListImports
* @see AWS
* API Documentation
*/
default ListImportsPublisher listImportsPaginator(Consumer listImportsRequest) {
return listImportsPaginator(ListImportsRequest.builder().applyMutation(listImportsRequest).build());
}
/**
*
* 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.
*
*
* @param listResourceScanRelatedResourcesRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListResourceScanRelatedResources
* @see AWS API Documentation
*/
default CompletableFuture listResourceScanRelatedResources(
ListResourceScanRelatedResourcesRequest listResourceScanRelatedResourcesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListResourceScanRelatedResourcesRequest.Builder}
* avoiding the need to create one manually via {@link ListResourceScanRelatedResourcesRequest#builder()}
*
*
* @param listResourceScanRelatedResourcesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListResourceScanRelatedResourcesRequest.Builder}
* to create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListResourceScanRelatedResources
* @see AWS API Documentation
*/
default CompletableFuture listResourceScanRelatedResources(
Consumer listResourceScanRelatedResourcesRequest) {
return listResourceScanRelatedResources(ListResourceScanRelatedResourcesRequest.builder()
.applyMutation(listResourceScanRelatedResourcesRequest).build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListResourceScanRelatedResourcesPublisher publisher = client.listResourceScanRelatedResourcesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListResourceScanRelatedResourcesPublisher publisher = client.listResourceScanRelatedResourcesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListResourceScanRelatedResourcesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listResourceScanRelatedResources(software.amazon.awssdk.services.cloudformation.model.ListResourceScanRelatedResourcesRequest)}
* operation.
*
*
* @param listResourceScanRelatedResourcesRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListResourceScanRelatedResources
* @see AWS API Documentation
*/
default ListResourceScanRelatedResourcesPublisher listResourceScanRelatedResourcesPaginator(
ListResourceScanRelatedResourcesRequest listResourceScanRelatedResourcesRequest) {
return new ListResourceScanRelatedResourcesPublisher(this, listResourceScanRelatedResourcesRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListResourceScanRelatedResourcesPublisher publisher = client.listResourceScanRelatedResourcesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListResourceScanRelatedResourcesPublisher publisher = client.listResourceScanRelatedResourcesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListResourceScanRelatedResourcesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listResourceScanRelatedResources(software.amazon.awssdk.services.cloudformation.model.ListResourceScanRelatedResourcesRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListResourceScanRelatedResourcesRequest.Builder}
* avoiding the need to create one manually via {@link ListResourceScanRelatedResourcesRequest#builder()}
*
*
* @param listResourceScanRelatedResourcesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListResourceScanRelatedResourcesRequest.Builder}
* to create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListResourceScanRelatedResources
* @see AWS API Documentation
*/
default ListResourceScanRelatedResourcesPublisher listResourceScanRelatedResourcesPaginator(
Consumer listResourceScanRelatedResourcesRequest) {
return listResourceScanRelatedResourcesPaginator(ListResourceScanRelatedResourcesRequest.builder()
.applyMutation(listResourceScanRelatedResourcesRequest).build());
}
/**
*
* 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.
*
*
* @param listResourceScanResourcesRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListResourceScanResources
* @see AWS API Documentation
*/
default CompletableFuture listResourceScanResources(
ListResourceScanResourcesRequest listResourceScanResourcesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListResourceScanResourcesRequest.Builder} avoiding
* the need to create one manually via {@link ListResourceScanResourcesRequest#builder()}
*
*
* @param listResourceScanResourcesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListResourceScanResourcesRequest.Builder} to
* create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListResourceScanResources
* @see AWS API Documentation
*/
default CompletableFuture listResourceScanResources(
Consumer listResourceScanResourcesRequest) {
return listResourceScanResources(ListResourceScanResourcesRequest.builder()
.applyMutation(listResourceScanResourcesRequest).build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListResourceScanResourcesPublisher publisher = client.listResourceScanResourcesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListResourceScanResourcesPublisher publisher = client.listResourceScanResourcesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListResourceScanResourcesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listResourceScanResources(software.amazon.awssdk.services.cloudformation.model.ListResourceScanResourcesRequest)}
* operation.
*
*
* @param listResourceScanResourcesRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListResourceScanResources
* @see AWS API Documentation
*/
default ListResourceScanResourcesPublisher listResourceScanResourcesPaginator(
ListResourceScanResourcesRequest listResourceScanResourcesRequest) {
return new ListResourceScanResourcesPublisher(this, listResourceScanResourcesRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListResourceScanResourcesPublisher publisher = client.listResourceScanResourcesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListResourceScanResourcesPublisher publisher = client.listResourceScanResourcesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListResourceScanResourcesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listResourceScanResources(software.amazon.awssdk.services.cloudformation.model.ListResourceScanResourcesRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListResourceScanResourcesRequest.Builder} avoiding
* the need to create one manually via {@link ListResourceScanResourcesRequest#builder()}
*
*
* @param listResourceScanResourcesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListResourceScanResourcesRequest.Builder} to
* create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListResourceScanResources
* @see AWS API Documentation
*/
default ListResourceScanResourcesPublisher listResourceScanResourcesPaginator(
Consumer listResourceScanResourcesRequest) {
return listResourceScanResourcesPaginator(ListResourceScanResourcesRequest.builder()
.applyMutation(listResourceScanResourcesRequest).build());
}
/**
*
* List the resource scans from newest to oldest. By default it will return up to 10 resource scans.
*
*
* @param listResourceScansRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListResourceScans
* @see AWS API Documentation
*/
default CompletableFuture listResourceScans(ListResourceScansRequest listResourceScansRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListResourceScansRequest.Builder} avoiding the need
* to create one manually via {@link ListResourceScansRequest#builder()}
*
*
* @param listResourceScansRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListResourceScansRequest.Builder} to create a
* request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListResourceScans
* @see AWS API Documentation
*/
default CompletableFuture listResourceScans(
Consumer listResourceScansRequest) {
return listResourceScans(ListResourceScansRequest.builder().applyMutation(listResourceScansRequest).build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListResourceScansPublisher publisher = client.listResourceScansPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListResourceScansPublisher publisher = client.listResourceScansPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListResourceScansResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listResourceScans(software.amazon.awssdk.services.cloudformation.model.ListResourceScansRequest)}
* operation.
*
*
* @param listResourceScansRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListResourceScans
* @see AWS API Documentation
*/
default ListResourceScansPublisher listResourceScansPaginator(ListResourceScansRequest listResourceScansRequest) {
return new ListResourceScansPublisher(this, listResourceScansRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListResourceScansPublisher publisher = client.listResourceScansPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListResourceScansPublisher publisher = client.listResourceScansPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListResourceScansResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listResourceScans(software.amazon.awssdk.services.cloudformation.model.ListResourceScansRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListResourceScansRequest.Builder} avoiding the need
* to create one manually via {@link ListResourceScansRequest#builder()}
*
*
* @param listResourceScansRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListResourceScansRequest.Builder} to create a
* request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListResourceScans
* @see AWS API Documentation
*/
default ListResourceScansPublisher listResourceScansPaginator(
Consumer listResourceScansRequest) {
return listResourceScansPaginator(ListResourceScansRequest.builder().applyMutation(listResourceScansRequest).build());
}
/**
*
* 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.
*
*
*
* @param listStackInstanceResourceDriftsRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListStackInstanceResourceDrifts
* @see AWS API Documentation
*/
default CompletableFuture listStackInstanceResourceDrifts(
ListStackInstanceResourceDriftsRequest listStackInstanceResourceDriftsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListStackInstanceResourceDriftsRequest.Builder}
* avoiding the need to create one manually via {@link ListStackInstanceResourceDriftsRequest#builder()}
*
*
* @param listStackInstanceResourceDriftsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListStackInstanceResourceDriftsRequest.Builder}
* to create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListStackInstanceResourceDrifts
* @see AWS API Documentation
*/
default CompletableFuture listStackInstanceResourceDrifts(
Consumer listStackInstanceResourceDriftsRequest) {
return listStackInstanceResourceDrifts(ListStackInstanceResourceDriftsRequest.builder()
.applyMutation(listStackInstanceResourceDriftsRequest).build());
}
/**
*
* 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.
*
*
* @param listStackInstancesRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListStackInstances
* @see AWS API Documentation
*/
default CompletableFuture listStackInstances(ListStackInstancesRequest listStackInstancesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListStackInstancesRequest.Builder} avoiding the
* need to create one manually via {@link ListStackInstancesRequest#builder()}
*
*
* @param listStackInstancesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListStackInstancesRequest.Builder} to create a
* request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListStackInstances
* @see AWS API Documentation
*/
default CompletableFuture listStackInstances(
Consumer listStackInstancesRequest) {
return listStackInstances(ListStackInstancesRequest.builder().applyMutation(listStackInstancesRequest).build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListStackInstancesPublisher publisher = client.listStackInstancesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListStackInstancesPublisher publisher = client.listStackInstancesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStackInstancesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listStackInstances(software.amazon.awssdk.services.cloudformation.model.ListStackInstancesRequest)}
* operation.
*
*
* @param listStackInstancesRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListStackInstances
* @see AWS API Documentation
*/
default ListStackInstancesPublisher listStackInstancesPaginator(ListStackInstancesRequest listStackInstancesRequest) {
return new ListStackInstancesPublisher(this, listStackInstancesRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListStackInstancesPublisher publisher = client.listStackInstancesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListStackInstancesPublisher publisher = client.listStackInstancesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStackInstancesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listStackInstances(software.amazon.awssdk.services.cloudformation.model.ListStackInstancesRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListStackInstancesRequest.Builder} avoiding the
* need to create one manually via {@link ListStackInstancesRequest#builder()}
*
*
* @param listStackInstancesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListStackInstancesRequest.Builder} to create a
* request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListStackInstances
* @see AWS API Documentation
*/
default ListStackInstancesPublisher listStackInstancesPaginator(
Consumer listStackInstancesRequest) {
return listStackInstancesPaginator(ListStackInstancesRequest.builder().applyMutation(listStackInstancesRequest).build());
}
/**
*
* 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.
*
*
* @param listStackResourcesRequest
* The input for the ListStackResource action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListStackResources
* @see AWS API Documentation
*/
default CompletableFuture listStackResources(ListStackResourcesRequest listStackResourcesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListStackResourcesRequest.Builder} avoiding the
* need to create one manually via {@link ListStackResourcesRequest#builder()}
*
*
* @param listStackResourcesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListStackResourcesRequest.Builder} to create a
* request. The input for the ListStackResource action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListStackResources
* @see AWS API Documentation
*/
default CompletableFuture listStackResources(
Consumer listStackResourcesRequest) {
return listStackResources(ListStackResourcesRequest.builder().applyMutation(listStackResourcesRequest).build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListStackResourcesPublisher publisher = client.listStackResourcesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListStackResourcesPublisher publisher = client.listStackResourcesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStackResourcesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listStackResources(software.amazon.awssdk.services.cloudformation.model.ListStackResourcesRequest)}
* operation.
*
*
* @param listStackResourcesRequest
* The input for the ListStackResource action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListStackResources
* @see AWS API Documentation
*/
default ListStackResourcesPublisher listStackResourcesPaginator(ListStackResourcesRequest listStackResourcesRequest) {
return new ListStackResourcesPublisher(this, listStackResourcesRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListStackResourcesPublisher publisher = client.listStackResourcesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListStackResourcesPublisher publisher = client.listStackResourcesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStackResourcesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listStackResources(software.amazon.awssdk.services.cloudformation.model.ListStackResourcesRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListStackResourcesRequest.Builder} avoiding the
* need to create one manually via {@link ListStackResourcesRequest#builder()}
*
*
* @param listStackResourcesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListStackResourcesRequest.Builder} to create a
* request. The input for the ListStackResource action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListStackResources
* @see AWS API Documentation
*/
default ListStackResourcesPublisher listStackResourcesPaginator(
Consumer listStackResourcesRequest) {
return listStackResourcesPaginator(ListStackResourcesRequest.builder().applyMutation(listStackResourcesRequest).build());
}
/**
*
* Returns summary information about deployment targets for a stack set.
*
*
* @param listStackSetAutoDeploymentTargetsRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListStackSetAutoDeploymentTargets
* @see AWS API Documentation
*/
default CompletableFuture listStackSetAutoDeploymentTargets(
ListStackSetAutoDeploymentTargetsRequest listStackSetAutoDeploymentTargetsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns summary information about deployment targets for a stack set.
*
*
*
* This is a convenience which creates an instance of the {@link ListStackSetAutoDeploymentTargetsRequest.Builder}
* avoiding the need to create one manually via {@link ListStackSetAutoDeploymentTargetsRequest#builder()}
*
*
* @param listStackSetAutoDeploymentTargetsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListStackSetAutoDeploymentTargetsRequest.Builder}
* to create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListStackSetAutoDeploymentTargets
* @see AWS API Documentation
*/
default CompletableFuture listStackSetAutoDeploymentTargets(
Consumer listStackSetAutoDeploymentTargetsRequest) {
return listStackSetAutoDeploymentTargets(ListStackSetAutoDeploymentTargetsRequest.builder()
.applyMutation(listStackSetAutoDeploymentTargetsRequest).build());
}
/**
*
* Returns summary information about the results of a stack set operation.
*
*
* @param listStackSetOperationResultsRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListStackSetOperationResults
* @see AWS API Documentation
*/
default CompletableFuture listStackSetOperationResults(
ListStackSetOperationResultsRequest listStackSetOperationResultsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns summary information about the results of a stack set operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListStackSetOperationResultsRequest.Builder}
* avoiding the need to create one manually via {@link ListStackSetOperationResultsRequest#builder()}
*
*
* @param listStackSetOperationResultsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsRequest.Builder}
* to create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListStackSetOperationResults
* @see AWS API Documentation
*/
default CompletableFuture listStackSetOperationResults(
Consumer listStackSetOperationResultsRequest) {
return listStackSetOperationResults(ListStackSetOperationResultsRequest.builder()
.applyMutation(listStackSetOperationResultsRequest).build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationResultsPublisher publisher = client.listStackSetOperationResultsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationResultsPublisher publisher = client.listStackSetOperationResultsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listStackSetOperationResults(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsRequest)}
* operation.
*
*
* @param listStackSetOperationResultsRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListStackSetOperationResults
* @see AWS API Documentation
*/
default ListStackSetOperationResultsPublisher listStackSetOperationResultsPaginator(
ListStackSetOperationResultsRequest listStackSetOperationResultsRequest) {
return new ListStackSetOperationResultsPublisher(this, listStackSetOperationResultsRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationResultsPublisher publisher = client.listStackSetOperationResultsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationResultsPublisher publisher = client.listStackSetOperationResultsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listStackSetOperationResults(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListStackSetOperationResultsRequest.Builder}
* avoiding the need to create one manually via {@link ListStackSetOperationResultsRequest#builder()}
*
*
* @param listStackSetOperationResultsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsRequest.Builder}
* to create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListStackSetOperationResults
* @see AWS API Documentation
*/
default ListStackSetOperationResultsPublisher listStackSetOperationResultsPaginator(
Consumer listStackSetOperationResultsRequest) {
return listStackSetOperationResultsPaginator(ListStackSetOperationResultsRequest.builder()
.applyMutation(listStackSetOperationResultsRequest).build());
}
/**
*
* Returns summary information about operations performed on a stack set.
*
*
* @param listStackSetOperationsRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListStackSetOperations
* @see AWS API Documentation
*/
default CompletableFuture listStackSetOperations(
ListStackSetOperationsRequest listStackSetOperationsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns summary information about operations performed on a stack set.
*
*
*
* This is a convenience which creates an instance of the {@link ListStackSetOperationsRequest.Builder} avoiding the
* need to create one manually via {@link ListStackSetOperationsRequest#builder()}
*
*
* @param listStackSetOperationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsRequest.Builder} to
* create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListStackSetOperations
* @see AWS API Documentation
*/
default CompletableFuture listStackSetOperations(
Consumer listStackSetOperationsRequest) {
return listStackSetOperations(ListStackSetOperationsRequest.builder().applyMutation(listStackSetOperationsRequest)
.build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationsPublisher publisher = client.listStackSetOperationsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationsPublisher publisher = client.listStackSetOperationsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listStackSetOperations(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsRequest)}
* operation.
*
*
* @param listStackSetOperationsRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListStackSetOperations
* @see AWS API Documentation
*/
default ListStackSetOperationsPublisher listStackSetOperationsPaginator(
ListStackSetOperationsRequest listStackSetOperationsRequest) {
return new ListStackSetOperationsPublisher(this, listStackSetOperationsRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationsPublisher publisher = client.listStackSetOperationsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationsPublisher publisher = client.listStackSetOperationsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listStackSetOperations(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListStackSetOperationsRequest.Builder} avoiding the
* need to create one manually via {@link ListStackSetOperationsRequest#builder()}
*
*
* @param listStackSetOperationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsRequest.Builder} to
* create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListStackSetOperations
* @see AWS API Documentation
*/
default ListStackSetOperationsPublisher listStackSetOperationsPaginator(
Consumer listStackSetOperationsRequest) {
return listStackSetOperationsPaginator(ListStackSetOperationsRequest.builder()
.applyMutation(listStackSetOperationsRequest).build());
}
/**
*
* Returns summary information about stack sets that are associated with the user.
*
*
* -
*
* [Self-managed permissions] If you set the CallAs parameter to SELF while signed in to
* your Amazon Web Services account, ListStackSets returns all self-managed stack sets in your Amazon
* Web Services account.
*
*
* -
*
* [Service-managed permissions] If you set the CallAs parameter to SELF while signed in
* to the organization's management account, ListStackSets returns all stack sets in the management
* account.
*
*
* -
*
* [Service-managed permissions] If you set the CallAs parameter to DELEGATED_ADMIN while
* signed in to your member account, ListStackSets returns all stack sets with service-managed
* permissions in the management account.
*
*
*
*
* @param listStackSetsRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListStackSets
* @see AWS
* API Documentation
*/
default CompletableFuture listStackSets(ListStackSetsRequest listStackSetsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns summary information about stack sets that are associated with the user.
*
*
* -
*
* [Self-managed permissions] If you set the CallAs parameter to SELF while signed in to
* your Amazon Web Services account, ListStackSets returns all self-managed stack sets in your Amazon
* Web Services account.
*
*
* -
*
* [Service-managed permissions] If you set the CallAs parameter to SELF while signed in
* to the organization's management account, ListStackSets returns all stack sets in the management
* account.
*
*
* -
*
* [Service-managed permissions] If you set the CallAs parameter to DELEGATED_ADMIN while
* signed in to your member account, ListStackSets returns all stack sets with service-managed
* permissions in the management account.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link ListStackSetsRequest.Builder} avoiding the need to
* create one manually via {@link ListStackSetsRequest#builder()}
*
*
* @param listStackSetsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListStackSetsRequest.Builder} to create a
* request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListStackSets
* @see AWS
* API Documentation
*/
default CompletableFuture listStackSets(Consumer listStackSetsRequest) {
return listStackSets(ListStackSetsRequest.builder().applyMutation(listStackSetsRequest).build());
}
/**
*
* Returns summary information about stack sets that are associated with the user.
*
*
* -
*
* [Self-managed permissions] If you set the CallAs parameter to SELF while signed in to
* your Amazon Web Services account, ListStackSets returns all self-managed stack sets in your Amazon
* Web Services account.
*
*
* -
*
* [Service-managed permissions] If you set the CallAs parameter to SELF while signed in
* to the organization's management account, ListStackSets returns all stack sets in the management
* account.
*
*
* -
*
* [Service-managed permissions] If you set the CallAs parameter to DELEGATED_ADMIN while
* signed in to your member account, ListStackSets returns all stack sets with service-managed
* permissions in the management account.
*
*
*
*
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListStackSets
* @see AWS
* API Documentation
*/
default CompletableFuture listStackSets() {
return listStackSets(ListStackSetsRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListStackSetsPublisher publisher = client.listStackSetsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListStackSetsPublisher publisher = client.listStackSetsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStackSetsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listStackSets(software.amazon.awssdk.services.cloudformation.model.ListStackSetsRequest)} operation.
*
*
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListStackSets
* @see AWS
* API Documentation
*/
default ListStackSetsPublisher listStackSetsPaginator() {
return listStackSetsPaginator(ListStackSetsRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListStackSetsPublisher publisher = client.listStackSetsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListStackSetsPublisher publisher = client.listStackSetsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStackSetsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listStackSets(software.amazon.awssdk.services.cloudformation.model.ListStackSetsRequest)} operation.
*
*
* @param listStackSetsRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListStackSets
* @see AWS
* API Documentation
*/
default ListStackSetsPublisher listStackSetsPaginator(ListStackSetsRequest listStackSetsRequest) {
return new ListStackSetsPublisher(this, listStackSetsRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListStackSetsPublisher publisher = client.listStackSetsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListStackSetsPublisher publisher = client.listStackSetsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStackSetsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listStackSets(software.amazon.awssdk.services.cloudformation.model.ListStackSetsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListStackSetsRequest.Builder} avoiding the need to
* create one manually via {@link ListStackSetsRequest#builder()}
*
*
* @param listStackSetsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListStackSetsRequest.Builder} to create a
* request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListStackSets
* @see AWS
* API Documentation
*/
default ListStackSetsPublisher listStackSetsPaginator(Consumer listStackSetsRequest) {
return listStackSetsPaginator(ListStackSetsRequest.builder().applyMutation(listStackSetsRequest).build());
}
/**
*
* 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).
*
*
* @param listStacksRequest
* The input for ListStacks action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListStacks
* @see AWS API
* Documentation
*/
default CompletableFuture listStacks(ListStacksRequest listStacksRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListStacksRequest.Builder} avoiding the need to
* create one manually via {@link ListStacksRequest#builder()}
*
*
* @param listStacksRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListStacksRequest.Builder} to create a
* request. The input for ListStacks action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListStacks
* @see AWS API
* Documentation
*/
default CompletableFuture listStacks(Consumer listStacksRequest) {
return listStacks(ListStacksRequest.builder().applyMutation(listStacksRequest).build());
}
/**
*
* 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).
*
*
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListStacks
* @see AWS API
* Documentation
*/
default CompletableFuture listStacks() {
return listStacks(ListStacksRequest.builder().build());
}
/**
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListStacksPublisher publisher = client.listStacksPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListStacksPublisher publisher = client.listStacksPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStacksResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest)} operation.
*
*
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListStacks
* @see AWS API
* Documentation
*/
default ListStacksPublisher listStacksPaginator() {
return listStacksPaginator(ListStacksRequest.builder().build());
}
/**
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListStacksPublisher publisher = client.listStacksPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListStacksPublisher publisher = client.listStacksPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStacksResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest)} operation.
*
*
* @param listStacksRequest
* The input for ListStacks action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListStacks
* @see AWS API
* Documentation
*/
default ListStacksPublisher listStacksPaginator(ListStacksRequest listStacksRequest) {
return new ListStacksPublisher(this, listStacksRequest);
}
/**
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListStacksPublisher publisher = client.listStacksPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListStacksPublisher publisher = client.listStacksPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListStacksResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListStacksRequest.Builder} avoiding the need to
* create one manually via {@link ListStacksRequest#builder()}
*
*
* @param listStacksRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListStacksRequest.Builder} to create a
* request. The input for ListStacks action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.ListStacks
* @see AWS API
* Documentation
*/
default ListStacksPublisher listStacksPaginator(Consumer listStacksRequest) {
return listStacksPaginator(ListStacksRequest.builder().applyMutation(listStacksRequest).build());
}
/**
*
* Returns a list of registration tokens for the specified extension(s).
*
*
* @param listTypeRegistrationsRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListTypeRegistrations
* @see AWS API Documentation
*/
default CompletableFuture listTypeRegistrations(
ListTypeRegistrationsRequest listTypeRegistrationsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of registration tokens for the specified extension(s).
*
*
*
* This is a convenience which creates an instance of the {@link ListTypeRegistrationsRequest.Builder} avoiding the
* need to create one manually via {@link ListTypeRegistrationsRequest#builder()}
*
*
* @param listTypeRegistrationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsRequest.Builder} to
* create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListTypeRegistrations
* @see AWS API Documentation
*/
default CompletableFuture listTypeRegistrations(
Consumer listTypeRegistrationsRequest) {
return listTypeRegistrations(ListTypeRegistrationsRequest.builder().applyMutation(listTypeRegistrationsRequest).build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListTypeRegistrationsPublisher publisher = client.listTypeRegistrationsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListTypeRegistrationsPublisher publisher = client.listTypeRegistrationsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listTypeRegistrations(software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsRequest)}
* operation.
*
*
* @param listTypeRegistrationsRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListTypeRegistrations
* @see AWS API Documentation
*/
default ListTypeRegistrationsPublisher listTypeRegistrationsPaginator(
ListTypeRegistrationsRequest listTypeRegistrationsRequest) {
return new ListTypeRegistrationsPublisher(this, listTypeRegistrationsRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListTypeRegistrationsPublisher publisher = client.listTypeRegistrationsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListTypeRegistrationsPublisher publisher = client.listTypeRegistrationsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listTypeRegistrations(software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListTypeRegistrationsRequest.Builder} avoiding the
* need to create one manually via {@link ListTypeRegistrationsRequest#builder()}
*
*
* @param listTypeRegistrationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsRequest.Builder} to
* create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListTypeRegistrations
* @see AWS API Documentation
*/
default ListTypeRegistrationsPublisher listTypeRegistrationsPaginator(
Consumer listTypeRegistrationsRequest) {
return listTypeRegistrationsPaginator(ListTypeRegistrationsRequest.builder().applyMutation(listTypeRegistrationsRequest)
.build());
}
/**
*
* Returns summary information about the versions of an extension.
*
*
* @param listTypeVersionsRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListTypeVersions
* @see AWS API Documentation
*/
default CompletableFuture listTypeVersions(ListTypeVersionsRequest listTypeVersionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns summary information about the versions of an extension.
*
*
*
* This is a convenience which creates an instance of the {@link ListTypeVersionsRequest.Builder} avoiding the need
* to create one manually via {@link ListTypeVersionsRequest#builder()}
*
*
* @param listTypeVersionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsRequest.Builder} to create a
* request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListTypeVersions
* @see AWS API Documentation
*/
default CompletableFuture listTypeVersions(
Consumer listTypeVersionsRequest) {
return listTypeVersions(ListTypeVersionsRequest.builder().applyMutation(listTypeVersionsRequest).build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListTypeVersionsPublisher publisher = client.listTypeVersionsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListTypeVersionsPublisher publisher = client.listTypeVersionsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listTypeVersions(software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsRequest)}
* operation.
*
*
* @param listTypeVersionsRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListTypeVersions
* @see AWS API Documentation
*/
default ListTypeVersionsPublisher listTypeVersionsPaginator(ListTypeVersionsRequest listTypeVersionsRequest) {
return new ListTypeVersionsPublisher(this, listTypeVersionsRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListTypeVersionsPublisher publisher = client.listTypeVersionsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListTypeVersionsPublisher publisher = client.listTypeVersionsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listTypeVersions(software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListTypeVersionsRequest.Builder} avoiding the need
* to create one manually via {@link ListTypeVersionsRequest#builder()}
*
*
* @param listTypeVersionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsRequest.Builder} to create a
* request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListTypeVersions
* @see AWS API Documentation
*/
default ListTypeVersionsPublisher listTypeVersionsPaginator(Consumer listTypeVersionsRequest) {
return listTypeVersionsPaginator(ListTypeVersionsRequest.builder().applyMutation(listTypeVersionsRequest).build());
}
/**
*
* Returns summary information about extension that have been registered with CloudFormation.
*
*
* @param listTypesRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListTypes
* @see AWS API
* Documentation
*/
default CompletableFuture listTypes(ListTypesRequest listTypesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns summary information about extension that have been registered with CloudFormation.
*
*
*
* This is a convenience which creates an instance of the {@link ListTypesRequest.Builder} avoiding the need to
* create one manually via {@link ListTypesRequest#builder()}
*
*
* @param listTypesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListTypesRequest.Builder} to create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListTypes
* @see AWS API
* Documentation
*/
default CompletableFuture listTypes(Consumer listTypesRequest) {
return listTypes(ListTypesRequest.builder().applyMutation(listTypesRequest).build());
}
/**
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListTypesPublisher publisher = client.listTypesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListTypesPublisher publisher = client.listTypesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListTypesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listTypes(software.amazon.awssdk.services.cloudformation.model.ListTypesRequest)} operation.
*
*
* @param listTypesRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListTypes
* @see AWS API
* Documentation
*/
default ListTypesPublisher listTypesPaginator(ListTypesRequest listTypesRequest) {
return new ListTypesPublisher(this, listTypesRequest);
}
/**
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} 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 method
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListTypesPublisher publisher = client.listTypesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudformation.paginators.ListTypesPublisher publisher = client.listTypesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudformation.model.ListTypesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listTypes(software.amazon.awssdk.services.cloudformation.model.ListTypesRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListTypesRequest.Builder} avoiding the need to
* create one manually via {@link ListTypesRequest#builder()}
*
*
* @param listTypesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.ListTypesRequest.Builder} to create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.ListTypes
* @see AWS API
* Documentation
*/
default ListTypesPublisher listTypesPaginator(Consumer listTypesRequest) {
return listTypesPaginator(ListTypesRequest.builder().applyMutation(listTypesRequest).build());
}
/**
*
* 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.
*
*
* @param publishTypeRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.PublishType
* @see AWS
* API Documentation
*/
default CompletableFuture publishType(PublishTypeRequest publishTypeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link PublishTypeRequest.Builder} avoiding the need to
* create one manually via {@link PublishTypeRequest#builder()}
*
*
* @param publishTypeRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.PublishTypeRequest.Builder} to create a
* request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.PublishType
* @see AWS
* API Documentation
*/
default CompletableFuture publishType(Consumer publishTypeRequest) {
return publishType(PublishTypeRequest.builder().applyMutation(publishTypeRequest).build());
}
/**
*
* Reports progress of a resource handler to CloudFormation.
*
*
* Reserved for use by the CloudFormation CLI. Don't use this API in your code.
*
*
* @param recordHandlerProgressRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.RecordHandlerProgress
* @see AWS API Documentation
*/
default CompletableFuture recordHandlerProgress(
RecordHandlerProgressRequest recordHandlerProgressRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link RecordHandlerProgressRequest.Builder} avoiding the
* need to create one manually via {@link RecordHandlerProgressRequest#builder()}
*
*
* @param recordHandlerProgressRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.RecordHandlerProgressRequest.Builder} to
* create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.RecordHandlerProgress
* @see AWS API Documentation
*/
default CompletableFuture recordHandlerProgress(
Consumer recordHandlerProgressRequest) {
return recordHandlerProgress(RecordHandlerProgressRequest.builder().applyMutation(recordHandlerProgressRequest).build());
}
/**
*
* 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.
*
*
*
* @param registerPublisherRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.RegisterPublisher
* @see AWS API Documentation
*/
default CompletableFuture registerPublisher(RegisterPublisherRequest registerPublisherRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link RegisterPublisherRequest.Builder} avoiding the need
* to create one manually via {@link RegisterPublisherRequest#builder()}
*
*
* @param registerPublisherRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.RegisterPublisherRequest.Builder} to create a
* request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.RegisterPublisher
* @see AWS API Documentation
*/
default CompletableFuture registerPublisher(
Consumer registerPublisherRequest) {
return registerPublisher(RegisterPublisherRequest.builder().applyMutation(registerPublisherRequest).build());
}
/**
*
* 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.
*
*
* @param registerTypeRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.RegisterType
* @see AWS
* API Documentation
*/
default CompletableFuture registerType(RegisterTypeRequest registerTypeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link RegisterTypeRequest.Builder} avoiding the need to
* create one manually via {@link RegisterTypeRequest#builder()}
*
*
* @param registerTypeRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.RegisterTypeRequest.Builder} to create a
* request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.RegisterType
* @see AWS
* API Documentation
*/
default CompletableFuture registerType(Consumer registerTypeRequest) {
return registerType(RegisterTypeRequest.builder().applyMutation(registerTypeRequest).build());
}
/**
*
* When specifying RollbackStack, you preserve the state of previously provisioned resources when an
* operation fails. You can check the status of the stack through the DescribeStacks operation.
*
*
* Rolls back the specified stack to the last known stable state from CREATE_FAILED or
* UPDATE_FAILED stack statuses.
*
*
* This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state
* includes any status in a *_COMPLETE. This includes the following stack statuses.
*
*
* -
*
* CREATE_COMPLETE
*
*
* -
*
* UPDATE_COMPLETE
*
*
* -
*
* UPDATE_ROLLBACK_COMPLETE
*
*
* -
*
* IMPORT_COMPLETE
*
*
* -
*
* IMPORT_ROLLBACK_COMPLETE
*
*
*
*
* @param rollbackStackRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.RollbackStack
* @see AWS
* API Documentation
*/
default CompletableFuture rollbackStack(RollbackStackRequest rollbackStackRequest) {
throw new UnsupportedOperationException();
}
/**
*
* When specifying RollbackStack, you preserve the state of previously provisioned resources when an
* operation fails. You can check the status of the stack through the DescribeStacks operation.
*
*
* Rolls back the specified stack to the last known stable state from CREATE_FAILED or
* UPDATE_FAILED stack statuses.
*
*
* This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state
* includes any status in a *_COMPLETE. This includes the following stack statuses.
*
*
* -
*
* CREATE_COMPLETE
*
*
* -
*
* UPDATE_COMPLETE
*
*
* -
*
* UPDATE_ROLLBACK_COMPLETE
*
*
* -
*
* IMPORT_COMPLETE
*
*
* -
*
* IMPORT_ROLLBACK_COMPLETE
*
*
*
*
*
* This is a convenience which creates an instance of the {@link RollbackStackRequest.Builder} avoiding the need to
* create one manually via {@link RollbackStackRequest#builder()}
*
*
* @param rollbackStackRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.RollbackStackRequest.Builder} to create a
* request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.RollbackStack
* @see AWS
* API Documentation
*/
default CompletableFuture rollbackStack(Consumer rollbackStackRequest) {
return rollbackStack(RollbackStackRequest.builder().applyMutation(rollbackStackRequest).build());
}
/**
*
* Sets a stack policy for a specified stack.
*
*
* @param setStackPolicyRequest
* The input for the SetStackPolicy action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.SetStackPolicy
* @see AWS
* API Documentation
*/
default CompletableFuture setStackPolicy(SetStackPolicyRequest setStackPolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Sets a stack policy for a specified stack.
*
*
*
* This is a convenience which creates an instance of the {@link SetStackPolicyRequest.Builder} avoiding the need to
* create one manually via {@link SetStackPolicyRequest#builder()}
*
*
* @param setStackPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.SetStackPolicyRequest.Builder} to create a
* request. The input for the SetStackPolicy action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.SetStackPolicy
* @see AWS
* API Documentation
*/
default CompletableFuture setStackPolicy(Consumer setStackPolicyRequest) {
return setStackPolicy(SetStackPolicyRequest.builder().applyMutation(setStackPolicyRequest).build());
}
/**
*
* 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.
*
*
*
* @param setTypeConfigurationRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.SetTypeConfiguration
* @see AWS API Documentation
*/
default CompletableFuture setTypeConfiguration(
SetTypeConfigurationRequest setTypeConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link SetTypeConfigurationRequest.Builder} avoiding the
* need to create one manually via {@link SetTypeConfigurationRequest#builder()}
*
*
* @param setTypeConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.SetTypeConfigurationRequest.Builder} to create
* a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.SetTypeConfiguration
* @see AWS API Documentation
*/
default CompletableFuture setTypeConfiguration(
Consumer setTypeConfigurationRequest) {
return setTypeConfiguration(SetTypeConfigurationRequest.builder().applyMutation(setTypeConfigurationRequest).build());
}
/**
*
* Specify the default version of an extension. The default version of an extension will be used in CloudFormation
* operations.
*
*
* @param setTypeDefaultVersionRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.SetTypeDefaultVersion
* @see AWS API Documentation
*/
default CompletableFuture setTypeDefaultVersion(
SetTypeDefaultVersionRequest setTypeDefaultVersionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link SetTypeDefaultVersionRequest.Builder} avoiding the
* need to create one manually via {@link SetTypeDefaultVersionRequest#builder()}
*
*
* @param setTypeDefaultVersionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.SetTypeDefaultVersionRequest.Builder} to
* create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.SetTypeDefaultVersion
* @see AWS API Documentation
*/
default CompletableFuture setTypeDefaultVersion(
Consumer setTypeDefaultVersionRequest) {
return setTypeDefaultVersion(SetTypeDefaultVersionRequest.builder().applyMutation(setTypeDefaultVersionRequest).build());
}
/**
*
* Sends a signal to the specified resource with a success or failure status. You can use the
* SignalResource operation in conjunction with a creation policy or update policy. CloudFormation
* doesn't proceed with a stack creation or update until resources receive the required number of signals or the
* timeout period is exceeded. The SignalResource operation is useful in cases where you want to send
* signals from anywhere other than an Amazon EC2 instance.
*
*
* @param signalResourceRequest
* The input for the SignalResource action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.SignalResource
* @see AWS
* API Documentation
*/
default CompletableFuture signalResource(SignalResourceRequest signalResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Sends a signal to the specified resource with a success or failure status. You can use the
* SignalResource operation in conjunction with a creation policy or update policy. CloudFormation
* doesn't proceed with a stack creation or update until resources receive the required number of signals or the
* timeout period is exceeded. The SignalResource operation is useful in cases where you want to send
* signals from anywhere other than an Amazon EC2 instance.
*
*
*
* This is a convenience which creates an instance of the {@link SignalResourceRequest.Builder} avoiding the need to
* create one manually via {@link SignalResourceRequest#builder()}
*
*
* @param signalResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.SignalResourceRequest.Builder} to create a
* request. The input for the SignalResource action.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudFormationException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudFormationAsyncClient.SignalResource
* @see AWS
* API Documentation
*/
default CompletableFuture signalResource(Consumer signalResourceRequest) {
return signalResource(SignalResourceRequest.builder().applyMutation(signalResourceRequest).build());
}
/**
*
* Starts a scan of the resources in this account in this Region. You can the status of a scan using the
* ListResourceScans API action.
*
*
* @param startResourceScanRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.StartResourceScan
* @see AWS API Documentation
*/
default CompletableFuture startResourceScan(StartResourceScanRequest startResourceScanRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link StartResourceScanRequest.Builder} avoiding the need
* to create one manually via {@link StartResourceScanRequest#builder()}
*
*
* @param startResourceScanRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.StartResourceScanRequest.Builder} to create a
* request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.StartResourceScan
* @see AWS API Documentation
*/
default CompletableFuture startResourceScan(
Consumer startResourceScanRequest) {
return startResourceScan(StartResourceScanRequest.builder().applyMutation(startResourceScanRequest).build());
}
/**
*
* 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.
*
*
* @param stopStackSetOperationRequest
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.StopStackSetOperation
* @see AWS API Documentation
*/
default CompletableFuture stopStackSetOperation(
StopStackSetOperationRequest stopStackSetOperationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link StopStackSetOperationRequest.Builder} avoiding the
* need to create one manually via {@link StopStackSetOperationRequest#builder()}
*
*
* @param stopStackSetOperationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.cloudformation.model.StopStackSetOperationRequest.Builder} to
* create a request.
* @return 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. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample CloudFormationAsyncClient.StopStackSetOperation
* @see AWS API Documentation
*/
default CompletableFuture stopStackSetOperation(
Consumer stopStackSetOperationRequest) {
return stopStackSetOperation(StopStackSetOperationRequest.builder().applyMutation(stopStackSetOperationRequest).build());
}
/**
*