Interface UpdateOpenIdConnectProviderRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<UpdateOpenIdConnectProviderRequest.Builder,,UpdateOpenIdConnectProviderRequest> IamRequest.Builder,SdkBuilder<UpdateOpenIdConnectProviderRequest.Builder,,UpdateOpenIdConnectProviderRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
UpdateOpenIdConnectProviderRequest
-
Method Summary
Modifier and TypeMethodDescriptioncontextProvider(Consumer<ContextProvider.Builder> contextProvider) The trusted identity propagation context provider configuration to set on the OIDC provider.contextProvider(ContextProvider contextProvider) The trusted identity propagation context provider configuration to set on the OIDC provider.identityCenterInstanceArn(String identityCenterInstanceArn) The Amazon Resource Name (ARN) of the IAM Identity Center instance to associate with the OIDC provider.openIDConnectProviderArn(String openIDConnectProviderArn) The Amazon Resource Name (ARN) of the IAM OIDC provider resource object to update.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.removeContextProvider(Boolean removeContextProvider) Specifies whether to remove the existing context provider configuration from the OIDC provider.removeIdentityCenterInstance(Boolean removeIdentityCenterInstance) Specifies whether to disassociate the IAM Identity Center instance from the OIDC provider.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.iam.model.IamRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
openIDConnectProviderArn
UpdateOpenIdConnectProviderRequest.Builder openIDConnectProviderArn(String 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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
contextProvider
default UpdateOpenIdConnectProviderRequest.Builder contextProvider(Consumer<ContextProvider.Builder> 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
This is a convenience method that creates an instance of theRemoveContextProvider. Do not specify bothContextProviderandRemoveContextProviderin the same request.ContextProvider.Builderavoiding the need to create one manually viaContextProvider.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocontextProvider(ContextProvider).- Parameters:
contextProvider- a consumer that will call methods onContextProvider.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
identityCenterInstanceArn
UpdateOpenIdConnectProviderRequest.Builder identityCenterInstanceArn(String 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.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
removeContextProvider- Specifies whether to remove the existing context provider configuration from the OIDC provider. Set this value totrueto remove the context provider.This parameter is mutually exclusive with
ContextProvider. In a single request, specify either a newContextProvidervalue orRemoveContextProvider, but not both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
removeIdentityCenterInstance
UpdateOpenIdConnectProviderRequest.Builder removeIdentityCenterInstance(Boolean 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.- Parameters:
removeIdentityCenterInstance- Specifies whether to disassociate the IAM Identity Center instance from the OIDC provider. Set this value totrueto remove the association.This parameter is mutually exclusive with
IdentityCenterInstanceArn. In a single request, specify either a newIdentityCenterInstanceArnvalue orRemoveIdentityCenterInstance, but not both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
UpdateOpenIdConnectProviderRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateOpenIdConnectProviderRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-