Interface UpdateOpenIdConnectProviderRequest.Builder

  • 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 both ContextProvider and RemoveContextProvider in 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 both ContextProvider and RemoveContextProvider in the same request.

      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 both ContextProvider and RemoveContextProvider in the same request.

      This is a convenience method that creates an instance of the ContextProvider.Builder avoiding the need to create one manually via ContextProvider.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to contextProvider(ContextProvider).

      Parameters:
      contextProvider - a consumer that will call methods on ContextProvider.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 both IdentityCenterInstanceArn and RemoveIdentityCenterInstance in 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 both IdentityCenterInstanceArn and RemoveIdentityCenterInstance in the same request.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • removeContextProvider

      UpdateOpenIdConnectProviderRequest.Builder removeContextProvider(Boolean removeContextProvider)

      Specifies whether to remove the existing context provider configuration from the OIDC provider. Set this value to true to remove the context provider.

      This parameter is mutually exclusive with ContextProvider. In a single request, specify either a new ContextProvider value or RemoveContextProvider, but not both.

      Parameters:
      removeContextProvider - Specifies whether to remove the existing context provider configuration from the OIDC provider. Set this value to true to remove the context provider.

      This parameter is mutually exclusive with ContextProvider. In a single request, specify either a new ContextProvider value or RemoveContextProvider, 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 true to remove the association.

      This parameter is mutually exclusive with IdentityCenterInstanceArn. In a single request, specify either a new IdentityCenterInstanceArn value or RemoveIdentityCenterInstance, but not both.

      Parameters:
      removeIdentityCenterInstance - Specifies whether to disassociate the IAM Identity Center instance from the OIDC provider. Set this value to true to remove the association.

      This parameter is mutually exclusive with IdentityCenterInstanceArn. In a single request, specify either a new IdentityCenterInstanceArn value or RemoveIdentityCenterInstance, but not both.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.