Class: AWSCDK::Lightsail::CfnDomain::DomainEntryProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
lightsail/cfn_domain.rb

Overview

Describes a domain recordset entry.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, target:, type:, id: nil, is_alias: nil) ⇒ DomainEntryProperty

Returns a new instance of DomainEntryProperty.

Parameters:

  • name (String) —

    The name of the domain.

  • target (String) —

    The target IP address ( 192.0.2.0 ), or AWS name server ( ns-111.awsdns-22.com. ).

  • type (String) —

    The type of domain entry, such as address for IPv4 (A), address for IPv6 (AAAA), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).

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

    The ID of the domain recordset entry.

  • is_alias (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    When true , specifies whether the domain entry is an alias used by the Lightsail load balancer, Lightsail container service, Lightsail content delivery network (CDN) distribution, or another AWS resource.



581
582
583
584
585
586
587
588
589
590
591
592
 
# File 'lightsail/cfn_domain.rb', line 581

def initialize(name:, target:, type:, id: nil, is_alias: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @target = target
  Jsii::Type.check_type(@target, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "target")
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @id = id
  Jsii::Type.check_type(@id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id") unless @id.nil?
  @is_alias = is_alias
  Jsii::Type.check_type(@is_alias, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "isAlias") unless @is_alias.nil?
end

Instance Attribute Details

#id ⇒ String? (readonly)

The ID of the domain recordset entry.

Returns:

  • (String, nil)

See Also:



626
627
628
 
# File 'lightsail/cfn_domain.rb', line 626

def id
  @id
end

#is_alias ⇒ Boolean, ... (readonly)

When true , specifies whether the domain entry is an alias used by the Lightsail load balancer, Lightsail container service, Lightsail content delivery network (CDN) distribution, or another AWS resource.

You can include an alias (A type) record in your request, which points to the DNS name of a load balancer, container service, CDN distribution, or other AWS resource and routes traffic to that resource.

Returns:

See Also:



633
634
635
 
# File 'lightsail/cfn_domain.rb', line 633

def is_alias
  @is_alias
end

#name ⇒ String (readonly)

The name of the domain.

Returns:

  • (String)

See Also:



598
599
600
 
# File 'lightsail/cfn_domain.rb', line 598

def name
  @name
end

#target ⇒ String (readonly)

The target IP address ( 192.0.2.0 ), or AWS name server ( ns-111.awsdns-22.com. ).

For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com . For Lightsail distributions, the value looks like exampled1182ne.cloudfront.net . For Lightsail container services, the value looks like container-service-1.example23scljs.us-west-2.cs.amazonlightsail.com . Be sure to also set is_alias to true when setting up an A record for a Lightsail load balancer, distribution, or container service.

Returns:

  • (String)

See Also:



605
606
607
 
# File 'lightsail/cfn_domain.rb', line 605

def target
  @target
end

#type ⇒ String (readonly)

The type of domain entry, such as address for IPv4 (A), address for IPv6 (AAAA), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).

The following domain entry types can be used:

  • A
  • AAAA
  • CNAME
  • MX
  • NS
  • SOA
  • SRV
  • TXT

Returns:

  • (String)

See Also:



621
622
623
 
# File 'lightsail/cfn_domain.rb', line 621

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



635
636
637
638
639
640
641
642
643
 
# File 'lightsail/cfn_domain.rb', line 635

def self.jsii_properties
  {
    :name => "name",
    :target => "target",
    :type => "type",
    :id => "id",
    :is_alias => "isAlias",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



645
646
647
648
649
650
651
652
653
654
655
 
# File 'lightsail/cfn_domain.rb', line 645

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "target" => @target,
    "type" => @type,
    "id" => @id,
    "isAlias" => @is_alias,
  })
  result.compact
end