Class: AWSCDK::Cognito::CfnIdentityPool::CognitoIdentityProviderProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cognito/cfn_identity_pool.rb

Overview

CognitoIdentityProvider is a property of the AWS::Cognito::IdentityPool resource that represents an Amazon Cognito user pool and its client ID.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client_id:, provider_name:, server_side_token_check: nil) ⇒ CognitoIdentityProviderProperty

Returns a new instance of CognitoIdentityProviderProperty.

Parameters:

  • client_id (String) —

    The client ID for the Amazon Cognito user pool.

  • provider_name (String) —

    The provider name for an Amazon Cognito user pool.

  • server_side_token_check (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    TRUE if server-side token validation is enabled for the identity provider’s token.



685
686
687
688
689
690
691
692
 
# File 'cognito/cfn_identity_pool.rb', line 685

def initialize(client_id:, provider_name:, server_side_token_check: nil)
  @client_id = client_id
  Jsii::Type.check_type(@client_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clientId")
  @provider_name = provider_name
  Jsii::Type.check_type(@provider_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "providerName")
  @server_side_token_check = server_side_token_check
  Jsii::Type.check_type(@server_side_token_check, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "serverSideTokenCheck") unless @server_side_token_check.nil?
end

Instance Attribute Details

#client_id ⇒ String (readonly)

The client ID for the Amazon Cognito user pool.

Returns:

  • (String)

See Also:



698
699
700
 
# File 'cognito/cfn_identity_pool.rb', line 698

def client_id
  @client_id
end

#provider_name ⇒ String (readonly)

The provider name for an Amazon Cognito user pool.

For example: cognito-idp.us-east-2.amazonaws.com/us-east-2_123456789 .

Returns:

  • (String)

See Also:



705
706
707
 
# File 'cognito/cfn_identity_pool.rb', line 705

def provider_name
  @provider_name
end

#server_side_token_check ⇒ Boolean, ... (readonly)

TRUE if server-side token validation is enabled for the identity provider’s token.

After you set the ServerSideTokenCheck to TRUE for an identity pool, that identity pool checks with the integrated user pools to make sure the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

If the user is signed out or deleted, the identity pool returns a 400 Not Authorized error.

Returns:

See Also:



714
715
716
 
# File 'cognito/cfn_identity_pool.rb', line 714

def server_side_token_check
  @server_side_token_check
end

Class Method Details

.jsii_properties ⇒ Object 



716
717
718
719
720
721
722
 
# File 'cognito/cfn_identity_pool.rb', line 716

def self.jsii_properties
  {
    :client_id => "clientId",
    :provider_name => "providerName",
    :server_side_token_check => "serverSideTokenCheck",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



724
725
726
727
728
729
730
731
732
 
# File 'cognito/cfn_identity_pool.rb', line 724

def to_jsii
  result = {}
  result.merge!({
    "clientId" => @client_id,
    "providerName" => @provider_name,
    "serverSideTokenCheck" => @server_side_token_check,
  })
  result.compact
end