Class: AWSCDK::IAM::CfnServerCertificateProps

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

Overview

Properties for defining a CfnServerCertificate.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(certificate_body: nil, certificate_chain: nil, path: nil, private_key: nil, server_certificate_name: nil, tags: nil) ⇒ CfnServerCertificateProps

Returns a new instance of CfnServerCertificateProps.

Parameters:

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

    The contents of the public key certificate.

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

    The contents of the public key certificate chain.

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

    The path for the server certificate.

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

    The contents of the private key in PEM-encoded format.

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

    The name for the server certificate.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    A list of tags that are attached to the server certificate.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'iam/cfn_server_certificate_props.rb', line 15

def initialize(certificate_body: nil, certificate_chain: nil, path: nil, private_key: nil, server_certificate_name: nil, tags: nil)
  @certificate_body = certificate_body
  Jsii::Type.check_type(@certificate_body, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "certificateBody") unless @certificate_body.nil?
  @certificate_chain = certificate_chain
  Jsii::Type.check_type(@certificate_chain, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "certificateChain") unless @certificate_chain.nil?
  @path = path
  Jsii::Type.check_type(@path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path") unless @path.nil?
  @private_key = private_key
  Jsii::Type.check_type(@private_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "privateKey") unless @private_key.nil?
  @server_certificate_name = server_certificate_name
  Jsii::Type.check_type(@server_certificate_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serverCertificateName") unless @server_certificate_name.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#certificate_body ⇒ String? (readonly)

The contents of the public key certificate.

Returns:

  • (String, nil)

See Also:



34
35
36
 
# File 'iam/cfn_server_certificate_props.rb', line 34

def certificate_body
  @certificate_body
end

#certificate_chain ⇒ String? (readonly)

The contents of the public key certificate chain.

Returns:

  • (String, nil)

See Also:



39
40
41
 
# File 'iam/cfn_server_certificate_props.rb', line 39

def certificate_chain
  @certificate_chain
end

#path ⇒ String? (readonly)

The path for the server certificate.

For more information about paths, see IAM identifiers in the IAM User Guide .

This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its regex pattern ) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! ( \u0021 ) through the DEL character ( \u007F ), including most punctuation characters, digits, and upper and lowercased letters.

If you are uploading a server certificate specifically for use with Amazon CloudFront distributions, you must specify a path using the path parameter. The path must begin with /cloudfront and must include a trailing slash (for example, /cloudfront/test/ ).

Returns:

  • (String, nil)

See Also:



50
51
52
 
# File 'iam/cfn_server_certificate_props.rb', line 50

def path
  @path
end

#private_key ⇒ String? (readonly)

The contents of the private key in PEM-encoded format.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character ( \u0020 ) through the end of the ASCII character range
  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF )
  • The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage return ( \u000D )

Returns:

  • (String, nil)

See Also:



61
62
63
 
# File 'iam/cfn_server_certificate_props.rb', line 61

def private_key
  @private_key
end

#server_certificate_name ⇒ String? (readonly)

The name for the server certificate.

Do not include the path in this value. The name of the certificate cannot contain any spaces.

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

Returns:

  • (String, nil)

See Also:



70
71
72
 
# File 'iam/cfn_server_certificate_props.rb', line 70

def server_certificate_name
  @server_certificate_name
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

A list of tags that are attached to the server certificate.

For more information about tagging, see Tagging IAM resources in the IAM User Guide .

Returns:

See Also:



77
78
79
 
# File 'iam/cfn_server_certificate_props.rb', line 77

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



79
80
81
82
83
84
85
86
87
88
 
# File 'iam/cfn_server_certificate_props.rb', line 79

def self.jsii_properties
  {
    :certificate_body => "certificateBody",
    :certificate_chain => "certificateChain",
    :path => "path",
    :private_key => "privateKey",
    :server_certificate_name => "serverCertificateName",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'iam/cfn_server_certificate_props.rb', line 90

def to_jsii
  result = {}
  result.merge!({
    "certificateBody" => @certificate_body,
    "certificateChain" => @certificate_chain,
    "path" => @path,
    "privateKey" => @private_key,
    "serverCertificateName" => @server_certificate_name,
    "tags" => @tags,
  })
  result.compact
end