Class: AWSCDK::Cognito::UserPoolIdentityProviderSamlMetadata

Inherits:
Jsii::Object
  • Object
show all
Defined in:
cognito/user_pool_identity_provider_saml_metadata.rb

Overview

Metadata for a SAML user pool identity provider.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ UserPoolIdentityProviderSamlMetadata

Returns a new instance of UserPoolIdentityProviderSamlMetadata.

Raises:

  • (NoMethodError) 


8
9
10
 
# File 'cognito/user_pool_identity_provider_saml_metadata.rb', line 8

def initialize(*args)
  raise NoMethodError, "aws-cdk-lib.aws_cognito.UserPoolIdentityProviderSamlMetadata does not have a visible constructor; use the provided factory methods"
end

Class Method Details

.file(file_content) ⇒ AWSCDK::Cognito::UserPoolIdentityProviderSamlMetadata

Specify SAML metadata via the contents of a file.

Parameters:

  • file_content (String)

Returns:

  • (AWSCDK::Cognito::UserPoolIdentityProviderSamlMetadata) 


23
24
25
26
 
# File 'cognito/user_pool_identity_provider_saml_metadata.rb', line 23

def self.file(file_content)
  Jsii::Type.check_type(file_content, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fileContent")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cognito.UserPoolIdentityProviderSamlMetadata", "file", [file_content])
end

.jsii_overridable_methods ⇒ Object 



12
13
14
15
16
17
 
# File 'cognito/user_pool_identity_provider_saml_metadata.rb', line 12

def self.jsii_overridable_methods
  {
    :metadata_content => { kind: :property, name: "metadataContent", is_optional: false },
    :metadata_type => { kind: :property, name: "metadataType", is_optional: false },
  }
end

.url(url) ⇒ AWSCDK::Cognito::UserPoolIdentityProviderSamlMetadata

Specify SAML metadata via a URL.

Parameters:

  • url (String)

Returns:

  • (AWSCDK::Cognito::UserPoolIdentityProviderSamlMetadata) 


32
33
34
35
 
# File 'cognito/user_pool_identity_provider_saml_metadata.rb', line 32

def self.url(url)
  Jsii::Type.check_type(url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "url")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cognito.UserPoolIdentityProviderSamlMetadata", "url", [url])
end

Instance Method Details

#metadata_content ⇒ String

A URL hosting SAML metadata, or the content of a file containing SAML metadata.

Returns:

  • (String) 


40
41
42
 
# File 'cognito/user_pool_identity_provider_saml_metadata.rb', line 40

def metadata_content()
  jsii_get_property("metadataContent")
end

#metadata_type ⇒ AWSCDK::Cognito::UserPoolIdentityProviderSamlMetadataType

The type of metadata, either a URL or file content.

Returns:



47
48
49
 
# File 'cognito/user_pool_identity_provider_saml_metadata.rb', line 47

def metadata_type()
  jsii_get_property("metadataType")
end