Class UpdateApiKeyCredentialProviderRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.bedrockagentcorecontrol.model.BedrockAgentCoreControlRequest
software.amazon.awssdk.services.bedrockagentcorecontrol.model.UpdateApiKeyCredentialProviderRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateApiKeyCredentialProviderRequest.Builder,UpdateApiKeyCredentialProviderRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateApiKeyCredentialProviderRequest extends BedrockAgentCoreControlRequest implements ToCopyableBuilder<UpdateApiKeyCredentialProviderRequest.Builder,UpdateApiKeyCredentialProviderRequest>

  • Method Details

    • name

      public final String name()

      The name of the API key credential provider to update.

      Returns:
      The name of the API key credential provider to update.

    • apiKey

      public final String apiKey()

      The new API key to use for authentication. This value replaces the existing API key and is encrypted and stored securely.

      Returns:
      The new API key to use for authentication. This value replaces the existing API key and is encrypted and stored securely.

    • apiKeySecretConfig

      public final 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.

      Returns:
      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.

    • apiKeySecretSource

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, apiKeySecretSource will return SecretSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from apiKeySecretSourceAsString().

      Returns:
      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.
      See Also:

    • apiKeySecretSourceAsString

      public final String apiKeySecretSourceAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, apiKeySecretSource will return SecretSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from apiKeySecretSourceAsString().

      Returns:
      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.
      See Also:

    • toBuilder

      public UpdateApiKeyCredentialProviderRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateApiKeyCredentialProviderRequest.Builder,UpdateApiKeyCredentialProviderRequest>
      Specified by:
      toBuilder in class BedrockAgentCoreControlRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateApiKeyCredentialProviderRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateApiKeyCredentialProviderRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.