Class: AWSCDK::EC2::CfnClientVpnEndpoint::FederatedAuthenticationRequestProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::EC2::CfnClientVpnEndpoint::FederatedAuthenticationRequestProperty

Defined in:

ec2/cfn_client_vpn_endpoint.rb

Overview

The IAM SAML identity provider used for federated authentication.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-federatedauthenticationrequest.html

Instance Attribute Summary

• #saml_provider_arn ⇒ String readonly

  The Amazon Resource Name (ARN) of the IAM SAML identity provider.

• #self_service_saml_provider_arn ⇒ String^? readonly

  The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(saml_provider_arn:, self_service_saml_provider_arn: nil) ⇒ FederatedAuthenticationRequestProperty constructor

  A new instance of FederatedAuthenticationRequestProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(saml_provider_arn:, self_service_saml_provider_arn: nil) ⇒ FederatedAuthenticationRequestProperty

Returns a new instance of FederatedAuthenticationRequestProperty.

Parameters:

• saml_provider_arn (String) —

  The Amazon Resource Name (ARN) of the IAM SAML identity provider.

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

  The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.

# File 'ec2/cfn_client_vpn_endpoint.rb', line 1115

def initialize(saml_provider_arn:, self_service_saml_provider_arn: nil)
  @saml_provider_arn = saml_provider_arn
  Jsii::Type.check_type(@saml_provider_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "samlProviderArn")
  @self_service_saml_provider_arn = self_service_saml_provider_arn
  Jsii::Type.check_type(@self_service_saml_provider_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "selfServiceSamlProviderArn") unless @self_service_saml_provider_arn.nil?
end

Instance Attribute Details

#saml_provider_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the IAM SAML identity provider.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-federatedauthenticationrequest.html#cfn-ec2-clientvpnendpoint-federatedauthenticationrequest-samlproviderarn

# File 'ec2/cfn_client_vpn_endpoint.rb', line 1126

def saml_provider_arn
  @saml_provider_arn
end

#self_service_saml_provider_arn ⇒ String^? (readonly)

The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-federatedauthenticationrequest.html#cfn-ec2-clientvpnendpoint-federatedauthenticationrequest-selfservicesamlproviderarn

# File 'ec2/cfn_client_vpn_endpoint.rb', line 1131

def self_service_saml_provider_arn
  @self_service_saml_provider_arn
end

Class Method Details

.jsii_properties ⇒ Object

# File 'ec2/cfn_client_vpn_endpoint.rb', line 1133

def self.jsii_properties
  {
    :saml_provider_arn => "samlProviderArn",
    :self_service_saml_provider_arn => "selfServiceSamlProviderArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'ec2/cfn_client_vpn_endpoint.rb', line 1140

def to_jsii
  result = {}
  result.merge!({
    "samlProviderArn" => @saml_provider_arn,
    "selfServiceSamlProviderArn" => @self_service_saml_provider_arn,
  })
  result.compact
end