Class: AWSCDK::IAM::SamlProviderProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
iam/saml_provider_props.rb

Overview

Properties for a SAML provider.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(metadata_document:, name: nil) ⇒ SamlProviderProps

Returns a new instance of SamlProviderProps.

Parameters:

  • metadata_document (AWSCDK::IAM::SamlMetadataDocument) —

    An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.

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

    The name of the provider to create.



9
10
11
12
13
14
 
# File 'iam/saml_provider_props.rb', line 9

def initialize(metadata_document:, name: nil)
  @metadata_document = metadata_document
  Jsii::Type.check_type(@metadata_document, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLlNhbWxNZXRhZGF0YURvY3VtZW50In0=")), "metadataDocument")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
end

Instance Attribute Details

#metadata_document ⇒ AWSCDK::IAM::SamlMetadataDocument (readonly)

An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.

Returns:



19
20
21
 
# File 'iam/saml_provider_props.rb', line 19

def metadata_document
  @metadata_document
end

#name ⇒ String? (readonly)

Note:

Default: - a CloudFormation generated name

The name of the provider to create.

This parameter allows a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Length must be between 1 and 128 characters.

Returns:

  • (String, nil) 


30
31
32
 
# File 'iam/saml_provider_props.rb', line 30

def name
  @name
end

Class Method Details

.jsii_properties ⇒ Object 



32
33
34
35
36
37
 
# File 'iam/saml_provider_props.rb', line 32

def self.jsii_properties
  {
    :metadata_document => "metadataDocument",
    :name => "name",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



39
40
41
42
43
44
45
46
 
# File 'iam/saml_provider_props.rb', line 39

def to_jsii
  result = {}
  result.merge!({
    "metadataDocument" => @metadata_document,
    "name" => @name,
  })
  result.compact
end