Class: AWSCDK::WorkspacesWeb::CfnIdentityProviderProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
workspaces_web/cfn_identity_provider_props.rb

Overview

Properties for defining a CfnIdentityProvider.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(identity_provider_details:, identity_provider_name:, identity_provider_type:, portal_arn: nil, tags: nil) ⇒ CfnIdentityProviderProps

Returns a new instance of CfnIdentityProviderProps.

Parameters:

  • identity_provider_details (AWSCDK::IResolvable, Hash{String => String}) —

    The identity provider details. The following list describes the provider detail keys for each identity provider type.

  • identity_provider_name (String) —

    The identity provider name.

  • identity_provider_type (String) —

    The identity provider type.

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

    The ARN of the identity provider.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) 


14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'workspaces_web/cfn_identity_provider_props.rb', line 14

def initialize(identity_provider_details:, identity_provider_name:, identity_provider_type:, portal_arn: nil, tags: nil)
  @identity_provider_details = identity_provider_details
  Jsii::Type.check_type(@identity_provider_details, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "identityProviderDetails")
  @identity_provider_name = identity_provider_name
  Jsii::Type.check_type(@identity_provider_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "identityProviderName")
  @identity_provider_type = identity_provider_type
  Jsii::Type.check_type(@identity_provider_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "identityProviderType")
  @portal_arn = portal_arn
  Jsii::Type.check_type(@portal_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "portalArn") unless @portal_arn.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#identity_provider_details ⇒ AWSCDK::IResolvable, Hash{String => String} (readonly)

The identity provider details. The following list describes the provider detail keys for each identity provider type.

  • For Google and Login with Amazon:
  • client_id
  • client_secret
  • authorize_scopes
  • For Facebook:
  • client_id
  • client_secret
  • authorize_scopes
  • api_version
  • For Sign in with Apple:
  • client_id
  • team_id
  • key_id
  • private_key
  • authorize_scopes
  • For OIDC providers:
  • client_id
  • client_secret
  • attributes_request_method
  • oidc_issuer
  • authorize_scopes
  • authorize_url if not available from discovery URL specified by oidc_issuer key
  • token_url if not available from discovery URL specified by oidc_issuer key
  • attributes_url if not available from discovery URL specified by oidc_issuer key
  • jwks_uri if not available from discovery URL specified by oidc_issuer key
  • For SAML providers:
  • MetadataFile OR MetadataURL
  • IDPSignout (boolean) optional
  • IDPInit (boolean) optional
  • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256
  • EncryptedResponses (boolean) optional

Returns:

See Also:



63
64
65
 
# File 'workspaces_web/cfn_identity_provider_props.rb', line 63

def identity_provider_details
  @identity_provider_details
end

#identity_provider_name ⇒ String (readonly)

The identity provider name.

Returns:

  • (String)

See Also:



68
69
70
 
# File 'workspaces_web/cfn_identity_provider_props.rb', line 68

def identity_provider_name
  @identity_provider_name
end

#identity_provider_type ⇒ String (readonly)

The identity provider type.

Returns:

  • (String)

See Also:



73
74
75
 
# File 'workspaces_web/cfn_identity_provider_props.rb', line 73

def identity_provider_type
  @identity_provider_type
end

#portal_arn ⇒ String? (readonly)

The ARN of the identity provider.

Returns:

  • (String, nil)

See Also:



78
79
80
 
# File 'workspaces_web/cfn_identity_provider_props.rb', line 78

def portal_arn
  @portal_arn
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

Returns:

See Also:



81
82
83
 
# File 'workspaces_web/cfn_identity_provider_props.rb', line 81

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



83
84
85
86
87
88
89
90
91
 
# File 'workspaces_web/cfn_identity_provider_props.rb', line 83

def self.jsii_properties
  {
    :identity_provider_details => "identityProviderDetails",
    :identity_provider_name => "identityProviderName",
    :identity_provider_type => "identityProviderType",
    :portal_arn => "portalArn",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



93
94
95
96
97
98
99
100
101
102
103
 
# File 'workspaces_web/cfn_identity_provider_props.rb', line 93

def to_jsii
  result = {}
  result.merge!({
    "identityProviderDetails" => @identity_provider_details,
    "identityProviderName" => @identity_provider_name,
    "identityProviderType" => @identity_provider_type,
    "portalArn" => @portal_arn,
    "tags" => @tags,
  })
  result.compact
end