Class UpdateOpenIdConnectProviderRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<UpdateOpenIdConnectProviderRequest.Builder,UpdateOpenIdConnectProviderRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final ContextProviderThe trusted identity propagation context provider configuration to set on the OIDC provider.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) Used to retrieve the value of a field from any class that extendsSdkRequest.final inthashCode()final StringThe Amazon Resource Name (ARN) of the IAM Identity Center instance to associate with the OIDC provider.final StringThe Amazon Resource Name (ARN) of the IAM OIDC provider resource object to update.final BooleanSpecifies whether to remove the existing context provider configuration from the OIDC provider.final BooleanSpecifies whether to disassociate the IAM Identity Center instance from the OIDC provider.static Class<? extends UpdateOpenIdConnectProviderRequest.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 class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
openIDConnectProviderArn
The Amazon Resource Name (ARN) of the IAM OIDC provider resource object to update. You can get a list of OIDC provider resource ARNs by using the ListOpenIDConnectProviders operation.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
- Returns:
- The Amazon Resource Name (ARN) of the IAM OIDC provider resource object to update. You can get a list of
OIDC provider resource ARNs by using the ListOpenIDConnectProviders operation.
For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
-
contextProvider
The trusted identity propagation context provider configuration to set on the OIDC provider. This configuration defines the subject mapping and the source-to-target key mappings that are used when trusted context is injected. For more information, see ContextProvider.
To remove the existing context provider instead of replacing it, use
RemoveContextProvider. Do not specify bothContextProviderandRemoveContextProviderin the same request.- Returns:
- The trusted identity propagation context provider configuration to set on the OIDC provider. This
configuration defines the subject mapping and the source-to-target key mappings that are used when
trusted context is injected. For more information, see ContextProvider.
To remove the existing context provider instead of replacing it, use
RemoveContextProvider. Do not specify bothContextProviderandRemoveContextProviderin the same request.
-
identityCenterInstanceArn
The Amazon Resource Name (ARN) of the IAM Identity Center instance to associate with the OIDC provider.
For the format, see InstanceMetadata in the IAM Identity Center API Reference.
To disassociate the currently associated instance instead of changing it, use
RemoveIdentityCenterInstance. Do not specify bothIdentityCenterInstanceArnandRemoveIdentityCenterInstancein the same request.- Returns:
- The Amazon Resource Name (ARN) of the IAM Identity Center instance to associate with the OIDC
provider.
For the format, see InstanceMetadata in the IAM Identity Center API Reference.
To disassociate the currently associated instance instead of changing it, use
RemoveIdentityCenterInstance. Do not specify bothIdentityCenterInstanceArnandRemoveIdentityCenterInstancein the same request.
-
removeContextProvider
Specifies whether to remove the existing context provider configuration from the OIDC provider. Set this value to
trueto remove the context provider.This parameter is mutually exclusive with
ContextProvider. In a single request, specify either a newContextProvidervalue orRemoveContextProvider, but not both.- Returns:
- Specifies whether to remove the existing context provider configuration from the OIDC provider. Set this
value to
trueto remove the context provider.This parameter is mutually exclusive with
ContextProvider. In a single request, specify either a newContextProvidervalue orRemoveContextProvider, but not both.
-
removeIdentityCenterInstance
Specifies whether to disassociate the IAM Identity Center instance from the OIDC provider. Set this value to
trueto remove the association.This parameter is mutually exclusive with
IdentityCenterInstanceArn. In a single request, specify either a newIdentityCenterInstanceArnvalue orRemoveIdentityCenterInstance, but not both.- Returns:
- Specifies whether to disassociate the IAM Identity Center instance from the OIDC provider. Set this value
to
trueto remove the association.This parameter is mutually exclusive with
IdentityCenterInstanceArn. In a single request, specify either a newIdentityCenterInstanceArnvalue orRemoveIdentityCenterInstance, 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<UpdateOpenIdConnectProviderRequest.Builder,UpdateOpenIdConnectProviderRequest> - Specified by:
toBuilderin classIamRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends UpdateOpenIdConnectProviderRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
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
Description copied from class:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. 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, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- 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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-