Class ContextProvider
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ContextProvider.Builder,ContextProvider>
Contains the trusted identity propagation context provider configuration for a SAML or OpenID Connect (OIDC) identity provider. The context provider defines how the subject is derived and how keys from the external identity provider's assertion or token are mapped into trusted context keys.
This data type is used as a request parameter in the CreateOpenIDConnectProvider, UpdateOpenIDConnectProvider, CreateSAMLProvider, and UpdateSAMLProvider operations, and as a response element in the GetOpenIDConnectProvider and GetSAMLProvider operations.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic ContextProvider.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 booleanFor responses, this returns true if the service returned a value for the KeyDefinitionList property.final List<ContextProviderKeyDefinition> A list of source-to-target key mappings that define how keys from the external identity provider's assertion or token are mapped into trusted context keys.static Class<? extends ContextProvider.Builder> final StringThe source key that is used to derive the subject for the injected trusted context.final StringThe source key that supplies the subject type from the external identity provider's assertion or token.final StringA static value for the subject type, such asuserorworkload.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
-
hasKeyDefinitionList
public final boolean hasKeyDefinitionList()For responses, this returns true if the service returned a value for the KeyDefinitionList 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. -
keyDefinitionList
A list of source-to-target key mappings that define how keys from the external identity provider's assertion or token are mapped into trusted context keys. You can specify from 0 to 10 mappings.
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
hasKeyDefinitionList()method.- Returns:
- A list of source-to-target key mappings that define how keys from the external identity provider's assertion or token are mapped into trusted context keys. You can specify from 0 to 10 mappings.
-
subjectSourceKey
The source key that is used to derive the subject for the injected trusted context. This value identifies the claim or attribute in the external identity provider's assertion or token that supplies the subject.
The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters:
_ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.- Returns:
- The source key that is used to derive the subject for the injected trusted context. This value identifies
the claim or attribute in the external identity provider's assertion or token that supplies the
subject.
The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters:
_ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.
-
subjectTypeValue
A static value for the subject type, such as
userorworkload.This parameter is optional and is mutually exclusive with
SubjectTypeSourceKey. Specify eitherSubjectTypeValueorSubjectTypeSourceKey, but not both.- Returns:
- A static value for the subject type, such as
userorworkload.This parameter is optional and is mutually exclusive with
SubjectTypeSourceKey. Specify eitherSubjectTypeValueorSubjectTypeSourceKey, but not both.
-
subjectTypeSourceKey
The source key that supplies the subject type from the external identity provider's assertion or token.
The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters:
_ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.This parameter is mutually exclusive with
SubjectTypeValue. Specify eitherSubjectTypeSourceKeyorSubjectTypeValue, but not both.- Returns:
- The source key that supplies the subject type from the external identity provider's assertion or
token.
The key can contain only ASCII letters (A-Z, a-z), numbers (0-9), single spaces, and the following characters:
_ . : / = + - @ #. It can't start or end with a space or contain two spaces in a row.This parameter is mutually exclusive with
SubjectTypeValue. Specify eitherSubjectTypeSourceKeyorSubjectTypeValue, but not both.
-
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<ContextProvider.Builder,ContextProvider> - 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.
-