Class: AWSCDK::AppSync::CfnAPI::AuthProviderProperty

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

Overview

Describes an authorization provider.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(auth_type:, cognito_config: nil, lambda_authorizer_config: nil, open_id_connect_config: nil) ⇒ AuthProviderProperty

Returns a new instance of AuthProviderProperty.

Parameters:



627
628
629
630
631
632
633
634
635
636
 
# File 'app_sync/cfn_api.rb', line 627

def initialize(auth_type:, cognito_config: nil, lambda_authorizer_config: nil, open_id_connect_config: nil)
  @auth_type = auth_type
  Jsii::Type.check_type(@auth_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authType")
  @cognito_config = cognito_config.is_a?(Hash) ? ::AWSCDK::AppSync::CfnAPI::CognitoConfigProperty.new(**cognito_config.transform_keys(&:to_sym)) : cognito_config
  Jsii::Type.check_type(@cognito_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzeW5jLkNmbkFwaS5Db2duaXRvQ29uZmlnUHJvcGVydHkifV19fQ==")), "cognitoConfig") unless @cognito_config.nil?
  @lambda_authorizer_config = lambda_authorizer_config.is_a?(Hash) ? ::AWSCDK::AppSync::CfnAPI::LambdaAuthorizerConfigProperty.new(**lambda_authorizer_config.transform_keys(&:to_sym)) : lambda_authorizer_config
  Jsii::Type.check_type(@lambda_authorizer_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzeW5jLkNmbkFwaS5MYW1iZGFBdXRob3JpemVyQ29uZmlnUHJvcGVydHkifV19fQ==")), "lambdaAuthorizerConfig") unless @lambda_authorizer_config.nil?
  @open_id_connect_config = open_id_connect_config.is_a?(Hash) ? ::AWSCDK::AppSync::CfnAPI::OpenIDConnectConfigProperty.new(**open_id_connect_config.transform_keys(&:to_sym)) : open_id_connect_config
  Jsii::Type.check_type(@open_id_connect_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzeW5jLkNmbkFwaS5PcGVuSURDb25uZWN0Q29uZmlnUHJvcGVydHkifV19fQ==")), "openIdConnectConfig") unless @open_id_connect_config.nil?
end

Instance Attribute Details

#auth_type ⇒ String (readonly)

The authorization type.

Returns:

  • (String)

See Also:



642
643
644
 
# File 'app_sync/cfn_api.rb', line 642

def auth_type
  @auth_type
end

#cognito_config ⇒ AWSCDK::IResolvable, ... (readonly)

Describes an Amazon Cognito user pool configuration.

Returns:

See Also:



647
648
649
 
# File 'app_sync/cfn_api.rb', line 647

def cognito_config
  @cognito_config
end

#lambda_authorizer_config ⇒ AWSCDK::IResolvable, ... (readonly)

A LambdaAuthorizerConfig specifies how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode.

Be aware that an AWS AppSync API can have only one AWS Lambda authorizer configured at a time.

Returns:

See Also:



654
655
656
 
# File 'app_sync/cfn_api.rb', line 654

def lambda_authorizer_config
  @lambda_authorizer_config
end

#open_id_connect_config ⇒ AWSCDK::IResolvable, ... (readonly)

Describes an OpenID Connect (OIDC) configuration.

Returns:

See Also:



659
660
661
 
# File 'app_sync/cfn_api.rb', line 659

def open_id_connect_config
  @open_id_connect_config
end

Class Method Details

.jsii_properties ⇒ Object 



661
662
663
664
665
666
667
668
 
# File 'app_sync/cfn_api.rb', line 661

def self.jsii_properties
  {
    :auth_type => "authType",
    :cognito_config => "cognitoConfig",
    :lambda_authorizer_config => "lambdaAuthorizerConfig",
    :open_id_connect_config => "openIdConnectConfig",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



670
671
672
673
674
675
676
677
678
679
 
# File 'app_sync/cfn_api.rb', line 670

def to_jsii
  result = {}
  result.merge!({
    "authType" => @auth_type,
    "cognitoConfig" => @cognito_config,
    "lambdaAuthorizerConfig" => @lambda_authorizer_config,
    "openIdConnectConfig" => @open_id_connect_config,
  })
  result.compact
end