Interface ResourceChange.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ResourceChange.Builder,ResourceChange>, SdkBuilder<ResourceChange.Builder,ResourceChange>, SdkPojo
Enclosing class:
ResourceChange
@Mutable @NotThreadSafe public static interface ResourceChange.Builder extends SdkPojo, CopyableBuilder<ResourceChange.Builder,ResourceChange>

  • Method Details

    • policyAction

      ResourceChange.Builder policyAction(String policyAction)

      The action that will be taken on the physical resource when the change set is executed.

      • Delete The resource will be deleted.

      • Retain The resource will be retained.

      • Snapshot The resource will have a snapshot taken.

      • ReplaceAndDelete The resource will be replaced and then deleted.

      • ReplaceAndRetain The resource will be replaced and then retained.

      • ReplaceAndSnapshot The resource will be replaced and then have a snapshot taken.

      Parameters:
      policyAction - The action that will be taken on the physical resource when the change set is executed.

      • Delete The resource will be deleted.

      • Retain The resource will be retained.

      • Snapshot The resource will have a snapshot taken.

      • ReplaceAndDelete The resource will be replaced and then deleted.

      • ReplaceAndRetain The resource will be replaced and then retained.

      • ReplaceAndSnapshot The resource will be replaced and then have a snapshot taken.

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

    • policyAction

      ResourceChange.Builder policyAction(PolicyAction policyAction)

      The action that will be taken on the physical resource when the change set is executed.

      • Delete The resource will be deleted.

      • Retain The resource will be retained.

      • Snapshot The resource will have a snapshot taken.

      • ReplaceAndDelete The resource will be replaced and then deleted.

      • ReplaceAndRetain The resource will be replaced and then retained.

      • ReplaceAndSnapshot The resource will be replaced and then have a snapshot taken.

      Parameters:
      policyAction - The action that will be taken on the physical resource when the change set is executed.

      • Delete The resource will be deleted.

      • Retain The resource will be retained.

      • Snapshot The resource will have a snapshot taken.

      • ReplaceAndDelete The resource will be replaced and then deleted.

      • ReplaceAndRetain The resource will be replaced and then retained.

      • ReplaceAndSnapshot The resource will be replaced and then have a snapshot taken.

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

    • action

      ResourceChange.Builder action(String action)

      The action that CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), Remove (deletes a resource), Import (imports a resource), or Dynamic (exact action for the resource can't be determined).

      Parameters:
      action - The action that CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), Remove (deletes a resource), Import (imports a resource), or Dynamic (exact action for the resource can't be determined).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • action

      ResourceChange.Builder action(ChangeAction action)

      The action that CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), Remove (deletes a resource), Import (imports a resource), or Dynamic (exact action for the resource can't be determined).

      Parameters:
      action - The action that CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), Remove (deletes a resource), Import (imports a resource), or Dynamic (exact action for the resource can't be determined).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • logicalResourceId

      ResourceChange.Builder logicalResourceId(String logicalResourceId)

      The resource's logical ID, which is defined in the stack's template.

      Parameters:
      logicalResourceId - The resource's logical ID, which is defined in the stack's template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • physicalResourceId

      ResourceChange.Builder physicalResourceId(String physicalResourceId)

      The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.

      Parameters:
      physicalResourceId - The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceType

      ResourceChange.Builder resourceType(String resourceType)

      The type of CloudFormation resource, such as AWS::S3::Bucket.

      Parameters:
      resourceType - The type of CloudFormation resource, such as AWS::S3::Bucket.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • replacement

      ResourceChange.Builder replacement(String replacement)

      For the Modify action, indicates whether CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of the RequiresRecreation property in the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is Always and the Evaluation field is Static, Replacement is True. If the RequiresRecreation field is Always and the Evaluation field is Dynamic, Replacement is Conditional.

      If you have multiple changes with different RequiresRecreation values, the Replacement value depends on the change with the most impact. A RequiresRecreation value of Always has the most impact, followed by Conditional, and then Never.

      Parameters:
      replacement - For the Modify action, indicates whether CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of the RequiresRecreation property in the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is Always and the Evaluation field is Static, Replacement is True. If the RequiresRecreation field is Always and the Evaluation field is Dynamic, Replacement is Conditional.

      If you have multiple changes with different RequiresRecreation values, the Replacement value depends on the change with the most impact. A RequiresRecreation value of Always has the most impact, followed by Conditional, and then Never.

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

    • replacement

      ResourceChange.Builder replacement(Replacement replacement)

      For the Modify action, indicates whether CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of the RequiresRecreation property in the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is Always and the Evaluation field is Static, Replacement is True. If the RequiresRecreation field is Always and the Evaluation field is Dynamic, Replacement is Conditional.

      If you have multiple changes with different RequiresRecreation values, the Replacement value depends on the change with the most impact. A RequiresRecreation value of Always has the most impact, followed by Conditional, and then Never.

      Parameters:
      replacement - For the Modify action, indicates whether CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of the RequiresRecreation property in the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is Always and the Evaluation field is Static, Replacement is True. If the RequiresRecreation field is Always and the Evaluation field is Dynamic, Replacement is Conditional.

      If you have multiple changes with different RequiresRecreation values, the Replacement value depends on the change with the most impact. A RequiresRecreation value of Always has the most impact, followed by Conditional, and then Never.

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

    • scopeWithStrings

      ResourceChange.Builder scopeWithStrings(Collection<String> scope)

      For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.

      Parameters:
      scope - For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopeWithStrings

      ResourceChange.Builder scopeWithStrings(String... scope)

      For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.

      Parameters:
      scope - For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scope

      ResourceChange.Builder scope(Collection<ResourceAttribute> scope)

      For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.

      Parameters:
      scope - For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scope

      ResourceChange.Builder scope(ResourceAttribute... scope)

      For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.

      Parameters:
      scope - For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • details

      ResourceChange.Builder details(Collection<ResourceChangeDetail> details)

      For the Modify action, a list of ResourceChangeDetail structures that describes the changes that CloudFormation will make to the resource.

      Parameters:
      details - For the Modify action, a list of ResourceChangeDetail structures that describes the changes that CloudFormation will make to the resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • details

      ResourceChange.Builder details(ResourceChangeDetail... details)

      For the Modify action, a list of ResourceChangeDetail structures that describes the changes that CloudFormation will make to the resource.

      Parameters:
      details - For the Modify action, a list of ResourceChangeDetail structures that describes the changes that CloudFormation will make to the resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • details

      ResourceChange.Builder details(Consumer<ResourceChangeDetail.Builder>... details)

      For the Modify action, a list of ResourceChangeDetail structures that describes the changes that CloudFormation will make to the resource.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to details(List<ResourceChangeDetail>).

      Parameters:
      details - a consumer that will call methods on ResourceChangeDetail.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • changeSetId

      ResourceChange.Builder changeSetId(String changeSetId)

      The change set ID of the nested change set.

      Parameters:
      changeSetId - The change set ID of the nested change set.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • moduleInfo

      ResourceChange.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 ResourceChange.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:

    • beforeContext

      ResourceChange.Builder beforeContext(String beforeContext)

      An encoded JSON string that contains the context of the resource before the change is executed.

      Parameters:
      beforeContext - An encoded JSON string that contains the context of the resource before the change is executed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • afterContext

      ResourceChange.Builder afterContext(String afterContext)

      An encoded JSON string that contains the context of the resource after the change is executed.

      Parameters:
      afterContext - An encoded JSON string that contains the context of the resource after the change is executed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.