Class: Aws::VerifiedPermissions::Types::Configuration

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

Overview

Note:

Configuration is a union - when making an API calls you must set exactly one of the members.

Contains configuration information used when creating a new 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.

This data type is used as a request parameter for the CreateIdentitySource operation.

See Also:

Direct Known Subclasses

CognitoUserPoolConfiguration, Unknown

Defined Under Namespace

Classes: CognitoUserPoolConfiguration, Unknown

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cognito_user_pool_configuration ⇒ Types::CognitoUserPoolConfiguration

Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool and one or more application client IDs.

Example: "configuration":\{"cognitoUserPoolConfiguration":\{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": \{"groupEntityType": "MyCorp::Group"\}\}\}

Returns:



704
705
706
707
708
709
710
711
712
713
 
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 704

class Configuration < Struct.new(
  :cognito_user_pool_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class CognitoUserPoolConfiguration < Configuration; end
  class Unknown < Configuration; end
end

#unknown ⇒ Object

Returns the value of attribute unknown

Returns:

  • (Object) —

    the current value of unknown



704
705
706
 
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 704

def unknown
  @unknown
end