Class: AWSCDK::AppSync::CfnAPI::CognitoConfigProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
app_sync/cfn_api.rb

Overview

Describes an Amazon Cognito configuration.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(aws_region:, user_pool_id:, app_id_client_regex: nil) ⇒ CognitoConfigProperty

Returns a new instance of CognitoConfigProperty.

Parameters:

  • aws_region (String) —

    The AWS Region in which the user pool was created.

  • user_pool_id (String) —

    The user pool ID.

  • app_id_client_regex (String, nil) (defaults to: nil) —

    A regular expression for validating the incoming Amazon Cognito user pool app client ID.



691
692
693
694
695
696
697
698
 
# File 'app_sync/cfn_api.rb', line 691

def initialize(aws_region:, user_pool_id:, app_id_client_regex: nil)
  @aws_region = aws_region
  Jsii::Type.check_type(@aws_region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "awsRegion")
  @user_pool_id = user_pool_id
  Jsii::Type.check_type(@user_pool_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "userPoolId")
  @app_id_client_regex = app_id_client_regex
  Jsii::Type.check_type(@app_id_client_regex, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "appIdClientRegex") unless @app_id_client_regex.nil?
end

Instance Attribute Details

#app_id_client_regex ⇒ String? (readonly)

A regular expression for validating the incoming Amazon Cognito user pool app client ID.

If this value isn't set, no filtering is applied.

Returns:

  • (String, nil)

See Also:



716
717
718
 
# File 'app_sync/cfn_api.rb', line 716

def app_id_client_regex
  @app_id_client_regex
end

#aws_region ⇒ String (readonly)

The AWS Region in which the user pool was created.

Returns:

  • (String)

See Also:



704
705
706
 
# File 'app_sync/cfn_api.rb', line 704

def aws_region
  @aws_region
end

#user_pool_id ⇒ String (readonly)

The user pool ID.

Returns:

  • (String)

See Also:



709
710
711
 
# File 'app_sync/cfn_api.rb', line 709

def user_pool_id
  @user_pool_id
end

Class Method Details

.jsii_properties ⇒ Object 



718
719
720
721
722
723
724
 
# File 'app_sync/cfn_api.rb', line 718

def self.jsii_properties
  {
    :aws_region => "awsRegion",
    :user_pool_id => "userPoolId",
    :app_id_client_regex => "appIdClientRegex",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



726
727
728
729
730
731
732
733
734
 
# File 'app_sync/cfn_api.rb', line 726

def to_jsii
  result = {}
  result.merge!({
    "awsRegion" => @aws_region,
    "userPoolId" => @user_pool_id,
    "appIdClientRegex" => @app_id_client_regex,
  })
  result.compact
end