Class: Aws::VerifiedPermissions::Types::CreateIdentitySourceInput

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:principal_entity_type]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an ConflictException error.

Verified Permissions recognizes a ClientToken for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of ClientToken.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


916
917
918
919
920
921
922
923
 
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 916

class CreateIdentitySourceInput < Struct.new(
  :client_token,
  :policy_store_id,
  :configuration,
  :principal_entity_type)
  SENSITIVE = [:principal_entity_type]
  include Aws::Structure
end

#configuration ⇒ Types::Configuration

Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.

At this time, the only valid member of this structure is a Amazon Cognito user pool configuration.

You must specify a UserPoolArn, and optionally, a ClientId.

Returns:



916
917
918
919
920
921
922
923
 
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 916

class CreateIdentitySourceInput < Struct.new(
  :client_token,
  :policy_store_id,
  :configuration,
  :principal_entity_type)
  SENSITIVE = [:principal_entity_type]
  include Aws::Structure
end

#policy_store_id ⇒ String

Specifies the ID of the policy store in which you want to store this identity source. Only policies and requests made using this policy store can reference identities from the identity provider configured in the new identity source.

Returns:

  • (String) 


916
917
918
919
920
921
922
923
 
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 916

class CreateIdentitySourceInput < Struct.new(
  :client_token,
  :policy_store_id,
  :configuration,
  :principal_entity_type)
  SENSITIVE = [:principal_entity_type]
  include Aws::Structure
end

#principal_entity_type ⇒ String

Specifies the namespace and data type of the principals generated for identities authenticated by the new identity source.

Returns:

  • (String) 


916
917
918
919
920
921
922
923
 
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 916

class CreateIdentitySourceInput < Struct.new(
  :client_token,
  :policy_store_id,
  :configuration,
  :principal_entity_type)
  SENSITIVE = [:principal_entity_type]
  include Aws::Structure
end