Interface UpdateScopeRequest.Builder

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

  • Method Details

    • scopeIdentifier

      UpdateScopeRequest.Builder scopeIdentifier(String scopeIdentifier)

      The identifier of the scope. This is the scope's Amazon Resource Name (ARN).

      Parameters:
      scopeIdentifier - The identifier of the scope. This is the scope's Amazon Resource Name (ARN).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updateToken

      UpdateScopeRequest.Builder updateToken(String updateToken)

      A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.

      Parameters:
      updateToken - A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopeDescription

      UpdateScopeRequest.Builder scopeDescription(String scopeDescription)

      A description of the scope.

      Parameters:
      scopeDescription - A description of the scope.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopeConfiguration

      UpdateScopeRequest.Builder scopeConfiguration(ScopeConfiguration scopeConfiguration)

      The configuration that defines which accounts and resources are in scope. If you don't include this member, the scope keeps its existing configuration.

      A new configuration can change which accounts and resources are selected, but it can't add or remove the account filter itself: a scope created for multi-account use stays multi-account, and a scope created for single-account use stays single-account.

      Parameters:
      scopeConfiguration - The configuration that defines which accounts and resources are in scope. If you don't include this member, the scope keeps its existing configuration.

      A new configuration can change which accounts and resources are selected, but it can't add or remove the account filter itself: a scope created for multi-account use stays multi-account, and a scope created for single-account use stays single-account.

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

    • scopeConfiguration

      default UpdateScopeRequest.Builder scopeConfiguration(Consumer<ScopeConfiguration.Builder> scopeConfiguration)

      The configuration that defines which accounts and resources are in scope. If you don't include this member, the scope keeps its existing configuration.

      A new configuration can change which accounts and resources are selected, but it can't add or remove the account filter itself: a scope created for multi-account use stays multi-account, and a scope created for single-account use stays single-account.

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

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

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

    • isPublished

      UpdateScopeRequest.Builder isPublished(Boolean isPublished)

      Specifies whether to publish the resource. When true, the resource is saved in published ( ACTIVE) state. When false, it is saved as a draft (DRAFT).

      Parameters:
      isPublished - Specifies whether to publish the resource. When true, the resource is saved in published (ACTIVE) state. When false, it is saved as a draft (DRAFT).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      UpdateScopeRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.

      Parameters:
      clientToken - A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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