Class BasicAuth
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<BasicAuth.Builder,BasicAuth>
Configuration for HTTP Basic Authentication using credentials stored in Amazon Web Services Secrets Manager. The
secret must contain a JSON object with username and password string fields. Username allows
alphanumeric characters and @._+=- symbols (pattern: ^[a-zA-Z0-9@._+=\-]+$). Password
allows alphanumeric characters and @._+=-!#$%&* symbols (pattern:
^[a-zA-Z0-9@._+=\-!#$%&*]+$). Both fields have a maximum length of 256 characters.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic BasicAuth.Builderbuilder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final StringThe Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing proxy credentials.static Class<? extends BasicAuth.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
secretArn
The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing proxy credentials. The secret must be a JSON object with
usernameandpasswordstring fields that meet validation requirements. The caller must havesecretsmanager:GetSecretValuepermission for this ARN. Example secret format:{"username": "proxy_user", "password": "secure_password"}- Returns:
- The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing proxy
credentials. The secret must be a JSON object with
usernameandpasswordstring fields that meet validation requirements. The caller must havesecretsmanager:GetSecretValuepermission for this ARN. Example secret format:{"username": "proxy_user", "password": "secure_password"}
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<BasicAuth.Builder,BasicAuth> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-