Class: AWSCDK::Route53::CfnRecordSet::GeoProximityLocationProperty

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

Overview

(Resource record sets only): A complex type that lets you specify where your resources are located.

Only one of LocalZoneGroup , Coordinates , or AWS Region is allowed per request at a time.

For more information about geoproximity routing, see Geoproximity routing in the Amazon Route 53 Developer Guide .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(aws_region: nil, bias: nil, coordinates: nil, local_zone_group: nil) ⇒ GeoProximityLocationProperty

Returns a new instance of GeoProximityLocationProperty.

Parameters:

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

    The AWS Region the resource you are directing DNS traffic to, is in.

  • bias (Numeric, nil) (defaults to: nil) —

    The bias increases or decreases the size of the geographic region from which Route 53 routes traffic to a resource.

  • coordinates (AWSCDK::IResolvable, AWSCDK::Route53::CfnRecordSet::CoordinatesProperty, nil) (defaults to: nil) —

    Contains the longitude and latitude for a geographic region.

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

    Specifies an AWS Local Zone Group.



1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
 
# File 'route53/cfn_record_set.rb', line 1035

def initialize(aws_region: nil, bias: nil, coordinates: nil, local_zone_group: nil)
  @aws_region = aws_region
  Jsii::Type.check_type(@aws_region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "awsRegion") unless @aws_region.nil?
  @bias = bias
  Jsii::Type.check_type(@bias, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "bias") unless @bias.nil?
  @coordinates = coordinates.is_a?(Hash) ? ::AWSCDK::Route53::CfnRecordSet::CoordinatesProperty.new(**coordinates.transform_keys(&:to_sym)) : coordinates
  Jsii::Type.check_type(@coordinates, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yb3V0ZTUzLkNmblJlY29yZFNldC5Db29yZGluYXRlc1Byb3BlcnR5In1dfX0=")), "coordinates") unless @coordinates.nil?
  @local_zone_group = local_zone_group
  Jsii::Type.check_type(@local_zone_group, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "localZoneGroup") unless @local_zone_group.nil?
end

Instance Attribute Details

#aws_region ⇒ String? (readonly)

The AWS Region the resource you are directing DNS traffic to, is in.

Returns:

  • (String, nil)

See Also:



1050
1051
1052
 
# File 'route53/cfn_record_set.rb', line 1050

def aws_region
  @aws_region
end

#bias ⇒ Numeric? (readonly)

The bias increases or decreases the size of the geographic region from which Route 53 routes traffic to a resource.

To use Bias to change the size of the geographic region, specify the applicable value for the bias:

  • To expand the size of the geographic region from which Route 53 routes traffic to a resource, specify a positive integer from 1 to 99 for the bias. Route 53 shrinks the size of adjacent regions.
  • To shrink the size of the geographic region from which Route 53 routes traffic to a resource, specify a negative bias of -1 to -99. Route 53 expands the size of adjacent regions.

Returns:

  • (Numeric, nil)

See Also:



1060
1061
1062
 
# File 'route53/cfn_record_set.rb', line 1060

def bias
  @bias
end

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

Contains the longitude and latitude for a geographic region.

Returns:

See Also:



1065
1066
1067
 
# File 'route53/cfn_record_set.rb', line 1065

def coordinates
  @coordinates
end

#local_zone_group ⇒ String? (readonly)

Specifies an AWS Local Zone Group.

A local Zone Group is usually the Local Zone code without the ending character. For example, if the Local Zone is us-east-1-bue-1a the Local Zone Group is us-east-1-bue-1 .

You can identify the Local Zones Group for a specific Local Zone by using the describe-availability-zones CLI command:

This command returns: "GroupName": "us-west-2-den-1" , specifying that the Local Zone us-west-2-den-1a belongs to the Local Zone Group us-west-2-den-1 .

Returns:

  • (String, nil)

See Also:



1076
1077
1078
 
# File 'route53/cfn_record_set.rb', line 1076

def local_zone_group
  @local_zone_group
end

Class Method Details

.jsii_properties ⇒ Object 



1078
1079
1080
1081
1082
1083
1084
1085
 
# File 'route53/cfn_record_set.rb', line 1078

def self.jsii_properties
  {
    :aws_region => "awsRegion",
    :bias => "bias",
    :coordinates => "coordinates",
    :local_zone_group => "localZoneGroup",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
 
# File 'route53/cfn_record_set.rb', line 1087

def to_jsii
  result = {}
  result.merge!({
    "awsRegion" => @aws_region,
    "bias" => @bias,
    "coordinates" => @coordinates,
    "localZoneGroup" => @local_zone_group,
  })
  result.compact
end