Class: AWSCDK::Route53::CfnRecordSetGroupProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
route53/cfn_record_set_group_props.rb

Overview

Properties for defining a CfnRecordSetGroup.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(comment: nil, hosted_zone_id: nil, hosted_zone_name: nil, record_sets: nil) ⇒ CfnRecordSetGroupProps

Returns a new instance of CfnRecordSetGroupProps.

Parameters:

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

    Optional: Any comments you want to include about a change batch request.

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

    The ID of the hosted zone that you want to create records in.

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

    The name of the hosted zone that you want to create records in.

  • record_sets (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Route53::CfnRecordSetGroup::RecordSetProperty>, nil) (defaults to: nil) —

    A complex type that contains one RecordSet element for each record that you want to create.



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

def initialize(comment: nil, hosted_zone_id: nil, hosted_zone_name: nil, record_sets: nil)
  @comment = comment
  Jsii::Type.check_type(@comment, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "comment") unless @comment.nil?
  @hosted_zone_id = hosted_zone_id
  Jsii::Type.check_type(@hosted_zone_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "hostedZoneId") unless @hosted_zone_id.nil?
  @hosted_zone_name = hosted_zone_name
  Jsii::Type.check_type(@hosted_zone_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "hostedZoneName") unless @hosted_zone_name.nil?
  @record_sets = record_sets
  Jsii::Type.check_type(@record_sets, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfcm91dGU1My5DZm5SZWNvcmRTZXRHcm91cC5SZWNvcmRTZXRQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "recordSets") unless @record_sets.nil?
end

Instance Attribute Details

#comment ⇒ String? (readonly)

Optional: Any comments you want to include about a change batch request.

Returns:

  • (String, nil)

See Also:



28
29
30
 
# File 'route53/cfn_record_set_group_props.rb', line 28

def comment
  @comment
end

#hosted_zone_id ⇒ String? (readonly)

The ID of the hosted zone that you want to create records in.

Specify either HostedZoneName or HostedZoneId , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using HostedZoneId .

Returns:

  • (String, nil)

See Also:



35
36
37
 
# File 'route53/cfn_record_set_group_props.rb', line 35

def hosted_zone_id
  @hosted_zone_id
end

#hosted_zone_name ⇒ String? (readonly)

The name of the hosted zone that you want to create records in.

You must include a trailing dot (for example, www.example.com. ) as part of the HostedZoneName .

When you create a stack using an AWS::Route53::RecordSet that specifies HostedZoneName , AWS CloudFormation attempts to find a hosted zone whose name matches the HostedZoneName . If AWS CloudFormation can't find a hosted zone with a matching domain name, or if there is more than one hosted zone with the specified domain name, AWS CloudFormation will not create the stack.

Specify either HostedZoneName or HostedZoneId , but not both. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using HostedZoneId .

Returns:

  • (String, nil)

See Also:



46
47
48
 
# File 'route53/cfn_record_set_group_props.rb', line 46

def hosted_zone_name
  @hosted_zone_name
end

#record_sets ⇒ AWSCDK::IResolvable, ... (readonly)

A complex type that contains one RecordSet element for each record that you want to create.

Returns:

See Also:



51
52
53
 
# File 'route53/cfn_record_set_group_props.rb', line 51

def record_sets
  @record_sets
end

Class Method Details

.jsii_properties ⇒ Object 



53
54
55
56
57
58
59
60
 
# File 'route53/cfn_record_set_group_props.rb', line 53

def self.jsii_properties
  {
    :comment => "comment",
    :hosted_zone_id => "hostedZoneId",
    :hosted_zone_name => "hostedZoneName",
    :record_sets => "recordSets",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



62
63
64
65
66
67
68
69
70
71
 
# File 'route53/cfn_record_set_group_props.rb', line 62

def to_jsii
  result = {}
  result.merge!({
    "comment" => @comment,
    "hostedZoneId" => @hosted_zone_id,
    "hostedZoneName" => @hosted_zone_name,
    "recordSets" => @record_sets,
  })
  result.compact
end