software.amazon.awssdk.services.cloudformation.model

Interface StackResource.Builder

All Superinterfaces:

Buildable, CopyableBuilder<StackResource.Builder,StackResource>, SdkBuilder<StackResource.Builder,StackResource>, SdkPojo

Enclosing class:

StackResource

public static interface StackResource.Builder
extends SdkPojo, CopyableBuilder<StackResource.Builder,StackResource>

Method Summary

Modifier and Type	Method and Description
StackResource.Builder	description(String description) User defined description associated with the resource.
default StackResource.Builder	driftInformation(Consumer<StackResourceDriftInformation.Builder> driftInformation) Information about whether the 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.
StackResource.Builder	driftInformation(StackResourceDriftInformation driftInformation) Information about whether the 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.
StackResource.Builder	logicalResourceId(String logicalResourceId) The logical name of the resource specified in the template.
default StackResource.Builder	moduleInfo(Consumer<ModuleInfo.Builder> moduleInfo) Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.
StackResource.Builder	moduleInfo(ModuleInfo moduleInfo) Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.
StackResource.Builder	physicalResourceId(String physicalResourceId) The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
StackResource.Builder	resourceStatus(ResourceStatus resourceStatus) Current status of the resource.
StackResource.Builder	resourceStatus(String resourceStatus) Current status of the resource.
StackResource.Builder	resourceStatusReason(String resourceStatusReason) Success/failure message associated with the resource.
StackResource.Builder	resourceType(String resourceType) Type of resource.
StackResource.Builder	stackId(String stackId) Unique identifier of the stack.
StackResource.Builder	stackName(String stackName) The name associated with the stack.
StackResource.Builder	timestamp(Instant timestamp) Time the status was updated.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

stackName

StackResource.Builder stackName(String stackName)

The name associated with the stack.

Parameters:

stackName - The name associated with the stack.

Returns:

Returns a reference to this object so that method calls can be chained together.

stackId

StackResource.Builder stackId(String stackId)

Unique identifier of the stack.

Parameters:

stackId - Unique identifier of the stack.

Returns:

Returns a reference to this object so that method calls can be chained together.

logicalResourceId

StackResource.Builder logicalResourceId(String logicalResourceId)

The logical name of the resource specified in the template.

Parameters:

logicalResourceId - The logical name of the resource specified in the template.

Returns:

Returns a reference to this object so that method calls can be chained together.

physicalResourceId

StackResource.Builder physicalResourceId(String physicalResourceId)

The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.

Parameters:

physicalResourceId - The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.

Returns:

Returns a reference to this object so that method calls can be chained together.

resourceType

StackResource.Builder resourceType(String resourceType)

Type of resource. For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.

Parameters:

resourceType - Type of resource. For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

timestamp

StackResource.Builder timestamp(Instant timestamp)

Time the status was updated.

Parameters:

timestamp - Time the status was updated.

Returns:

Returns a reference to this object so that method calls can be chained together.

resourceStatus

StackResource.Builder resourceStatus(String resourceStatus)

Current status of the resource.

Parameters:

resourceStatus - Current status of the resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ResourceStatus, ResourceStatus

resourceStatus

StackResource.Builder resourceStatus(ResourceStatus resourceStatus)

Current status of the resource.

Parameters:

resourceStatus - Current status of the resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ResourceStatus, ResourceStatus

resourceStatusReason

StackResource.Builder resourceStatusReason(String resourceStatusReason)

Success/failure message associated with the resource.

Parameters:

resourceStatusReason - Success/failure message associated with the resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

StackResource.Builder description(String description)

User defined description associated with the resource.

Parameters:

description - User defined description associated with the resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

driftInformation

StackResource.Builder driftInformation(StackResourceDriftInformation driftInformation)

Information about whether the 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. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

Parameters:

driftInformation - Information about whether the 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. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

Returns:

Returns a reference to this object so that method calls can be chained together.

driftInformation

default StackResource.Builder driftInformation(Consumer<StackResourceDriftInformation.Builder> driftInformation)

Information about whether the 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. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

This is a convenience method that creates an instance of the StackResourceDriftInformation.Builder avoiding the need to create one manually via StackResourceDriftInformation.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to driftInformation(StackResourceDriftInformation).

Parameters:

driftInformation - a consumer that will call methods on StackResourceDriftInformation.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

driftInformation(StackResourceDriftInformation)

moduleInfo

StackResource.Builder moduleInfo(ModuleInfo moduleInfo)

Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

Parameters:

moduleInfo - Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

Returns:

Returns a reference to this object so that method calls can be chained together.

moduleInfo

default StackResource.Builder moduleInfo(Consumer<ModuleInfo.Builder> moduleInfo)

Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

This is a convenience method that creates an instance of the ModuleInfo.Builder avoiding the need to create one manually via ModuleInfo.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to moduleInfo(ModuleInfo).

Parameters:

moduleInfo - a consumer that will call methods on ModuleInfo.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

moduleInfo(ModuleInfo)