Class: AWSCDK::AppSync::CfnGraphQLAPI::UserPoolConfigProperty

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

Overview

The UserPoolConfig property type specifies the optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint for an AWS AppSync GraphQL API.

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, default_action: nil, user_pool_id: nil) ⇒ UserPoolConfigProperty

Returns a new instance of UserPoolConfigProperty.

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.

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

    The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.

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

    The user pool ID.



1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
 
# File 'app_sync/cfn_graph_qlapi.rb', line 1198

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



1215
1216
1217
 
# File 'app_sync/cfn_graph_qlapi.rb', line 1215

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:



1220
1221
1222
 
# File 'app_sync/cfn_graph_qlapi.rb', line 1220

def aws_region
  @aws_region
end

#default_action ⇒ String? (readonly)

The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.

When specifying Amazon Cognito user pools as the default authentication, you must set the value for DefaultAction to ALLOW if specifying AdditionalAuthenticationProviders .

Returns:

  • (String, nil)

See Also:



1227
1228
1229
 
# File 'app_sync/cfn_graph_qlapi.rb', line 1227

def default_action
  @default_action
end

#user_pool_id ⇒ String? (readonly)

The user pool ID.

Returns:

  • (String, nil)

See Also:



1232
1233
1234
 
# File 'app_sync/cfn_graph_qlapi.rb', line 1232

def user_pool_id
  @user_pool_id
end

Class Method Details

.jsii_properties ⇒ Object 



1234
1235
1236
1237
1238
1239
1240
1241
 
# File 'app_sync/cfn_graph_qlapi.rb', line 1234

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

Instance Method Details

#to_jsii ⇒ Object 



1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
 
# File 'app_sync/cfn_graph_qlapi.rb', line 1243

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