Interface CreateScopeRequest.Builder

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

  • Method Details

    • clientToken

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

    • scopeName

      CreateScopeRequest.Builder scopeName(String scopeName)

      The name of the scope.

      Parameters:
      scopeName - The name of the scope.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopeDescription

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

      CreateScopeRequest.Builder scopeConfiguration(ScopeConfiguration scopeConfiguration)

      The configuration that defines which accounts and resources are in scope.

      Parameters:
      scopeConfiguration - The configuration that defines which accounts and resources are in scope.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopeConfiguration

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

      The configuration that defines which accounts and resources are in scope.

      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

      CreateScopeRequest.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). Default: true.

      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). Default: true.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateScopeRequest.Builder tags(Map<String,String> tags)

      The tags to add to the resource when it is created.

      Parameters:
      tags - The tags to add to the resource when it is created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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