Interface SignalResourceRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CloudFormationRequest.Builder
,CopyableBuilder<SignalResourceRequest.Builder,
,SignalResourceRequest> SdkBuilder<SignalResourceRequest.Builder,
,SignalResourceRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
SignalResourceRequest
-
Method Summary
Modifier and TypeMethodDescriptionlogicalResourceId
(String logicalResourceId) The logical ID of the resource that you want to signal.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The stack name or unique stack ID that includes the resource that you want to signal.The status of the signal, which is either success or failure.status
(ResourceSignalStatus status) The status of the signal, which is either success or failure.A unique ID of the signal.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
stackName
The stack name or unique stack ID that includes the resource that you want to signal.
- Parameters:
stackName
- The stack name or unique stack ID that includes the resource that you want to signal.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
logicalResourceId
The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.
- Parameters:
logicalResourceId
- The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
uniqueId
A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID.
- Parameters:
uniqueId
- A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
The status of the signal, which is either success or failure. A failure signal causes CloudFormation to immediately fail the stack creation or update.
- Parameters:
status
- The status of the signal, which is either success or failure. A failure signal causes CloudFormation to immediately fail the stack creation or update.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The status of the signal, which is either success or failure. A failure signal causes CloudFormation to immediately fail the stack creation or update.
- Parameters:
status
- The status of the signal, which is either success or failure. A failure signal causes CloudFormation to immediately fail the stack creation or update.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
SignalResourceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
SignalResourceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-