Class: AWSCDK::Route53::CfnRecordSet

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSRoute53::IRecordSetRef
Defined in:
route53/cfn_record_set.rb

Overview

Information about the record that you want to create.

The AWS::Route53::RecordSet type can be used as a standalone resource or as an embedded property in the AWS::Route53::RecordSetGroup type. Note that some AWS::Route53::RecordSet properties are valid only when used within AWS::Route53::RecordSetGroup .

For more information, see ChangeResourceRecordSets in the Amazon Route 53 API Reference .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnRecordSet

Create a new AWS::Route53::RecordSet.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::Route53::CfnRecordSetProps) —

    Resource properties.



21
22
23
24
25
26
27
 
# File 'route53/cfn_record_set.rb', line 21

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Route53::CfnRecordSetProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfcm91dGU1My5DZm5SZWNvcmRTZXRQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


190
191
192
 
# File 'route53/cfn_record_set.rb', line 190

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_route53.CfnRecordSet", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_record_set(x) ⇒ Boolean

Checks whether the given object is a CfnRecordSet.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


92
93
94
95
 
# File 'route53/cfn_record_set.rb', line 92

def self.is_cfn_record_set(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_route53.CfnRecordSet", "isCfnRecordSet", [x])
end

.jsii_overridable_methods ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'route53/cfn_record_set.rb', line 29

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :record_set_ref => { kind: :property, name: "recordSetRef", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :type => { kind: :property, name: "type", is_optional: false },
    :alias_target => { kind: :property, name: "aliasTarget", is_optional: true },
    :cidr_routing_config => { kind: :property, name: "cidrRoutingConfig", is_optional: true },
    :comment => { kind: :property, name: "comment", is_optional: true },
    :failover => { kind: :property, name: "failover", is_optional: true },
    :geo_location => { kind: :property, name: "geoLocation", is_optional: true },
    :geo_proximity_location => { kind: :property, name: "geoProximityLocation", is_optional: true },
    :health_check_id => { kind: :property, name: "healthCheckId", is_optional: true },
    :hosted_zone_id => { kind: :property, name: "hostedZoneId", is_optional: true },
    :hosted_zone_name => { kind: :property, name: "hostedZoneName", is_optional: true },
    :multi_value_answer => { kind: :property, name: "multiValueAnswer", is_optional: true },
    :region => { kind: :property, name: "region", is_optional: true },
    :resource_records => { kind: :property, name: "resourceRecords", is_optional: true },
    :set_identifier => { kind: :property, name: "setIdentifier", is_optional: true },
    :ttl => { kind: :property, name: "ttl", is_optional: true },
    :weight => { kind: :property, name: "weight", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



454
455
456
457
 
# File 'route53/cfn_record_set.rb', line 454

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



466
467
468
469
 
# File 'route53/cfn_record_set.rb', line 466

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



476
477
478
479
 
# File 'route53/cfn_record_set.rb', line 476

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



487
488
489
490
491
 
# File 'route53/cfn_record_set.rb', line 487

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


544
545
546
547
548
 
# File 'route53/cfn_record_set.rb', line 544

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



554
555
556
557
 
# File 'route53/cfn_record_set.rb', line 554

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



566
567
568
569
570
 
# File 'route53/cfn_record_set.rb', line 566

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#alias_target ⇒ AWSCDK::IResolvable, ...

Alias resource record sets only: Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.

Returns:



235
236
237
 
# File 'route53/cfn_record_set.rb', line 235

def alias_target()
  jsii_get_property("aliasTarget")
end

#alias_target=(value) ⇒ Object 



239
240
241
242
243
 
# File 'route53/cfn_record_set.rb', line 239

def alias_target=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Route53::CfnRecordSet::AliasTargetProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yb3V0ZTUzLkNmblJlY29yZFNldC5BbGlhc1RhcmdldFByb3BlcnR5In1dfX0=")), "aliasTarget") unless value.nil?
  jsii_set_property("aliasTarget", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



579
580
581
582
 
# File 'route53/cfn_record_set.rb', line 579

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



601
602
603
604
605
606
 
# File 'route53/cfn_record_set.rb', line 601

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_id ⇒ String

This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

Returns:

  • (String) 


197
198
199
 
# File 'route53/cfn_record_set.rb', line 197

def attr_id()
  jsii_get_property("attrId")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



143
144
145
 
# File 'route53/cfn_record_set.rb', line 143

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


148
149
150
 
# File 'route53/cfn_record_set.rb', line 148

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


610
611
612
613
 
# File 'route53/cfn_record_set.rb', line 610

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


153
154
155
 
# File 'route53/cfn_record_set.rb', line 153

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


160
161
162
 
# File 'route53/cfn_record_set.rb', line 160

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cidr_routing_config ⇒ AWSCDK::IResolvable, ...

The object that is specified in resource record set object when you are linking a resource record set to a CIDR location.

Returns:



248
249
250
 
# File 'route53/cfn_record_set.rb', line 248

def cidr_routing_config()
  jsii_get_property("cidrRoutingConfig")
end

#cidr_routing_config=(value) ⇒ Object 



252
253
254
255
256
 
# File 'route53/cfn_record_set.rb', line 252

def cidr_routing_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Route53::CfnRecordSet::CIDRRoutingConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yb3V0ZTUzLkNmblJlY29yZFNldC5DaWRyUm91dGluZ0NvbmZpZ1Byb3BlcnR5In1dfX0=")), "cidrRoutingConfig") unless value.nil?
  jsii_set_property("cidrRoutingConfig", value)
end

#comment ⇒ String?

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

Returns:

  • (String, nil) 


261
262
263
 
# File 'route53/cfn_record_set.rb', line 261

def comment()
  jsii_get_property("comment")
end

#comment=(value) ⇒ Object 



265
266
267
268
 
# File 'route53/cfn_record_set.rb', line 265

def comment=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "comment") unless value.nil?
  jsii_set_property("comment", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


105
106
107
 
# File 'route53/cfn_record_set.rb', line 105

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



165
166
167
 
# File 'route53/cfn_record_set.rb', line 165

def env()
  jsii_get_property("env")
end

#failover ⇒ String?

Failover resource record sets only: To configure failover, you add the Failover element to two resource record sets.

Returns:

  • (String, nil) 


273
274
275
 
# File 'route53/cfn_record_set.rb', line 273

def failover()
  jsii_get_property("failover")
end

#failover=(value) ⇒ Object 



277
278
279
280
 
# File 'route53/cfn_record_set.rb', line 277

def failover=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "failover") unless value.nil?
  jsii_set_property("failover", value)
end

#geo_location ⇒ AWSCDK::IResolvable, ...

Geolocation resource record sets only: A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query.

Returns:



285
286
287
 
# File 'route53/cfn_record_set.rb', line 285

def geo_location()
  jsii_get_property("geoLocation")
end

#geo_location=(value) ⇒ Object 



289
290
291
292
293
 
# File 'route53/cfn_record_set.rb', line 289

def geo_location=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Route53::CfnRecordSet::GeoLocationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yb3V0ZTUzLkNmblJlY29yZFNldC5HZW9Mb2NhdGlvblByb3BlcnR5In1dfX0=")), "geoLocation") unless value.nil?
  jsii_set_property("geoLocation", value)
end

#geo_proximity_location ⇒ AWSCDK::IResolvable, ...

GeoproximityLocation resource record sets only: A complex type that lets you control how Route 53 responds to DNS queries based on the geographic origin of the query and your resources.

Returns:



298
299
300
 
# File 'route53/cfn_record_set.rb', line 298

def geo_proximity_location()
  jsii_get_property("geoProximityLocation")
end

#geo_proximity_location=(value) ⇒ Object 



302
303
304
305
306
 
# File 'route53/cfn_record_set.rb', line 302

def geo_proximity_location=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Route53::CfnRecordSet::GeoProximityLocationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yb3V0ZTUzLkNmblJlY29yZFNldC5HZW9Qcm94aW1pdHlMb2NhdGlvblByb3BlcnR5In1dfX0=")), "geoProximityLocation") unless value.nil?
  jsii_set_property("geoProximityLocation", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



623
624
625
626
627
 
# File 'route53/cfn_record_set.rb', line 623

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



634
635
636
637
 
# File 'route53/cfn_record_set.rb', line 634

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#health_check_id ⇒ String?

If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the HealthCheckId element and specify the ID of the applicable health check.

Returns:

  • (String, nil) 


311
312
313
 
# File 'route53/cfn_record_set.rb', line 311

def health_check_id()
  jsii_get_property("healthCheckId")
end

#health_check_id=(value) ⇒ Object 



315
316
317
318
 
# File 'route53/cfn_record_set.rb', line 315

def health_check_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "healthCheckId") unless value.nil?
  jsii_set_property("healthCheckId", value)
end

#hosted_zone_id ⇒ String?

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

Returns:

  • (String, nil) 


323
324
325
 
# File 'route53/cfn_record_set.rb', line 323

def hosted_zone_id()
  jsii_get_property("hostedZoneId")
end

#hosted_zone_id=(value) ⇒ Object 



327
328
329
330
 
# File 'route53/cfn_record_set.rb', line 327

def hosted_zone_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "hostedZoneId") unless value.nil?
  jsii_set_property("hostedZoneId", value)
end

#hosted_zone_name ⇒ String?

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

Returns:

  • (String, nil) 


335
336
337
 
# File 'route53/cfn_record_set.rb', line 335

def hosted_zone_name()
  jsii_get_property("hostedZoneName")
end

#hosted_zone_name=(value) ⇒ Object 



339
340
341
342
 
# File 'route53/cfn_record_set.rb', line 339

def hosted_zone_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "hostedZoneName") unless value.nil?
  jsii_set_property("hostedZoneName", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



704
705
706
707
 
# File 'route53/cfn_record_set.rb', line 704

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


117
118
119
 
# File 'route53/cfn_record_set.rb', line 117

def logical_id()
  jsii_get_property("logicalId")
end

#multi_value_answer ⇒ Boolean, ...

Multivalue answer resource record sets only : To route traffic approximately randomly to multiple resources, such as web servers, create one multivalue answer record for each resource and specify true for MultiValueAnswer .

Returns:



347
348
349
 
# File 'route53/cfn_record_set.rb', line 347

def multi_value_answer()
  jsii_get_property("multiValueAnswer")
end

#multi_value_answer=(value) ⇒ Object 



351
352
353
354
 
# File 'route53/cfn_record_set.rb', line 351

def multi_value_answer=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "multiValueAnswer") unless value.nil?
  jsii_set_property("multiValueAnswer", value)
end

#name ⇒ String

The name of the record that you want to create, update, or delete.

Returns:

  • (String) 


211
212
213
 
# File 'route53/cfn_record_set.rb', line 211

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



215
216
217
218
 
# File 'route53/cfn_record_set.rb', line 215

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


100
101
102
 
# File 'route53/cfn_record_set.rb', line 100

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



645
646
647
 
# File 'route53/cfn_record_set.rb', line 645

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



652
653
654
 
# File 'route53/cfn_record_set.rb', line 652

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



445
446
447
448
 
# File 'route53/cfn_record_set.rb', line 445

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#record_set_ref ⇒ AWSCDK::Interfaces::AWSRoute53::RecordSetReference

A reference to a RecordSet resource.

Returns:



204
205
206
 
# File 'route53/cfn_record_set.rb', line 204

def record_set_ref()
  jsii_get_property("recordSetRef")
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


136
137
138
 
# File 'route53/cfn_record_set.rb', line 136

def ref()
  jsii_get_property("ref")
end

#region ⇒ String?

Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to.

Returns:

  • (String, nil) 


359
360
361
 
# File 'route53/cfn_record_set.rb', line 359

def region()
  jsii_get_property("region")
end

#region=(value) ⇒ Object 



363
364
365
366
 
# File 'route53/cfn_record_set.rb', line 363

def region=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "region") unless value.nil?
  jsii_set_property("region", value)
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



