Class UpdateOpenIdConnectProviderRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateOpenIdConnectProviderRequest.Builder,UpdateOpenIdConnectProviderRequest>

@Generated("software.amazon.awssdk:codegen") public final class UpdateOpenIdConnectProviderRequest extends IamRequest implements ToCopyableBuilder<UpdateOpenIdConnectProviderRequest.Builder,UpdateOpenIdConnectProviderRequest>
  • Method Details

    • openIDConnectProviderArn

      public final 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.

      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

      public final ContextProvider 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:
      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.

    • identityCenterInstanceArn

      public final 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.

      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 both IdentityCenterInstanceArn and RemoveIdentityCenterInstance in the same request.

    • removeContextProvider

      public final 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.

      Returns:
      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.

    • removeIdentityCenterInstance

      public final 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.

      Returns:
      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.

    • toBuilder

      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateOpenIdConnectProviderRequest.Builder,UpdateOpenIdConnectProviderRequest>
      Specified by:
      toBuilder in class IamRequest
      Returns:
      a builder for type T
    • builder

    • serializableBuilderClass

      public static Class<? extends UpdateOpenIdConnectProviderRequest.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.