Interface CreateApiKeyCredentialProviderResponse.Builder

All Superinterfaces:
AwsResponse.Builder, BedrockAgentCoreControlResponse.Builder, Buildable, CopyableBuilder<CreateApiKeyCredentialProviderResponse.Builder,CreateApiKeyCredentialProviderResponse>, SdkBuilder<CreateApiKeyCredentialProviderResponse.Builder,CreateApiKeyCredentialProviderResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
CreateApiKeyCredentialProviderResponse
@Mutable @NotThreadSafe public static interface CreateApiKeyCredentialProviderResponse.Builder extends BedrockAgentCoreControlResponse.Builder, SdkPojo, CopyableBuilder<CreateApiKeyCredentialProviderResponse.Builder,CreateApiKeyCredentialProviderResponse>

  • Method Details

    • apiKeySecretArn

      CreateApiKeyCredentialProviderResponse.Builder apiKeySecretArn(Secret apiKeySecretArn)

      The Amazon Resource Name (ARN) of the secret containing the API key.

      Parameters:
      apiKeySecretArn - The Amazon Resource Name (ARN) of the secret containing the API key.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • apiKeySecretArn

      default CreateApiKeyCredentialProviderResponse.Builder apiKeySecretArn(Consumer<Secret.Builder> apiKeySecretArn)

      The Amazon Resource Name (ARN) of the secret containing the API key.

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

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

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

    • apiKeySecretJsonKey

      CreateApiKeyCredentialProviderResponse.Builder apiKeySecretJsonKey(String apiKeySecretJsonKey)

      The JSON key used to extract the API key value from the Amazon Web Services Secrets Manager secret.

      Parameters:
      apiKeySecretJsonKey - The JSON key used to extract the API key value from the Amazon Web Services Secrets Manager secret.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • apiKeySecretSource

      CreateApiKeyCredentialProviderResponse.Builder apiKeySecretSource(String apiKeySecretSource)

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

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

    • apiKeySecretSource

      CreateApiKeyCredentialProviderResponse.Builder apiKeySecretSource(SecretSourceType apiKeySecretSource)

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

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

    • name

      CreateApiKeyCredentialProviderResponse.Builder name(String name)

      The name of the created API key credential provider.

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

    • credentialProviderArn

      CreateApiKeyCredentialProviderResponse.Builder credentialProviderArn(String credentialProviderArn)

      The Amazon Resource Name (ARN) of the created API key credential provider.

      Parameters:
      credentialProviderArn - The Amazon Resource Name (ARN) of the created API key credential provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.