Class: AWSCDK::APIGateway::MTLSConfig

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
api_gateway/mtls_config.rb

Overview

The mTLS authentication configuration for a custom domain name.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket:, key:, version: nil) ⇒ MTLSConfig

Returns a new instance of MTLSConfig.

Parameters:

  • bucket (AWSCDK::S3::IBucket) —

    The bucket that the trust store is hosted in.

  • key (String) —

    The key in S3 to look at for the trust store.

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

    The version of the S3 object that contains your truststore.



10
11
12
13
14
15
16
17
 
# File 'api_gateway/mtls_config.rb', line 10

def initialize(bucket:, key:, version: nil)
  @bucket = bucket
  Jsii::Type.check_type(@bucket, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfczMuSUJ1Y2tldCJ9")), "bucket")
  @key = key
  Jsii::Type.check_type(@key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  @version = version
  Jsii::Type.check_type(@version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "version") unless @version.nil?
end

Instance Attribute Details

#bucket ⇒ AWSCDK::S3::IBucket (readonly)

The bucket that the trust store is hosted in.

Returns:



22
23
24
 
# File 'api_gateway/mtls_config.rb', line 22

def bucket
  @bucket
end

#key ⇒ String (readonly)

The key in S3 to look at for the trust store.

Returns:

  • (String) 


26
27
28
 
# File 'api_gateway/mtls_config.rb', line 26

def key
  @key
end

#version ⇒ String? (readonly)

Note:

Default: - latest version

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) 


33
34
35
 
# File 'api_gateway/mtls_config.rb', line 33

def version
  @version
end

Class Method Details

.jsii_properties ⇒ Object 



35
36
37
38
39
40
41
 
# File 'api_gateway/mtls_config.rb', line 35

def self.jsii_properties
  {
    :bucket => "bucket",
    :key => "key",
    :version => "version",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



43
44
45
46
47
48
49
50
51
 
# File 'api_gateway/mtls_config.rb', line 43

def to_jsii
  result = {}
  result.merge!({
    "bucket" => @bucket,
    "key" => @key,
    "version" => @version,
  })
  result.compact
end