Interface ApiKeyCredentialProvider.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ApiKeyCredentialProvider.Builder,
,ApiKeyCredentialProvider> SdkBuilder<ApiKeyCredentialProvider.Builder,
,ApiKeyCredentialProvider> SdkPojo
- Enclosing class:
ApiKeyCredentialProvider
@Mutable
@NotThreadSafe
public static interface ApiKeyCredentialProvider.Builder
extends SdkPojo, CopyableBuilder<ApiKeyCredentialProvider.Builder,ApiKeyCredentialProvider>
-
Method Summary
Modifier and TypeMethodDescriptioncredentialLocation
(String credentialLocation) The location of the API key credential.credentialLocation
(ApiKeyCredentialLocation credentialLocation) The location of the API key credential.credentialParameterName
(String credentialParameterName) The name of the credential parameter for the API key.credentialPrefix
(String credentialPrefix) The prefix for the API key credential.providerArn
(String providerArn) The Amazon Resource Name (ARN) of the API key credential provider.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
providerArn
The Amazon Resource Name (ARN) of the API key credential provider. This ARN identifies the provider in Amazon Web Services.
- Parameters:
providerArn
- The Amazon Resource Name (ARN) of the API key credential provider. This ARN identifies the provider in Amazon Web Services.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
credentialParameterName
The name of the credential parameter for the API key. This parameter name is used when sending the API key to the target endpoint.
- Parameters:
credentialParameterName
- The name of the credential parameter for the API key. This parameter name is used when sending the API key to the target endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
credentialPrefix
The prefix for the API key credential. This prefix is added to the API key when sending it to the target endpoint.
- Parameters:
credentialPrefix
- The prefix for the API key credential. This prefix is added to the API key when sending it to the target endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
credentialLocation
The location of the API key credential. This field specifies where in the request the API key should be placed.
- Parameters:
credentialLocation
- The location of the API key credential. This field specifies where in the request the API key should be placed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
credentialLocation
The location of the API key credential. This field specifies where in the request the API key should be placed.
- Parameters:
credentialLocation
- The location of the API key credential. This field specifies where in the request the API key should be placed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-