Class AuthenticationConfigurationInput
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<AuthenticationConfigurationInput.Builder,AuthenticationConfigurationInput>
A structure containing the authentication configuration in the CreateConnection request.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal AuthenticationTypeA structure containing the authentication configuration in the CreateConnection request.final StringA structure containing the authentication configuration in the CreateConnection request.The credentials used when the authentication type is basic authentication.builder()The credentials used when the authentication type is custom authentication.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 booleanFor responses, this returns true if the service returned a value for the CustomAuthenticationCredentials property.final inthashCode()final StringThe ARN of the KMS key used to encrypt the connection.final OAuth2PropertiesInputThe properties for OAuth2 authentication in the CreateConnection request.final StringThe secret manager ARN to store credentials in the CreateConnection request.static Class<? extends AuthenticationConfigurationInput.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
-
authenticationType
A structure containing the authentication configuration in the CreateConnection request.
If the service returns an enum value that is not available in the current SDK version,
authenticationTypewill returnAuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromauthenticationTypeAsString().- Returns:
- A structure containing the authentication configuration in the CreateConnection request.
- See Also:
-
authenticationTypeAsString
A structure containing the authentication configuration in the CreateConnection request.
If the service returns an enum value that is not available in the current SDK version,
authenticationTypewill returnAuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromauthenticationTypeAsString().- Returns:
- A structure containing the authentication configuration in the CreateConnection request.
- See Also:
-
oAuth2Properties
The properties for OAuth2 authentication in the CreateConnection request.
- Returns:
- The properties for OAuth2 authentication in the CreateConnection request.
-
secretArn
The secret manager ARN to store credentials in the CreateConnection request.
- Returns:
- The secret manager ARN to store credentials in the CreateConnection request.
-
kmsKeyArn
The ARN of the KMS key used to encrypt the connection. Only taken an as input in the request and stored in the Secret Manager.
- Returns:
- The ARN of the KMS key used to encrypt the connection. Only taken an as input in the request and stored in the Secret Manager.
-
basicAuthenticationCredentials
The credentials used when the authentication type is basic authentication.
- Returns:
- The credentials used when the authentication type is basic authentication.
-
hasCustomAuthenticationCredentials
public final boolean hasCustomAuthenticationCredentials()For responses, this returns true if the service returned a value for the CustomAuthenticationCredentials property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
customAuthenticationCredentials
The credentials used when the authentication type is custom authentication.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasCustomAuthenticationCredentials()method.- Returns:
- The credentials used when the authentication type is custom authentication.
-
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<AuthenticationConfigurationInput.Builder,AuthenticationConfigurationInput> - 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.
-