Interface StartResourceStateUpdateRequest.Builder

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

  • Method Details

    • resourceArn

      StartResourceStateUpdateRequest.Builder resourceArn(String resourceArn)

      The Amazon Resource Name (ARN) of the image build version to update. The image must be in one of these terminal states: AVAILABLE, DEPRECATED, DISABLED, FAILED, or CANCELLED. Images with FAILED or CANCELLED status can transition only to DELETED.

      Parameters:
      resourceArn - The Amazon Resource Name (ARN) of the image build version to update. The image must be in one of these terminal states: AVAILABLE, DEPRECATED, DISABLED, FAILED, or CANCELLED. Images with FAILED or CANCELLED status can transition only to DELETED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • state

      StartResourceStateUpdateRequest.Builder state(ResourceState state)

      Specifies the lifecycle action to take for this request. For AMI-based images, valid values are AVAILABLE, DEPRECATED, DISABLED, and DELETED. For container-based images, only DELETED is supported.

      Parameters:
      state - Specifies the lifecycle action to take for this request. For AMI-based images, valid values are AVAILABLE, DEPRECATED, DISABLED, and DELETED. For container-based images, only DELETED is supported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • state

      default StartResourceStateUpdateRequest.Builder state(Consumer<ResourceState.Builder> state)

      Specifies the lifecycle action to take for this request. For AMI-based images, valid values are AVAILABLE, DEPRECATED, DISABLED, and DELETED. For container-based images, only DELETED is supported.

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

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

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

    • executionRole

      StartResourceStateUpdateRequest.Builder executionRole(String executionRole)

      The name or Amazon Resource Name (ARN) of the IAM role that’s used to update image state.

      Parameters:
      executionRole - The name or Amazon Resource Name (ARN) of the IAM role that’s used to update image state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • includeResources

      StartResourceStateUpdateRequest.Builder includeResources(ResourceStateUpdateIncludeResources includeResources)

      Specifies which image resources to include in the state update. When specified, the lifecycle action applies to underlying resources. These resources include AMIs, snapshots, and containers in addition to the Image Builder image resource. Requires executionRole to also be specified. To delete an image and its underlying resources, you must specify includeResources. To delete only the Image Builder image record without affecting underlying resources, use the DeleteImage API instead.

      Parameters:
      includeResources - Specifies which image resources to include in the state update. When specified, the lifecycle action applies to underlying resources. These resources include AMIs, snapshots, and containers in addition to the Image Builder image resource. Requires executionRole to also be specified. To delete an image and its underlying resources, you must specify includeResources. To delete only the Image Builder image record without affecting underlying resources, use the DeleteImage API instead.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • includeResources

      default StartResourceStateUpdateRequest.Builder includeResources(Consumer<ResourceStateUpdateIncludeResources.Builder> includeResources)

      Specifies which image resources to include in the state update. When specified, the lifecycle action applies to underlying resources. These resources include AMIs, snapshots, and containers in addition to the Image Builder image resource. Requires executionRole to also be specified. To delete an image and its underlying resources, you must specify includeResources. To delete only the Image Builder image record without affecting underlying resources, use the DeleteImage API instead.

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

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

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

    • exclusionRules

      StartResourceStateUpdateRequest.Builder exclusionRules(ResourceStateUpdateExclusionRules exclusionRules)

      Skip action on the image resource and associated resources if specified exclusion rules are met.

      Parameters:
      exclusionRules - Skip action on the image resource and associated resources if specified exclusion rules are met.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • exclusionRules

      default StartResourceStateUpdateRequest.Builder exclusionRules(Consumer<ResourceStateUpdateExclusionRules.Builder> exclusionRules)

      Skip action on the image resource and associated resources if specified exclusion rules are met.

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

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

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

    • updateAt

      StartResourceStateUpdateRequest.Builder updateAt(Instant updateAt)

      Specifies the timestamp when the state transition takes effect. Use this parameter only when the target status is DEPRECATED. The value must be a future time.

      Parameters:
      updateAt - Specifies the timestamp when the state transition takes effect. Use this parameter only when the target status is DEPRECATED. The value must be a future time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      StartResourceStateUpdateRequest.Builder clientToken(String clientToken)

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      Parameters:
      clientToken - Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      StartResourceStateUpdateRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartResourceStateUpdateRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.