1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Dns
  5. getRrset
Oracle Cloud Infrastructure v2.2.0 published on Friday, Jul 12, 2024 by Pulumi

oci.Dns.getRrset

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.2.0 published on Friday, Jul 12, 2024 by Pulumi

    This data source provides details about a specific Rrset resource in Oracle Cloud Infrastructure DNS service.

    Gets a list of all records in the specified RRSet. The results are sorted by recordHash by default. For private zones, the scope query parameter is required with a value of PRIVATE. When the zone name is provided as a path parameter and PRIVATE is used for the scope query parameter then the viewId query parameter is required.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testRrset = oci.Dns.getRrset({
        domain: rrsetDomain,
        rtype: rrsetRtype,
        zoneNameOrId: testZone.id,
        compartmentId: compartmentId,
        scope: rrsetScope,
        viewId: testView.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_rrset = oci.Dns.get_rrset(domain=rrset_domain,
        rtype=rrset_rtype,
        zone_name_or_id=test_zone["id"],
        compartment_id=compartment_id,
        scope=rrset_scope,
        view_id=test_view["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Dns"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Dns.GetRrset(ctx, &dns.GetRrsetArgs{
    			Domain:        rrsetDomain,
    			Rtype:         rrsetRtype,
    			ZoneNameOrId:  testZone.Id,
    			CompartmentId: pulumi.StringRef(compartmentId),
    			Scope:         pulumi.StringRef(rrsetScope),
    			ViewId:        pulumi.StringRef(testView.Id),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testRrset = Oci.Dns.GetRrset.Invoke(new()
        {
            Domain = rrsetDomain,
            Rtype = rrsetRtype,
            ZoneNameOrId = testZone.Id,
            CompartmentId = compartmentId,
            Scope = rrsetScope,
            ViewId = testView.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Dns.DnsFunctions;
    import com.pulumi.oci.Dns.inputs.GetRrsetArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var testRrset = DnsFunctions.getRrset(GetRrsetArgs.builder()
                .domain(rrsetDomain)
                .rtype(rrsetRtype)
                .zoneNameOrId(testZone.id())
                .compartmentId(compartmentId)
                .scope(rrsetScope)
                .viewId(testView.id())
                .build());
    
        }
    }
    
    variables:
      testRrset:
        fn::invoke:
          Function: oci:Dns:getRrset
          Arguments:
            domain: ${rrsetDomain}
            rtype: ${rrsetRtype}
            zoneNameOrId: ${testZone.id}
            compartmentId: ${compartmentId}
            scope: ${rrsetScope}
            viewId: ${testView.id}
    

    Using getRrset

    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 getRrset(args: GetRrsetArgs, opts?: InvokeOptions): Promise<GetRrsetResult>
    function getRrsetOutput(args: GetRrsetOutputArgs, opts?: InvokeOptions): Output<GetRrsetResult>
    def get_rrset(compartment_id: Optional[str] = None,
                  domain: Optional[str] = None,
                  rtype: Optional[str] = None,
                  scope: Optional[str] = None,
                  view_id: Optional[str] = None,
                  zone_name_or_id: Optional[str] = None,
                  zone_version: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetRrsetResult
    def get_rrset_output(compartment_id: Optional[pulumi.Input[str]] = None,
                  domain: Optional[pulumi.Input[str]] = None,
                  rtype: Optional[pulumi.Input[str]] = None,
                  scope: Optional[pulumi.Input[str]] = None,
                  view_id: Optional[pulumi.Input[str]] = None,
                  zone_name_or_id: Optional[pulumi.Input[str]] = None,
                  zone_version: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetRrsetResult]
    func GetRrset(ctx *Context, args *GetRrsetArgs, opts ...InvokeOption) (*GetRrsetResult, error)
    func GetRrsetOutput(ctx *Context, args *GetRrsetOutputArgs, opts ...InvokeOption) GetRrsetResultOutput

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

    public static class GetRrset 
    {
        public static Task<GetRrsetResult> InvokeAsync(GetRrsetArgs args, InvokeOptions? opts = null)
        public static Output<GetRrsetResult> Invoke(GetRrsetInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRrsetResult> getRrset(GetRrsetArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Dns/getRrset:getRrset
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Domain string
    The target fully-qualified domain name (FQDN) within the target zone.
    Rtype string
    The type of the target RRSet within the target zone.
    ZoneNameOrId string
    The name or OCID of the target zone.
    CompartmentId string
    The OCID of the compartment the resource belongs to.
    Scope string
    Specifies to operate only on resources that have a matching DNS scope. This value will be null for zones in the global DNS and PRIVATE when listing private Rrsets.
    ViewId string
    The OCID of the view the resource is associated with.
    ZoneVersion string
    The version of the zone for which data is requested.
    Domain string
    The target fully-qualified domain name (FQDN) within the target zone.
    Rtype string
    The type of the target RRSet within the target zone.
    ZoneNameOrId string
    The name or OCID of the target zone.
    CompartmentId string
    The OCID of the compartment the resource belongs to.
    Scope string
    Specifies to operate only on resources that have a matching DNS scope. This value will be null for zones in the global DNS and PRIVATE when listing private Rrsets.
    ViewId string
    The OCID of the view the resource is associated with.
    ZoneVersion string
    The version of the zone for which data is requested.
    domain String
    The target fully-qualified domain name (FQDN) within the target zone.
    rtype String
    The type of the target RRSet within the target zone.
    zoneNameOrId String
    The name or OCID of the target zone.
    compartmentId String
    The OCID of the compartment the resource belongs to.
    scope String
    Specifies to operate only on resources that have a matching DNS scope. This value will be null for zones in the global DNS and PRIVATE when listing private Rrsets.
    viewId String
    The OCID of the view the resource is associated with.
    zoneVersion String
    The version of the zone for which data is requested.
    domain string
    The target fully-qualified domain name (FQDN) within the target zone.
    rtype string
    The type of the target RRSet within the target zone.
    zoneNameOrId string
    The name or OCID of the target zone.
    compartmentId string
    The OCID of the compartment the resource belongs to.
    scope string
    Specifies to operate only on resources that have a matching DNS scope. This value will be null for zones in the global DNS and PRIVATE when listing private Rrsets.
    viewId string
    The OCID of the view the resource is associated with.
    zoneVersion string
    The version of the zone for which data is requested.
    domain str
    The target fully-qualified domain name (FQDN) within the target zone.
    rtype str
    The type of the target RRSet within the target zone.
    zone_name_or_id str
    The name or OCID of the target zone.
    compartment_id str
    The OCID of the compartment the resource belongs to.
    scope str
    Specifies to operate only on resources that have a matching DNS scope. This value will be null for zones in the global DNS and PRIVATE when listing private Rrsets.
    view_id str
    The OCID of the view the resource is associated with.
    zone_version str
    The version of the zone for which data is requested.
    domain String
    The target fully-qualified domain name (FQDN) within the target zone.
    rtype String
    The type of the target RRSet within the target zone.
    zoneNameOrId String
    The name or OCID of the target zone.
    compartmentId String
    The OCID of the compartment the resource belongs to.
    scope String
    Specifies to operate only on resources that have a matching DNS scope. This value will be null for zones in the global DNS and PRIVATE when listing private Rrsets.
    viewId String
    The OCID of the view the resource is associated with.
    zoneVersion String
    The version of the zone for which data is requested.

    getRrset Result

    The following output properties are available:

    Domain string
    The fully qualified domain name where the record can be located.
    Id string
    Items List<GetRrsetItem>
    Rtype string
    The type of DNS record, such as A or CNAME. For more information, see Resource Record (RR) TYPEs.
    ZoneNameOrId string
    CompartmentId string
    Scope string
    ViewId string
    ZoneVersion string
    Domain string
    The fully qualified domain name where the record can be located.
    Id string
    Items []GetRrsetItem
    Rtype string
    The type of DNS record, such as A or CNAME. For more information, see Resource Record (RR) TYPEs.
    ZoneNameOrId string
    CompartmentId string
    Scope string
    ViewId string
    ZoneVersion string
    domain String
    The fully qualified domain name where the record can be located.
    id String
    items List<GetRrsetItem>
    rtype String
    The type of DNS record, such as A or CNAME. For more information, see Resource Record (RR) TYPEs.
    zoneNameOrId String
    compartmentId String
    scope String
    viewId String
    zoneVersion String
    domain string
    The fully qualified domain name where the record can be located.
    id string
    items GetRrsetItem[]
    rtype string
    The type of DNS record, such as A or CNAME. For more information, see Resource Record (RR) TYPEs.
    zoneNameOrId string
    compartmentId string
    scope string
    viewId string
    zoneVersion string
    domain str
    The fully qualified domain name where the record can be located.
    id str
    items Sequence[dns.GetRrsetItem]
    rtype str
    The type of DNS record, such as A or CNAME. For more information, see Resource Record (RR) TYPEs.
    zone_name_or_id str
    compartment_id str
    scope str
    view_id str
    zone_version str
    domain String
    The fully qualified domain name where the record can be located.
    id String
    items List<Property Map>
    rtype String
    The type of DNS record, such as A or CNAME. For more information, see Resource Record (RR) TYPEs.
    zoneNameOrId String
    compartmentId String
    scope String
    viewId String
    zoneVersion String

    Supporting Types

    GetRrsetItem

    Domain string
    The target fully-qualified domain name (FQDN) within the target zone.
    IsProtected bool
    A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed.
    Rdata string
    The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see Supported DNS Resource Record Types
    RecordHash string
    A unique identifier for the record within its zone.
    RrsetVersion string
    The latest version of the record's zone in which its RRSet differs from the preceding version.
    Rtype string
    The type of the target RRSet within the target zone.
    Ttl int
    The Time To Live for the record, in seconds.
    Domain string
    The target fully-qualified domain name (FQDN) within the target zone.
    IsProtected bool
    A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed.
    Rdata string
    The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see Supported DNS Resource Record Types
    RecordHash string
    A unique identifier for the record within its zone.
    RrsetVersion string
    The latest version of the record's zone in which its RRSet differs from the preceding version.
    Rtype string
    The type of the target RRSet within the target zone.
    Ttl int
    The Time To Live for the record, in seconds.
    domain String
    The target fully-qualified domain name (FQDN) within the target zone.
    isProtected Boolean
    A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed.
    rdata String
    The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see Supported DNS Resource Record Types
    recordHash String
    A unique identifier for the record within its zone.
    rrsetVersion String
    The latest version of the record's zone in which its RRSet differs from the preceding version.
    rtype String
    The type of the target RRSet within the target zone.
    ttl Integer
    The Time To Live for the record, in seconds.
    domain string
    The target fully-qualified domain name (FQDN) within the target zone.
    isProtected boolean
    A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed.
    rdata string
    The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see Supported DNS Resource Record Types
    recordHash string
    A unique identifier for the record within its zone.
    rrsetVersion string
    The latest version of the record's zone in which its RRSet differs from the preceding version.
    rtype string
    The type of the target RRSet within the target zone.
    ttl number
    The Time To Live for the record, in seconds.
    domain str
    The target fully-qualified domain name (FQDN) within the target zone.
    is_protected bool
    A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed.
    rdata str
    The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see Supported DNS Resource Record Types
    record_hash str
    A unique identifier for the record within its zone.
    rrset_version str
    The latest version of the record's zone in which its RRSet differs from the preceding version.
    rtype str
    The type of the target RRSet within the target zone.
    ttl int
    The Time To Live for the record, in seconds.
    domain String
    The target fully-qualified domain name (FQDN) within the target zone.
    isProtected Boolean
    A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed.
    rdata String
    The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see Supported DNS Resource Record Types
    recordHash String
    A unique identifier for the record within its zone.
    rrsetVersion String
    The latest version of the record's zone in which its RRSet differs from the preceding version.
    rtype String
    The type of the target RRSet within the target zone.
    ttl Number
    The Time To Live for the record, in seconds.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.2.0 published on Friday, Jul 12, 2024 by Pulumi