Class: AWSCDK::AppSync::CfnDomainNameProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
app_sync/cfn_domain_name_props.rb

Overview

Properties for defining a CfnDomainName.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(certificate_arn:, domain_name:, description: nil, tags: nil) ⇒ CfnDomainNameProps

Returns a new instance of CfnDomainNameProps.

Parameters:

  • certificate_arn (String) —

    The Amazon Resource Name (ARN) of the certificate.

  • domain_name (String) —

    The domain name.

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

    The decription for your domain name.

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

    A set of tags (key-value pairs) for this domain name.



13
14
15
16
17
18
19
20
21
22
 
# File 'app_sync/cfn_domain_name_props.rb', line 13

def initialize(certificate_arn:, domain_name:, description: nil, tags: nil)
  @certificate_arn = certificate_arn
  Jsii::Type.check_type(@certificate_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "certificateArn")
  @domain_name = domain_name
  Jsii::Type.check_type(@domain_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainName")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.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_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the certificate.

This will be an Certificate Manager certificate.

Returns:

  • (String)

See Also:



30
31
32
 
# File 'app_sync/cfn_domain_name_props.rb', line 30

def certificate_arn
  @certificate_arn
end

#description ⇒ String? (readonly)

The decription for your domain name.

Returns:

  • (String, nil)

See Also:



40
41
42
 
# File 'app_sync/cfn_domain_name_props.rb', line 40

def description
  @description
end

#domain_name ⇒ String (readonly)

The domain name.

Returns:

  • (String)

See Also:



35
36
37
 
# File 'app_sync/cfn_domain_name_props.rb', line 35

def domain_name
  @domain_name
end

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

A set of tags (key-value pairs) for this domain name.

Returns:

See Also:



45
46
47
 
# File 'app_sync/cfn_domain_name_props.rb', line 45

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



47
48
49
50
51
52
53
54
 
# File 'app_sync/cfn_domain_name_props.rb', line 47

def self.jsii_properties
  {
    :certificate_arn => "certificateArn",
    :domain_name => "domainName",
    :description => "description",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



56
57
58
59
60
61
62
63
64
65
 
# File 'app_sync/cfn_domain_name_props.rb', line 56

def to_jsii
  result = {}
  result.merge!({
    "certificateArn" => @certificate_arn,
    "domainName" => @domain_name,
    "description" => @description,
    "tags" => @tags,
  })
  result.compact
end