663
664
665
666
 
# File 'route53/cfn_record_set.rb', line 663

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


670
671
672
673
 
# File 'route53/cfn_record_set.rb', line 670

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



680
681
682
683
684
 
# File 'route53/cfn_record_set.rb', line 680

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#resource_records ⇒ Array<String>?

One or more values that correspond with the value that you specified for the Type property.

Returns:

  • (Array<String>, nil) 


371
372
373
 
# File 'route53/cfn_record_set.rb', line 371

def resource_records()
  jsii_get_property("resourceRecords")
end

#resource_records=(value) ⇒ Object 



375
376
377
378
 
# File 'route53/cfn_record_set.rb', line 375

def resource_records=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "resourceRecords") unless value.nil?
  jsii_set_property("resourceRecords", value)
end

#set_identifier ⇒ String?

Resource record sets that have a routing policy other than simple: An identifier that differentiates among multiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named acme.example.com that have a type of A. In a group of resource record sets that have the same name and type, the value of SetIdentifier must be unique for each resource record set.

Returns:

  • (String, nil) 


383
384
385
 
# File 'route53/cfn_record_set.rb', line 383

def set_identifier()
  jsii_get_property("setIdentifier")
end

#set_identifier=(value) ⇒ Object 



387
388
389
390
 
# File 'route53/cfn_record_set.rb', line 387

