Class: AWSCDK::FinSpace::CfnEnvironment::FederationParametersProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
fin_space/cfn_environment.rb

Overview

Configuration information when authentication mode is FEDERATED.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(application_call_back_url: nil, attribute_map: nil, federation_provider_name: nil, federation_urn: nil, saml_metadata_document: nil, saml_metadata_url: nil) ⇒ FederationParametersProperty

Returns a new instance of FederationParametersProperty.

Parameters:

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

    The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).

  • attribute_map (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::FinSpace::CfnEnvironment::AttributeMapItemsProperty>, nil) (defaults to: nil) —

    SAML attribute name and value.

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

    Name of the identity provider (IdP).

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

    The Uniform Resource Name (URN).

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

    SAML 2.0 Metadata document from identity provider (IdP).

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

    Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).



735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'fin_space/cfn_environment.rb', line 735

def initialize(application_call_back_url: nil, attribute_map: nil, federation_provider_name: nil, federation_urn: nil, saml_metadata_document: nil, saml_metadata_url: nil)
  @application_call_back_url = application_call_back_url
  Jsii::Type.check_type(@application_call_back_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationCallBackUrl") unless @application_call_back_url.nil?
  @attribute_map = attribute_map
  Jsii::Type.check_type(@attribute_map, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZmluc3BhY2UuQ2ZuRW52aXJvbm1lbnQuQXR0cmlidXRlTWFwSXRlbXNQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "attributeMap") unless @attribute_map.nil?
  @federation_provider_name = federation_provider_name
  Jsii::Type.check_type(@federation_provider_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "federationProviderName") unless @federation_provider_name.nil?
  @federation_urn = federation_urn
  Jsii::Type.check_type(@federation_urn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "federationUrn") unless @federation_urn.nil?
  @saml_metadata_document = saml_metadata_document
  Jsii::Type.check_type(@saml_metadata_document, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "samlMetadataDocument") unless @saml_metadata_document.nil?
  @saml_metadata_url = saml_metadata_url
  Jsii::Type.check_type(@saml_metadata_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "samlMetadataUrl") unless @saml_metadata_url.nil?
end

Instance Attribute Details

#application_call_back_url ⇒ String? (readonly)

The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).

Returns:

  • (String, nil)

See Also:



754
755
756
 
# File 'fin_space/cfn_environment.rb', line 754

def application_call_back_url
  @application_call_back_url
end

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

SAML attribute name and value.

The name must always be Email and the value should be set to the attribute definition in which user email is set. For example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress . Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.

Returns:

See Also:



761
762
763
 
# File 'fin_space/cfn_environment.rb', line 761

def attribute_map
  @attribute_map
end

#federation_provider_name ⇒ String? (readonly)

Name of the identity provider (IdP).

Returns:

  • (String, nil)

See Also:



766
767
768
 
# File 'fin_space/cfn_environment.rb', line 766

def federation_provider_name
  @federation_provider_name
end

#federation_urn ⇒ String? (readonly)

The Uniform Resource Name (URN).

Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.

Returns:

  • (String, nil)

See Also:



773
774
775
 
# File 'fin_space/cfn_environment.rb', line 773

def federation_urn
  @federation_urn
end

#saml_metadata_document ⇒ String? (readonly)

SAML 2.0 Metadata document from identity provider (IdP).

Returns:

  • (String, nil)

See Also:



778
779
780
 
# File 'fin_space/cfn_environment.rb', line 778

def saml_metadata_document
  @saml_metadata_document
end

#saml_metadata_url ⇒ String? (readonly)

Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).

Returns:

  • (String, nil)

See Also:



783
784
785
 
# File 'fin_space/cfn_environment.rb', line 783

def saml_metadata_url
  @saml_metadata_url
end

Class Method Details

.jsii_properties ⇒ Object 



785
786
787
788
789
790
791
792
793
794
 
# File 'fin_space/cfn_environment.rb', line 785

def self.jsii_properties
  {
    :application_call_back_url => "applicationCallBackUrl",
    :attribute_map => "attributeMap",
    :federation_provider_name => "federationProviderName",
    :federation_urn => "federationUrn",
    :saml_metadata_document => "samlMetadataDocument",
    :saml_metadata_url => "samlMetadataUrl",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



796
797
798
799
800
801
802
803
804
805
806
807
 
# File 'fin_space/cfn_environment.rb', line 796

def to_jsii
  result = {}
  result.merge!({
    "applicationCallBackUrl" => @application_call_back_url,
    "attributeMap" => @attribute_map,
    "federationProviderName" => @federation_provider_name,
    "federationUrn" => @federation_urn,
    "samlMetadataDocument" => @saml_metadata_document,
    "samlMetadataUrl" => @saml_metadata_url,
  })
  result.compact
end