Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. route53
  6. getRecordSet

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.78.0
published on Monday, Sep 7, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.route53.getRecordSet

aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.78.0
published on Monday, Sep 7, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Route53::RecordSet.

    Using getRecordSet

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRecordSet(args: GetRecordSetArgs, opts?: InvokeOptions): Promise<GetRecordSetResult>
function getRecordSetOutput(args: GetRecordSetOutputArgs, opts?: InvokeOutputOptions): Output<GetRecordSetResult>
    def get_record_set(hosted_zone_id: Optional[str] = None,
                   name: Optional[str] = None,
                   set_identifier: Optional[str] = None,
                   type: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetRecordSetResult
def get_record_set_output(hosted_zone_id: pulumi.Input[Optional[str]] = None,
                   name: pulumi.Input[Optional[str]] = None,
                   set_identifier: pulumi.Input[Optional[str]] = None,
                   type: pulumi.Input[Optional[str]] = None,
                   opts: Optional[InvokeOutputOptions] = None) -> Output[GetRecordSetResult]
    func LookupRecordSet(ctx *Context, args *LookupRecordSetArgs, opts ...InvokeOption) (*LookupRecordSetResult, error)
func LookupRecordSetOutput(ctx *Context, args *LookupRecordSetOutputArgs, opts ...InvokeOption) LookupRecordSetResultOutput

    > Note: This function is named LookupRecordSet in the Go SDK.

    public static class GetRecordSet 
{
    public static Task<GetRecordSetResult> InvokeAsync(GetRecordSetArgs args, InvokeOptions? opts = null)
    public static Output<GetRecordSetResult> Invoke(GetRecordSetInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetRecordSetResult> Invoke(GetRecordSetInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetRecordSetResult> getRecordSet(GetRecordSetArgs args, InvokeOptions options)
public static Output<GetRecordSetResult> getRecordSet(GetRecordSetArgs args, InvokeOptions options)
public static Output<GetRecordSetResult> getRecordSet(GetRecordSetArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: aws-native:route53:getRecordSet
  arguments:
    # arguments dictionary
    data "aws-native_route53_get_record_set" "name" {
    # arguments
}

    The following arguments are supported:

    HostedZoneId string
    The ID of the hosted zone that you want to create records in.
    Name string
    The name of the record that you want to create, update, or delete.
    SetIdentifier string
    An identifier that differentiates among multiple resource record sets that have the same combination of name and type.
    Type string
    The DNS record type.
    HostedZoneId string
    The ID of the hosted zone that you want to create records in.
    Name string
    The name of the record that you want to create, update, or delete.
    SetIdentifier string
    An identifier that differentiates among multiple resource record sets that have the same combination of name and type.
    Type string
    The DNS record type.
    hosted_zone_id string
    The ID of the hosted zone that you want to create records in.
    name string
    The name of the record that you want to create, update, or delete.
    set_identifier string
    An identifier that differentiates among multiple resource record sets that have the same combination of name and type.
    type string
    The DNS record type.
    hostedZoneId String
    The ID of the hosted zone that you want to create records in.
    name String
    The name of the record that you want to create, update, or delete.
    setIdentifier String
    An identifier that differentiates among multiple resource record sets that have the same combination of name and type.
    type String
    The DNS record type.
    hostedZoneId string
    The ID of the hosted zone that you want to create records in.
    name string
    The name of the record that you want to create, update, or delete.
    setIdentifier string
    An identifier that differentiates among multiple resource record sets that have the same combination of name and type.
    type string
    The DNS record type.
    hosted_zone_id str
    The ID of the hosted zone that you want to create records in.
    name str
    The name of the record that you want to create, update, or delete.
    set_identifier str
    An identifier that differentiates among multiple resource record sets that have the same combination of name and type.
    type str
    The DNS record type.
    hostedZoneId String
    The ID of the hosted zone that you want to create records in.
    name String
    The name of the record that you want to create, update, or delete.
    setIdentifier String
    An identifier that differentiates among multiple resource record sets that have the same combination of name and type.
    type String
    The DNS record type.

    getRecordSet Result

    The following output properties are available:

    AliasTarget Pulumi.AwsNative.Route53.Outputs.RecordSetAliasTarget
    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.
    CidrRoutingConfig Pulumi.AwsNative.Route53.Outputs.RecordSetCidrRoutingConfig
    The object that is specified in resource record set object when you are linking a resource record set to a CIDR location.
    Failover Pulumi.AwsNative.Route53.RecordSetFailover
    To configure failover, you add the Failover element to two resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other resource record set, you specify SECONDARY. In addition, you include the HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set.
    GeoLocation Pulumi.AwsNative.Route53.Outputs.RecordSetGeoLocation
    A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query.
    HealthCheckId 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.
    MultiValueAnswer bool
    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.
    Name string
    The name of the record that you want to create, update, or delete.
    Region string
    The Amazon EC2 Region where you created the resource that this resource record set refers to.
    ResourceRecords List<string>
    One or more values that correspond with the value that you specified for the Type property.
    SetIdentifier string
    An identifier that differentiates among multiple resource record sets that have the same combination of name and type.
    Ttl string
    The resource record cache time to live (TTL), in seconds.
    Type string
    The DNS record type.
    Weight int
    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. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total.
    AliasTarget RecordSetAliasTarget
    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.
    CidrRoutingConfig RecordSetCidrRoutingConfig
    The object that is specified in resource record set object when you are linking a resource record set to a CIDR location.
    Failover RecordSetFailover
    To configure failover, you add the Failover element to two resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other resource record set, you specify SECONDARY. In addition, you include the HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set.
    GeoLocation RecordSetGeoLocation
    A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query.
    HealthCheckId 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.
    MultiValueAnswer bool
    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.
    Name string
    The name of the record that you want to create, update, or delete.
    Region string
    The Amazon EC2 Region where you created the resource that this resource record set refers to.
    ResourceRecords []string
    One or more values that correspond with the value that you specified for the Type property.
    SetIdentifier string
    An identifier that differentiates among multiple resource record sets that have the same combination of name and type.
    Ttl string
    The resource record cache time to live (TTL), in seconds.
    Type string
    The DNS record type.
    Weight int
    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. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total.
    alias_target object
    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.
    cidr_routing_config object
    The object that is specified in resource record set object when you are linking a resource record set to a CIDR location.
    failover "PRIMARY" | "SECONDARY"
    To configure failover, you add the Failover element to two resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other resource record set, you specify SECONDARY. In addition, you include the HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set.
    geo_location object
    A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query.
    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.
    multi_value_answer bool
    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.
    name string
    The name of the record that you want to create, update, or delete.
    region string
    The Amazon EC2 Region where you created the resource that this resource record set refers to.
    resource_records list(string)
    One or more values that correspond with the value that you specified for the Type property.
    set_identifier string
    An identifier that differentiates among multiple resource record sets that have the same combination of name and type.
    ttl string
    The resource record cache time to live (TTL), in seconds.
    type string
    The DNS record type.
    weight number
    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. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total.
    aliasTarget RecordSetAliasTarget
    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.
    cidrRoutingConfig RecordSetCidrRoutingConfig
    The object that is specified in resource record set object when you are linking a resource record set to a CIDR location.
    failover RecordSetFailover
    To configure failover, you add the Failover element to two resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other resource record set, you specify SECONDARY. In addition, you include the HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set.
    geoLocation RecordSetGeoLocation
    A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query.
    healthCheckId 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.
    multiValueAnswer Boolean
    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.
    name String
    The name of the record that you want to create, update, or delete.
    region String
    The Amazon EC2 Region where you created the resource that this resource record set refers to.
    resourceRecords List<String>
    One or more values that correspond with the value that you specified for the Type property.
    setIdentifier String
    An identifier that differentiates among multiple resource record sets that have the same combination of name and type.
    ttl String
    The resource record cache time to live (TTL), in seconds.
    type String
    The DNS record type.
    weight Integer
    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. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total.
    aliasTarget RecordSetAliasTarget
    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.
    cidrRoutingConfig RecordSetCidrRoutingConfig
    The object that is specified in resource record set object when you are linking a resource record set to a CIDR location.
    failover RecordSetFailover
    To configure failover, you add the Failover element to two resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other resource record set, you specify SECONDARY. In addition, you include the HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set.
    geoLocation RecordSetGeoLocation
    A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query.
    healthCheckId 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.
    multiValueAnswer boolean
    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.
    name string
    The name of the record that you want to create, update, or delete.
    region string
    The Amazon EC2 Region where you created the resource that this resource record set refers to.
    resourceRecords string[]
    One or more values that correspond with the value that you specified for the Type property.
    setIdentifier string
    An identifier that differentiates among multiple resource record sets that have the same combination of name and type.
    ttl string
    The resource record cache time to live (TTL), in seconds.
    type string
    The DNS record type.
    weight number
    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. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total.
    alias_target RecordSetAliasTarget
    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.
    cidr_routing_config RecordSetCidrRoutingConfig
    The object that is specified in resource record set object when you are linking a resource record set to a CIDR location.
    failover RecordSetFailover
    To configure failover, you add the Failover element to two resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other resource record set, you specify SECONDARY. In addition, you include the HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set.
    geo_location RecordSetGeoLocation
    A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query.
    health_check_id str
    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.
    multi_value_answer bool
    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.
    name str
    The name of the record that you want to create, update, or delete.
    region str
    The Amazon EC2 Region where you created the resource that this resource record set refers to.
    resource_records Sequence[str]
    One or more values that correspond with the value that you specified for the Type property.
    set_identifier str
    An identifier that differentiates among multiple resource record sets that have the same combination of name and type.
    ttl str
    The resource record cache time to live (TTL), in seconds.
    type str
    The DNS record type.
    weight int
    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. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total.
    aliasTarget Property Map
    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.
    cidrRoutingConfig Property Map
    The object that is specified in resource record set object when you are linking a resource record set to a CIDR location.
    failover "PRIMARY" | "SECONDARY"
    To configure failover, you add the Failover element to two resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other resource record set, you specify SECONDARY. In addition, you include the HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set.
    geoLocation Property Map
    A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query.
    healthCheckId 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.
    multiValueAnswer Boolean
    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.
    name String
    The name of the record that you want to create, update, or delete.
    region String
    The Amazon EC2 Region where you created the resource that this resource record set refers to.
    resourceRecords List<String>
    One or more values that correspond with the value that you specified for the Type property.
    setIdentifier String
    An identifier that differentiates among multiple resource record sets that have the same combination of name and type.
    ttl String
    The resource record cache time to live (TTL), in seconds.
    type String
    The DNS record type.
    weight Number
    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. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total.

    Supporting Types

    RecordSetAliasTarget

    DnsName string
    The value that you specify depends on where you want to route queries.
    HostedZoneId string
    The value used depends on where you want to route traffic.
    EvaluateTargetHealth bool
    When EvaluateTargetHealth is true, an alias resource record set inherits the health of the referenced AWS resource, such as an ELB load balancer or another resource record set in the hosted zone.
    DnsName string
    The value that you specify depends on where you want to route queries.
    HostedZoneId string
    The value used depends on where you want to route traffic.
    EvaluateTargetHealth bool
    When EvaluateTargetHealth is true, an alias resource record set inherits the health of the referenced AWS resource, such as an ELB load balancer or another resource record set in the hosted zone.
    dns_name string
    The value that you specify depends on where you want to route queries.
    hosted_zone_id string
    The value used depends on where you want to route traffic.
    evaluate_target_health bool
    When EvaluateTargetHealth is true, an alias resource record set inherits the health of the referenced AWS resource, such as an ELB load balancer or another resource record set in the hosted zone.
    dnsName String
    The value that you specify depends on where you want to route queries.
    hostedZoneId String
    The value used depends on where you want to route traffic.
    evaluateTargetHealth Boolean
    When EvaluateTargetHealth is true, an alias resource record set inherits the health of the referenced AWS resource, such as an ELB load balancer or another resource record set in the hosted zone.
    dnsName string
    The value that you specify depends on where you want to route queries.
    hostedZoneId string
    The value used depends on where you want to route traffic.
    evaluateTargetHealth boolean
    When EvaluateTargetHealth is true, an alias resource record set inherits the health of the referenced AWS resource, such as an ELB load balancer or another resource record set in the hosted zone.
    dns_name str
    The value that you specify depends on where you want to route queries.
    hosted_zone_id str
    The value used depends on where you want to route traffic.
    evaluate_target_health bool
    When EvaluateTargetHealth is true, an alias resource record set inherits the health of the referenced AWS resource, such as an ELB load balancer or another resource record set in the hosted zone.
    dnsName String
    The value that you specify depends on where you want to route queries.
    hostedZoneId String
    The value used depends on where you want to route traffic.
    evaluateTargetHealth Boolean
    When EvaluateTargetHealth is true, an alias resource record set inherits the health of the referenced AWS resource, such as an ELB load balancer or another resource record set in the hosted zone.

    RecordSetCidrRoutingConfig

    CollectionId string
    The CIDR collection ID.
    LocationName string
    The CIDR collection location name.
    CollectionId string
    The CIDR collection ID.
    LocationName string
    The CIDR collection location name.
    collection_id string
    The CIDR collection ID.
    location_name string
    The CIDR collection location name.
    collectionId String
    The CIDR collection ID.
    locationName String
    The CIDR collection location name.
    collectionId string
    The CIDR collection ID.
    locationName string
    The CIDR collection location name.
    collection_id str
    The CIDR collection ID.
    location_name str
    The CIDR collection location name.
    collectionId String
    The CIDR collection ID.
    locationName String
    The CIDR collection location name.

    RecordSetFailover

    RecordSetGeoLocation

    ContinentCode string
    For geolocation resource record sets, a two-letter abbreviation that identifies a continent.
    CountryCode string
    For geolocation resource record sets, the two-letter code for a country.
    SubdivisionCode string
    For geolocation resource record sets, the two-letter code for a state of the United States.
    ContinentCode string
    For geolocation resource record sets, a two-letter abbreviation that identifies a continent.
    CountryCode string
    For geolocation resource record sets, the two-letter code for a country.
    SubdivisionCode string
    For geolocation resource record sets, the two-letter code for a state of the United States.
    continent_code string
    For geolocation resource record sets, a two-letter abbreviation that identifies a continent.
    country_code string
    For geolocation resource record sets, the two-letter code for a country.
    subdivision_code string
    For geolocation resource record sets, the two-letter code for a state of the United States.
    continentCode String
    For geolocation resource record sets, a two-letter abbreviation that identifies a continent.
    countryCode String
    For geolocation resource record sets, the two-letter code for a country.
    subdivisionCode String
    For geolocation resource record sets, the two-letter code for a state of the United States.
    continentCode string
    For geolocation resource record sets, a two-letter abbreviation that identifies a continent.
    countryCode string
    For geolocation resource record sets, the two-letter code for a country.
    subdivisionCode string
    For geolocation resource record sets, the two-letter code for a state of the United States.
    continent_code str
    For geolocation resource record sets, a two-letter abbreviation that identifies a continent.
    country_code str
    For geolocation resource record sets, the two-letter code for a country.
    subdivision_code str
    For geolocation resource record sets, the two-letter code for a state of the United States.
    continentCode String
    For geolocation resource record sets, a two-letter abbreviation that identifies a continent.
    countryCode String
    For geolocation resource record sets, the two-letter code for a country.
    subdivisionCode String
    For geolocation resource record sets, the two-letter code for a state of the United States.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.78.0
    published on Monday, Sep 7, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial