Package software.amazon.awssdk.services.apigateway.model

Interface CreateApiKeyRequest.Builder

All Superinterfaces:
ApiGatewayRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<CreateApiKeyRequest.Builder,CreateApiKeyRequest>, SdkBuilder<CreateApiKeyRequest.Builder,CreateApiKeyRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateApiKeyRequest
public static interface CreateApiKeyRequest.Builder extends ApiGatewayRequest.Builder, SdkPojo, CopyableBuilder<CreateApiKeyRequest.Builder,CreateApiKeyRequest>

  • Method Details

    • name

      CreateApiKeyRequest.Builder name(String name)

      The name of the ApiKey.

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

    • description

      CreateApiKeyRequest.Builder description(String description)

      The description of the ApiKey.

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

    • enabled

      CreateApiKeyRequest.Builder enabled(Boolean enabled)

      Specifies whether the ApiKey can be used by callers.

      Parameters:
      enabled - Specifies whether the ApiKey can be used by callers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • generateDistinctId

      CreateApiKeyRequest.Builder generateDistinctId(Boolean generateDistinctId)

      Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.

      Parameters:
      generateDistinctId - Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • value

      CreateApiKeyRequest.Builder value(String value)

      Specifies a value of the API key.

      Parameters:
      value - Specifies a value of the API key.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stageKeys

      CreateApiKeyRequest.Builder stageKeys(Collection<StageKey> stageKeys)

      DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

      Parameters:
      stageKeys - DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stageKeys

      CreateApiKeyRequest.Builder stageKeys(StageKey... stageKeys)

      DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

      Parameters:
      stageKeys - DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stageKeys

      CreateApiKeyRequest.Builder stageKeys(Consumer<StageKey.Builder>... stageKeys)

      DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

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

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

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

    • customerId

      CreateApiKeyRequest.Builder customerId(String customerId)

      An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.

      Parameters:
      customerId - An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

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

      The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

      Parameters:
      tags - The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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