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. You must provide this property together with includeResources. Neither is valid without the other.

      Parameters:
      executionRole - The name or Amazon Resource Name (ARN) of the IAM role that's used to update image state. You must provide this property together with includeResources. Neither is valid without the other.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • includeResources

      StartResourceStateUpdateRequest.Builder includeResources(ResourceStateUpdateIncludeResources includeResources)

      Specifies which underlying resources to update, in addition to the Image Builder image resource itself. Snapshots and containers are only valid for the DELETED state. To set an image to DELETED, you must include its underlying resources. To delete only the Image Builder image record, use the DeleteImage operation instead.

      Parameters:
      includeResources - Specifies which underlying resources to update, in addition to the Image Builder image resource itself. Snapshots and containers are only valid for the DELETED state. To set an image to DELETED, you must include its underlying resources. To delete only the Image Builder image record, use the DeleteImage operation 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 underlying resources to update, in addition to the Image Builder image resource itself. Snapshots and containers are only valid for the DELETED state. To set an image to DELETED, you must include its underlying resources. To delete only the Image Builder image record, use the DeleteImage operation 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)

      Rules that Image Builder evaluates against each of the image's AMIs. Matching AMIs and their snapshots are skipped. Exclusion rules only take effect when the request includes AMIs. If the target state is DELETED and any resource was skipped, the Image Builder image resource itself is also retained. For the DEPRECATED and DISABLED target states, Image Builder updates the image resource's state regardless of exclusions.

      Parameters:
      exclusionRules - Rules that Image Builder evaluates against each of the image's AMIs. Matching AMIs and their snapshots are skipped. Exclusion rules only take effect when the request includes AMIs. If the target state is DELETED and any resource was skipped, the Image Builder image resource itself is also retained. For the DEPRECATED and DISABLED target states, Image Builder updates the image resource's state regardless of exclusions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • exclusionRules

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

      Rules that Image Builder evaluates against each of the image's AMIs. Matching AMIs and their snapshots are skipped. Exclusion rules only take effect when the request includes AMIs. If the target state is DELETED and any resource was skipped, the Image Builder image resource itself is also retained. For the DEPRECATED and DISABLED target states, Image Builder updates the image resource's state regardless of exclusions.

      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)

      The timestamp that indicates when resources are updated by a lifecycle action. This property is valid only when the target status is DEPRECATED, and the value must be a future time. If you don't specify a value, Image Builder begins the state update right away. For a scheduled deprecation, included AMIs get their EC2 deprecation time set immediately, and Image Builder schedules the image resource to transition to DEPRECATED at that time.

      Parameters:
      updateAt - The timestamp that indicates when resources are updated by a lifecycle action. This property is valid only when the target status is DEPRECATED, and the value must be a future time. If you don't specify a value, Image Builder begins the state update right away. For a scheduled deprecation, included AMIs get their EC2 deprecation time set immediately, and Image Builder schedules the image resource to transition to DEPRECATED at that time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      StartResourceStateUpdateRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      Parameters:
      clientToken - A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. 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.