Class: AWSCDK::APIGateway::CfnDomainName::MutualTLSAuthenticationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::APIGateway::CfnDomainName::MutualTLSAuthenticationProperty

Defined in:

api_gateway/cfn_domain_name.rb

Overview

The mutual TLS authentication configuration for a custom domain name.

If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html

Instance Attribute Summary

• #truststore_uri ⇒ String^? readonly

  An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example s3://bucket-name/key-name .

• #truststore_version ⇒ String^? readonly

  The version of the S3 object that contains your truststore.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(truststore_uri: nil, truststore_version: nil) ⇒ MutualTLSAuthenticationProperty constructor

  A new instance of MutualTLSAuthenticationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(truststore_uri: nil, truststore_version: nil) ⇒ MutualTLSAuthenticationProperty

Returns a new instance of MutualTLSAuthenticationProperty.

Parameters:

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

  An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example s3://bucket-name/key-name .

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

  The version of the S3 object that contains your truststore.

# File 'api_gateway/cfn_domain_name.rb', line 758

def initialize(truststore_uri: nil, truststore_version: nil)
  @truststore_uri = truststore_uri
  Jsii::Type.check_type(@truststore_uri, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "truststoreUri") unless @truststore_uri.nil?
  @truststore_version = truststore_version
  Jsii::Type.check_type(@truststore_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "truststoreVersion") unless @truststore_version.nil?
end

Instance Attribute Details

#truststore_uri ⇒ String^? (readonly)

An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example s3://bucket-name/key-name .

The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html#cfn-apigateway-domainname-mutualtlsauthentication-truststoreuri

# File 'api_gateway/cfn_domain_name.rb', line 771

def truststore_uri
  @truststore_uri
end

#truststore_version ⇒ String^? (readonly)

The version of the S3 object that contains your truststore.

To specify a version, you must have versioning enabled for the S3 bucket.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html#cfn-apigateway-domainname-mutualtlsauthentication-truststoreversion

# File 'api_gateway/cfn_domain_name.rb', line 778

def truststore_version
  @truststore_version
end

Class Method Details

.jsii_properties ⇒ Object

# File 'api_gateway/cfn_domain_name.rb', line 780

def self.jsii_properties
  {
    :truststore_uri => "truststoreUri",
    :truststore_version => "truststoreVersion",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'api_gateway/cfn_domain_name.rb', line 787

def to_jsii
  result = {}
  result.merge!({
    "truststoreUri" => @truststore_uri,
    "truststoreVersion" => @truststore_version,
  })
  result.compact
end