Class: AWSCDK::AppSync::CfnGraphQLAPI::CognitoUserPoolConfigProperty

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

Overview

Describes an Amazon Cognito user pool configuration.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of CognitoUserPoolConfigProperty.

Parameters:

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

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

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

    The AWS Region in which the user pool was created.

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

    The user pool ID.



862
863
864
865
866
867
868
869
 
# File 'app_sync/cfn_graph_qlapi.rb', line 862

def initialize(app_id_client_regex: nil, aws_region: nil, user_pool_id: nil)
  @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?
  @aws_region = aws_region
  Jsii::Type.check_type(@aws_region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "awsRegion") unless @aws_region.nil?
  @user_pool_id = user_pool_id
  Jsii::Type.check_type(@user_pool_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "userPoolId") unless @user_pool_id.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:



877
878
879
 
# File 'app_sync/cfn_graph_qlapi.rb', line 877

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, nil)

See Also:



882
883
884
 
# File 'app_sync/cfn_graph_qlapi.rb', line 882

def aws_region
  @aws_region
end

#user_pool_id ⇒ String? (readonly)

The user pool ID.

Returns:

  • (String, nil)

See Also:



887
888
889
 
# File 'app_sync/cfn_graph_qlapi.rb', line 887

def user_pool_id
  @user_pool_id
end

Class Method Details

.jsii_properties ⇒ Object 



889
890
891
892
893
894
895
 
# File 'app_sync/cfn_graph_qlapi.rb', line 889

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

Instance Method Details

#to_jsii ⇒ Object 



897
898
899
900
901
902
903
904
905
 
# File 'app_sync/cfn_graph_qlapi.rb', line 897

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