Interface CloudFormationClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.
CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Amazon EC2 Auto Scaling to build highly reliable, highly scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services infrastructure.
With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.
For more information about CloudFormation, see the CloudFormation product page.
CloudFormation makes use of other Amazon Web Services products. If you need additional technical information about a specific Amazon Web Services product, you can find the product's technical documentation at docs.aws.amazon.com.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionactivateOrganizationsAccess(Consumer<ActivateOrganizationsAccessRequest.Builder> activateOrganizationsAccessRequest) Activate trusted access with Organizations.activateOrganizationsAccess(ActivateOrganizationsAccessRequest activateOrganizationsAccessRequest) Activate trusted access with Organizations.default ActivateTypeResponseactivateType(Consumer<ActivateTypeRequest.Builder> activateTypeRequest) Activates a public third-party extension, making it available for use in stack templates.default ActivateTypeResponseactivateType(ActivateTypeRequest activateTypeRequest) Activates a public third-party extension, making it available for use in stack templates.batchDescribeTypeConfigurations(Consumer<BatchDescribeTypeConfigurationsRequest.Builder> batchDescribeTypeConfigurationsRequest) Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region.batchDescribeTypeConfigurations(BatchDescribeTypeConfigurationsRequest batchDescribeTypeConfigurationsRequest) Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region.static CloudFormationClientBuilderbuilder()Create a builder that can be used to configure and create aCloudFormationClient.default CancelUpdateStackResponsecancelUpdateStack(Consumer<CancelUpdateStackRequest.Builder> cancelUpdateStackRequest) Cancels an update on the specified stack.default CancelUpdateStackResponsecancelUpdateStack(CancelUpdateStackRequest cancelUpdateStackRequest) Cancels an update on the specified stack.default ContinueUpdateRollbackResponsecontinueUpdateRollback(Consumer<ContinueUpdateRollbackRequest.Builder> continueUpdateRollbackRequest) For a specified stack that's in theUPDATE_ROLLBACK_FAILEDstate, continues rolling it back to theUPDATE_ROLLBACK_COMPLETEstate.default ContinueUpdateRollbackResponsecontinueUpdateRollback(ContinueUpdateRollbackRequest continueUpdateRollbackRequest) For a specified stack that's in theUPDATE_ROLLBACK_FAILEDstate, continues rolling it back to theUPDATE_ROLLBACK_COMPLETEstate.static CloudFormationClientcreate()Create aCloudFormationClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateChangeSetResponsecreateChangeSet(Consumer<CreateChangeSetRequest.Builder> createChangeSetRequest) Creates a list of changes that will be applied to a stack so that you can review the changes before executing them.default CreateChangeSetResponsecreateChangeSet(CreateChangeSetRequest createChangeSetRequest) Creates a list of changes that will be applied to a stack so that you can review the changes before executing them.default CreateGeneratedTemplateResponsecreateGeneratedTemplate(Consumer<CreateGeneratedTemplateRequest.Builder> createGeneratedTemplateRequest) Creates a template from existing resources that are not already managed with CloudFormation.default CreateGeneratedTemplateResponsecreateGeneratedTemplate(CreateGeneratedTemplateRequest createGeneratedTemplateRequest) Creates a template from existing resources that are not already managed with CloudFormation.default CreateStackResponsecreateStack(Consumer<CreateStackRequest.Builder> createStackRequest) Creates a stack as specified in the template.default CreateStackResponsecreateStack(CreateStackRequest createStackRequest) Creates a stack as specified in the template.default CreateStackInstancesResponsecreateStackInstances(Consumer<CreateStackInstancesRequest.Builder> createStackInstancesRequest) Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions.default CreateStackInstancesResponsecreateStackInstances(CreateStackInstancesRequest createStackInstancesRequest) Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions.default CreateStackSetResponsecreateStackSet(Consumer<CreateStackSetRequest.Builder> createStackSetRequest) Creates a stack set.default CreateStackSetResponsecreateStackSet(CreateStackSetRequest createStackSetRequest) Creates a stack set.deactivateOrganizationsAccess(Consumer<DeactivateOrganizationsAccessRequest.Builder> deactivateOrganizationsAccessRequest) Deactivates trusted access with Organizations.deactivateOrganizationsAccess(DeactivateOrganizationsAccessRequest deactivateOrganizationsAccessRequest) Deactivates trusted access with Organizations.default DeactivateTypeResponsedeactivateType(Consumer<DeactivateTypeRequest.Builder> deactivateTypeRequest) Deactivates a public extension that was previously activated in this account and Region.default DeactivateTypeResponsedeactivateType(DeactivateTypeRequest deactivateTypeRequest) Deactivates a public extension that was previously activated in this account and Region.default DeleteChangeSetResponsedeleteChangeSet(Consumer<DeleteChangeSetRequest.Builder> deleteChangeSetRequest) Deletes the specified change set.default DeleteChangeSetResponsedeleteChangeSet(DeleteChangeSetRequest deleteChangeSetRequest) Deletes the specified change set.default DeleteGeneratedTemplateResponsedeleteGeneratedTemplate(Consumer<DeleteGeneratedTemplateRequest.Builder> deleteGeneratedTemplateRequest) Deleted a generated template.default DeleteGeneratedTemplateResponsedeleteGeneratedTemplate(DeleteGeneratedTemplateRequest deleteGeneratedTemplateRequest) Deleted a generated template.default DeleteStackResponsedeleteStack(Consumer<DeleteStackRequest.Builder> deleteStackRequest) Deletes a specified stack.default DeleteStackResponsedeleteStack(DeleteStackRequest deleteStackRequest) Deletes a specified stack.default DeleteStackInstancesResponsedeleteStackInstances(Consumer<DeleteStackInstancesRequest.Builder> deleteStackInstancesRequest) Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.default DeleteStackInstancesResponsedeleteStackInstances(DeleteStackInstancesRequest deleteStackInstancesRequest) Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.default DeleteStackSetResponsedeleteStackSet(Consumer<DeleteStackSetRequest.Builder> deleteStackSetRequest) Deletes a stack set.default DeleteStackSetResponsedeleteStackSet(DeleteStackSetRequest deleteStackSetRequest) Deletes a stack set.default DeregisterTypeResponsederegisterType(Consumer<DeregisterTypeRequest.Builder> deregisterTypeRequest) Marks an extension or extension version asDEPRECATEDin the CloudFormation registry, removing it from active use.default DeregisterTypeResponsederegisterType(DeregisterTypeRequest deregisterTypeRequest) Marks an extension or extension version asDEPRECATEDin the CloudFormation registry, removing it from active use.default DescribeAccountLimitsResponseRetrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account.default DescribeAccountLimitsResponsedescribeAccountLimits(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest) Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account.default DescribeAccountLimitsResponsedescribeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest) Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account.default DescribeAccountLimitsIterableThis is a variant ofdescribeAccountLimits(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsRequest)operation.default DescribeAccountLimitsIterabledescribeAccountLimitsPaginator(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest) This is a variant ofdescribeAccountLimits(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsRequest)operation.default DescribeAccountLimitsIterabledescribeAccountLimitsPaginator(DescribeAccountLimitsRequest describeAccountLimitsRequest) This is a variant ofdescribeAccountLimits(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsRequest)operation.default DescribeChangeSetResponsedescribeChangeSet(Consumer<DescribeChangeSetRequest.Builder> describeChangeSetRequest) Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set.default DescribeChangeSetResponsedescribeChangeSet(DescribeChangeSetRequest describeChangeSetRequest) Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set.default DescribeChangeSetHooksResponsedescribeChangeSetHooks(Consumer<DescribeChangeSetHooksRequest.Builder> describeChangeSetHooksRequest) Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.default DescribeChangeSetHooksResponsedescribeChangeSetHooks(DescribeChangeSetHooksRequest describeChangeSetHooksRequest) Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.describeGeneratedTemplate(Consumer<DescribeGeneratedTemplateRequest.Builder> describeGeneratedTemplateRequest) Describes a generated template.describeGeneratedTemplate(DescribeGeneratedTemplateRequest describeGeneratedTemplateRequest) Describes a generated template.describeOrganizationsAccess(Consumer<DescribeOrganizationsAccessRequest.Builder> describeOrganizationsAccessRequest) Retrieves information about the account'sOrganizationAccessstatus.describeOrganizationsAccess(DescribeOrganizationsAccessRequest describeOrganizationsAccessRequest) Retrieves information about the account'sOrganizationAccessstatus.default DescribePublisherResponsedescribePublisher(Consumer<DescribePublisherRequest.Builder> describePublisherRequest) Returns information about a CloudFormation extension publisher.default DescribePublisherResponsedescribePublisher(DescribePublisherRequest describePublisherRequest) Returns information about a CloudFormation extension publisher.default DescribeResourceScanResponsedescribeResourceScan(Consumer<DescribeResourceScanRequest.Builder> describeResourceScanRequest) Describes details of a resource scan.default DescribeResourceScanResponsedescribeResourceScan(DescribeResourceScanRequest describeResourceScanRequest) Describes details of a resource scan.describeStackDriftDetectionStatus(Consumer<DescribeStackDriftDetectionStatusRequest.Builder> describeStackDriftDetectionStatusRequest) Returns information about a stack drift detection operation.describeStackDriftDetectionStatus(DescribeStackDriftDetectionStatusRequest describeStackDriftDetectionStatusRequest) Returns information about a stack drift detection operation.default DescribeStackEventsResponsedescribeStackEvents(Consumer<DescribeStackEventsRequest.Builder> describeStackEventsRequest) Returns all stack related events for a specified stack in reverse chronological order.default DescribeStackEventsResponsedescribeStackEvents(DescribeStackEventsRequest describeStackEventsRequest) Returns all stack related events for a specified stack in reverse chronological order.default DescribeStackEventsIterabledescribeStackEventsPaginator(Consumer<DescribeStackEventsRequest.Builder> describeStackEventsRequest) This is a variant ofdescribeStackEvents(software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsRequest)operation.default DescribeStackEventsIterabledescribeStackEventsPaginator(DescribeStackEventsRequest describeStackEventsRequest) This is a variant ofdescribeStackEvents(software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsRequest)operation.default DescribeStackInstanceResponsedescribeStackInstance(Consumer<DescribeStackInstanceRequest.Builder> describeStackInstanceRequest) Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region.default DescribeStackInstanceResponsedescribeStackInstance(DescribeStackInstanceRequest describeStackInstanceRequest) Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region.default DescribeStackResourceResponsedescribeStackResource(Consumer<DescribeStackResourceRequest.Builder> describeStackResourceRequest) Returns a description of the specified resource in the specified stack.default DescribeStackResourceResponsedescribeStackResource(DescribeStackResourceRequest describeStackResourceRequest) Returns a description of the specified resource in the specified stack.describeStackResourceDrifts(Consumer<DescribeStackResourceDriftsRequest.Builder> describeStackResourceDriftsRequest) Returns drift information for the resources that have been checked for drift in the specified stack.describeStackResourceDrifts(DescribeStackResourceDriftsRequest describeStackResourceDriftsRequest) Returns drift information for the resources that have been checked for drift in the specified stack.describeStackResourceDriftsPaginator(Consumer<DescribeStackResourceDriftsRequest.Builder> describeStackResourceDriftsRequest) This is a variant ofdescribeStackResourceDrifts(software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsRequest)operation.describeStackResourceDriftsPaginator(DescribeStackResourceDriftsRequest describeStackResourceDriftsRequest) This is a variant ofdescribeStackResourceDrifts(software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsRequest)operation.default DescribeStackResourcesResponsedescribeStackResources(Consumer<DescribeStackResourcesRequest.Builder> describeStackResourcesRequest) Returns Amazon Web Services resource descriptions for running and deleted stacks.default DescribeStackResourcesResponsedescribeStackResources(DescribeStackResourcesRequest describeStackResourcesRequest) Returns Amazon Web Services resource descriptions for running and deleted stacks.default DescribeStacksResponseReturns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.default DescribeStacksResponsedescribeStacks(Consumer<DescribeStacksRequest.Builder> describeStacksRequest) Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.default DescribeStacksResponsedescribeStacks(DescribeStacksRequest describeStacksRequest) Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.default DescribeStackSetResponsedescribeStackSet(Consumer<DescribeStackSetRequest.Builder> describeStackSetRequest) Returns the description of the specified StackSet.default DescribeStackSetResponsedescribeStackSet(DescribeStackSetRequest describeStackSetRequest) Returns the description of the specified StackSet.describeStackSetOperation(Consumer<DescribeStackSetOperationRequest.Builder> describeStackSetOperationRequest) Returns the description of the specified StackSet operation.describeStackSetOperation(DescribeStackSetOperationRequest describeStackSetOperationRequest) Returns the description of the specified StackSet operation.default DescribeStacksIterableThis is a variant ofdescribeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest)operation.default DescribeStacksIterabledescribeStacksPaginator(Consumer<DescribeStacksRequest.Builder> describeStacksRequest) This is a variant ofdescribeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest)operation.default DescribeStacksIterabledescribeStacksPaginator(DescribeStacksRequest describeStacksRequest) This is a variant ofdescribeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest)operation.default DescribeTypeResponsedescribeType(Consumer<DescribeTypeRequest.Builder> describeTypeRequest) Returns detailed information about an extension that has been registered.default DescribeTypeResponsedescribeType(DescribeTypeRequest describeTypeRequest) Returns detailed information about an extension that has been registered.default DescribeTypeRegistrationResponsedescribeTypeRegistration(Consumer<DescribeTypeRegistrationRequest.Builder> describeTypeRegistrationRequest) Returns information about an extension's registration, including its current status and type and version identifiers.default DescribeTypeRegistrationResponsedescribeTypeRegistration(DescribeTypeRegistrationRequest describeTypeRegistrationRequest) Returns information about an extension's registration, including its current status and type and version identifiers.default DetectStackDriftResponsedetectStackDrift(Consumer<DetectStackDriftRequest.Builder> detectStackDriftRequest) Detects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters.default DetectStackDriftResponsedetectStackDrift(DetectStackDriftRequest detectStackDriftRequest) Detects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters.default DetectStackResourceDriftResponsedetectStackResourceDrift(Consumer<DetectStackResourceDriftRequest.Builder> detectStackResourceDriftRequest) Returns information about whether a resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters.default DetectStackResourceDriftResponsedetectStackResourceDrift(DetectStackResourceDriftRequest detectStackResourceDriftRequest) Returns information about whether a resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters.default DetectStackSetDriftResponsedetectStackSetDrift(Consumer<DetectStackSetDriftRequest.Builder> detectStackSetDriftRequest) Detect drift on a stack set.default DetectStackSetDriftResponsedetectStackSetDrift(DetectStackSetDriftRequest detectStackSetDriftRequest) Detect drift on a stack set.default EstimateTemplateCostResponseestimateTemplateCost(Consumer<EstimateTemplateCostRequest.Builder> estimateTemplateCostRequest) Returns the estimated monthly cost of a template.default EstimateTemplateCostResponseestimateTemplateCost(EstimateTemplateCostRequest estimateTemplateCostRequest) Returns the estimated monthly cost of a template.default ExecuteChangeSetResponseexecuteChangeSet(Consumer<ExecuteChangeSetRequest.Builder> executeChangeSetRequest) Updates a stack using the input information that was provided when the specified change set was created.default ExecuteChangeSetResponseexecuteChangeSet(ExecuteChangeSetRequest executeChangeSetRequest) Updates a stack using the input information that was provided when the specified change set was created.default GetGeneratedTemplateResponsegetGeneratedTemplate(Consumer<GetGeneratedTemplateRequest.Builder> getGeneratedTemplateRequest) Retrieves a generated template.default GetGeneratedTemplateResponsegetGeneratedTemplate(GetGeneratedTemplateRequest getGeneratedTemplateRequest) Retrieves a generated template.default GetStackPolicyResponsegetStackPolicy(Consumer<GetStackPolicyRequest.Builder> getStackPolicyRequest) Returns the stack policy for a specified stack.default GetStackPolicyResponsegetStackPolicy(GetStackPolicyRequest getStackPolicyRequest) Returns the stack policy for a specified stack.default GetTemplateResponsegetTemplate(Consumer<GetTemplateRequest.Builder> getTemplateRequest) Returns the template body for a specified stack.default GetTemplateResponsegetTemplate(GetTemplateRequest getTemplateRequest) Returns the template body for a specified stack.default GetTemplateSummaryResponsegetTemplateSummary(Consumer<GetTemplateSummaryRequest.Builder> getTemplateSummaryRequest) Returns information about a new or existing template.default GetTemplateSummaryResponsegetTemplateSummary(GetTemplateSummaryRequest getTemplateSummaryRequest) Returns information about a new or existing template.default ImportStacksToStackSetResponseimportStacksToStackSet(Consumer<ImportStacksToStackSetRequest.Builder> importStacksToStackSetRequest) Import existing stacks into a new stack sets.default ImportStacksToStackSetResponseimportStacksToStackSet(ImportStacksToStackSetRequest importStacksToStackSetRequest) Import existing stacks into a new stack sets.default ListChangeSetsResponselistChangeSets(Consumer<ListChangeSetsRequest.Builder> listChangeSetsRequest) Returns the ID and status of each active change set for a stack.default ListChangeSetsResponselistChangeSets(ListChangeSetsRequest listChangeSetsRequest) Returns the ID and status of each active change set for a stack.default ListChangeSetsIterablelistChangeSetsPaginator(Consumer<ListChangeSetsRequest.Builder> listChangeSetsRequest) This is a variant oflistChangeSets(software.amazon.awssdk.services.cloudformation.model.ListChangeSetsRequest)operation.default ListChangeSetsIterablelistChangeSetsPaginator(ListChangeSetsRequest listChangeSetsRequest) This is a variant oflistChangeSets(software.amazon.awssdk.services.cloudformation.model.ListChangeSetsRequest)operation.default ListExportsResponseLists all exported output values in the account and Region in which you call this action.default ListExportsResponselistExports(Consumer<ListExportsRequest.Builder> listExportsRequest) Lists all exported output values in the account and Region in which you call this action.default ListExportsResponselistExports(ListExportsRequest listExportsRequest) Lists all exported output values in the account and Region in which you call this action.default ListExportsIterableThis is a variant oflistExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest)operation.default ListExportsIterablelistExportsPaginator(Consumer<ListExportsRequest.Builder> listExportsRequest) This is a variant oflistExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest)operation.default ListExportsIterablelistExportsPaginator(ListExportsRequest listExportsRequest) This is a variant oflistExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest)operation.default ListGeneratedTemplatesResponselistGeneratedTemplates(Consumer<ListGeneratedTemplatesRequest.Builder> listGeneratedTemplatesRequest) Lists your generated templates in this Region.default ListGeneratedTemplatesResponselistGeneratedTemplates(ListGeneratedTemplatesRequest listGeneratedTemplatesRequest) Lists your generated templates in this Region.default ListGeneratedTemplatesIterablelistGeneratedTemplatesPaginator(Consumer<ListGeneratedTemplatesRequest.Builder> listGeneratedTemplatesRequest) This is a variant oflistGeneratedTemplates(software.amazon.awssdk.services.cloudformation.model.ListGeneratedTemplatesRequest)operation.default ListGeneratedTemplatesIterablelistGeneratedTemplatesPaginator(ListGeneratedTemplatesRequest listGeneratedTemplatesRequest) This is a variant oflistGeneratedTemplates(software.amazon.awssdk.services.cloudformation.model.ListGeneratedTemplatesRequest)operation.default ListHookResultsResponselistHookResults(Consumer<ListHookResultsRequest.Builder> listHookResultsRequest) Returns summaries of invoked Hooks when a change set or Cloud Control API operation target is provided.default ListHookResultsResponselistHookResults(ListHookResultsRequest listHookResultsRequest) Returns summaries of invoked Hooks when a change set or Cloud Control API operation target is provided.default ListImportsResponselistImports(Consumer<ListImportsRequest.Builder> listImportsRequest) Lists all stacks that are importing an exported output value.default ListImportsResponselistImports(ListImportsRequest listImportsRequest) Lists all stacks that are importing an exported output value.default ListImportsIterablelistImportsPaginator(Consumer<ListImportsRequest.Builder> listImportsRequest) This is a variant oflistImports(software.amazon.awssdk.services.cloudformation.model.ListImportsRequest)operation.default ListImportsIterablelistImportsPaginator(ListImportsRequest listImportsRequest) This is a variant oflistImports(software.amazon.awssdk.services.cloudformation.model.ListImportsRequest)operation.listResourceScanRelatedResources(Consumer<ListResourceScanRelatedResourcesRequest.Builder> listResourceScanRelatedResourcesRequest) Lists the related resources for a list of resources from a resource scan.listResourceScanRelatedResources(ListResourceScanRelatedResourcesRequest listResourceScanRelatedResourcesRequest) Lists the related resources for a list of resources from a resource scan.listResourceScanRelatedResourcesPaginator(Consumer<ListResourceScanRelatedResourcesRequest.Builder> listResourceScanRelatedResourcesRequest) This is a variant oflistResourceScanRelatedResources(software.amazon.awssdk.services.cloudformation.model.ListResourceScanRelatedResourcesRequest)operation.listResourceScanRelatedResourcesPaginator(ListResourceScanRelatedResourcesRequest listResourceScanRelatedResourcesRequest) This is a variant oflistResourceScanRelatedResources(software.amazon.awssdk.services.cloudformation.model.ListResourceScanRelatedResourcesRequest)operation.listResourceScanResources(Consumer<ListResourceScanResourcesRequest.Builder> listResourceScanResourcesRequest) Lists the resources from a resource scan.listResourceScanResources(ListResourceScanResourcesRequest listResourceScanResourcesRequest) Lists the resources from a resource scan.listResourceScanResourcesPaginator(Consumer<ListResourceScanResourcesRequest.Builder> listResourceScanResourcesRequest) This is a variant oflistResourceScanResources(software.amazon.awssdk.services.cloudformation.model.ListResourceScanResourcesRequest)operation.listResourceScanResourcesPaginator(ListResourceScanResourcesRequest listResourceScanResourcesRequest) This is a variant oflistResourceScanResources(software.amazon.awssdk.services.cloudformation.model.ListResourceScanResourcesRequest)operation.default ListResourceScansResponselistResourceScans(Consumer<ListResourceScansRequest.Builder> listResourceScansRequest) List the resource scans from newest to oldest.default ListResourceScansResponselistResourceScans(ListResourceScansRequest listResourceScansRequest) List the resource scans from newest to oldest.default ListResourceScansIterablelistResourceScansPaginator(Consumer<ListResourceScansRequest.Builder> listResourceScansRequest) This is a variant oflistResourceScans(software.amazon.awssdk.services.cloudformation.model.ListResourceScansRequest)operation.default ListResourceScansIterablelistResourceScansPaginator(ListResourceScansRequest listResourceScansRequest) This is a variant oflistResourceScans(software.amazon.awssdk.services.cloudformation.model.ListResourceScansRequest)operation.listStackInstanceResourceDrifts(Consumer<ListStackInstanceResourceDriftsRequest.Builder> listStackInstanceResourceDriftsRequest) Returns drift information for resources in a stack instance.listStackInstanceResourceDrifts(ListStackInstanceResourceDriftsRequest listStackInstanceResourceDriftsRequest) Returns drift information for resources in a stack instance.default ListStackInstancesResponselistStackInstances(Consumer<ListStackInstancesRequest.Builder> listStackInstancesRequest) Returns summary information about stack instances that are associated with the specified stack set.default ListStackInstancesResponselistStackInstances(ListStackInstancesRequest listStackInstancesRequest) Returns summary information about stack instances that are associated with the specified stack set.default ListStackInstancesIterablelistStackInstancesPaginator(Consumer<ListStackInstancesRequest.Builder> listStackInstancesRequest) This is a variant oflistStackInstances(software.amazon.awssdk.services.cloudformation.model.ListStackInstancesRequest)operation.default ListStackInstancesIterablelistStackInstancesPaginator(ListStackInstancesRequest listStackInstancesRequest) This is a variant oflistStackInstances(software.amazon.awssdk.services.cloudformation.model.ListStackInstancesRequest)operation.default ListStackResourcesResponselistStackResources(Consumer<ListStackResourcesRequest.Builder> listStackResourcesRequest) Returns descriptions of all resources of the specified stack.default ListStackResourcesResponselistStackResources(ListStackResourcesRequest listStackResourcesRequest) Returns descriptions of all resources of the specified stack.default ListStackResourcesIterablelistStackResourcesPaginator(Consumer<ListStackResourcesRequest.Builder> listStackResourcesRequest) This is a variant oflistStackResources(software.amazon.awssdk.services.cloudformation.model.ListStackResourcesRequest)operation.default ListStackResourcesIterablelistStackResourcesPaginator(ListStackResourcesRequest listStackResourcesRequest) This is a variant oflistStackResources(software.amazon.awssdk.services.cloudformation.model.ListStackResourcesRequest)operation.default ListStacksResponseReturns the summary information for stacks whose status matches the specified StackStatusFilter.default ListStacksResponselistStacks(Consumer<ListStacksRequest.Builder> listStacksRequest) Returns the summary information for stacks whose status matches the specified StackStatusFilter.default ListStacksResponselistStacks(ListStacksRequest listStacksRequest) Returns the summary information for stacks whose status matches the specified StackStatusFilter.listStackSetAutoDeploymentTargets(Consumer<ListStackSetAutoDeploymentTargetsRequest.Builder> listStackSetAutoDeploymentTargetsRequest) Returns summary information about deployment targets for a stack set.listStackSetAutoDeploymentTargets(ListStackSetAutoDeploymentTargetsRequest listStackSetAutoDeploymentTargetsRequest) Returns summary information about deployment targets for a stack set.listStackSetOperationResults(Consumer<ListStackSetOperationResultsRequest.Builder> listStackSetOperationResultsRequest) Returns summary information about the results of a stack set operation.listStackSetOperationResults(ListStackSetOperationResultsRequest listStackSetOperationResultsRequest) Returns summary information about the results of a stack set operation.listStackSetOperationResultsPaginator(Consumer<ListStackSetOperationResultsRequest.Builder> listStackSetOperationResultsRequest) This is a variant oflistStackSetOperationResults(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsRequest)operation.listStackSetOperationResultsPaginator(ListStackSetOperationResultsRequest listStackSetOperationResultsRequest) This is a variant oflistStackSetOperationResults(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsRequest)operation.default ListStackSetOperationsResponselistStackSetOperations(Consumer<ListStackSetOperationsRequest.Builder> listStackSetOperationsRequest) Returns summary information about operations performed on a stack set.default ListStackSetOperationsResponselistStackSetOperations(ListStackSetOperationsRequest listStackSetOperationsRequest) Returns summary information about operations performed on a stack set.default ListStackSetOperationsIterablelistStackSetOperationsPaginator(Consumer<ListStackSetOperationsRequest.Builder> listStackSetOperationsRequest) This is a variant oflistStackSetOperations(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsRequest)operation.default ListStackSetOperationsIterablelistStackSetOperationsPaginator(ListStackSetOperationsRequest listStackSetOperationsRequest) This is a variant oflistStackSetOperations(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsRequest)operation.default ListStackSetsResponseReturns summary information about stack sets that are associated with the user.default ListStackSetsResponselistStackSets(Consumer<ListStackSetsRequest.Builder> listStackSetsRequest) Returns summary information about stack sets that are associated with the user.default ListStackSetsResponselistStackSets(ListStackSetsRequest listStackSetsRequest) Returns summary information about stack sets that are associated with the user.default ListStackSetsIterableThis is a variant oflistStackSets(software.amazon.awssdk.services.cloudformation.model.ListStackSetsRequest)operation.default ListStackSetsIterablelistStackSetsPaginator(Consumer<ListStackSetsRequest.Builder> listStackSetsRequest) This is a variant oflistStackSets(software.amazon.awssdk.services.cloudformation.model.ListStackSetsRequest)operation.default ListStackSetsIterablelistStackSetsPaginator(ListStackSetsRequest listStackSetsRequest) This is a variant oflistStackSets(software.amazon.awssdk.services.cloudformation.model.ListStackSetsRequest)operation.default ListStacksIterableThis is a variant oflistStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest)operation.default ListStacksIterablelistStacksPaginator(Consumer<ListStacksRequest.Builder> listStacksRequest) This is a variant oflistStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest)operation.default ListStacksIterablelistStacksPaginator(ListStacksRequest listStacksRequest) This is a variant oflistStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest)operation.default ListTypeRegistrationsResponselistTypeRegistrations(Consumer<ListTypeRegistrationsRequest.Builder> listTypeRegistrationsRequest) Returns a list of registration tokens for the specified extension(s).default ListTypeRegistrationsResponselistTypeRegistrations(ListTypeRegistrationsRequest listTypeRegistrationsRequest) Returns a list of registration tokens for the specified extension(s).default ListTypeRegistrationsIterablelistTypeRegistrationsPaginator(Consumer<ListTypeRegistrationsRequest.Builder> listTypeRegistrationsRequest) This is a variant oflistTypeRegistrations(software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsRequest)operation.default ListTypeRegistrationsIterablelistTypeRegistrationsPaginator(ListTypeRegistrationsRequest listTypeRegistrationsRequest) This is a variant oflistTypeRegistrations(software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsRequest)operation.default ListTypesResponselistTypes(Consumer<ListTypesRequest.Builder> listTypesRequest) Returns summary information about extension that have been registered with CloudFormation.default ListTypesResponselistTypes(ListTypesRequest listTypesRequest) Returns summary information about extension that have been registered with CloudFormation.default ListTypesIterablelistTypesPaginator(Consumer<ListTypesRequest.Builder> listTypesRequest) This is a variant oflistTypes(software.amazon.awssdk.services.cloudformation.model.ListTypesRequest)operation.default ListTypesIterablelistTypesPaginator(ListTypesRequest listTypesRequest) This is a variant oflistTypes(software.amazon.awssdk.services.cloudformation.model.ListTypesRequest)operation.default ListTypeVersionsResponselistTypeVersions(Consumer<ListTypeVersionsRequest.Builder> listTypeVersionsRequest) Returns summary information about the versions of an extension.default ListTypeVersionsResponselistTypeVersions(ListTypeVersionsRequest listTypeVersionsRequest) Returns summary information about the versions of an extension.default ListTypeVersionsIterablelistTypeVersionsPaginator(Consumer<ListTypeVersionsRequest.Builder> listTypeVersionsRequest) This is a variant oflistTypeVersions(software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsRequest)operation.default ListTypeVersionsIterablelistTypeVersionsPaginator(ListTypeVersionsRequest listTypeVersionsRequest) This is a variant oflistTypeVersions(software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsRequest)operation.default PublishTypeResponsepublishType(Consumer<PublishTypeRequest.Builder> publishTypeRequest) Publishes the specified extension to the CloudFormation registry as a public extension in this Region.default PublishTypeResponsepublishType(PublishTypeRequest publishTypeRequest) Publishes the specified extension to the CloudFormation registry as a public extension in this Region.default RecordHandlerProgressResponserecordHandlerProgress(Consumer<RecordHandlerProgressRequest.Builder> recordHandlerProgressRequest) Reports progress of a resource handler to CloudFormation.default RecordHandlerProgressResponserecordHandlerProgress(RecordHandlerProgressRequest recordHandlerProgressRequest) Reports progress of a resource handler to CloudFormation.default RegisterPublisherResponseregisterPublisher(Consumer<RegisterPublisherRequest.Builder> registerPublisherRequest) Registers your account as a publisher of public extensions in the CloudFormation registry.default RegisterPublisherResponseregisterPublisher(RegisterPublisherRequest registerPublisherRequest) Registers your account as a publisher of public extensions in the CloudFormation registry.default RegisterTypeResponseregisterType(Consumer<RegisterTypeRequest.Builder> registerTypeRequest) Registers an extension with the CloudFormation service.default RegisterTypeResponseregisterType(RegisterTypeRequest registerTypeRequest) Registers an extension with the CloudFormation service.default RollbackStackResponserollbackStack(Consumer<RollbackStackRequest.Builder> rollbackStackRequest) When specifyingRollbackStack, you preserve the state of previously provisioned resources when an operation fails.default RollbackStackResponserollbackStack(RollbackStackRequest rollbackStackRequest) When specifyingRollbackStack, you preserve the state of previously provisioned resources when an operation fails.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadatadefault SetStackPolicyResponsesetStackPolicy(Consumer<SetStackPolicyRequest.Builder> setStackPolicyRequest) Sets a stack policy for a specified stack.default SetStackPolicyResponsesetStackPolicy(SetStackPolicyRequest setStackPolicyRequest) Sets a stack policy for a specified stack.default SetTypeConfigurationResponsesetTypeConfiguration(Consumer<SetTypeConfigurationRequest.Builder> setTypeConfigurationRequest) Specifies the configuration data for a registered CloudFormation extension, in the given account and Region.default SetTypeConfigurationResponsesetTypeConfiguration(SetTypeConfigurationRequest setTypeConfigurationRequest) Specifies the configuration data for a registered CloudFormation extension, in the given account and Region.default SetTypeDefaultVersionResponsesetTypeDefaultVersion(Consumer<SetTypeDefaultVersionRequest.Builder> setTypeDefaultVersionRequest) Specify the default version of an extension.default SetTypeDefaultVersionResponsesetTypeDefaultVersion(SetTypeDefaultVersionRequest setTypeDefaultVersionRequest) Specify the default version of an extension.default SignalResourceResponsesignalResource(Consumer<SignalResourceRequest.Builder> signalResourceRequest) Sends a signal to the specified resource with a success or failure status.default SignalResourceResponsesignalResource(SignalResourceRequest signalResourceRequest) Sends a signal to the specified resource with a success or failure status.default StartResourceScanResponsestartResourceScan(Consumer<StartResourceScanRequest.Builder> startResourceScanRequest) Starts a scan of the resources in this account in this Region.default StartResourceScanResponsestartResourceScan(StartResourceScanRequest startResourceScanRequest) Starts a scan of the resources in this account in this Region.default StopStackSetOperationResponsestopStackSetOperation(Consumer<StopStackSetOperationRequest.Builder> stopStackSetOperationRequest) Stops an in-progress operation on a stack set and its associated stack instances.default StopStackSetOperationResponsestopStackSetOperation(StopStackSetOperationRequest stopStackSetOperationRequest) Stops an in-progress operation on a stack set and its associated stack instances.default TestTypeResponsetestType(Consumer<TestTypeRequest.Builder> testTypeRequest) Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.default TestTypeResponsetestType(TestTypeRequest testTypeRequest) Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.default UpdateGeneratedTemplateResponseupdateGeneratedTemplate(Consumer<UpdateGeneratedTemplateRequest.Builder> updateGeneratedTemplateRequest) Updates a generated template.default UpdateGeneratedTemplateResponseupdateGeneratedTemplate(UpdateGeneratedTemplateRequest updateGeneratedTemplateRequest) Updates a generated template.default UpdateStackResponseupdateStack(Consumer<UpdateStackRequest.Builder> updateStackRequest) Updates a stack as specified in the template.default UpdateStackResponseupdateStack(UpdateStackRequest updateStackRequest) Updates a stack as specified in the template.default UpdateStackInstancesResponseupdateStackInstances(Consumer<UpdateStackInstancesRequest.Builder> updateStackInstancesRequest) Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions.default UpdateStackInstancesResponseupdateStackInstances(UpdateStackInstancesRequest updateStackInstancesRequest) Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions.default UpdateStackSetResponseupdateStackSet(Consumer<UpdateStackSetRequest.Builder> updateStackSetRequest) Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.default UpdateStackSetResponseupdateStackSet(UpdateStackSetRequest updateStackSetRequest) Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.updateTerminationProtection(Consumer<UpdateTerminationProtectionRequest.Builder> updateTerminationProtectionRequest) Updates termination protection for the specified stack.updateTerminationProtection(UpdateTerminationProtectionRequest updateTerminationProtectionRequest) Updates termination protection for the specified stack.default ValidateTemplateResponsevalidateTemplate(Consumer<ValidateTemplateRequest.Builder> validateTemplateRequest) Validates a specified template.default ValidateTemplateResponsevalidateTemplate(ValidateTemplateRequest validateTemplateRequest) Validates a specified template.default CloudFormationWaiterwaiter()Create an instance ofCloudFormationWaiterusing this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
activateOrganizationsAccess
default ActivateOrganizationsAccessResponse activateOrganizationsAccess(ActivateOrganizationsAccessRequest activateOrganizationsAccessRequest) throws InvalidOperationException, OperationNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Activate trusted access with Organizations. With trusted access between StackSets and Organizations activated, the management account has permissions to create and manage StackSets for your organization.
- Parameters:
activateOrganizationsAccessRequest-- Returns:
- Result of the ActivateOrganizationsAccess operation returned by the service.
- See Also:
-
activateOrganizationsAccess
default ActivateOrganizationsAccessResponse activateOrganizationsAccess(Consumer<ActivateOrganizationsAccessRequest.Builder> activateOrganizationsAccessRequest) throws InvalidOperationException, OperationNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Activate trusted access with Organizations. With trusted access between StackSets and Organizations activated, the management account has permissions to create and manage StackSets for your organization.
This is a convenience which creates an instance of the
ActivateOrganizationsAccessRequest.Builderavoiding the need to create one manually viaActivateOrganizationsAccessRequest.builder()- Parameters:
activateOrganizationsAccessRequest- AConsumerthat will call methods onActivateOrganizationsAccessRequest.Builderto create a request.- Returns:
- Result of the ActivateOrganizationsAccess operation returned by the service.
- See Also:
-
activateType
default ActivateTypeResponse activateType(ActivateTypeRequest activateTypeRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Activates a public third-party extension, making it available for use in stack templates. 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 Using public extensions in the CloudFormation User Guide.
- Parameters:
activateTypeRequest-- Returns:
- Result of the ActivateType operation returned by the service.
- See Also:
-
activateType
default ActivateTypeResponse activateType(Consumer<ActivateTypeRequest.Builder> activateTypeRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Activates a public third-party extension, making it available for use in stack templates. 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 Using public extensions in the CloudFormation User Guide.
This is a convenience which creates an instance of the
ActivateTypeRequest.Builderavoiding the need to create one manually viaActivateTypeRequest.builder()- Parameters:
activateTypeRequest- AConsumerthat will call methods onActivateTypeRequest.Builderto create a request.- Returns:
- Result of the ActivateType operation returned by the service.
- See Also:
-
batchDescribeTypeConfigurations
default BatchDescribeTypeConfigurationsResponse batchDescribeTypeConfigurations(BatchDescribeTypeConfigurationsRequest batchDescribeTypeConfigurationsRequest) throws TypeConfigurationNotFoundException, CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region.
For more information, see Edit configuration data for extensions in your account in the CloudFormation User Guide.
- Parameters:
batchDescribeTypeConfigurationsRequest-- Returns:
- Result of the BatchDescribeTypeConfigurations operation returned by the service.
- See Also:
-
batchDescribeTypeConfigurations
default BatchDescribeTypeConfigurationsResponse batchDescribeTypeConfigurations(Consumer<BatchDescribeTypeConfigurationsRequest.Builder> batchDescribeTypeConfigurationsRequest) throws TypeConfigurationNotFoundException, CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region.
For more information, see Edit configuration data for extensions in your account in the CloudFormation User Guide.
This is a convenience which creates an instance of the
BatchDescribeTypeConfigurationsRequest.Builderavoiding the need to create one manually viaBatchDescribeTypeConfigurationsRequest.builder()- Parameters:
batchDescribeTypeConfigurationsRequest- AConsumerthat will call methods onBatchDescribeTypeConfigurationsRequest.Builderto create a request.- Returns:
- Result of the BatchDescribeTypeConfigurations operation returned by the service.
- See Also:
-
cancelUpdateStack
default CancelUpdateStackResponse cancelUpdateStack(CancelUpdateStackRequest cancelUpdateStackRequest) throws TokenAlreadyExistsException, AwsServiceException, SdkClientException, CloudFormationException Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.
You can cancel only stacks that are in the
UPDATE_IN_PROGRESSstate.- Parameters:
cancelUpdateStackRequest- The input for the CancelUpdateStack action.- Returns:
- Result of the CancelUpdateStack operation returned by the service.
- See Also:
-
cancelUpdateStack
default CancelUpdateStackResponse cancelUpdateStack(Consumer<CancelUpdateStackRequest.Builder> cancelUpdateStackRequest) throws TokenAlreadyExistsException, AwsServiceException, SdkClientException, CloudFormationException Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.
You can cancel only stacks that are in the
UPDATE_IN_PROGRESSstate.
This is a convenience which creates an instance of the
CancelUpdateStackRequest.Builderavoiding the need to create one manually viaCancelUpdateStackRequest.builder()- Parameters:
cancelUpdateStackRequest- AConsumerthat will call methods onCancelUpdateStackRequest.Builderto create a request. The input for the CancelUpdateStack action.- Returns:
- Result of the CancelUpdateStack operation returned by the service.
- See Also:
-
continueUpdateRollback
default ContinueUpdateRollbackResponse continueUpdateRollback(ContinueUpdateRollbackRequest continueUpdateRollbackRequest) throws TokenAlreadyExistsException, AwsServiceException, SdkClientException, CloudFormationException For a specified stack that's in the
UPDATE_ROLLBACK_FAILEDstate, continues rolling it back to theUPDATE_ROLLBACK_COMPLETEstate. Depending on the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can return your stack to a working state (theUPDATE_ROLLBACK_COMPLETEstate), and then try to update the stack again.A stack goes into the
UPDATE_ROLLBACK_FAILEDstate when CloudFormation can't roll back all changes after a failed stack update. For example, you might have a stack that's rolling back to an old database instance that was deleted outside of CloudFormation. Because CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail.- Parameters:
continueUpdateRollbackRequest- The input for the ContinueUpdateRollback action.- Returns:
- Result of the ContinueUpdateRollback operation returned by the service.
- See Also:
-
continueUpdateRollback
default ContinueUpdateRollbackResponse continueUpdateRollback(Consumer<ContinueUpdateRollbackRequest.Builder> continueUpdateRollbackRequest) throws TokenAlreadyExistsException, AwsServiceException, SdkClientException, CloudFormationException For a specified stack that's in the
UPDATE_ROLLBACK_FAILEDstate, continues rolling it back to theUPDATE_ROLLBACK_COMPLETEstate. Depending on the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can return your stack to a working state (theUPDATE_ROLLBACK_COMPLETEstate), and then try to update the stack again.A stack goes into the
UPDATE_ROLLBACK_FAILEDstate when CloudFormation can't roll back all changes after a failed stack update. For example, you might have a stack that's rolling back to an old database instance that was deleted outside of CloudFormation. Because CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail.
This is a convenience which creates an instance of the
ContinueUpdateRollbackRequest.Builderavoiding the need to create one manually viaContinueUpdateRollbackRequest.builder()- Parameters:
continueUpdateRollbackRequest- AConsumerthat will call methods onContinueUpdateRollbackRequest.Builderto create a request. The input for the ContinueUpdateRollback action.- Returns:
- Result of the ContinueUpdateRollback operation returned by the service.
- See Also:
-
createChangeSet
default CreateChangeSetResponse createChangeSet(CreateChangeSetRequest createChangeSetRequest) throws AlreadyExistsException, InsufficientCapabilitiesException, LimitExceededException, AwsServiceException, SdkClientException, CloudFormationException Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you create a change set for an existing stack, CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack.
To create a change set for a stack that doesn't exist, for the
ChangeSetTypeparameter, specifyCREATE. To create a change set for an existing stack, specifyUPDATEfor theChangeSetTypeparameter. To create a change set for an import operation, specifyIMPORTfor theChangeSetTypeparameter. After theCreateChangeSetcall 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
IncludeNestedStackstoTrue.- Parameters:
createChangeSetRequest- The input for the CreateChangeSet action.- Returns:
- Result of the CreateChangeSet operation returned by the service.
- See Also:
-
createChangeSet
default CreateChangeSetResponse createChangeSet(Consumer<CreateChangeSetRequest.Builder> createChangeSetRequest) throws AlreadyExistsException, InsufficientCapabilitiesException, LimitExceededException, AwsServiceException, SdkClientException, CloudFormationException Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you create a change set for an existing stack, CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack.
To create a change set for a stack that doesn't exist, for the
ChangeSetTypeparameter, specifyCREATE. To create a change set for an existing stack, specifyUPDATEfor theChangeSetTypeparameter. To create a change set for an import operation, specifyIMPORTfor theChangeSetTypeparameter. After theCreateChangeSetcall 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
IncludeNestedStackstoTrue.
This is a convenience which creates an instance of the
CreateChangeSetRequest.Builderavoiding the need to create one manually viaCreateChangeSetRequest.builder()- Parameters:
createChangeSetRequest- AConsumerthat will call methods onCreateChangeSetRequest.Builderto create a request. The input for the CreateChangeSet action.- Returns:
- Result of the CreateChangeSet operation returned by the service.
- See Also:
-
createGeneratedTemplate
default CreateGeneratedTemplateResponse createGeneratedTemplate(CreateGeneratedTemplateRequest createGeneratedTemplateRequest) throws AlreadyExistsException, LimitExceededException, ConcurrentResourcesLimitExceededException, AwsServiceException, SdkClientException, CloudFormationException Creates a template from existing resources that are not already managed with CloudFormation. You can check the status of the template generation using the
DescribeGeneratedTemplateAPI action.- Parameters:
createGeneratedTemplateRequest-- Returns:
- Result of the CreateGeneratedTemplate operation returned by the service.
- See Also:
-
createGeneratedTemplate
default CreateGeneratedTemplateResponse createGeneratedTemplate(Consumer<CreateGeneratedTemplateRequest.Builder> createGeneratedTemplateRequest) throws AlreadyExistsException, LimitExceededException, ConcurrentResourcesLimitExceededException, AwsServiceException, SdkClientException, CloudFormationException Creates a template from existing resources that are not already managed with CloudFormation. You can check the status of the template generation using the
DescribeGeneratedTemplateAPI action.
This is a convenience which creates an instance of the
CreateGeneratedTemplateRequest.Builderavoiding the need to create one manually viaCreateGeneratedTemplateRequest.builder()- Parameters:
createGeneratedTemplateRequest- AConsumerthat will call methods onCreateGeneratedTemplateRequest.Builderto create a request.- Returns:
- Result of the CreateGeneratedTemplate operation returned by the service.
- See Also:
-
createStack
default CreateStackResponse createStack(CreateStackRequest createStackRequest) throws LimitExceededException, AlreadyExistsException, TokenAlreadyExistsException, InsufficientCapabilitiesException, AwsServiceException, SdkClientException, CloudFormationException Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack through the DescribeStacks operation.
For more information about creating a stack and monitoring stack progress, see Managing Amazon Web Services resources as a single unit with CloudFormation stacks in the CloudFormation User Guide.
- Parameters:
createStackRequest- The input for CreateStack action.- Returns:
- Result of the CreateStack operation returned by the service.
- See Also:
-
createStack
default CreateStackResponse createStack(Consumer<CreateStackRequest.Builder> createStackRequest) throws LimitExceededException, AlreadyExistsException, TokenAlreadyExistsException, InsufficientCapabilitiesException, AwsServiceException, SdkClientException, CloudFormationException Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack through the DescribeStacks operation.
For more information about creating a stack and monitoring stack progress, see Managing Amazon Web Services resources as a single unit with CloudFormation stacks in the CloudFormation User Guide.
This is a convenience which creates an instance of the
CreateStackRequest.Builderavoiding the need to create one manually viaCreateStackRequest.builder()- Parameters:
createStackRequest- AConsumerthat will call methods onCreateStackRequest.Builderto create a request. The input for CreateStack action.- Returns:
- Result of the CreateStack operation returned by the service.
- See Also:
-
createStackInstances
default CreateStackInstancesResponse createStackInstances(CreateStackInstancesRequest createStackInstancesRequest) throws StackSetNotFoundException, OperationInProgressException, OperationIdAlreadyExistsException, StaleRequestException, InvalidOperationException, LimitExceededException, AwsServiceException, SdkClientException, CloudFormationException 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
AccountsorDeploymentTargets, and you must specify at least one value forRegions.- Parameters:
createStackInstancesRequest-- Returns:
- Result of the CreateStackInstances operation returned by the service.
- See Also:
-
createStackInstances
default CreateStackInstancesResponse createStackInstances(Consumer<CreateStackInstancesRequest.Builder> createStackInstancesRequest) throws StackSetNotFoundException, OperationInProgressException, OperationIdAlreadyExistsException, StaleRequestException, InvalidOperationException, LimitExceededException, AwsServiceException, SdkClientException, CloudFormationException Creates stack instances for the specified accounts, within the specified 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
AccountsorDeploymentTargets, and you must specify at least one value forRegions.
This is a convenience which creates an instance of the
CreateStackInstancesRequest.Builderavoiding the need to create one manually viaCreateStackInstancesRequest.builder()- Parameters:
createStackInstancesRequest- AConsumerthat will call methods onCreateStackInstancesRequest.Builderto create a request.- Returns:
- Result of the CreateStackInstances operation returned by the service.
- See Also:
-
createStackSet
default CreateStackSetResponse createStackSet(CreateStackSetRequest createStackSetRequest) throws NameAlreadyExistsException, CreatedButModifiedException, LimitExceededException, AwsServiceException, SdkClientException, CloudFormationException Creates a stack set.
- Parameters:
createStackSetRequest-- Returns:
- Result of the CreateStackSet operation returned by the service.
- See Also:
-
createStackSet
default CreateStackSetResponse createStackSet(Consumer<CreateStackSetRequest.Builder> createStackSetRequest) throws NameAlreadyExistsException, CreatedButModifiedException, LimitExceededException, AwsServiceException, SdkClientException, CloudFormationException Creates a stack set.
This is a convenience which creates an instance of the
CreateStackSetRequest.Builderavoiding the need to create one manually viaCreateStackSetRequest.builder()- Parameters:
createStackSetRequest- AConsumerthat will call methods onCreateStackSetRequest.Builderto create a request.- Returns:
- Result of the CreateStackSet operation returned by the service.
- See Also:
-
deactivateOrganizationsAccess
default DeactivateOrganizationsAccessResponse deactivateOrganizationsAccess(DeactivateOrganizationsAccessRequest deactivateOrganizationsAccessRequest) throws InvalidOperationException, OperationNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Deactivates trusted access with Organizations. If trusted access is deactivated, the management account does not have permissions to create and manage service-managed StackSets for your organization.
- Parameters:
deactivateOrganizationsAccessRequest-- Returns:
- Result of the DeactivateOrganizationsAccess operation returned by the service.
- See Also:
-
deactivateOrganizationsAccess
default DeactivateOrganizationsAccessResponse deactivateOrganizationsAccess(Consumer<DeactivateOrganizationsAccessRequest.Builder> deactivateOrganizationsAccessRequest) throws InvalidOperationException, OperationNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Deactivates trusted access with Organizations. If trusted access is deactivated, the management account does not have permissions to create and manage service-managed StackSets for your organization.
This is a convenience which creates an instance of the
DeactivateOrganizationsAccessRequest.Builderavoiding the need to create one manually viaDeactivateOrganizationsAccessRequest.builder()- Parameters:
deactivateOrganizationsAccessRequest- AConsumerthat will call methods onDeactivateOrganizationsAccessRequest.Builderto create a request.- Returns:
- Result of the DeactivateOrganizationsAccess operation returned by the service.
- See Also:
-
deactivateType
default DeactivateTypeResponse deactivateType(DeactivateTypeRequest deactivateTypeRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Deactivates a public extension that was previously activated in this account and Region.
Once deactivated, an extension can't be used in any CloudFormation operation. This includes stack update operations where the stack template includes the extension, even if no updates are being made to the extension. In addition, deactivated extensions aren't automatically updated if a new version of the extension is released.
- Parameters:
deactivateTypeRequest-- Returns:
- Result of the DeactivateType operation returned by the service.
- See Also:
-
deactivateType
default DeactivateTypeResponse deactivateType(Consumer<DeactivateTypeRequest.Builder> deactivateTypeRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Deactivates a public extension that was previously activated in this account and Region.
Once deactivated, an extension can't be used in any CloudFormation operation. This includes stack update operations where the stack template includes the extension, even if no updates are being made to the extension. In addition, deactivated extensions aren't automatically updated if a new version of the extension is released.
This is a convenience which creates an instance of the
DeactivateTypeRequest.Builderavoiding the need to create one manually viaDeactivateTypeRequest.builder()- Parameters:
deactivateTypeRequest- AConsumerthat will call methods onDeactivateTypeRequest.Builderto create a request.- Returns:
- Result of the DeactivateType operation returned by the service.
- See Also:
-
deleteChangeSet
default DeleteChangeSetResponse deleteChangeSet(DeleteChangeSetRequest deleteChangeSetRequest) throws InvalidChangeSetStatusException, AwsServiceException, SdkClientException, CloudFormationException Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.
If the call successfully completes, CloudFormation successfully deleted the change set.
If
IncludeNestedStacksspecifiesTrueduring the creation of the nested change set, thenDeleteChangeSetwill delete all change sets that belong to the stacks hierarchy and will also delete all change sets for nested stacks with the status ofREVIEW_IN_PROGRESS.- Parameters:
deleteChangeSetRequest- The input for the DeleteChangeSet action.- Returns:
- Result of the DeleteChangeSet operation returned by the service.
- See Also:
-
deleteChangeSet
default DeleteChangeSetResponse deleteChangeSet(Consumer<DeleteChangeSetRequest.Builder> deleteChangeSetRequest) throws InvalidChangeSetStatusException, AwsServiceException, SdkClientException, CloudFormationException Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.
If the call successfully completes, CloudFormation successfully deleted the change set.
If
IncludeNestedStacksspecifiesTrueduring the creation of the nested change set, thenDeleteChangeSetwill delete all change sets that belong to the stacks hierarchy and will also delete all change sets for nested stacks with the status ofREVIEW_IN_PROGRESS.
This is a convenience which creates an instance of the
DeleteChangeSetRequest.Builderavoiding the need to create one manually viaDeleteChangeSetRequest.builder()- Parameters:
deleteChangeSetRequest- AConsumerthat will call methods onDeleteChangeSetRequest.Builderto create a request. The input for the DeleteChangeSet action.- Returns:
- Result of the DeleteChangeSet operation returned by the service.
- See Also:
-
deleteGeneratedTemplate
default DeleteGeneratedTemplateResponse deleteGeneratedTemplate(DeleteGeneratedTemplateRequest deleteGeneratedTemplateRequest) throws GeneratedTemplateNotFoundException, ConcurrentResourcesLimitExceededException, AwsServiceException, SdkClientException, CloudFormationException Deleted a generated template.
- Parameters:
deleteGeneratedTemplateRequest-- Returns:
- Result of the DeleteGeneratedTemplate operation returned by the service.
- See Also:
-
deleteGeneratedTemplate
default DeleteGeneratedTemplateResponse deleteGeneratedTemplate(Consumer<DeleteGeneratedTemplateRequest.Builder> deleteGeneratedTemplateRequest) throws GeneratedTemplateNotFoundException, ConcurrentResourcesLimitExceededException, AwsServiceException, SdkClientException, CloudFormationException Deleted a generated template.
This is a convenience which creates an instance of the
DeleteGeneratedTemplateRequest.Builderavoiding the need to create one manually viaDeleteGeneratedTemplateRequest.builder()- Parameters:
deleteGeneratedTemplateRequest- AConsumerthat will call methods onDeleteGeneratedTemplateRequest.Builderto create a request.- Returns:
- Result of the DeleteGeneratedTemplate operation returned by the service.
- See Also:
-
deleteStack
default DeleteStackResponse deleteStack(DeleteStackRequest deleteStackRequest) throws TokenAlreadyExistsException, AwsServiceException, SdkClientException, CloudFormationException 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.
For more information about deleting a stack, see Delete a stack from the CloudFormation console in the CloudFormation User Guide.
- Parameters:
deleteStackRequest- The input for DeleteStack action.- Returns:
- Result of the DeleteStack operation returned by the service.
- See Also:
-
deleteStack
default DeleteStackResponse deleteStack(Consumer<DeleteStackRequest.Builder> deleteStackRequest) throws TokenAlreadyExistsException, AwsServiceException, SdkClientException, CloudFormationException Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't show up in the DescribeStacks operation if the deletion has been completed successfully.
For more information about deleting a stack, see Delete a stack from the CloudFormation console in the CloudFormation User Guide.
This is a convenience which creates an instance of the
DeleteStackRequest.Builderavoiding the need to create one manually viaDeleteStackRequest.builder()- Parameters:
deleteStackRequest- AConsumerthat will call methods onDeleteStackRequest.Builderto create a request. The input for DeleteStack action.- Returns:
- Result of the DeleteStack operation returned by the service.
- See Also:
-
deleteStackInstances
default DeleteStackInstancesResponse deleteStackInstances(DeleteStackInstancesRequest deleteStackInstancesRequest) throws StackSetNotFoundException, OperationInProgressException, OperationIdAlreadyExistsException, StaleRequestException, InvalidOperationException, AwsServiceException, SdkClientException, CloudFormationException Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
- Parameters:
deleteStackInstancesRequest-- Returns:
- Result of the DeleteStackInstances operation returned by the service.
- See Also:
-
deleteStackInstances
default DeleteStackInstancesResponse deleteStackInstances(Consumer<DeleteStackInstancesRequest.Builder> deleteStackInstancesRequest) throws StackSetNotFoundException, OperationInProgressException, OperationIdAlreadyExistsException, StaleRequestException, InvalidOperationException, AwsServiceException, SdkClientException, CloudFormationException Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
This is a convenience which creates an instance of the
DeleteStackInstancesRequest.Builderavoiding the need to create one manually viaDeleteStackInstancesRequest.builder()- Parameters:
deleteStackInstancesRequest- AConsumerthat will call methods onDeleteStackInstancesRequest.Builderto create a request.- Returns:
- Result of the DeleteStackInstances operation returned by the service.
- See Also:
-
deleteStackSet
default DeleteStackSetResponse deleteStackSet(DeleteStackSetRequest deleteStackSetRequest) throws StackSetNotEmptyException, OperationInProgressException, AwsServiceException, SdkClientException, CloudFormationException Deletes a stack set. Before you can delete a stack set, all its member stack instances must be deleted. For more information about how to complete this, see DeleteStackInstances.
- Parameters:
deleteStackSetRequest-- Returns:
- Result of the DeleteStackSet operation returned by the service.
- See Also:
-
deleteStackSet
default DeleteStackSetResponse deleteStackSet(Consumer<DeleteStackSetRequest.Builder> deleteStackSetRequest) throws StackSetNotEmptyException, OperationInProgressException, AwsServiceException, SdkClientException, CloudFormationException Deletes a stack set. Before you can delete a stack set, all its member stack instances must be deleted. For more information about how to complete this, see DeleteStackInstances.
This is a convenience which creates an instance of the
DeleteStackSetRequest.Builderavoiding the need to create one manually viaDeleteStackSetRequest.builder()- Parameters:
deleteStackSetRequest- AConsumerthat will call methods onDeleteStackSetRequest.Builderto create a request.- Returns:
- Result of the DeleteStackSet operation returned by the service.
- See Also:
-
deregisterType
default DeregisterTypeResponse deregisterType(DeregisterTypeRequest deregisterTypeRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Marks an extension or extension version as
DEPRECATEDin the CloudFormation registry, removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations.To deregister an entire extension, you must individually deregister all active versions of that extension. If an extension has only a single active version, deregistering that version results in the extension itself being deregistered and marked as deprecated in the registry.
You can't deregister the default version of an extension if there are other active version of that extension. If you do deregister the default version of an extension, the extension type itself is deregistered as well and marked as deprecated.
To view the deprecation status of an extension or extension version, use DescribeType.
- Parameters:
deregisterTypeRequest-- Returns:
- Result of the DeregisterType operation returned by the service.
- See Also:
-
deregisterType
default DeregisterTypeResponse deregisterType(Consumer<DeregisterTypeRequest.Builder> deregisterTypeRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Marks an extension or extension version as
DEPRECATEDin the CloudFormation registry, removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations.To deregister an entire extension, you must individually deregister all active versions of that extension. If an extension has only a single active version, deregistering that version results in the extension itself being deregistered and marked as deprecated in the registry.
You can't deregister the default version of an extension if there are other active version of that extension. If you do deregister the default version of an extension, the extension type itself is deregistered as well and marked as deprecated.
To view the deprecation status of an extension or extension version, use DescribeType.
This is a convenience which creates an instance of the
DeregisterTypeRequest.Builderavoiding the need to create one manually viaDeregisterTypeRequest.builder()- Parameters:
deregisterTypeRequest- AConsumerthat will call methods onDeregisterTypeRequest.Builderto create a request.- Returns:
- Result of the DeregisterType operation returned by the service.
- See Also:
-
describeAccountLimits
default DescribeAccountLimitsResponse describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest) throws AwsServiceException, SdkClientException, CloudFormationException Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see Understand CloudFormation quotas in the CloudFormation User Guide.
- Parameters:
describeAccountLimitsRequest- The input for the DescribeAccountLimits action.- Returns:
- Result of the DescribeAccountLimits operation returned by the service.
- See Also:
-
describeAccountLimits
default DescribeAccountLimitsResponse describeAccountLimits(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest) throws AwsServiceException, SdkClientException, CloudFormationException Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see Understand CloudFormation quotas in the CloudFormation User Guide.
This is a convenience which creates an instance of the
DescribeAccountLimitsRequest.Builderavoiding the need to create one manually viaDescribeAccountLimitsRequest.builder()- Parameters:
describeAccountLimitsRequest- AConsumerthat will call methods onDescribeAccountLimitsRequest.Builderto create a request. The input for the DescribeAccountLimits action.- Returns:
- Result of the DescribeAccountLimits operation returned by the service.
- See Also:
-
describeAccountLimits
default DescribeAccountLimitsResponse describeAccountLimits() throws AwsServiceException, SdkClientException, CloudFormationExceptionRetrieves 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 Understand CloudFormation quotas in the CloudFormation User Guide.
- Returns:
- Result of the DescribeAccountLimits operation returned by the service.
- See Also:
-
describeAccountLimitsPaginator
default DescribeAccountLimitsIterable describeAccountLimitsPaginator() throws AwsServiceException, SdkClientException, CloudFormationExceptionThis is a variant of
describeAccountLimits(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsIterable responses = client.describeAccountLimitsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsIterable responses = client .describeAccountLimitsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsIterable responses = client.describeAccountLimitsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAccountLimits(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeAccountLimitsPaginator
default DescribeAccountLimitsIterable describeAccountLimitsPaginator(DescribeAccountLimitsRequest describeAccountLimitsRequest) throws AwsServiceException, SdkClientException, CloudFormationException This is a variant of
describeAccountLimits(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsIterable responses = client.describeAccountLimitsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsIterable responses = client .describeAccountLimitsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsIterable responses = client.describeAccountLimitsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAccountLimits(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsRequest)operation.- Parameters:
describeAccountLimitsRequest- The input for the DescribeAccountLimits action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeAccountLimitsPaginator
default DescribeAccountLimitsIterable describeAccountLimitsPaginator(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest) throws AwsServiceException, SdkClientException, CloudFormationException This is a variant of
describeAccountLimits(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsIterable responses = client.describeAccountLimitsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsIterable responses = client .describeAccountLimitsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.DescribeAccountLimitsIterable responses = client.describeAccountLimitsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAccountLimits(software.amazon.awssdk.services.cloudformation.model.DescribeAccountLimitsRequest)operation.
This is a convenience which creates an instance of the
DescribeAccountLimitsRequest.Builderavoiding the need to create one manually viaDescribeAccountLimitsRequest.builder()- Parameters:
describeAccountLimitsRequest- AConsumerthat will call methods onDescribeAccountLimitsRequest.Builderto create a request. The input for the DescribeAccountLimits action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeChangeSet
default DescribeChangeSetResponse describeChangeSet(DescribeChangeSetRequest describeChangeSetRequest) throws ChangeSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see Update CloudFormation stacks using change sets in the CloudFormation User Guide.
- Parameters:
describeChangeSetRequest- The input for the DescribeChangeSet action.- Returns:
- Result of the DescribeChangeSet operation returned by the service.
- See Also:
-
describeChangeSet
default DescribeChangeSetResponse describeChangeSet(Consumer<DescribeChangeSetRequest.Builder> describeChangeSetRequest) throws ChangeSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see Update CloudFormation stacks using change sets in the CloudFormation User Guide.
This is a convenience which creates an instance of the
DescribeChangeSetRequest.Builderavoiding the need to create one manually viaDescribeChangeSetRequest.builder()- Parameters:
describeChangeSetRequest- AConsumerthat will call methods onDescribeChangeSetRequest.Builderto create a request. The input for the DescribeChangeSet action.- Returns:
- Result of the DescribeChangeSet operation returned by the service.
- See Also:
-
describeChangeSetHooks
default DescribeChangeSetHooksResponse describeChangeSetHooks(DescribeChangeSetHooksRequest describeChangeSetHooksRequest) throws ChangeSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.
- Parameters:
describeChangeSetHooksRequest-- Returns:
- Result of the DescribeChangeSetHooks operation returned by the service.
- See Also:
-
describeChangeSetHooks
default DescribeChangeSetHooksResponse describeChangeSetHooks(Consumer<DescribeChangeSetHooksRequest.Builder> describeChangeSetHooksRequest) throws ChangeSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.
This is a convenience which creates an instance of the
DescribeChangeSetHooksRequest.Builderavoiding the need to create one manually viaDescribeChangeSetHooksRequest.builder()- Parameters:
describeChangeSetHooksRequest- AConsumerthat will call methods onDescribeChangeSetHooksRequest.Builderto create a request.- Returns:
- Result of the DescribeChangeSetHooks operation returned by the service.
- See Also:
-
describeGeneratedTemplate
default DescribeGeneratedTemplateResponse describeGeneratedTemplate(DescribeGeneratedTemplateRequest describeGeneratedTemplateRequest) throws GeneratedTemplateNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Describes a generated template. The output includes details about the progress of the creation of a generated template started by a
CreateGeneratedTemplateAPI action or the update of a generated template started with anUpdateGeneratedTemplateAPI action.- Parameters:
describeGeneratedTemplateRequest-- Returns:
- Result of the DescribeGeneratedTemplate operation returned by the service.
- See Also:
-
describeGeneratedTemplate
default DescribeGeneratedTemplateResponse describeGeneratedTemplate(Consumer<DescribeGeneratedTemplateRequest.Builder> describeGeneratedTemplateRequest) throws GeneratedTemplateNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Describes a generated template. The output includes details about the progress of the creation of a generated template started by a
CreateGeneratedTemplateAPI action or the update of a generated template started with anUpdateGeneratedTemplateAPI action.
This is a convenience which creates an instance of the
DescribeGeneratedTemplateRequest.Builderavoiding the need to create one manually viaDescribeGeneratedTemplateRequest.builder()- Parameters:
describeGeneratedTemplateRequest- AConsumerthat will call methods onDescribeGeneratedTemplateRequest.Builderto create a request.- Returns:
- Result of the DescribeGeneratedTemplate operation returned by the service.
- See Also:
-
describeOrganizationsAccess
default DescribeOrganizationsAccessResponse describeOrganizationsAccess(DescribeOrganizationsAccessRequest describeOrganizationsAccessRequest) throws InvalidOperationException, OperationNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Retrieves information about the account's
OrganizationAccessstatus. This API can be called either by the management account or the delegated administrator by using theCallAsparameter. This API can also be called without theCallAsparameter by the management account.- Parameters:
describeOrganizationsAccessRequest-- Returns:
- Result of the DescribeOrganizationsAccess operation returned by the service.
- See Also:
-
describeOrganizationsAccess
default DescribeOrganizationsAccessResponse describeOrganizationsAccess(Consumer<DescribeOrganizationsAccessRequest.Builder> describeOrganizationsAccessRequest) throws InvalidOperationException, OperationNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Retrieves information about the account's
OrganizationAccessstatus. This API can be called either by the management account or the delegated administrator by using theCallAsparameter. This API can also be called without theCallAsparameter by the management account.
This is a convenience which creates an instance of the
DescribeOrganizationsAccessRequest.Builderavoiding the need to create one manually viaDescribeOrganizationsAccessRequest.builder()- Parameters:
describeOrganizationsAccessRequest- AConsumerthat will call methods onDescribeOrganizationsAccessRequest.Builderto create a request.- Returns:
- Result of the DescribeOrganizationsAccess operation returned by the service.
- See Also:
-
describePublisher
default DescribePublisherResponse describePublisher(DescribePublisherRequest describePublisherRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException Returns information about a CloudFormation extension publisher.
If you don't supply a
PublisherId, and you have registered as an extension publisher,DescribePublisherreturns 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 Command Line Interface (CLI) User Guide
- Parameters:
describePublisherRequest-- Returns:
- Result of the DescribePublisher operation returned by the service.
- See Also:
-
describePublisher
default DescribePublisherResponse describePublisher(Consumer<DescribePublisherRequest.Builder> describePublisherRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException Returns information about a CloudFormation extension publisher.
If you don't supply a
PublisherId, and you have registered as an extension publisher,DescribePublisherreturns 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 Command Line Interface (CLI) User Guide
This is a convenience which creates an instance of the
DescribePublisherRequest.Builderavoiding the need to create one manually viaDescribePublisherRequest.builder()- Parameters:
describePublisherRequest- AConsumerthat will call methods onDescribePublisherRequest.Builderto create a request.- Returns:
- Result of the DescribePublisher operation returned by the service.
- See Also:
-
describeResourceScan
default DescribeResourceScanResponse describeResourceScan(DescribeResourceScanRequest describeResourceScanRequest) throws ResourceScanNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Describes details of a resource scan.
- Parameters:
describeResourceScanRequest-- Returns:
- Result of the DescribeResourceScan operation returned by the service.
- See Also:
-
describeResourceScan
default DescribeResourceScanResponse describeResourceScan(Consumer<DescribeResourceScanRequest.Builder> describeResourceScanRequest) throws ResourceScanNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Describes details of a resource scan.
This is a convenience which creates an instance of the
DescribeResourceScanRequest.Builderavoiding the need to create one manually viaDescribeResourceScanRequest.builder()- Parameters:
describeResourceScanRequest- AConsumerthat will call methods onDescribeResourceScanRequest.Builderto create a request.- Returns:
- Result of the DescribeResourceScan operation returned by the service.
- See Also:
-
describeStackDriftDetectionStatus
default DescribeStackDriftDetectionStatusResponse describeStackDriftDetectionStatus(DescribeStackDriftDetectionStatusRequest describeStackDriftDetectionStatusRequest) throws AwsServiceException, SdkClientException, CloudFormationException Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from 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 Detect unmanaged configuration changes to stacks and resources with drift detection.
Use DetectStackDrift to initiate a stack drift detection operation.
DetectStackDriftreturns aStackDriftDetectionIdyou can use to monitor the progress of the operation usingDescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.- Parameters:
describeStackDriftDetectionStatusRequest-- Returns:
- Result of the DescribeStackDriftDetectionStatus operation returned by the service.
- See Also:
-
describeStackDriftDetectionStatus
default DescribeStackDriftDetectionStatusResponse describeStackDriftDetectionStatus(Consumer<DescribeStackDriftDetectionStatusRequest.Builder> describeStackDriftDetectionStatusRequest) throws AwsServiceException, SdkClientException, CloudFormationException Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from 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 Detect unmanaged configuration changes to stacks and resources with drift detection.
Use DetectStackDrift to initiate a stack drift detection operation.
DetectStackDriftreturns aStackDriftDetectionIdyou can use to monitor the progress of the operation usingDescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.
This is a convenience which creates an instance of the
DescribeStackDriftDetectionStatusRequest.Builderavoiding the need to create one manually viaDescribeStackDriftDetectionStatusRequest.builder()- Parameters:
describeStackDriftDetectionStatusRequest- AConsumerthat will call methods onDescribeStackDriftDetectionStatusRequest.Builderto create a request.- Returns:
- Result of the DescribeStackDriftDetectionStatus operation returned by the service.
- See Also:
-
describeStackEvents
default DescribeStackEventsResponse describeStackEvents(DescribeStackEventsRequest describeStackEventsRequest) throws AwsServiceException, SdkClientException, CloudFormationException Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, see Understand CloudFormation stack creation events in the CloudFormation User Guide.
You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).
- Parameters:
describeStackEventsRequest- The input for DescribeStackEvents action.- Returns:
- Result of the DescribeStackEvents operation returned by the service.
- See Also:
-
describeStackEvents
default DescribeStackEventsResponse describeStackEvents(Consumer<DescribeStackEventsRequest.Builder> describeStackEventsRequest) throws AwsServiceException, SdkClientException, CloudFormationException Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, see Understand CloudFormation stack creation events in the CloudFormation User Guide.
You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).
This is a convenience which creates an instance of the
DescribeStackEventsRequest.Builderavoiding the need to create one manually viaDescribeStackEventsRequest.builder()- Parameters:
describeStackEventsRequest- AConsumerthat will call methods onDescribeStackEventsRequest.Builderto create a request. The input for DescribeStackEvents action.- Returns:
- Result of the DescribeStackEvents operation returned by the service.
- See Also:
-
describeStackEventsPaginator
default DescribeStackEventsIterable describeStackEventsPaginator(DescribeStackEventsRequest describeStackEventsRequest) throws AwsServiceException, SdkClientException, CloudFormationException This is a variant of
describeStackEvents(software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.DescribeStackEventsIterable responses = client.describeStackEventsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.DescribeStackEventsIterable responses = client .describeStackEventsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.DescribeStackEventsIterable responses = client.describeStackEventsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeStackEvents(software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsRequest)operation.- Parameters:
describeStackEventsRequest- The input for DescribeStackEvents action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeStackEventsPaginator
default DescribeStackEventsIterable describeStackEventsPaginator(Consumer<DescribeStackEventsRequest.Builder> describeStackEventsRequest) throws AwsServiceException, SdkClientException, CloudFormationException This is a variant of
describeStackEvents(software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.DescribeStackEventsIterable responses = client.describeStackEventsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.DescribeStackEventsIterable responses = client .describeStackEventsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.DescribeStackEventsIterable responses = client.describeStackEventsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeStackEvents(software.amazon.awssdk.services.cloudformation.model.DescribeStackEventsRequest)operation.
This is a convenience which creates an instance of the
DescribeStackEventsRequest.Builderavoiding the need to create one manually viaDescribeStackEventsRequest.builder()- Parameters:
describeStackEventsRequest- AConsumerthat will call methods onDescribeStackEventsRequest.Builderto create a request. The input for DescribeStackEvents action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeStackInstance
default DescribeStackInstanceResponse describeStackInstance(DescribeStackInstanceRequest describeStackInstanceRequest) throws StackSetNotFoundException, StackInstanceNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region.
For a list of stack instances that are associated with a specific StackSet, use ListStackInstances.
- Parameters:
describeStackInstanceRequest-- Returns:
- Result of the DescribeStackInstance operation returned by the service.
- See Also:
-
describeStackInstance
default DescribeStackInstanceResponse describeStackInstance(Consumer<DescribeStackInstanceRequest.Builder> describeStackInstanceRequest) throws StackSetNotFoundException, StackInstanceNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region.
For a list of stack instances that are associated with a specific StackSet, use ListStackInstances.
This is a convenience which creates an instance of the
DescribeStackInstanceRequest.Builderavoiding the need to create one manually viaDescribeStackInstanceRequest.builder()- Parameters:
describeStackInstanceRequest- AConsumerthat will call methods onDescribeStackInstanceRequest.Builderto create a request.- Returns:
- Result of the DescribeStackInstance operation returned by the service.
- See Also:
-
describeStackResource
default DescribeStackResourceResponse describeStackResource(DescribeStackResourceRequest describeStackResourceRequest) throws AwsServiceException, SdkClientException, CloudFormationException Returns a description of the specified resource in the specified stack.
For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.
- Parameters:
describeStackResourceRequest- The input for DescribeStackResource action.- Returns:
- Result of the DescribeStackResource operation returned by the service.
- See Also:
-
describeStackResource
default DescribeStackResourceResponse describeStackResource(Consumer<DescribeStackResourceRequest.Builder> describeStackResourceRequest) throws AwsServiceException, SdkClientException, CloudFormationException Returns a description of the specified resource in the specified stack.
For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.
This is a convenience which creates an instance of the
DescribeStackResourceRequest.Builderavoiding the need to create one manually viaDescribeStackResourceRequest.builder()- Parameters:
describeStackResourceRequest- AConsumerthat will call methods onDescribeStackResourceRequest.Builderto create a request. The input for DescribeStackResource action.- Returns:
- Result of the DescribeStackResource operation returned by the service.
- See Also:
-
describeStackResourceDrifts
default DescribeStackResourceDriftsResponse describeStackResourceDrifts(DescribeStackResourceDriftsRequest describeStackResourceDriftsRequest) throws AwsServiceException, SdkClientException, CloudFormationException Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects configuration drift.
For a given stack, there will be one
StackResourceDriftfor 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 Resource type support for imports and drift detection.Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.
- Parameters:
describeStackResourceDriftsRequest-- Returns:
- Result of the DescribeStackResourceDrifts operation returned by the service.
- See Also:
-
describeStackResourceDrifts
default DescribeStackResourceDriftsResponse describeStackResourceDrifts(Consumer<DescribeStackResourceDriftsRequest.Builder> describeStackResourceDriftsRequest) throws AwsServiceException, SdkClientException, CloudFormationException Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects configuration drift.
For a given stack, there will be one
StackResourceDriftfor 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 Resource type support for imports and drift detection.Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.
This is a convenience which creates an instance of the
DescribeStackResourceDriftsRequest.Builderavoiding the need to create one manually viaDescribeStackResourceDriftsRequest.builder()- Parameters:
describeStackResourceDriftsRequest- AConsumerthat will call methods onDescribeStackResourceDriftsRequest.Builderto create a request.- Returns:
- Result of the DescribeStackResourceDrifts operation returned by the service.
- See Also:
-
describeStackResourceDriftsPaginator
default DescribeStackResourceDriftsIterable describeStackResourceDriftsPaginator(DescribeStackResourceDriftsRequest describeStackResourceDriftsRequest) throws AwsServiceException, SdkClientException, CloudFormationException This is a variant of
describeStackResourceDrifts(software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.DescribeStackResourceDriftsIterable responses = client.describeStackResourceDriftsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.DescribeStackResourceDriftsIterable responses = client .describeStackResourceDriftsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.DescribeStackResourceDriftsIterable responses = client.describeStackResourceDriftsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeStackResourceDrifts(software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsRequest)operation.- Parameters:
describeStackResourceDriftsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeStackResourceDriftsPaginator
default DescribeStackResourceDriftsIterable describeStackResourceDriftsPaginator(Consumer<DescribeStackResourceDriftsRequest.Builder> describeStackResourceDriftsRequest) throws AwsServiceException, SdkClientException, CloudFormationException This is a variant of
describeStackResourceDrifts(software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.DescribeStackResourceDriftsIterable responses = client.describeStackResourceDriftsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.DescribeStackResourceDriftsIterable responses = client .describeStackResourceDriftsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.DescribeStackResourceDriftsIterable responses = client.describeStackResourceDriftsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeStackResourceDrifts(software.amazon.awssdk.services.cloudformation.model.DescribeStackResourceDriftsRequest)operation.
This is a convenience which creates an instance of the
DescribeStackResourceDriftsRequest.Builderavoiding the need to create one manually viaDescribeStackResourceDriftsRequest.builder()- Parameters:
describeStackResourceDriftsRequest- AConsumerthat will call methods onDescribeStackResourceDriftsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeStackResources
default DescribeStackResourcesResponse describeStackResources(DescribeStackResourcesRequest describeStackResourcesRequest) throws AwsServiceException, SdkClientException, CloudFormationException Returns Amazon Web Services resource descriptions for running and deleted stacks. If
StackNameis specified, all the associated resources that are part of the stack are returned. IfPhysicalResourceIdis 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
ListStackResourcesinstead.For deleted stacks,
DescribeStackResourcesreturns resource information for up to 90 days after the stack has been deleted.You must specify either
StackNameorPhysicalResourceId, but not both. In addition, you can specifyLogicalResourceIdto filter the returned result. For more information about resources, theLogicalResourceIdandPhysicalResourceId, see the CloudFormation User Guide.A
ValidationErroris returned if you specify bothStackNameandPhysicalResourceIdin the same request.- Parameters:
describeStackResourcesRequest- The input for DescribeStackResources action.- Returns:
- Result of the DescribeStackResources operation returned by the service.
- See Also:
-
describeStackResources
default DescribeStackResourcesResponse describeStackResources(Consumer<DescribeStackResourcesRequest.Builder> describeStackResourcesRequest) throws AwsServiceException, SdkClientException, CloudFormationException Returns Amazon Web Services resource descriptions for running and deleted stacks. If
StackNameis specified, all the associated resources that are part of the stack are returned. IfPhysicalResourceIdis 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
ListStackResourcesinstead.For deleted stacks,
DescribeStackResourcesreturns resource information for up to 90 days after the stack has been deleted.You must specify either
StackNameorPhysicalResourceId, but not both. In addition, you can specifyLogicalResourceIdto filter the returned result. For more information about resources, theLogicalResourceIdandPhysicalResourceId, see the CloudFormation User Guide.A
ValidationErroris returned if you specify bothStackNameandPhysicalResourceIdin the same request.
This is a convenience which creates an instance of the
DescribeStackResourcesRequest.Builderavoiding the need to create one manually viaDescribeStackResourcesRequest.builder()- Parameters:
describeStackResourcesRequest- AConsumerthat will call methods onDescribeStackResourcesRequest.Builderto create a request. The input for DescribeStackResources action.- Returns:
- Result of the DescribeStackResources operation returned by the service.
- See Also:
-
describeStackSet
default DescribeStackSetResponse describeStackSet(DescribeStackSetRequest describeStackSetRequest) throws StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Returns the description of the specified StackSet.
- Parameters:
describeStackSetRequest-- Returns:
- Result of the DescribeStackSet operation returned by the service.
- See Also:
-
describeStackSet
default DescribeStackSetResponse describeStackSet(Consumer<DescribeStackSetRequest.Builder> describeStackSetRequest) throws StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Returns the description of the specified StackSet.
This is a convenience which creates an instance of the
DescribeStackSetRequest.Builderavoiding the need to create one manually viaDescribeStackSetRequest.builder()- Parameters:
describeStackSetRequest- AConsumerthat will call methods onDescribeStackSetRequest.Builderto create a request.- Returns:
- Result of the DescribeStackSet operation returned by the service.
- See Also:
-
describeStackSetOperation
default DescribeStackSetOperationResponse describeStackSetOperation(DescribeStackSetOperationRequest describeStackSetOperationRequest) throws StackSetNotFoundException, OperationNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Returns the description of the specified StackSet operation.
- Parameters:
describeStackSetOperationRequest-- Returns:
- Result of the DescribeStackSetOperation operation returned by the service.
- See Also:
-
describeStackSetOperation
default DescribeStackSetOperationResponse describeStackSetOperation(Consumer<DescribeStackSetOperationRequest.Builder> describeStackSetOperationRequest) throws StackSetNotFoundException, OperationNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Returns the description of the specified StackSet operation.
This is a convenience which creates an instance of the
DescribeStackSetOperationRequest.Builderavoiding the need to create one manually viaDescribeStackSetOperationRequest.builder()- Parameters:
describeStackSetOperationRequest- AConsumerthat will call methods onDescribeStackSetOperationRequest.Builderto create a request.- Returns:
- Result of the DescribeStackSetOperation operation returned by the service.
- See Also:
-
describeStacks
default DescribeStacksResponse describeStacks(DescribeStacksRequest describeStacksRequest) throws AwsServiceException, SdkClientException, CloudFormationException Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. For more information about a stack's event history, see Understand CloudFormation stack creation events in the CloudFormation User Guide.
If the stack doesn't exist, a
ValidationErroris returned.- Parameters:
describeStacksRequest- The input for DescribeStacks action.- Returns:
- Result of the DescribeStacks operation returned by the service.
- See Also:
-
describeStacks
default DescribeStacksResponse describeStacks(Consumer<DescribeStacksRequest.Builder> describeStacksRequest) throws AwsServiceException, SdkClientException, CloudFormationException Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. For more information about a stack's event history, see Understand CloudFormation stack creation events in the CloudFormation User Guide.
If the stack doesn't exist, a
ValidationErroris returned.
This is a convenience which creates an instance of the
DescribeStacksRequest.Builderavoiding the need to create one manually viaDescribeStacksRequest.builder()- Parameters:
describeStacksRequest- AConsumerthat will call methods onDescribeStacksRequest.Builderto create a request. The input for DescribeStacks action.- Returns:
- Result of the DescribeStacks operation returned by the service.
- See Also:
-
describeStacks
default DescribeStacksResponse describeStacks() throws AwsServiceException, SdkClientException, CloudFormationExceptionReturns 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 Understand CloudFormation stack creation events in the CloudFormation User Guide.
If the stack doesn't exist, a
ValidationErroris returned.- Returns:
- Result of the DescribeStacks operation returned by the service.
- See Also:
-
describeStacksPaginator
default DescribeStacksIterable describeStacksPaginator() throws AwsServiceException, SdkClientException, CloudFormationExceptionThis is a variant of
describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.DescribeStacksIterable responses = client.describeStacksPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksIterable responses = client .describeStacksPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.DescribeStacksResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.DescribeStacksIterable responses = client.describeStacksPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeStacksPaginator
default DescribeStacksIterable describeStacksPaginator(DescribeStacksRequest describeStacksRequest) throws AwsServiceException, SdkClientException, CloudFormationException This is a variant of
describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.DescribeStacksIterable responses = client.describeStacksPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksIterable responses = client .describeStacksPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.DescribeStacksResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.DescribeStacksIterable responses = client.describeStacksPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest)operation.- Parameters:
describeStacksRequest- The input for DescribeStacks action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeStacksPaginator
default DescribeStacksIterable describeStacksPaginator(Consumer<DescribeStacksRequest.Builder> describeStacksRequest) throws AwsServiceException, SdkClientException, CloudFormationException This is a variant of
describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.DescribeStacksIterable responses = client.describeStacksPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.DescribeStacksIterable responses = client .describeStacksPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.DescribeStacksResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.DescribeStacksIterable responses = client.describeStacksPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeStacks(software.amazon.awssdk.services.cloudformation.model.DescribeStacksRequest)operation.
This is a convenience which creates an instance of the
DescribeStacksRequest.Builderavoiding the need to create one manually viaDescribeStacksRequest.builder()- Parameters:
describeStacksRequest- AConsumerthat will call methods onDescribeStacksRequest.Builderto create a request. The input for DescribeStacks action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeType
default DescribeTypeResponse describeType(DescribeTypeRequest describeTypeRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Returns detailed information about an extension that has been registered.
If you specify a
VersionId,DescribeTypereturns information about that specific extension version. Otherwise, it returns information about the default extension version.- Parameters:
describeTypeRequest-- Returns:
- Result of the DescribeType operation returned by the service.
- See Also:
-
describeType
default DescribeTypeResponse describeType(Consumer<DescribeTypeRequest.Builder> describeTypeRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Returns detailed information about an extension that has been registered.
If you specify a
VersionId,DescribeTypereturns information about that specific extension version. Otherwise, it returns information about the default extension version.
This is a convenience which creates an instance of the
DescribeTypeRequest.Builderavoiding the need to create one manually viaDescribeTypeRequest.builder()- Parameters:
describeTypeRequest- AConsumerthat will call methods onDescribeTypeRequest.Builderto create a request.- Returns:
- Result of the DescribeType operation returned by the service.
- See Also:
-
describeTypeRegistration
default DescribeTypeRegistrationResponse describeTypeRegistration(DescribeTypeRegistrationRequest describeTypeRegistrationRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException Returns information about an extension's registration, including its current status and type and version identifiers.
When you initiate a registration request using RegisterType, you can then use DescribeTypeRegistration to monitor the progress of that registration request.
Once the registration request has completed, use DescribeType to return detailed information about an extension.
- Parameters:
describeTypeRegistrationRequest-- Returns:
- Result of the DescribeTypeRegistration operation returned by the service.
- See Also:
-
describeTypeRegistration
default DescribeTypeRegistrationResponse describeTypeRegistration(Consumer<DescribeTypeRegistrationRequest.Builder> describeTypeRegistrationRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException Returns information about an extension's registration, including its current status and type and version identifiers.
When you initiate a registration request using RegisterType, you can then use DescribeTypeRegistration to monitor the progress of that registration request.
Once the registration request has completed, use DescribeType to return detailed information about an extension.
This is a convenience which creates an instance of the
DescribeTypeRegistrationRequest.Builderavoiding the need to create one manually viaDescribeTypeRegistrationRequest.builder()- Parameters:
describeTypeRegistrationRequest- AConsumerthat will call methods onDescribeTypeRegistrationRequest.Builderto create a request.- Returns:
- Result of the DescribeTypeRegistration operation returned by the service.
- See Also:
-
detectStackDrift
default DetectStackDriftResponse detectStackDrift(DetectStackDriftRequest detectStackDriftRequest) throws AwsServiceException, SdkClientException, CloudFormationException 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 Detect unmanaged configuration changes to stacks and resources with drift detection.
Use
DetectStackDriftto 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 Resource type support for imports and drift detection.
DetectStackDriftcan 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
DetectStackDriftdirectly on the nested stack itself.- Parameters:
detectStackDriftRequest-- Returns:
- Result of the DetectStackDrift operation returned by the service.
- See Also:
-
detectStackDrift
default DetectStackDriftResponse detectStackDrift(Consumer<DetectStackDriftRequest.Builder> detectStackDriftRequest) throws AwsServiceException, SdkClientException, CloudFormationException 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 Detect unmanaged configuration changes to stacks and resources with drift detection.
Use
DetectStackDriftto 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 Resource type support for imports and drift detection.
DetectStackDriftcan 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
DetectStackDriftdirectly on the nested stack itself.
This is a convenience which creates an instance of the
DetectStackDriftRequest.Builderavoiding the need to create one manually viaDetectStackDriftRequest.builder()- Parameters:
detectStackDriftRequest- AConsumerthat will call methods onDetectStackDriftRequest.Builderto create a request.- Returns:
- Result of the DetectStackDrift operation returned by the service.
- See Also:
-
detectStackResourceDrift
default DetectStackResourceDriftResponse detectStackResourceDrift(DetectStackResourceDriftRequest detectStackResourceDriftRequest) throws AwsServiceException, SdkClientException, CloudFormationException 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 Detect unmanaged configuration changes to stacks and resources with drift detection.
Use
DetectStackResourceDriftto 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 Resource type support for imports and drift detection.
- Parameters:
detectStackResourceDriftRequest-- Returns:
- Result of the DetectStackResourceDrift operation returned by the service.
- See Also:
-
detectStackResourceDrift
default DetectStackResourceDriftResponse detectStackResourceDrift(Consumer<DetectStackResourceDriftRequest.Builder> detectStackResourceDriftRequest) throws AwsServiceException, SdkClientException, CloudFormationException 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 Detect unmanaged configuration changes to stacks and resources with drift detection.
Use
DetectStackResourceDriftto 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 Resource type support for imports and drift detection.
This is a convenience which creates an instance of the
DetectStackResourceDriftRequest.Builderavoiding the need to create one manually viaDetectStackResourceDriftRequest.builder()- Parameters:
detectStackResourceDriftRequest- AConsumerthat will call methods onDetectStackResourceDriftRequest.Builderto create a request.- Returns:
- Result of the DetectStackResourceDrift operation returned by the service.
- See Also:
-
detectStackSetDrift
default DetectStackSetDriftResponse detectStackSetDrift(DetectStackSetDriftRequest detectStackSetDriftRequest) throws InvalidOperationException, OperationInProgressException, StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation performs drift detection on a stack set.
DetectStackSetDriftreturns theOperationIdof the stack set drift detection operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection operation. The drift detection operation may take some time, depending on the number of stack instances included in the stack set, in addition to the number of resources included in each stack.Once the operation has completed, use the following actions to return drift information:
-
Use DescribeStackSet to return detailed information about the stack set, including detailed information about the last completed drift operation performed on the stack set. (Information about drift operations that are in progress isn't included.)
-
Use ListStackInstances to return a list of stack instances belonging to the stack set, including the drift status and last drift time checked of each instance.
-
Use DescribeStackInstance to return detailed information about a specific stack instance, including its drift status and last drift time checked.
For more information about performing a drift detection operation on a stack set, see Detecting unmanaged changes in stack sets.
You can only run a single drift detection operation on a given stack set at one time.
To stop a drift detection stack set operation, use StopStackSetOperation.
- Parameters:
detectStackSetDriftRequest-- Returns:
- Result of the DetectStackSetDrift operation returned by the service.
- See Also:
-
-
detectStackSetDrift
default DetectStackSetDriftResponse detectStackSetDrift(Consumer<DetectStackSetDriftRequest.Builder> detectStackSetDriftRequest) throws InvalidOperationException, OperationInProgressException, StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation performs drift detection on a stack set.
DetectStackSetDriftreturns theOperationIdof the stack set drift detection operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection operation. The drift detection operation may take some time, depending on the number of stack instances included in the stack set, in addition to the number of resources included in each stack.Once the operation has completed, use the following actions to return drift information:
-
Use DescribeStackSet to return detailed information about the stack set, including detailed information about the last completed drift operation performed on the stack set. (Information about drift operations that are in progress isn't included.)
-
Use ListStackInstances to return a list of stack instances belonging to the stack set, including the drift status and last drift time checked of each instance.
-
Use DescribeStackInstance to return detailed information about a specific stack instance, including its drift status and last drift time checked.
For more information about performing a drift detection operation on a stack set, see Detecting unmanaged changes in stack sets.
You can only run a single drift detection operation on a given stack set at one time.
To stop a drift detection stack set operation, use StopStackSetOperation.
This is a convenience which creates an instance of the
DetectStackSetDriftRequest.Builderavoiding the need to create one manually viaDetectStackSetDriftRequest.builder()- Parameters:
detectStackSetDriftRequest- AConsumerthat will call methods onDetectStackSetDriftRequest.Builderto create a request.- Returns:
- Result of the DetectStackSetDrift operation returned by the service.
- See Also:
-
-
estimateTemplateCost
default EstimateTemplateCostResponse estimateTemplateCost(EstimateTemplateCostRequest estimateTemplateCostRequest) throws AwsServiceException, SdkClientException, CloudFormationException Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
- Parameters:
estimateTemplateCostRequest- The input for an EstimateTemplateCost action.- Returns:
- Result of the EstimateTemplateCost operation returned by the service.
- See Also:
-
estimateTemplateCost
default EstimateTemplateCostResponse estimateTemplateCost(Consumer<EstimateTemplateCostRequest.Builder> estimateTemplateCostRequest) throws AwsServiceException, SdkClientException, CloudFormationException Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
This is a convenience which creates an instance of the
EstimateTemplateCostRequest.Builderavoiding the need to create one manually viaEstimateTemplateCostRequest.builder()- Parameters:
estimateTemplateCostRequest- AConsumerthat will call methods onEstimateTemplateCostRequest.Builderto create a request. The input for an EstimateTemplateCost action.- Returns:
- Result of the EstimateTemplateCost operation returned by the service.
- See Also:
-
executeChangeSet
default ExecuteChangeSetResponse executeChangeSet(ExecuteChangeSetRequest executeChangeSetRequest) throws InvalidChangeSetStatusException, ChangeSetNotFoundException, InsufficientCapabilitiesException, TokenAlreadyExistsException, AwsServiceException, SdkClientException, CloudFormationException Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.
When you execute a change set, CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.
If a stack policy is associated with the stack, CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.
To create a change set for the entire stack hierarchy,
IncludeNestedStacksmust have been set toTrue.- Parameters:
executeChangeSetRequest- The input for the ExecuteChangeSet action.- Returns:
- Result of the ExecuteChangeSet operation returned by the service.
- See Also:
-
executeChangeSet
default ExecuteChangeSetResponse executeChangeSet(Consumer<ExecuteChangeSetRequest.Builder> executeChangeSetRequest) throws InvalidChangeSetStatusException, ChangeSetNotFoundException, InsufficientCapabilitiesException, TokenAlreadyExistsException, AwsServiceException, SdkClientException, CloudFormationException Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.
When you execute a change set, CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.
If a stack policy is associated with the stack, CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.
To create a change set for the entire stack hierarchy,
IncludeNestedStacksmust have been set toTrue.
This is a convenience which creates an instance of the
ExecuteChangeSetRequest.Builderavoiding the need to create one manually viaExecuteChangeSetRequest.builder()- Parameters:
executeChangeSetRequest- AConsumerthat will call methods onExecuteChangeSetRequest.Builderto create a request. The input for the ExecuteChangeSet action.- Returns:
- Result of the ExecuteChangeSet operation returned by the service.
- See Also:
-
getGeneratedTemplate
default GetGeneratedTemplateResponse getGeneratedTemplate(GetGeneratedTemplateRequest getGeneratedTemplateRequest) throws GeneratedTemplateNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Retrieves a generated template. If the template is in an
InProgressorPendingstatus then the template returned will be the template when the template was last in aCompletestatus. If the template has not yet been in aCompletestatus then an empty template will be returned.- Parameters:
getGeneratedTemplateRequest-- Returns:
- Result of the GetGeneratedTemplate operation returned by the service.
- See Also:
-
getGeneratedTemplate
default GetGeneratedTemplateResponse getGeneratedTemplate(Consumer<GetGeneratedTemplateRequest.Builder> getGeneratedTemplateRequest) throws GeneratedTemplateNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Retrieves a generated template. If the template is in an
InProgressorPendingstatus then the template returned will be the template when the template was last in aCompletestatus. If the template has not yet been in aCompletestatus then an empty template will be returned.
This is a convenience which creates an instance of the
GetGeneratedTemplateRequest.Builderavoiding the need to create one manually viaGetGeneratedTemplateRequest.builder()- Parameters:
getGeneratedTemplateRequest- AConsumerthat will call methods onGetGeneratedTemplateRequest.Builderto create a request.- Returns:
- Result of the GetGeneratedTemplate operation returned by the service.
- See Also:
-
getStackPolicy
default GetStackPolicyResponse getStackPolicy(GetStackPolicyRequest getStackPolicyRequest) throws AwsServiceException, SdkClientException, CloudFormationException Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
- Parameters:
getStackPolicyRequest- The input for the GetStackPolicy action.- Returns:
- Result of the GetStackPolicy operation returned by the service.
- See Also:
-
getStackPolicy
default GetStackPolicyResponse getStackPolicy(Consumer<GetStackPolicyRequest.Builder> getStackPolicyRequest) throws AwsServiceException, SdkClientException, CloudFormationException Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
This is a convenience which creates an instance of the
GetStackPolicyRequest.Builderavoiding the need to create one manually viaGetStackPolicyRequest.builder()- Parameters:
getStackPolicyRequest- AConsumerthat will call methods onGetStackPolicyRequest.Builderto create a request. The input for the GetStackPolicy action.- Returns:
- Result of the GetStackPolicy operation returned by the service.
- See Also:
-
getTemplate
default GetTemplateResponse getTemplate(GetTemplateRequest getTemplateRequest) throws ChangeSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Returns the template body for a specified stack. You can get the template for running or deleted stacks.
For deleted stacks,
GetTemplatereturns the template for up to 90 days after the stack has been deleted.If the template doesn't exist, a
ValidationErroris returned.- Parameters:
getTemplateRequest- The input for a GetTemplate action.- Returns:
- Result of the GetTemplate operation returned by the service.
- See Also:
-
getTemplate
default GetTemplateResponse getTemplate(Consumer<GetTemplateRequest.Builder> getTemplateRequest) throws ChangeSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Returns the template body for a specified stack. You can get the template for running or deleted stacks.
For deleted stacks,
GetTemplatereturns the template for up to 90 days after the stack has been deleted.If the template doesn't exist, a
ValidationErroris returned.
This is a convenience which creates an instance of the
GetTemplateRequest.Builderavoiding the need to create one manually viaGetTemplateRequest.builder()- Parameters:
getTemplateRequest- AConsumerthat will call methods onGetTemplateRequest.Builderto create a request. The input for a GetTemplate action.- Returns:
- Result of the GetTemplate operation returned by the service.
- See Also:
-
getTemplateSummary
default GetTemplateSummaryResponse getTemplateSummary(GetTemplateSummaryRequest getTemplateSummaryRequest) throws StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Returns information about a new or existing template. The
GetTemplateSummaryaction 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
GetTemplateSummaryaction when you submit a template, or you can get template information for a stack set, or a running or deleted stack.For deleted stacks,
GetTemplateSummaryreturns the template information for up to 90 days after the stack has been deleted. If the template doesn't exist, aValidationErroris returned.- Parameters:
getTemplateSummaryRequest- The input for the GetTemplateSummary action.- Returns:
- Result of the GetTemplateSummary operation returned by the service.
- See Also:
-
getTemplateSummary
default GetTemplateSummaryResponse getTemplateSummary(Consumer<GetTemplateSummaryRequest.Builder> getTemplateSummaryRequest) throws StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Returns information about a new or existing template. The
GetTemplateSummaryaction 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
GetTemplateSummaryaction when you submit a template, or you can get template information for a stack set, or a running or deleted stack.For deleted stacks,
GetTemplateSummaryreturns the template information for up to 90 days after the stack has been deleted. If the template doesn't exist, aValidationErroris returned.
This is a convenience which creates an instance of the
GetTemplateSummaryRequest.Builderavoiding the need to create one manually viaGetTemplateSummaryRequest.builder()- Parameters:
getTemplateSummaryRequest- AConsumerthat will call methods onGetTemplateSummaryRequest.Builderto create a request. The input for the GetTemplateSummary action.- Returns:
- Result of the GetTemplateSummary operation returned by the service.
- See Also:
-
importStacksToStackSet
default ImportStacksToStackSetResponse importStacksToStackSet(ImportStacksToStackSetRequest importStacksToStackSetRequest) throws LimitExceededException, StackSetNotFoundException, InvalidOperationException, OperationInProgressException, OperationIdAlreadyExistsException, StackNotFoundException, StaleRequestException, AwsServiceException, SdkClientException, CloudFormationException Import existing stacks into a new stack sets. Use the stack import operation to import up to 10 stacks into a new stack set in the same account as the source stack or in a different administrator account and Region, by specifying the stack ID of the stack you intend to import.
- Parameters:
importStacksToStackSetRequest-- Returns:
- Result of the ImportStacksToStackSet operation returned by the service.
- See Also:
-
importStacksToStackSet
default ImportStacksToStackSetResponse importStacksToStackSet(Consumer<ImportStacksToStackSetRequest.Builder> importStacksToStackSetRequest) throws LimitExceededException, StackSetNotFoundException, InvalidOperationException, OperationInProgressException, OperationIdAlreadyExistsException, StackNotFoundException, StaleRequestException, AwsServiceException, SdkClientException, CloudFormationException Import existing stacks into a new stack sets. Use the stack import operation to import up to 10 stacks into a new stack set in the same account as the source stack or in a different administrator account and Region, by specifying the stack ID of the stack you intend to import.
This is a convenience which creates an instance of the
ImportStacksToStackSetRequest.Builderavoiding the need to create one manually viaImportStacksToStackSetRequest.builder()- Parameters:
importStacksToStackSetRequest- AConsumerthat will call methods onImportStacksToStackSetRequest.Builderto create a request.- Returns:
- Result of the ImportStacksToStackSet operation returned by the service.
- See Also:
-
listChangeSets
default ListChangeSetsResponse listChangeSets(ListChangeSetsRequest listChangeSetsRequest) throws AwsServiceException, SdkClientException, CloudFormationException Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets that are in the
CREATE_IN_PROGRESSorCREATE_PENDINGstate.- Parameters:
listChangeSetsRequest- The input for the ListChangeSets action.- Returns:
- Result of the ListChangeSets operation returned by the service.
- See Also:
-
listChangeSets
default ListChangeSetsResponse listChangeSets(Consumer<ListChangeSetsRequest.Builder> listChangeSetsRequest) throws AwsServiceException, SdkClientException, CloudFormationException Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets that are in the
CREATE_IN_PROGRESSorCREATE_PENDINGstate.
This is a convenience which creates an instance of the
ListChangeSetsRequest.Builderavoiding the need to create one manually viaListChangeSetsRequest.builder()- Parameters:
listChangeSetsRequest- AConsumerthat will call methods onListChangeSetsRequest.Builderto create a request. The input for the ListChangeSets action.- Returns:
- Result of the ListChangeSets operation returned by the service.
- See Also:
-
listChangeSetsPaginator
default ListChangeSetsIterable listChangeSetsPaginator(ListChangeSetsRequest listChangeSetsRequest) throws AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listChangeSets(software.amazon.awssdk.services.cloudformation.model.ListChangeSetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListChangeSetsIterable responses = client.listChangeSetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListChangeSetsIterable responses = client .listChangeSetsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListChangeSetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListChangeSetsIterable responses = client.listChangeSetsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChangeSets(software.amazon.awssdk.services.cloudformation.model.ListChangeSetsRequest)operation.- Parameters:
listChangeSetsRequest- The input for the ListChangeSets action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listChangeSetsPaginator
default ListChangeSetsIterable listChangeSetsPaginator(Consumer<ListChangeSetsRequest.Builder> listChangeSetsRequest) throws AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listChangeSets(software.amazon.awssdk.services.cloudformation.model.ListChangeSetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListChangeSetsIterable responses = client.listChangeSetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListChangeSetsIterable responses = client .listChangeSetsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListChangeSetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListChangeSetsIterable responses = client.listChangeSetsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChangeSets(software.amazon.awssdk.services.cloudformation.model.ListChangeSetsRequest)operation.
This is a convenience which creates an instance of the
ListChangeSetsRequest.Builderavoiding the need to create one manually viaListChangeSetsRequest.builder()- Parameters:
listChangeSetsRequest- AConsumerthat will call methods onListChangeSetsRequest.Builderto create a request. The input for the ListChangeSets action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listExports
default ListExportsResponse listExports(ListExportsRequest listExportsRequest) throws AwsServiceException, SdkClientException, CloudFormationException Lists all exported output values in the account and Region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the Fn::ImportValue function.
For more information, see Get exported outputs from a deployed CloudFormation stack.
- Parameters:
listExportsRequest-- Returns:
- Result of the ListExports operation returned by the service.
- See Also:
-
listExports
default ListExportsResponse listExports(Consumer<ListExportsRequest.Builder> listExportsRequest) throws AwsServiceException, SdkClientException, CloudFormationException Lists all exported output values in the account and Region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the Fn::ImportValue function.
For more information, see Get exported outputs from a deployed CloudFormation stack.
This is a convenience which creates an instance of the
ListExportsRequest.Builderavoiding the need to create one manually viaListExportsRequest.builder()- Parameters:
listExportsRequest- AConsumerthat will call methods onListExportsRequest.Builderto create a request.- Returns:
- Result of the ListExports operation returned by the service.
- See Also:
-
listExports
default ListExportsResponse listExports() throws AwsServiceException, SdkClientException, CloudFormationExceptionLists 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 Get exported outputs from a deployed CloudFormation stack.
- Returns:
- Result of the ListExports operation returned by the service.
- See Also:
-
listExportsPaginator
default ListExportsIterable listExportsPaginator() throws AwsServiceException, SdkClientException, CloudFormationExceptionThis is a variant of
listExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListExportsIterable responses = client.listExportsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListExportsIterable responses = client .listExportsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListExportsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListExportsIterable responses = client.listExportsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listExportsPaginator
default ListExportsIterable listExportsPaginator(ListExportsRequest listExportsRequest) throws AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListExportsIterable responses = client.listExportsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListExportsIterable responses = client .listExportsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListExportsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListExportsIterable responses = client.listExportsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest)operation.- Parameters:
listExportsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listExportsPaginator
default ListExportsIterable listExportsPaginator(Consumer<ListExportsRequest.Builder> listExportsRequest) throws AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListExportsIterable responses = client.listExportsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListExportsIterable responses = client .listExportsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListExportsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListExportsIterable responses = client.listExportsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExports(software.amazon.awssdk.services.cloudformation.model.ListExportsRequest)operation.
This is a convenience which creates an instance of the
ListExportsRequest.Builderavoiding the need to create one manually viaListExportsRequest.builder()- Parameters:
listExportsRequest- AConsumerthat will call methods onListExportsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listGeneratedTemplates
default ListGeneratedTemplatesResponse listGeneratedTemplates(ListGeneratedTemplatesRequest listGeneratedTemplatesRequest) throws AwsServiceException, SdkClientException, CloudFormationException Lists your generated templates in this Region.
- Parameters:
listGeneratedTemplatesRequest-- Returns:
- Result of the ListGeneratedTemplates operation returned by the service.
- See Also:
-
listGeneratedTemplates
default ListGeneratedTemplatesResponse listGeneratedTemplates(Consumer<ListGeneratedTemplatesRequest.Builder> listGeneratedTemplatesRequest) throws AwsServiceException, SdkClientException, CloudFormationException Lists your generated templates in this Region.
This is a convenience which creates an instance of the
ListGeneratedTemplatesRequest.Builderavoiding the need to create one manually viaListGeneratedTemplatesRequest.builder()- Parameters:
listGeneratedTemplatesRequest- AConsumerthat will call methods onListGeneratedTemplatesRequest.Builderto create a request.- Returns:
- Result of the ListGeneratedTemplates operation returned by the service.
- See Also:
-
listGeneratedTemplatesPaginator
default ListGeneratedTemplatesIterable listGeneratedTemplatesPaginator(ListGeneratedTemplatesRequest listGeneratedTemplatesRequest) throws AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listGeneratedTemplates(software.amazon.awssdk.services.cloudformation.model.ListGeneratedTemplatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListGeneratedTemplatesIterable responses = client.listGeneratedTemplatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListGeneratedTemplatesIterable responses = client .listGeneratedTemplatesPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListGeneratedTemplatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListGeneratedTemplatesIterable responses = client.listGeneratedTemplatesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGeneratedTemplates(software.amazon.awssdk.services.cloudformation.model.ListGeneratedTemplatesRequest)operation.- Parameters:
listGeneratedTemplatesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listGeneratedTemplatesPaginator
default ListGeneratedTemplatesIterable listGeneratedTemplatesPaginator(Consumer<ListGeneratedTemplatesRequest.Builder> listGeneratedTemplatesRequest) throws AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listGeneratedTemplates(software.amazon.awssdk.services.cloudformation.model.ListGeneratedTemplatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListGeneratedTemplatesIterable responses = client.listGeneratedTemplatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListGeneratedTemplatesIterable responses = client .listGeneratedTemplatesPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListGeneratedTemplatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListGeneratedTemplatesIterable responses = client.listGeneratedTemplatesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGeneratedTemplates(software.amazon.awssdk.services.cloudformation.model.ListGeneratedTemplatesRequest)operation.
This is a convenience which creates an instance of the
ListGeneratedTemplatesRequest.Builderavoiding the need to create one manually viaListGeneratedTemplatesRequest.builder()- Parameters:
listGeneratedTemplatesRequest- AConsumerthat will call methods onListGeneratedTemplatesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listHookResults
default ListHookResultsResponse listHookResults(ListHookResultsRequest listHookResultsRequest) throws HookResultNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Returns summaries of invoked Hooks when a change set or Cloud Control API operation target is provided.
- Parameters:
listHookResultsRequest-- Returns:
- Result of the ListHookResults operation returned by the service.
- See Also:
-
listHookResults
default ListHookResultsResponse listHookResults(Consumer<ListHookResultsRequest.Builder> listHookResultsRequest) throws HookResultNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Returns summaries of invoked Hooks when a change set or Cloud Control API operation target is provided.
This is a convenience which creates an instance of the
ListHookResultsRequest.Builderavoiding the need to create one manually viaListHookResultsRequest.builder()- Parameters:
listHookResultsRequest- AConsumerthat will call methods onListHookResultsRequest.Builderto create a request.- Returns:
- Result of the ListHookResults operation returned by the service.
- See Also:
-
listImports
default ListImportsResponse listImports(ListImportsRequest listImportsRequest) throws AwsServiceException, SdkClientException, CloudFormationException Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports.
For more information about importing an exported output value, see the Fn::ImportValue function.
- Parameters:
listImportsRequest-- Returns:
- Result of the ListImports operation returned by the service.
- See Also:
-
listImports
default ListImportsResponse listImports(Consumer<ListImportsRequest.Builder> listImportsRequest) throws AwsServiceException, SdkClientException, CloudFormationException Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports.
For more information about importing an exported output value, see the Fn::ImportValue function.
This is a convenience which creates an instance of the
ListImportsRequest.Builderavoiding the need to create one manually viaListImportsRequest.builder()- Parameters:
listImportsRequest- AConsumerthat will call methods onListImportsRequest.Builderto create a request.- Returns:
- Result of the ListImports operation returned by the service.
- See Also:
-
listImportsPaginator
default ListImportsIterable listImportsPaginator(ListImportsRequest listImportsRequest) throws AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listImports(software.amazon.awssdk.services.cloudformation.model.ListImportsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListImportsIterable responses = client.listImportsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListImportsIterable responses = client .listImportsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListImportsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListImportsIterable responses = client.listImportsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImports(software.amazon.awssdk.services.cloudformation.model.ListImportsRequest)operation.- Parameters:
listImportsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listImportsPaginator
default ListImportsIterable listImportsPaginator(Consumer<ListImportsRequest.Builder> listImportsRequest) throws AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listImports(software.amazon.awssdk.services.cloudformation.model.ListImportsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListImportsIterable responses = client.listImportsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListImportsIterable responses = client .listImportsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListImportsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListImportsIterable responses = client.listImportsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImports(software.amazon.awssdk.services.cloudformation.model.ListImportsRequest)operation.
This is a convenience which creates an instance of the
ListImportsRequest.Builderavoiding the need to create one manually viaListImportsRequest.builder()- Parameters:
listImportsRequest- AConsumerthat will call methods onListImportsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listResourceScanRelatedResources
default ListResourceScanRelatedResourcesResponse listResourceScanRelatedResources(ListResourceScanRelatedResourcesRequest listResourceScanRelatedResourcesRequest) throws ResourceScanNotFoundException, ResourceScanInProgressException, AwsServiceException, SdkClientException, CloudFormationException Lists the related resources for a list of resources from a resource scan. The response indicates whether each returned resource is already managed by CloudFormation.
- Parameters:
listResourceScanRelatedResourcesRequest-- Returns:
- Result of the ListResourceScanRelatedResources operation returned by the service.
- See Also:
-
listResourceScanRelatedResources
default ListResourceScanRelatedResourcesResponse listResourceScanRelatedResources(Consumer<ListResourceScanRelatedResourcesRequest.Builder> listResourceScanRelatedResourcesRequest) throws ResourceScanNotFoundException, ResourceScanInProgressException, AwsServiceException, SdkClientException, CloudFormationException Lists the related resources for a list of resources from a resource scan. The response indicates whether each returned resource is already managed by CloudFormation.
This is a convenience which creates an instance of the
ListResourceScanRelatedResourcesRequest.Builderavoiding the need to create one manually viaListResourceScanRelatedResourcesRequest.builder()- Parameters:
listResourceScanRelatedResourcesRequest- AConsumerthat will call methods onListResourceScanRelatedResourcesRequest.Builderto create a request.- Returns:
- Result of the ListResourceScanRelatedResources operation returned by the service.
- See Also:
-
listResourceScanRelatedResourcesPaginator
default ListResourceScanRelatedResourcesIterable listResourceScanRelatedResourcesPaginator(ListResourceScanRelatedResourcesRequest listResourceScanRelatedResourcesRequest) throws ResourceScanNotFoundException, ResourceScanInProgressException, AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listResourceScanRelatedResources(software.amazon.awssdk.services.cloudformation.model.ListResourceScanRelatedResourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListResourceScanRelatedResourcesIterable responses = client.listResourceScanRelatedResourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListResourceScanRelatedResourcesIterable responses = client .listResourceScanRelatedResourcesPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListResourceScanRelatedResourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListResourceScanRelatedResourcesIterable responses = client.listResourceScanRelatedResourcesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceScanRelatedResources(software.amazon.awssdk.services.cloudformation.model.ListResourceScanRelatedResourcesRequest)operation.- Parameters:
listResourceScanRelatedResourcesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listResourceScanRelatedResourcesPaginator
default ListResourceScanRelatedResourcesIterable listResourceScanRelatedResourcesPaginator(Consumer<ListResourceScanRelatedResourcesRequest.Builder> listResourceScanRelatedResourcesRequest) throws ResourceScanNotFoundException, ResourceScanInProgressException, AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listResourceScanRelatedResources(software.amazon.awssdk.services.cloudformation.model.ListResourceScanRelatedResourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListResourceScanRelatedResourcesIterable responses = client.listResourceScanRelatedResourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListResourceScanRelatedResourcesIterable responses = client .listResourceScanRelatedResourcesPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListResourceScanRelatedResourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListResourceScanRelatedResourcesIterable responses = client.listResourceScanRelatedResourcesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceScanRelatedResources(software.amazon.awssdk.services.cloudformation.model.ListResourceScanRelatedResourcesRequest)operation.
This is a convenience which creates an instance of the
ListResourceScanRelatedResourcesRequest.Builderavoiding the need to create one manually viaListResourceScanRelatedResourcesRequest.builder()- Parameters:
listResourceScanRelatedResourcesRequest- AConsumerthat will call methods onListResourceScanRelatedResourcesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listResourceScanResources
default ListResourceScanResourcesResponse listResourceScanResources(ListResourceScanResourcesRequest listResourceScanResourcesRequest) throws ResourceScanNotFoundException, ResourceScanInProgressException, AwsServiceException, SdkClientException, CloudFormationException Lists the resources from a resource scan. The results can be filtered by resource identifier, resource type prefix, tag key, and tag value. Only resources that match all specified filters are returned. The response indicates whether each returned resource is already managed by CloudFormation.
- Parameters:
listResourceScanResourcesRequest-- Returns:
- Result of the ListResourceScanResources operation returned by the service.
- See Also:
-
listResourceScanResources
default ListResourceScanResourcesResponse listResourceScanResources(Consumer<ListResourceScanResourcesRequest.Builder> listResourceScanResourcesRequest) throws ResourceScanNotFoundException, ResourceScanInProgressException, AwsServiceException, SdkClientException, CloudFormationException Lists the resources from a resource scan. The results can be filtered by resource identifier, resource type prefix, tag key, and tag value. Only resources that match all specified filters are returned. The response indicates whether each returned resource is already managed by CloudFormation.
This is a convenience which creates an instance of the
ListResourceScanResourcesRequest.Builderavoiding the need to create one manually viaListResourceScanResourcesRequest.builder()- Parameters:
listResourceScanResourcesRequest- AConsumerthat will call methods onListResourceScanResourcesRequest.Builderto create a request.- Returns:
- Result of the ListResourceScanResources operation returned by the service.
- See Also:
-
listResourceScanResourcesPaginator
default ListResourceScanResourcesIterable listResourceScanResourcesPaginator(ListResourceScanResourcesRequest listResourceScanResourcesRequest) throws ResourceScanNotFoundException, ResourceScanInProgressException, AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listResourceScanResources(software.amazon.awssdk.services.cloudformation.model.ListResourceScanResourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListResourceScanResourcesIterable responses = client.listResourceScanResourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListResourceScanResourcesIterable responses = client .listResourceScanResourcesPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListResourceScanResourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListResourceScanResourcesIterable responses = client.listResourceScanResourcesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceScanResources(software.amazon.awssdk.services.cloudformation.model.ListResourceScanResourcesRequest)operation.- Parameters:
listResourceScanResourcesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listResourceScanResourcesPaginator
default ListResourceScanResourcesIterable listResourceScanResourcesPaginator(Consumer<ListResourceScanResourcesRequest.Builder> listResourceScanResourcesRequest) throws ResourceScanNotFoundException, ResourceScanInProgressException, AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listResourceScanResources(software.amazon.awssdk.services.cloudformation.model.ListResourceScanResourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListResourceScanResourcesIterable responses = client.listResourceScanResourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListResourceScanResourcesIterable responses = client .listResourceScanResourcesPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListResourceScanResourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListResourceScanResourcesIterable responses = client.listResourceScanResourcesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceScanResources(software.amazon.awssdk.services.cloudformation.model.ListResourceScanResourcesRequest)operation.
This is a convenience which creates an instance of the
ListResourceScanResourcesRequest.Builderavoiding the need to create one manually viaListResourceScanResourcesRequest.builder()- Parameters:
listResourceScanResourcesRequest- AConsumerthat will call methods onListResourceScanResourcesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listResourceScans
default ListResourceScansResponse listResourceScans(ListResourceScansRequest listResourceScansRequest) throws AwsServiceException, SdkClientException, CloudFormationException List the resource scans from newest to oldest. By default it will return up to 10 resource scans.
- Parameters:
listResourceScansRequest-- Returns:
- Result of the ListResourceScans operation returned by the service.
- See Also:
-
listResourceScans
default ListResourceScansResponse listResourceScans(Consumer<ListResourceScansRequest.Builder> listResourceScansRequest) throws AwsServiceException, SdkClientException, CloudFormationException List the resource scans from newest to oldest. By default it will return up to 10 resource scans.
This is a convenience which creates an instance of the
ListResourceScansRequest.Builderavoiding the need to create one manually viaListResourceScansRequest.builder()- Parameters:
listResourceScansRequest- AConsumerthat will call methods onListResourceScansRequest.Builderto create a request.- Returns:
- Result of the ListResourceScans operation returned by the service.
- See Also:
-
listResourceScansPaginator
default ListResourceScansIterable listResourceScansPaginator(ListResourceScansRequest listResourceScansRequest) throws AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listResourceScans(software.amazon.awssdk.services.cloudformation.model.ListResourceScansRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListResourceScansIterable responses = client.listResourceScansPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListResourceScansIterable responses = client .listResourceScansPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListResourceScansResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListResourceScansIterable responses = client.listResourceScansPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceScans(software.amazon.awssdk.services.cloudformation.model.ListResourceScansRequest)operation.- Parameters:
listResourceScansRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listResourceScansPaginator
default ListResourceScansIterable listResourceScansPaginator(Consumer<ListResourceScansRequest.Builder> listResourceScansRequest) throws AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listResourceScans(software.amazon.awssdk.services.cloudformation.model.ListResourceScansRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListResourceScansIterable responses = client.listResourceScansPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListResourceScansIterable responses = client .listResourceScansPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListResourceScansResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListResourceScansIterable responses = client.listResourceScansPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceScans(software.amazon.awssdk.services.cloudformation.model.ListResourceScansRequest)operation.
This is a convenience which creates an instance of the
ListResourceScansRequest.Builderavoiding the need to create one manually viaListResourceScansRequest.builder()- Parameters:
listResourceScansRequest- AConsumerthat will call methods onListResourceScansRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listStackInstanceResourceDrifts
default ListStackInstanceResourceDriftsResponse listStackInstanceResourceDrifts(ListStackInstanceResourceDriftsRequest listStackInstanceResourceDriftsRequest) throws StackSetNotFoundException, StackInstanceNotFoundException, OperationNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Returns drift information for resources in a stack instance.
ListStackInstanceResourceDriftsreturns drift information for the most recent drift detection operation. If an operation is in progress, it may only return partial results.- Parameters:
listStackInstanceResourceDriftsRequest-- Returns:
- Result of the ListStackInstanceResourceDrifts operation returned by the service.
- See Also:
-
listStackInstanceResourceDrifts
default ListStackInstanceResourceDriftsResponse listStackInstanceResourceDrifts(Consumer<ListStackInstanceResourceDriftsRequest.Builder> listStackInstanceResourceDriftsRequest) throws StackSetNotFoundException, StackInstanceNotFoundException, OperationNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Returns drift information for resources in a stack instance.
ListStackInstanceResourceDriftsreturns drift information for the most recent drift detection operation. If an operation is in progress, it may only return partial results.
This is a convenience which creates an instance of the
ListStackInstanceResourceDriftsRequest.Builderavoiding the need to create one manually viaListStackInstanceResourceDriftsRequest.builder()- Parameters:
listStackInstanceResourceDriftsRequest- AConsumerthat will call methods onListStackInstanceResourceDriftsRequest.Builderto create a request.- Returns:
- Result of the ListStackInstanceResourceDrifts operation returned by the service.
- See Also:
-
listStackInstances
default ListStackInstancesResponse listStackInstances(ListStackInstancesRequest listStackInstancesRequest) throws StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region, or that have a specific status.
- Parameters:
listStackInstancesRequest-- Returns:
- Result of the ListStackInstances operation returned by the service.
- See Also:
-
listStackInstances
default ListStackInstancesResponse listStackInstances(Consumer<ListStackInstancesRequest.Builder> listStackInstancesRequest) throws StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region, or that have a specific status.
This is a convenience which creates an instance of the
ListStackInstancesRequest.Builderavoiding the need to create one manually viaListStackInstancesRequest.builder()- Parameters:
listStackInstancesRequest- AConsumerthat will call methods onListStackInstancesRequest.Builderto create a request.- Returns:
- Result of the ListStackInstances operation returned by the service.
- See Also:
-
listStackInstancesPaginator
default ListStackInstancesIterable listStackInstancesPaginator(ListStackInstancesRequest listStackInstancesRequest) throws StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listStackInstances(software.amazon.awssdk.services.cloudformation.model.ListStackInstancesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListStackInstancesIterable responses = client.listStackInstancesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListStackInstancesIterable responses = client .listStackInstancesPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListStackInstancesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListStackInstancesIterable responses = client.listStackInstancesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStackInstances(software.amazon.awssdk.services.cloudformation.model.ListStackInstancesRequest)operation.- Parameters:
listStackInstancesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listStackInstancesPaginator
default ListStackInstancesIterable listStackInstancesPaginator(Consumer<ListStackInstancesRequest.Builder> listStackInstancesRequest) throws StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listStackInstances(software.amazon.awssdk.services.cloudformation.model.ListStackInstancesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListStackInstancesIterable responses = client.listStackInstancesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListStackInstancesIterable responses = client .listStackInstancesPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListStackInstancesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListStackInstancesIterable responses = client.listStackInstancesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStackInstances(software.amazon.awssdk.services.cloudformation.model.ListStackInstancesRequest)operation.
This is a convenience which creates an instance of the
ListStackInstancesRequest.Builderavoiding the need to create one manually viaListStackInstancesRequest.builder()- Parameters:
listStackInstancesRequest- AConsumerthat will call methods onListStackInstancesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listStackResources
default ListStackResourcesResponse listStackResources(ListStackResourcesRequest listStackResourcesRequest) throws AwsServiceException, SdkClientException, CloudFormationException Returns descriptions of all resources of the specified stack.
For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.
- Parameters:
listStackResourcesRequest- The input for the ListStackResource action.- Returns:
- Result of the ListStackResources operation returned by the service.
- See Also:
-
listStackResources
default ListStackResourcesResponse listStackResources(Consumer<ListStackResourcesRequest.Builder> listStackResourcesRequest) throws AwsServiceException, SdkClientException, CloudFormationException Returns descriptions of all resources of the specified stack.
For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.
This is a convenience which creates an instance of the
ListStackResourcesRequest.Builderavoiding the need to create one manually viaListStackResourcesRequest.builder()- Parameters:
listStackResourcesRequest- AConsumerthat will call methods onListStackResourcesRequest.Builderto create a request. The input for the ListStackResource action.- Returns:
- Result of the ListStackResources operation returned by the service.
- See Also:
-
listStackResourcesPaginator
default ListStackResourcesIterable listStackResourcesPaginator(ListStackResourcesRequest listStackResourcesRequest) throws AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listStackResources(software.amazon.awssdk.services.cloudformation.model.ListStackResourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListStackResourcesIterable responses = client.listStackResourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListStackResourcesIterable responses = client .listStackResourcesPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListStackResourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListStackResourcesIterable responses = client.listStackResourcesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStackResources(software.amazon.awssdk.services.cloudformation.model.ListStackResourcesRequest)operation.- Parameters:
listStackResourcesRequest- The input for the ListStackResource action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listStackResourcesPaginator
default ListStackResourcesIterable listStackResourcesPaginator(Consumer<ListStackResourcesRequest.Builder> listStackResourcesRequest) throws AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listStackResources(software.amazon.awssdk.services.cloudformation.model.ListStackResourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListStackResourcesIterable responses = client.listStackResourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListStackResourcesIterable responses = client .listStackResourcesPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListStackResourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListStackResourcesIterable responses = client.listStackResourcesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStackResources(software.amazon.awssdk.services.cloudformation.model.ListStackResourcesRequest)operation.
This is a convenience which creates an instance of the
ListStackResourcesRequest.Builderavoiding the need to create one manually viaListStackResourcesRequest.builder()- Parameters:
listStackResourcesRequest- AConsumerthat will call methods onListStackResourcesRequest.Builderto create a request. The input for the ListStackResource action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listStackSetAutoDeploymentTargets
default ListStackSetAutoDeploymentTargetsResponse listStackSetAutoDeploymentTargets(ListStackSetAutoDeploymentTargetsRequest listStackSetAutoDeploymentTargetsRequest) throws StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Returns summary information about deployment targets for a stack set.
- Parameters:
listStackSetAutoDeploymentTargetsRequest-- Returns:
- Result of the ListStackSetAutoDeploymentTargets operation returned by the service.
- See Also:
-
listStackSetAutoDeploymentTargets
default ListStackSetAutoDeploymentTargetsResponse listStackSetAutoDeploymentTargets(Consumer<ListStackSetAutoDeploymentTargetsRequest.Builder> listStackSetAutoDeploymentTargetsRequest) throws StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Returns summary information about deployment targets for a stack set.
This is a convenience which creates an instance of the
ListStackSetAutoDeploymentTargetsRequest.Builderavoiding the need to create one manually viaListStackSetAutoDeploymentTargetsRequest.builder()- Parameters:
listStackSetAutoDeploymentTargetsRequest- AConsumerthat will call methods onListStackSetAutoDeploymentTargetsRequest.Builderto create a request.- Returns:
- Result of the ListStackSetAutoDeploymentTargets operation returned by the service.
- See Also:
-
listStackSetOperationResults
default ListStackSetOperationResultsResponse listStackSetOperationResults(ListStackSetOperationResultsRequest listStackSetOperationResultsRequest) throws StackSetNotFoundException, OperationNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Returns summary information about the results of a stack set operation.
- Parameters:
listStackSetOperationResultsRequest-- Returns:
- Result of the ListStackSetOperationResults operation returned by the service.
- See Also:
-
listStackSetOperationResults
default ListStackSetOperationResultsResponse listStackSetOperationResults(Consumer<ListStackSetOperationResultsRequest.Builder> listStackSetOperationResultsRequest) throws StackSetNotFoundException, OperationNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Returns summary information about the results of a stack set operation.
This is a convenience which creates an instance of the
ListStackSetOperationResultsRequest.Builderavoiding the need to create one manually viaListStackSetOperationResultsRequest.builder()- Parameters:
listStackSetOperationResultsRequest- AConsumerthat will call methods onListStackSetOperationResultsRequest.Builderto create a request.- Returns:
- Result of the ListStackSetOperationResults operation returned by the service.
- See Also:
-
listStackSetOperationResultsPaginator
default ListStackSetOperationResultsIterable listStackSetOperationResultsPaginator(ListStackSetOperationResultsRequest listStackSetOperationResultsRequest) throws StackSetNotFoundException, OperationNotFoundException, AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listStackSetOperationResults(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationResultsIterable responses = client.listStackSetOperationResultsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationResultsIterable responses = client .listStackSetOperationResultsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationResultsIterable responses = client.listStackSetOperationResultsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStackSetOperationResults(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsRequest)operation.- Parameters:
listStackSetOperationResultsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listStackSetOperationResultsPaginator
default ListStackSetOperationResultsIterable listStackSetOperationResultsPaginator(Consumer<ListStackSetOperationResultsRequest.Builder> listStackSetOperationResultsRequest) throws StackSetNotFoundException, OperationNotFoundException, AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listStackSetOperationResults(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationResultsIterable responses = client.listStackSetOperationResultsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationResultsIterable responses = client .listStackSetOperationResultsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationResultsIterable responses = client.listStackSetOperationResultsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStackSetOperationResults(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationResultsRequest)operation.
This is a convenience which creates an instance of the
ListStackSetOperationResultsRequest.Builderavoiding the need to create one manually viaListStackSetOperationResultsRequest.builder()- Parameters:
listStackSetOperationResultsRequest- AConsumerthat will call methods onListStackSetOperationResultsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listStackSetOperations
default ListStackSetOperationsResponse listStackSetOperations(ListStackSetOperationsRequest listStackSetOperationsRequest) throws StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Returns summary information about operations performed on a stack set.
- Parameters:
listStackSetOperationsRequest-- Returns:
- Result of the ListStackSetOperations operation returned by the service.
- See Also:
-
listStackSetOperations
default ListStackSetOperationsResponse listStackSetOperations(Consumer<ListStackSetOperationsRequest.Builder> listStackSetOperationsRequest) throws StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Returns summary information about operations performed on a stack set.
This is a convenience which creates an instance of the
ListStackSetOperationsRequest.Builderavoiding the need to create one manually viaListStackSetOperationsRequest.builder()- Parameters:
listStackSetOperationsRequest- AConsumerthat will call methods onListStackSetOperationsRequest.Builderto create a request.- Returns:
- Result of the ListStackSetOperations operation returned by the service.
- See Also:
-
listStackSetOperationsPaginator
default ListStackSetOperationsIterable listStackSetOperationsPaginator(ListStackSetOperationsRequest listStackSetOperationsRequest) throws StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listStackSetOperations(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationsIterable responses = client.listStackSetOperationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationsIterable responses = client .listStackSetOperationsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationsIterable responses = client.listStackSetOperationsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStackSetOperations(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsRequest)operation.- Parameters:
listStackSetOperationsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listStackSetOperationsPaginator
default ListStackSetOperationsIterable listStackSetOperationsPaginator(Consumer<ListStackSetOperationsRequest.Builder> listStackSetOperationsRequest) throws StackSetNotFoundException, AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listStackSetOperations(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationsIterable responses = client.listStackSetOperationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationsIterable responses = client .listStackSetOperationsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListStackSetOperationsIterable responses = client.listStackSetOperationsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStackSetOperations(software.amazon.awssdk.services.cloudformation.model.ListStackSetOperationsRequest)operation.
This is a convenience which creates an instance of the
ListStackSetOperationsRequest.Builderavoiding the need to create one manually viaListStackSetOperationsRequest.builder()- Parameters:
listStackSetOperationsRequest- AConsumerthat will call methods onListStackSetOperationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listStackSets
default ListStackSetsResponse listStackSets(ListStackSetsRequest listStackSetsRequest) throws AwsServiceException, SdkClientException, CloudFormationException Returns summary information about stack sets that are associated with the user.
-
[Self-managed permissions] If you set the
CallAsparameter toSELFwhile signed in to your Amazon Web Services account,ListStackSetsreturns all self-managed stack sets in your Amazon Web Services account. -
[Service-managed permissions] If you set the
CallAsparameter toSELFwhile signed in to the organization's management account,ListStackSetsreturns all stack sets in the management account. -
[Service-managed permissions] If you set the
CallAsparameter toDELEGATED_ADMINwhile signed in to your member account,ListStackSetsreturns all stack sets with service-managed permissions in the management account.
- Parameters:
listStackSetsRequest-- Returns:
- Result of the ListStackSets operation returned by the service.
- See Also:
-
-
listStackSets
default ListStackSetsResponse listStackSets(Consumer<ListStackSetsRequest.Builder> listStackSetsRequest) throws AwsServiceException, SdkClientException, CloudFormationException Returns summary information about stack sets that are associated with the user.
-
[Self-managed permissions] If you set the
CallAsparameter toSELFwhile signed in to your Amazon Web Services account,ListStackSetsreturns all self-managed stack sets in your Amazon Web Services account. -
[Service-managed permissions] If you set the
CallAsparameter toSELFwhile signed in to the organization's management account,ListStackSetsreturns all stack sets in the management account. -
[Service-managed permissions] If you set the
CallAsparameter toDELEGATED_ADMINwhile signed in to your member account,ListStackSetsreturns all stack sets with service-managed permissions in the management account.
This is a convenience which creates an instance of the
ListStackSetsRequest.Builderavoiding the need to create one manually viaListStackSetsRequest.builder()- Parameters:
listStackSetsRequest- AConsumerthat will call methods onListStackSetsRequest.Builderto create a request.- Returns:
- Result of the ListStackSets operation returned by the service.
- See Also:
-
-
listStackSets
default ListStackSetsResponse listStackSets() throws AwsServiceException, SdkClientException, CloudFormationExceptionReturns summary information about stack sets that are associated with the user.
-
[Self-managed permissions] If you set the
CallAsparameter toSELFwhile signed in to your Amazon Web Services account,ListStackSetsreturns all self-managed stack sets in your Amazon Web Services account. -
[Service-managed permissions] If you set the
CallAsparameter toSELFwhile signed in to the organization's management account,ListStackSetsreturns all stack sets in the management account. -
[Service-managed permissions] If you set the
CallAsparameter toDELEGATED_ADMINwhile signed in to your member account,ListStackSetsreturns all stack sets with service-managed permissions in the management account.
- Returns:
- Result of the ListStackSets operation returned by the service.
- See Also:
-
-
listStackSetsPaginator
default ListStackSetsIterable listStackSetsPaginator() throws AwsServiceException, SdkClientException, CloudFormationExceptionThis is a variant of
listStackSets(software.amazon.awssdk.services.cloudformation.model.ListStackSetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListStackSetsIterable responses = client.listStackSetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListStackSetsIterable responses = client .listStackSetsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListStackSetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListStackSetsIterable responses = client.listStackSetsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStackSets(software.amazon.awssdk.services.cloudformation.model.ListStackSetsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listStackSetsPaginator
default ListStackSetsIterable listStackSetsPaginator(ListStackSetsRequest listStackSetsRequest) throws AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listStackSets(software.amazon.awssdk.services.cloudformation.model.ListStackSetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListStackSetsIterable responses = client.listStackSetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListStackSetsIterable responses = client .listStackSetsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListStackSetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListStackSetsIterable responses = client.listStackSetsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStackSets(software.amazon.awssdk.services.cloudformation.model.ListStackSetsRequest)operation.- Parameters:
listStackSetsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listStackSetsPaginator
default ListStackSetsIterable listStackSetsPaginator(Consumer<ListStackSetsRequest.Builder> listStackSetsRequest) throws AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listStackSets(software.amazon.awssdk.services.cloudformation.model.ListStackSetsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListStackSetsIterable responses = client.listStackSetsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListStackSetsIterable responses = client .listStackSetsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListStackSetsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListStackSetsIterable responses = client.listStackSetsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStackSets(software.amazon.awssdk.services.cloudformation.model.ListStackSetsRequest)operation.
This is a convenience which creates an instance of the
ListStackSetsRequest.Builderavoiding the need to create one manually viaListStackSetsRequest.builder()- Parameters:
listStackSetsRequest- AConsumerthat will call methods onListStackSetsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listStacks
default ListStacksResponse listStacks(ListStacksRequest listStacksRequest) throws AwsServiceException, SdkClientException, CloudFormationException Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).
- Parameters:
listStacksRequest- The input for ListStacks action.- Returns:
- Result of the ListStacks operation returned by the service.
- See Also:
-
listStacks
default ListStacksResponse listStacks(Consumer<ListStacksRequest.Builder> listStacksRequest) throws AwsServiceException, SdkClientException, CloudFormationException Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).
This is a convenience which creates an instance of the
ListStacksRequest.Builderavoiding the need to create one manually viaListStacksRequest.builder()- Parameters:
listStacksRequest- AConsumerthat will call methods onListStacksRequest.Builderto create a request. The input for ListStacks action.- Returns:
- Result of the ListStacks operation returned by the service.
- See Also:
-
listStacks
default ListStacksResponse listStacks() throws AwsServiceException, SdkClientException, CloudFormationExceptionReturns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).
- Returns:
- Result of the ListStacks operation returned by the service.
- See Also:
-
listStacksPaginator
default ListStacksIterable listStacksPaginator() throws AwsServiceException, SdkClientException, CloudFormationExceptionThis is a variant of
listStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListStacksIterable responses = client.listStacksPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListStacksIterable responses = client.listStacksPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListStacksResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListStacksIterable responses = client.listStacksPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listStacksPaginator
default ListStacksIterable listStacksPaginator(ListStacksRequest listStacksRequest) throws AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListStacksIterable responses = client.listStacksPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListStacksIterable responses = client.listStacksPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListStacksResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListStacksIterable responses = client.listStacksPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest)operation.- Parameters:
listStacksRequest- The input for ListStacks action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listStacksPaginator
default ListStacksIterable listStacksPaginator(Consumer<ListStacksRequest.Builder> listStacksRequest) throws AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListStacksIterable responses = client.listStacksPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListStacksIterable responses = client.listStacksPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListStacksResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListStacksIterable responses = client.listStacksPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStacks(software.amazon.awssdk.services.cloudformation.model.ListStacksRequest)operation.
This is a convenience which creates an instance of the
ListStacksRequest.Builderavoiding the need to create one manually viaListStacksRequest.builder()- Parameters:
listStacksRequest- AConsumerthat will call methods onListStacksRequest.Builderto create a request. The input for ListStacks action.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTypeRegistrations
default ListTypeRegistrationsResponse listTypeRegistrations(ListTypeRegistrationsRequest listTypeRegistrationsRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException Returns a list of registration tokens for the specified extension(s).
- Parameters:
listTypeRegistrationsRequest-- Returns:
- Result of the ListTypeRegistrations operation returned by the service.
- See Also:
-
listTypeRegistrations
default ListTypeRegistrationsResponse listTypeRegistrations(Consumer<ListTypeRegistrationsRequest.Builder> listTypeRegistrationsRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException Returns a list of registration tokens for the specified extension(s).
This is a convenience which creates an instance of the
ListTypeRegistrationsRequest.Builderavoiding the need to create one manually viaListTypeRegistrationsRequest.builder()- Parameters:
listTypeRegistrationsRequest- AConsumerthat will call methods onListTypeRegistrationsRequest.Builderto create a request.- Returns:
- Result of the ListTypeRegistrations operation returned by the service.
- See Also:
-
listTypeRegistrationsPaginator
default ListTypeRegistrationsIterable listTypeRegistrationsPaginator(ListTypeRegistrationsRequest listTypeRegistrationsRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listTypeRegistrations(software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListTypeRegistrationsIterable responses = client.listTypeRegistrationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListTypeRegistrationsIterable responses = client .listTypeRegistrationsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListTypeRegistrationsIterable responses = client.listTypeRegistrationsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTypeRegistrations(software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsRequest)operation.- Parameters:
listTypeRegistrationsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTypeRegistrationsPaginator
default ListTypeRegistrationsIterable listTypeRegistrationsPaginator(Consumer<ListTypeRegistrationsRequest.Builder> listTypeRegistrationsRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listTypeRegistrations(software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListTypeRegistrationsIterable responses = client.listTypeRegistrationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListTypeRegistrationsIterable responses = client .listTypeRegistrationsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListTypeRegistrationsIterable responses = client.listTypeRegistrationsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTypeRegistrations(software.amazon.awssdk.services.cloudformation.model.ListTypeRegistrationsRequest)operation.
This is a convenience which creates an instance of the
ListTypeRegistrationsRequest.Builderavoiding the need to create one manually viaListTypeRegistrationsRequest.builder()- Parameters:
listTypeRegistrationsRequest- AConsumerthat will call methods onListTypeRegistrationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTypeVersions
default ListTypeVersionsResponse listTypeVersions(ListTypeVersionsRequest listTypeVersionsRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException Returns summary information about the versions of an extension.
- Parameters:
listTypeVersionsRequest-- Returns:
- Result of the ListTypeVersions operation returned by the service.
- See Also:
-
listTypeVersions
default ListTypeVersionsResponse listTypeVersions(Consumer<ListTypeVersionsRequest.Builder> listTypeVersionsRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException Returns summary information about the versions of an extension.
This is a convenience which creates an instance of the
ListTypeVersionsRequest.Builderavoiding the need to create one manually viaListTypeVersionsRequest.builder()- Parameters:
listTypeVersionsRequest- AConsumerthat will call methods onListTypeVersionsRequest.Builderto create a request.- Returns:
- Result of the ListTypeVersions operation returned by the service.
- See Also:
-
listTypeVersionsPaginator
default ListTypeVersionsIterable listTypeVersionsPaginator(ListTypeVersionsRequest listTypeVersionsRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listTypeVersions(software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListTypeVersionsIterable responses = client.listTypeVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListTypeVersionsIterable responses = client .listTypeVersionsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListTypeVersionsIterable responses = client.listTypeVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTypeVersions(software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsRequest)operation.- Parameters:
listTypeVersionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTypeVersionsPaginator
default ListTypeVersionsIterable listTypeVersionsPaginator(Consumer<ListTypeVersionsRequest.Builder> listTypeVersionsRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listTypeVersions(software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListTypeVersionsIterable responses = client.listTypeVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListTypeVersionsIterable responses = client .listTypeVersionsPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListTypeVersionsIterable responses = client.listTypeVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTypeVersions(software.amazon.awssdk.services.cloudformation.model.ListTypeVersionsRequest)operation.
This is a convenience which creates an instance of the
ListTypeVersionsRequest.Builderavoiding the need to create one manually viaListTypeVersionsRequest.builder()- Parameters:
listTypeVersionsRequest- AConsumerthat will call methods onListTypeVersionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTypes
default ListTypesResponse listTypes(ListTypesRequest listTypesRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException Returns summary information about extension that have been registered with CloudFormation.
- Parameters:
listTypesRequest-- Returns:
- Result of the ListTypes operation returned by the service.
- See Also:
-
listTypes
default ListTypesResponse listTypes(Consumer<ListTypesRequest.Builder> listTypesRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException Returns summary information about extension that have been registered with CloudFormation.
This is a convenience which creates an instance of the
ListTypesRequest.Builderavoiding the need to create one manually viaListTypesRequest.builder()- Parameters:
listTypesRequest- AConsumerthat will call methods onListTypesRequest.Builderto create a request.- Returns:
- Result of the ListTypes operation returned by the service.
- See Also:
-
listTypesPaginator
default ListTypesIterable listTypesPaginator(ListTypesRequest listTypesRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listTypes(software.amazon.awssdk.services.cloudformation.model.ListTypesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListTypesIterable responses = client.listTypesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListTypesIterable responses = client.listTypesPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListTypesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListTypesIterable responses = client.listTypesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTypes(software.amazon.awssdk.services.cloudformation.model.ListTypesRequest)operation.- Parameters:
listTypesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTypesPaginator
default ListTypesIterable listTypesPaginator(Consumer<ListTypesRequest.Builder> listTypesRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException This is a variant of
listTypes(software.amazon.awssdk.services.cloudformation.model.ListTypesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.cloudformation.paginators.ListTypesIterable responses = client.listTypesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.cloudformation.paginators.ListTypesIterable responses = client.listTypesPaginator(request); for (software.amazon.awssdk.services.cloudformation.model.ListTypesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.cloudformation.paginators.ListTypesIterable responses = client.listTypesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTypes(software.amazon.awssdk.services.cloudformation.model.ListTypesRequest)operation.
This is a convenience which creates an instance of the
ListTypesRequest.Builderavoiding the need to create one manually viaListTypesRequest.builder()- Parameters:
listTypesRequest- AConsumerthat will call methods onListTypesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
publishType
default PublishTypeResponse publishType(PublishTypeRequest publishTypeRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Publishes the specified extension to the CloudFormation registry as a public extension in this Region. Public extensions are available for use by all CloudFormation users. For more information about publishing extensions, see Publishing extensions to make them available for public use in the CloudFormation Command Line Interface (CLI) User Guide.
To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.
- Parameters:
publishTypeRequest-- Returns:
- Result of the PublishType operation returned by the service.
- See Also:
-
publishType
default PublishTypeResponse publishType(Consumer<PublishTypeRequest.Builder> publishTypeRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Publishes the specified extension to the CloudFormation registry as a public extension in this Region. Public extensions are available for use by all CloudFormation users. For more information about publishing extensions, see Publishing extensions to make them available for public use in the CloudFormation Command Line Interface (CLI) User Guide.
To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.
This is a convenience which creates an instance of the
PublishTypeRequest.Builderavoiding the need to create one manually viaPublishTypeRequest.builder()- Parameters:
publishTypeRequest- AConsumerthat will call methods onPublishTypeRequest.Builderto create a request.- Returns:
- Result of the PublishType operation returned by the service.
- See Also:
-
recordHandlerProgress
default RecordHandlerProgressResponse recordHandlerProgress(RecordHandlerProgressRequest recordHandlerProgressRequest) throws InvalidStateTransitionException, OperationStatusCheckFailedException, AwsServiceException, SdkClientException, CloudFormationException Reports progress of a resource handler to CloudFormation.
Reserved for use by the CloudFormation CLI. Don't use this API in your code.
- Parameters:
recordHandlerProgressRequest-- Returns:
- Result of the RecordHandlerProgress operation returned by the service.
- See Also:
-
recordHandlerProgress
default RecordHandlerProgressResponse recordHandlerProgress(Consumer<RecordHandlerProgressRequest.Builder> recordHandlerProgressRequest) throws InvalidStateTransitionException, OperationStatusCheckFailedException, AwsServiceException, SdkClientException, CloudFormationException Reports progress of a resource handler to CloudFormation.
Reserved for use by the CloudFormation CLI. Don't use this API in your code.
This is a convenience which creates an instance of the
RecordHandlerProgressRequest.Builderavoiding the need to create one manually viaRecordHandlerProgressRequest.builder()- Parameters:
recordHandlerProgressRequest- AConsumerthat will call methods onRecordHandlerProgressRequest.Builderto create a request.- Returns:
- Result of the RecordHandlerProgress operation returned by the service.
- See Also:
-
registerPublisher
default RegisterPublisherResponse registerPublisher(RegisterPublisherRequest registerPublisherRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users. This publisher ID applies to your account in all Amazon Web Services Regions.
For information about requirements for registering as a public extension publisher, see Prerequisite: Registering your account to publish CloudFormation extensions in the CloudFormation Command Line Interface (CLI) User Guide.
- Parameters:
registerPublisherRequest-- Returns:
- Result of the RegisterPublisher operation returned by the service.
- See Also:
-
registerPublisher
default RegisterPublisherResponse registerPublisher(Consumer<RegisterPublisherRequest.Builder> registerPublisherRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users. This publisher ID applies to your account in all Amazon Web Services Regions.
For information about requirements for registering as a public extension publisher, see Prerequisite: Registering your account to publish CloudFormation extensions in the CloudFormation Command Line Interface (CLI) User Guide.
This is a convenience which creates an instance of the
RegisterPublisherRequest.Builderavoiding the need to create one manually viaRegisterPublisherRequest.builder()- Parameters:
registerPublisherRequest- AConsumerthat will call methods onRegisterPublisherRequest.Builderto create a request.- Returns:
- Result of the RegisterPublisher operation returned by the service.
- See Also:
-
registerType
default RegisterTypeResponse registerType(RegisterTypeRequest registerTypeRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:
-
Validating the extension schema.
-
Determining which handlers, if any, have been specified for the extension.
-
Making the extension available for use in your account.
For more information about how to develop extensions and ready them for registration, see Creating resource types using the CloudFormation CLI in the CloudFormation Command Line Interface (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 Edit configuration data for extensions in your account in the CloudFormation User Guide.
- Parameters:
registerTypeRequest-- Returns:
- Result of the RegisterType operation returned by the service.
- See Also:
-
-
registerType
default RegisterTypeResponse registerType(Consumer<RegisterTypeRequest.Builder> registerTypeRequest) throws CfnRegistryException, AwsServiceException, SdkClientException, CloudFormationException Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:
-
Validating the extension schema.
-
Determining which handlers, if any, have been specified for the extension.
-
Making the extension available for use in your account.
For more information about how to develop extensions and ready them for registration, see Creating resource types using the CloudFormation CLI in the CloudFormation Command Line Interface (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 Edit configuration data for extensions in your account in the CloudFormation User Guide.
This is a convenience which creates an instance of the
RegisterTypeRequest.Builderavoiding the need to create one manually viaRegisterTypeRequest.builder()- Parameters:
registerTypeRequest- AConsumerthat will call methods onRegisterTypeRequest.Builderto create a request.- Returns:
- Result of the RegisterType operation returned by the service.
- See Also:
-
-
rollbackStack
default RollbackStackResponse rollbackStack(RollbackStackRequest rollbackStackRequest) throws TokenAlreadyExistsException, AwsServiceException, SdkClientException, CloudFormationException When specifying
RollbackStack, you preserve the state of previously provisioned resources when an operation fails. You can check the status of the stack through the DescribeStacks operation.Rolls back the specified stack to the last known stable state from
CREATE_FAILEDorUPDATE_FAILEDstack statuses.This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state includes any status in a
*_COMPLETE. This includes the following stack statuses.-
CREATE_COMPLETE -
UPDATE_COMPLETE -
UPDATE_ROLLBACK_COMPLETE -
IMPORT_COMPLETE -
IMPORT_ROLLBACK_COMPLETE
- Parameters:
rollbackStackRequest-- Returns:
- Result of the RollbackStack operation returned by the service.
- See Also:
-
-
rollbackStack
default RollbackStackResponse rollbackStack(Consumer<RollbackStackRequest.Builder> rollbackStackRequest) throws TokenAlreadyExistsException, AwsServiceException, SdkClientException, CloudFormationException When specifying
RollbackStack, you preserve the state of previously provisioned resources when an operation fails. You can check the status of the stack through the DescribeStacks operation.Rolls back the specified stack to the last known stable state from
CREATE_FAILEDorUPDATE_FAILEDstack statuses.This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state includes any status in a
*_COMPLETE. This includes the following stack statuses.-
CREATE_COMPLETE -
UPDATE_COMPLETE -
UPDATE_ROLLBACK_COMPLETE -
IMPORT_COMPLETE -
IMPORT_ROLLBACK_COMPLETE
This is a convenience which creates an instance of the
RollbackStackRequest.Builderavoiding the need to create one manually viaRollbackStackRequest.builder()- Parameters:
rollbackStackRequest- AConsumerthat will call methods onRollbackStackRequest.Builderto create a request.- Returns:
- Result of the RollbackStack operation returned by the service.
- See Also:
-
-
setStackPolicy
default SetStackPolicyResponse setStackPolicy(SetStackPolicyRequest setStackPolicyRequest) throws AwsServiceException, SdkClientException, CloudFormationException Sets a stack policy for a specified stack.
- Parameters:
setStackPolicyRequest- The input for the SetStackPolicy action.- Returns:
- Result of the SetStackPolicy operation returned by the service.
- See Also:
-
setStackPolicy
default SetStackPolicyResponse setStackPolicy(Consumer<SetStackPolicyRequest.Builder> setStackPolicyRequest) throws AwsServiceException, SdkClientException, CloudFormationException Sets a stack policy for a specified stack.
This is a convenience which creates an instance of the
SetStackPolicyRequest.Builderavoiding the need to create one manually viaSetStackPolicyRequest.builder()- Parameters:
setStackPolicyRequest- AConsumerthat will call methods onSetStackPolicyRequest.Builderto create a request. The input for the SetStackPolicy action.- Returns:
- Result of the SetStackPolicy operation returned by the service.
- See Also:
-
setTypeConfiguration
default SetTypeConfigurationResponse setTypeConfiguration(SetTypeConfigurationRequest setTypeConfigurationRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Specifies the configuration data for a registered CloudFormation extension, in the given account and Region.
To view the current configuration data for an extension, refer to the
ConfigurationSchemaelement of DescribeType. For more information, see Edit configuration data for extensions in your account 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 Specify values stored in other services using dynamic references in the CloudFormation User Guide.
- Parameters:
setTypeConfigurationRequest-- Returns:
- Result of the SetTypeConfiguration operation returned by the service.
- See Also:
-
setTypeConfiguration
default SetTypeConfigurationResponse setTypeConfiguration(Consumer<SetTypeConfigurationRequest.Builder> setTypeConfigurationRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Specifies the configuration data for a registered CloudFormation extension, in the given account and Region.
To view the current configuration data for an extension, refer to the
ConfigurationSchemaelement of DescribeType. For more information, see Edit configuration data for extensions in your account 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 Specify values stored in other services using dynamic references in the CloudFormation User Guide.
This is a convenience which creates an instance of the
SetTypeConfigurationRequest.Builderavoiding the need to create one manually viaSetTypeConfigurationRequest.builder()- Parameters:
setTypeConfigurationRequest- AConsumerthat will call methods onSetTypeConfigurationRequest.Builderto create a request.- Returns:
- Result of the SetTypeConfiguration operation returned by the service.
- See Also:
-
setTypeDefaultVersion
default SetTypeDefaultVersionResponse setTypeDefaultVersion(SetTypeDefaultVersionRequest setTypeDefaultVersionRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.
- Parameters:
setTypeDefaultVersionRequest-- Returns:
- Result of the SetTypeDefaultVersion operation returned by the service.
- See Also:
-
setTypeDefaultVersion
default SetTypeDefaultVersionResponse setTypeDefaultVersion(Consumer<SetTypeDefaultVersionRequest.Builder> setTypeDefaultVersionRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.
This is a convenience which creates an instance of the
SetTypeDefaultVersionRequest.Builderavoiding the need to create one manually viaSetTypeDefaultVersionRequest.builder()- Parameters:
setTypeDefaultVersionRequest- AConsumerthat will call methods onSetTypeDefaultVersionRequest.Builderto create a request.- Returns:
- Result of the SetTypeDefaultVersion operation returned by the service.
- See Also:
-
signalResource
default SignalResourceResponse signalResource(SignalResourceRequest signalResourceRequest) throws AwsServiceException, SdkClientException, CloudFormationException Sends a signal to the specified resource with a success or failure status. You can use the
SignalResourceoperation 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. TheSignalResourceoperation is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.- Parameters:
signalResourceRequest- The input for the SignalResource action.- Returns:
- Result of the SignalResource operation returned by the service.
- See Also:
-
signalResource
default SignalResourceResponse signalResource(Consumer<SignalResourceRequest.Builder> signalResourceRequest) throws AwsServiceException, SdkClientException, CloudFormationException Sends a signal to the specified resource with a success or failure status. You can use the
SignalResourceoperation 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. TheSignalResourceoperation is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.
This is a convenience which creates an instance of the
SignalResourceRequest.Builderavoiding the need to create one manually viaSignalResourceRequest.builder()- Parameters:
signalResourceRequest- AConsumerthat will call methods onSignalResourceRequest.Builderto create a request. The input for the SignalResource action.- Returns:
- Result of the SignalResource operation returned by the service.
- See Also:
-
startResourceScan
default StartResourceScanResponse startResourceScan(StartResourceScanRequest startResourceScanRequest) throws ResourceScanInProgressException, ResourceScanLimitExceededException, AwsServiceException, SdkClientException, CloudFormationException Starts a scan of the resources in this account in this Region. You can the status of a scan using the
ListResourceScansAPI action.- Parameters:
startResourceScanRequest-- Returns:
- Result of the StartResourceScan operation returned by the service.
- See Also:
-
startResourceScan
default StartResourceScanResponse startResourceScan(Consumer<StartResourceScanRequest.Builder> startResourceScanRequest) throws ResourceScanInProgressException, ResourceScanLimitExceededException, AwsServiceException, SdkClientException, CloudFormationException Starts a scan of the resources in this account in this Region. You can the status of a scan using the
ListResourceScansAPI action.
This is a convenience which creates an instance of the
StartResourceScanRequest.Builderavoiding the need to create one manually viaStartResourceScanRequest.builder()- Parameters:
startResourceScanRequest- AConsumerthat will call methods onStartResourceScanRequest.Builderto create a request.- Returns:
- Result of the StartResourceScan operation returned by the service.
- See Also:
-
stopStackSetOperation
default StopStackSetOperationResponse stopStackSetOperation(StopStackSetOperationRequest stopStackSetOperationRequest) throws StackSetNotFoundException, OperationNotFoundException, InvalidOperationException, AwsServiceException, SdkClientException, CloudFormationException Stops an in-progress operation on a stack set and its associated stack instances. StackSets will cancel all the unstarted stack instance deployments and wait for those are in-progress to complete.
- Parameters:
stopStackSetOperationRequest-- Returns:
- Result of the StopStackSetOperation operation returned by the service.
- See Also:
-
stopStackSetOperation
default StopStackSetOperationResponse stopStackSetOperation(Consumer<StopStackSetOperationRequest.Builder> stopStackSetOperationRequest) throws StackSetNotFoundException, OperationNotFoundException, InvalidOperationException, AwsServiceException, SdkClientException, CloudFormationException Stops an in-progress operation on a stack set and its associated stack instances. StackSets will cancel all the unstarted stack instance deployments and wait for those are in-progress to complete.
This is a convenience which creates an instance of the
StopStackSetOperationRequest.Builderavoiding the need to create one manually viaStopStackSetOperationRequest.builder()- Parameters:
stopStackSetOperationRequest- AConsumerthat will call methods onStopStackSetOperationRequest.Builderto create a request.- Returns:
- Result of the StopStackSetOperation operation returned by the service.
- See Also:
-
testType
default TestTypeResponse testType(TestTypeRequest testTypeRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.
-
For resource types, this includes passing all contracts tests defined for the type.
-
For modules, this includes determining if the module's model meets all necessary requirements.
For more information, see Testing your public extension before publishing in the CloudFormation Command Line Interface (CLI) User Guide.
If you don't specify a version, CloudFormation uses the default version of the extension in your account and Region for testing.
To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more information, see RegisterType.
Once you've initiated testing on an extension using
TestType, you can pass the returnedTypeVersionArninto DescribeType to monitor the current test status and test status description for the extension.An extension must have a test status of
PASSEDbefore it can be published. For more information, see Publishing extensions to make them available for public use in the CloudFormation Command Line Interface (CLI) User Guide.- Parameters:
testTypeRequest-- Returns:
- Result of the TestType operation returned by the service.
- See Also:
-
-
testType
default TestTypeResponse testType(Consumer<TestTypeRequest.Builder> testTypeRequest) throws CfnRegistryException, TypeNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.
-
For resource types, this includes passing all contracts tests defined for the type.
-
For modules, this includes determining if the module's model meets all necessary requirements.
For more information, see Testing your public extension before publishing in the CloudFormation Command Line Interface (CLI) User Guide.
If you don't specify a version, CloudFormation uses the default version of the extension in your account and Region for testing.
To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more information, see RegisterType.
Once you've initiated testing on an extension using
TestType, you can pass the returnedTypeVersionArninto DescribeType to monitor the current test status and test status description for the extension.An extension must have a test status of
PASSEDbefore it can be published. For more information, see Publishing extensions to make them available for public use in the CloudFormation Command Line Interface (CLI) User Guide.
This is a convenience which creates an instance of the
TestTypeRequest.Builderavoiding the need to create one manually viaTestTypeRequest.builder()- Parameters:
testTypeRequest- AConsumerthat will call methods onTestTypeRequest.Builderto create a request.- Returns:
- Result of the TestType operation returned by the service.
- See Also:
-
-
updateGeneratedTemplate
default UpdateGeneratedTemplateResponse updateGeneratedTemplate(UpdateGeneratedTemplateRequest updateGeneratedTemplateRequest) throws AlreadyExistsException, GeneratedTemplateNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, CloudFormationException Updates a generated template. This can be used to change the name, add and remove resources, refresh resources, and change the
DeletionPolicyandUpdateReplacePolicysettings. You can check the status of the update to the generated template using theDescribeGeneratedTemplateAPI action.- Parameters:
updateGeneratedTemplateRequest-- Returns:
- Result of the UpdateGeneratedTemplate operation returned by the service.
- See Also:
-
updateGeneratedTemplate
default UpdateGeneratedTemplateResponse updateGeneratedTemplate(Consumer<UpdateGeneratedTemplateRequest.Builder> updateGeneratedTemplateRequest) throws AlreadyExistsException, GeneratedTemplateNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, CloudFormationException Updates a generated template. This can be used to change the name, add and remove resources, refresh resources, and change the
DeletionPolicyandUpdateReplacePolicysettings. You can check the status of the update to the generated template using theDescribeGeneratedTemplateAPI action.
This is a convenience which creates an instance of the
UpdateGeneratedTemplateRequest.Builderavoiding the need to create one manually viaUpdateGeneratedTemplateRequest.builder()- Parameters:
updateGeneratedTemplateRequest- AConsumerthat will call methods onUpdateGeneratedTemplateRequest.Builderto create a request.- Returns:
- Result of the UpdateGeneratedTemplate operation returned by the service.
- See Also:
-
updateStack
default UpdateStackResponse updateStack(UpdateStackRequest updateStackRequest) throws InsufficientCapabilitiesException, TokenAlreadyExistsException, AwsServiceException, SdkClientException, CloudFormationException Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack through the DescribeStacks action.
To get a copy of the template for an existing stack, you can use the GetTemplate action.
For more information about updating a stack and monitoring the progress of the update, see Managing Amazon Web Services resources as a single unit with CloudFormation stacks in the CloudFormation User Guide.
- Parameters:
updateStackRequest- The input for an UpdateStack action.- Returns:
- Result of the UpdateStack operation returned by the service.
- See Also:
-
updateStack
default UpdateStackResponse updateStack(Consumer<UpdateStackRequest.Builder> updateStackRequest) throws InsufficientCapabilitiesException, TokenAlreadyExistsException, AwsServiceException, SdkClientException, CloudFormationException Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack through the DescribeStacks action.
To get a copy of the template for an existing stack, you can use the GetTemplate action.
For more information about updating a stack and monitoring the progress of the update, see Managing Amazon Web Services resources as a single unit with CloudFormation stacks in the CloudFormation User Guide.
This is a convenience which creates an instance of the
UpdateStackRequest.Builderavoiding the need to create one manually viaUpdateStackRequest.builder()- Parameters:
updateStackRequest- AConsumerthat will call methods onUpdateStackRequest.Builderto create a request. The input for an UpdateStack action.- Returns:
- Result of the UpdateStack operation returned by the service.
- See Also:
-
updateStackInstances
default UpdateStackInstancesResponse updateStackInstances(UpdateStackInstancesRequest updateStackInstancesRequest) throws StackSetNotFoundException, StackInstanceNotFoundException, OperationInProgressException, OperationIdAlreadyExistsException, StaleRequestException, InvalidOperationException, AwsServiceException, SdkClientException, CloudFormationException Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.
You can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances.
During stack set updates, any parameters overridden for a stack instance aren't updated, but retain their overridden value.
You can only update the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using
UpdateStackInstances.- Parameters:
updateStackInstancesRequest-- Returns:
- Result of the UpdateStackInstances operation returned by the service.
- See Also:
-
updateStackInstances
default UpdateStackInstancesResponse updateStackInstances(Consumer<UpdateStackInstancesRequest.Builder> updateStackInstancesRequest) throws StackSetNotFoundException, StackInstanceNotFoundException, OperationInProgressException, OperationIdAlreadyExistsException, StaleRequestException, InvalidOperationException, AwsServiceException, SdkClientException, CloudFormationException Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.
You can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances.
During stack set updates, any parameters overridden for a stack instance aren't updated, but retain their overridden value.
You can only update the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using
UpdateStackInstances.
This is a convenience which creates an instance of the
UpdateStackInstancesRequest.Builderavoiding the need to create one manually viaUpdateStackInstancesRequest.builder()- Parameters:
updateStackInstancesRequest- AConsumerthat will call methods onUpdateStackInstancesRequest.Builderto create a request.- Returns:
- Result of the UpdateStackInstances operation returned by the service.
- See Also:
-
updateStackSet
default UpdateStackSetResponse updateStackSet(UpdateStackSetRequest updateStackSetRequest) throws StackSetNotFoundException, OperationInProgressException, OperationIdAlreadyExistsException, StaleRequestException, InvalidOperationException, StackInstanceNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.
Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.
- Parameters:
updateStackSetRequest-- Returns:
- Result of the UpdateStackSet operation returned by the service.
- See Also:
-
updateStackSet
default UpdateStackSetResponse updateStackSet(Consumer<UpdateStackSetRequest.Builder> updateStackSetRequest) throws StackSetNotFoundException, OperationInProgressException, OperationIdAlreadyExistsException, StaleRequestException, InvalidOperationException, StackInstanceNotFoundException, AwsServiceException, SdkClientException, CloudFormationException Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.
Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.
This is a convenience which creates an instance of the
UpdateStackSetRequest.Builderavoiding the need to create one manually viaUpdateStackSetRequest.builder()- Parameters:
updateStackSetRequest- AConsumerthat will call methods onUpdateStackSetRequest.Builderto create a request.- Returns:
- Result of the UpdateStackSet operation returned by the service.
- See Also:
-
updateTerminationProtection
default UpdateTerminationProtectionResponse updateTerminationProtection(UpdateTerminationProtectionRequest updateTerminationProtectionRequest) throws AwsServiceException, SdkClientException, CloudFormationException Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protect a CloudFormation stack from being deleted in the CloudFormation User Guide.
For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack.
- Parameters:
updateTerminationProtectionRequest-- Returns:
- Result of the UpdateTerminationProtection operation returned by the service.
- See Also:
-
updateTerminationProtection
default UpdateTerminationProtectionResponse updateTerminationProtection(Consumer<UpdateTerminationProtectionRequest.Builder> updateTerminationProtectionRequest) throws AwsServiceException, SdkClientException, CloudFormationException Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protect a CloudFormation stack from being deleted in the CloudFormation User Guide.
For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack.
This is a convenience which creates an instance of the
UpdateTerminationProtectionRequest.Builderavoiding the need to create one manually viaUpdateTerminationProtectionRequest.builder()- Parameters:
updateTerminationProtectionRequest- AConsumerthat will call methods onUpdateTerminationProtectionRequest.Builderto create a request.- Returns:
- Result of the UpdateTerminationProtection operation returned by the service.
- See Also:
-
validateTemplate
default ValidateTemplateResponse validateTemplate(ValidateTemplateRequest validateTemplateRequest) throws AwsServiceException, SdkClientException, CloudFormationException Validates a specified template. CloudFormation first checks if the template is valid JSON. If it isn't, CloudFormation checks if the template is valid YAML. If both these checks fail, CloudFormation returns a template validation error.
- Parameters:
validateTemplateRequest- The input for ValidateTemplate action.- Returns:
- Result of the ValidateTemplate operation returned by the service.
- See Also:
-
validateTemplate
default ValidateTemplateResponse validateTemplate(Consumer<ValidateTemplateRequest.Builder> validateTemplateRequest) throws AwsServiceException, SdkClientException, CloudFormationException Validates a specified template. CloudFormation first checks if the template is valid JSON. If it isn't, CloudFormation checks if the template is valid YAML. If both these checks fail, CloudFormation returns a template validation error.
This is a convenience which creates an instance of the
ValidateTemplateRequest.Builderavoiding the need to create one manually viaValidateTemplateRequest.builder()- Parameters:
validateTemplateRequest- AConsumerthat will call methods onValidateTemplateRequest.Builderto create a request. The input for ValidateTemplate action.- Returns:
- Result of the ValidateTemplate operation returned by the service.
- See Also:
-
waiter
Create an instance ofCloudFormationWaiterusing this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
CloudFormationWaiter
-
create
Create aCloudFormationClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aCloudFormationClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-