def set_identifier=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "setIdentifier") unless value.nil?
  jsii_set_property("setIdentifier", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



689
690
691
 
# File 'route53/cfn_record_set.rb', line 689

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



126
127
128
 
# File 'route53/cfn_record_set.rb', line 126

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



421
422
423
 
# File 'route53/cfn_record_set.rb', line 421

def to_string()
  jsii_call_method("toString", [])
end

#ttl ⇒ String?

The resource record cache time to live (TTL), in seconds.

Note the following:.

Returns:

  • (String, nil) 


397
398
399
 
# File 'route53/cfn_record_set.rb', line 397

def ttl()
  jsii_get_property("ttl")
end

#ttl=(value) ⇒ Object 



401
402
403
404
 
# File 'route53/cfn_record_set.rb', line 401

def ttl=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ttl") unless value.nil?
  jsii_set_property("ttl", value)
end

#type ⇒ String

The DNS record type.

Returns:

  • (String) 


223
224
225
 
# File 'route53/cfn_record_set.rb', line 223

def type()
  jsii_get_property("type")
end

#type=(value) ⇒ Object 



227
228
229
230
 
# File 'route53/cfn_record_set.rb', line 227

def type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  jsii_set_property("type", value)
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


173
174
175
 
# File 'route53/cfn_record_set.rb', line 173

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


183
184
185
 
# File 'route53/cfn_record_set.rb', line 183

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


695
696
697
698
 
# File 'route53/cfn_record_set.rb', line 695

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#weight ⇒ Numeric?

Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set.

Returns:

  • (Numeric, nil) 


409
410
411
 
# File 'route53/cfn_record_set.rb', line 409

def weight()
  jsii_get_property("weight")
end

#weight=(value) ⇒ Object 



413
414
415
416
 
# File 'route53/cfn_record_set.rb', line 413

def weight=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "weight") unless value.nil?
  jsii_set_property("weight", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


434
435
436
437
438
439
 
# File 'route53/cfn_record_set.rb', line 434

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end