Class: Aws::IAM::Types::UpdateOpenIDConnectProviderRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#context_provider ⇒ Types::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.



13694
13695
13696
13697
13698
13699
13700
13701
13702
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 13694

class UpdateOpenIDConnectProviderRequest < Struct.new(
  :open_id_connect_provider_arn,
  :context_provider,
  :identity_center_instance_arn,
  :remove_context_provider,
  :remove_identity_center_instance)
  SENSITIVE = []
  include Aws::Structure
end

#identity_center_instance_arn ⇒ String

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:

  • (String)


13694
13695
13696
13697
13698
13699
13700
13701
13702
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 13694

class UpdateOpenIDConnectProviderRequest < Struct.new(
  :open_id_connect_provider_arn,
  :context_provider,
  :identity_center_instance_arn,
  :remove_context_provider,
  :remove_identity_center_instance)
  SENSITIVE = []
  include Aws::Structure
end

#open_id_connect_provider_arn ⇒ String

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:

  • (String)


13694
13695
13696
13697
13698
13699
13700
13701
13702
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 13694

class UpdateOpenIDConnectProviderRequest < Struct.new(
  :open_id_connect_provider_arn,
  :context_provider,
  :identity_center_instance_arn,
  :remove_context_provider,
  :remove_identity_center_instance)
  SENSITIVE = []
  include Aws::Structure
end

#remove_context_provider ⇒ Boolean

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:

  • (Boolean)


13694
13695
13696
13697
13698
13699
13700
13701
13702
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 13694

class UpdateOpenIDConnectProviderRequest < Struct.new(
  :open_id_connect_provider_arn,
  :context_provider,
  :identity_center_instance_arn,
  :remove_context_provider,
  :remove_identity_center_instance)
  SENSITIVE = []
  include Aws::Structure
end

#remove_identity_center_instance ⇒ Boolean

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:

  • (Boolean)


13694
13695
13696
13697
13698
13699
13700
13701
13702
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 13694

class UpdateOpenIDConnectProviderRequest < Struct.new(
  :open_id_connect_provider_arn,
  :context_provider,
  :identity_center_instance_arn,
  :remove_context_provider,
  :remove_identity_center_instance)
  SENSITIVE = []
  include Aws::Structure
end