Interface CreateApiKeyCredentialProviderRequest.Builder

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

  • Method Details

    • name

      CreateApiKeyCredentialProviderRequest.Builder name(String name)

      The name of the API key credential provider. The name must be unique within your account.

      Parameters:
      name - The name of the API key credential provider. The name must be unique within your account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • apiKey

      CreateApiKeyCredentialProviderRequest.Builder apiKey(String apiKey)

      The API key to use for authentication. This value is encrypted and stored securely.

      Parameters:
      apiKey - The API key to use for authentication. This value is encrypted and stored securely.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • apiKeySecretConfig

      CreateApiKeyCredentialProviderRequest.Builder apiKeySecretConfig(SecretReference apiKeySecretConfig)

      A reference to the Amazon Web Services Secrets Manager secret that stores the API key. This includes the secret ID and the JSON key used to extract the API key value from the secret. Required when apiKeySecretSource is set to EXTERNAL.

      Parameters:
      apiKeySecretConfig - A reference to the Amazon Web Services Secrets Manager secret that stores the API key. This includes the secret ID and the JSON key used to extract the API key value from the secret. Required when apiKeySecretSource is set to EXTERNAL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • apiKeySecretConfig

      default CreateApiKeyCredentialProviderRequest.Builder apiKeySecretConfig(Consumer<SecretReference.Builder> apiKeySecretConfig)

      A reference to the Amazon Web Services Secrets Manager secret that stores the API key. This includes the secret ID and the JSON key used to extract the API key value from the secret. Required when apiKeySecretSource is set to EXTERNAL.

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

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

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

    • apiKeySecretSource

      CreateApiKeyCredentialProviderRequest.Builder apiKeySecretSource(String apiKeySecretSource)

      The source type of the API key secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

      Parameters:
      apiKeySecretSource - The source type of the API key secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • apiKeySecretSource

      CreateApiKeyCredentialProviderRequest.Builder apiKeySecretSource(SecretSourceType apiKeySecretSource)

      The source type of the API key secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

      Parameters:
      apiKeySecretSource - The source type of the API key secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

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

      A map of tag keys and values to assign to the API key credential provider. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

      Parameters:
      tags - A map of tag keys and values to assign to the API key credential provider. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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