Interface StackResourceDrift.Builder

  • Method Details

    • stackId

      The ID of the stack.

      Parameters:
      stackId - The ID of the stack.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • logicalResourceId

      StackResourceDrift.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

      StackResourceDrift.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.
    • physicalResourceIdContext

      StackResourceDrift.Builder physicalResourceIdContext(Collection<PhysicalResourceIdContextKeyValuePair> physicalResourceIdContext)

      Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context key-value pair specifies a unique resource that contains the targeted resource.

      Parameters:
      physicalResourceIdContext - Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context key-value pair specifies a unique resource that contains the targeted resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • physicalResourceIdContext

      StackResourceDrift.Builder physicalResourceIdContext(PhysicalResourceIdContextKeyValuePair... physicalResourceIdContext)

      Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context key-value pair specifies a unique resource that contains the targeted resource.

      Parameters:
      physicalResourceIdContext - Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context key-value pair specifies a unique resource that contains the targeted resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • physicalResourceIdContext

      StackResourceDrift.Builder physicalResourceIdContext(Consumer<PhysicalResourceIdContextKeyValuePair.Builder>... physicalResourceIdContext)

      Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context key-value pair specifies a unique resource that contains the targeted resource.

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

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

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

      StackResourceDrift.Builder resourceType(String resourceType)

      The type of the resource.

      Parameters:
      resourceType - The type of the resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • expectedProperties

      StackResourceDrift.Builder expectedProperties(String expectedProperties)

      A JSON structure that contains the expected property values of the stack resource, as defined in the stack template and any values specified as template parameters.

      For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

      Parameters:
      expectedProperties - A JSON structure that contains the expected property values of the stack resource, as defined in the stack template and any values specified as template parameters.

      For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

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

      StackResourceDrift.Builder actualProperties(String actualProperties)

      A JSON structure that contains the actual property values of the stack resource.

      For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

      Parameters:
      actualProperties - A JSON structure that contains the actual property values of the stack resource.

      For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

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

      StackResourceDrift.Builder propertyDifferences(Collection<PropertyDifference> propertyDifferences)

      A collection of the resource properties whose actual values differ from their expected values. These will be present only for resources whose StackResourceDriftStatus is MODIFIED.

      Parameters:
      propertyDifferences - A collection of the resource properties whose actual values differ from their expected values. These will be present only for resources whose StackResourceDriftStatus is MODIFIED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • propertyDifferences

      StackResourceDrift.Builder propertyDifferences(PropertyDifference... propertyDifferences)

      A collection of the resource properties whose actual values differ from their expected values. These will be present only for resources whose StackResourceDriftStatus is MODIFIED.

      Parameters:
      propertyDifferences - A collection of the resource properties whose actual values differ from their expected values. These will be present only for resources whose StackResourceDriftStatus is MODIFIED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • propertyDifferences

      StackResourceDrift.Builder propertyDifferences(Consumer<PropertyDifference.Builder>... propertyDifferences)

      A collection of the resource properties whose actual values differ from their expected values. These will be present only for resources whose StackResourceDriftStatus is MODIFIED.

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

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

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

      StackResourceDrift.Builder stackResourceDriftStatus(String stackResourceDriftStatus)

      Status of the resource's actual configuration compared to its expected configuration.

      • DELETED: The resource differs from its expected template configuration because the resource has been deleted.

      • MODIFIED: One or more resource properties differ from their expected values (as defined in the stack template and any values specified as template parameters).

      • IN_SYNC: The resource's actual configuration matches its expected template configuration.

      • NOT_CHECKED: CloudFormation does not currently return this value.

      • UNKNOWN: CloudFormation could not run drift detection for the resource. See the DriftStatusReason for details.

      Parameters:
      stackResourceDriftStatus - Status of the resource's actual configuration compared to its expected configuration.

      • DELETED: The resource differs from its expected template configuration because the resource has been deleted.

      • MODIFIED: One or more resource properties differ from their expected values (as defined in the stack template and any values specified as template parameters).

      • IN_SYNC: The resource's actual configuration matches its expected template configuration.

      • NOT_CHECKED: CloudFormation does not currently return this value.

      • UNKNOWN: CloudFormation could not run drift detection for the resource. See the DriftStatusReason for details.

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

      StackResourceDrift.Builder stackResourceDriftStatus(StackResourceDriftStatus stackResourceDriftStatus)

      Status of the resource's actual configuration compared to its expected configuration.

      • DELETED: The resource differs from its expected template configuration because the resource has been deleted.

      • MODIFIED: One or more resource properties differ from their expected values (as defined in the stack template and any values specified as template parameters).

      • IN_SYNC: The resource's actual configuration matches its expected template configuration.

      • NOT_CHECKED: CloudFormation does not currently return this value.

      • UNKNOWN: CloudFormation could not run drift detection for the resource. See the DriftStatusReason for details.

      Parameters:
      stackResourceDriftStatus - Status of the resource's actual configuration compared to its expected configuration.

      • DELETED: The resource differs from its expected template configuration because the resource has been deleted.

      • MODIFIED: One or more resource properties differ from their expected values (as defined in the stack template and any values specified as template parameters).

      • IN_SYNC: The resource's actual configuration matches its expected template configuration.

      • NOT_CHECKED: CloudFormation does not currently return this value.

      • UNKNOWN: CloudFormation could not run drift detection for the resource. See the DriftStatusReason for details.

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

      StackResourceDrift.Builder timestamp(Instant timestamp)

      Time at which CloudFormation performed drift detection on the stack resource.

      Parameters:
      timestamp - Time at which CloudFormation performed drift detection on the stack resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • moduleInfo

      StackResourceDrift.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 StackResourceDrift.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:
    • driftStatusReason

      StackResourceDrift.Builder driftStatusReason(String driftStatusReason)

      The reason for the drift status.

      Parameters:
      driftStatusReason - The reason for the drift status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.