Module dns

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-openstack repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-openstack repo.

Resources

Resource RecordSet

class RecordSet extends CustomResource

Manages a DNS record set in the OpenStack DNS Service.

Example Usage

Automatically detect the correct network

import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const exampleZone = new openstack.dns.Zone("exampleZone", {
    description: "a zone",
    email: "email2@example.com",
    ttl: 6000,
    type: "PRIMARY",
});
const rsExampleCom = new openstack.dns.RecordSet("rsExampleCom", {
    description: "An example record set",
    records: ["10.0.0.1"],
    ttl: 3000,
    type: "A",
    zoneId: exampleZone.id,
});

constructor

new RecordSet(name: string, args: RecordSetArgs, opts?: pulumi.CustomResourceOptions)

Create a RecordSet resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RecordSetState, opts?: pulumi.CustomResourceOptions): RecordSet

Get an existing RecordSet resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is RecordSet

Returns true if the given object is an instance of RecordSet. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the record set. Note the . at the end of the name. Changing this creates a new DNS record set.

property records

public records: pulumi.Output<string[] | undefined>;

An array of DNS records. Note: if an IPv6 address contains brackets ([ ]), the brackets will be stripped and the modified address will be recorded in the state.

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 DNS client. If omitted, the region argument of the provider is used. Changing this creates a new DNS record set.

property ttl

public ttl: pulumi.Output<number>;

The time to live (TTL) of the record set.

property type

public type: pulumi.Output<string>;

The type of record set. Examples: “A”, “MX”. Changing this creates a new DNS record set.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property valueSpecs

public valueSpecs: pulumi.Output<{[key: string]: any} | undefined>;

Map of additional options. Changing this creates a new record set.

property zoneId

public zoneId: pulumi.Output<string>;

The ID of the zone in which to create the record set. Changing this creates a new DNS record set.

Resource Zone

class Zone extends CustomResource

Manages a DNS zone in the OpenStack DNS Service.

Example Usage

Automatically detect the correct network

import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const exampleCom = new openstack.dns.Zone("example.com", {
    description: "An example zone",
    email: "jdoe@example.com",
    ttl: 3000,
    type: "PRIMARY",
});

constructor

new Zone(name: string, args?: ZoneArgs, opts?: pulumi.CustomResourceOptions)

Create a Zone resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ZoneState, opts?: pulumi.CustomResourceOptions): Zone

Get an existing Zone resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Zone

Returns true if the given object is an instance of Zone. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property attributes

public attributes: pulumi.Output<{[key: string]: any} | undefined>;

Attributes for the DNS Service scheduler. Changing this creates a new zone.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property masters

public masters: pulumi.Output<string[] | undefined>;

An array of master DNS servers. For when type is SECONDARY.

property name

public name: pulumi.Output<string>;

The name of the zone. Note the . at the end of the name. Changing this creates a new DNS zone.

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 Compute client. Keypairs are associated with accounts, but a Compute client is needed to create one. If omitted, the region argument of the provider is used. Changing this creates a new DNS zone.

property ttl

public ttl: pulumi.Output<number>;

The time to live (TTL) of the zone.

property type

public type: pulumi.Output<string>;

The type of zone. Can either be PRIMARY or SECONDARY. Changing this creates a new zone.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property valueSpecs

public valueSpecs: pulumi.Output<{[key: string]: any} | undefined>;

Map of additional options. Changing this creates a new zone.

Functions

Function getDnsZone

getDnsZone(args?: GetDnsZoneArgs, opts?: pulumi.InvokeOptions): Promise<GetDnsZoneResult>

Use this data source to get the ID of an available OpenStack DNS zone.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const zone1 = pulumi.output(openstack.dns.getDnsZone({
    name: "example.com",
}, { async: true }));

Others

interface GetDnsZoneArgs

interface GetDnsZoneArgs

A collection of arguments for invoking getDnsZone.

property attributes

attributes?: undefined | {[key: string]: any};

Attributes of the DNS Service scheduler.

property createdAt

createdAt?: undefined | string;

The time the zone was created.

property description

description?: undefined | string;

A description of the zone.

property email

email?: undefined | string;

The email contact for the zone record.

property masters

masters?: string[];

An array of master DNS servers. When type is SECONDARY.

property name

name?: undefined | string;

The name of the zone.

property poolId

poolId?: undefined | string;

The ID of the pool hosting the zone.

property projectId

projectId?: undefined | string;

The project ID that owns the zone.

property region

region?: undefined | string;

The region in which to obtain the V2 DNS client. A DNS client is needed to retrieve zone ids. If omitted, the region argument of the provider is used.

property serial

serial?: undefined | number;

The serial number of the zone.

property status

status?: undefined | string;

The zone’s status.

property transferredAt

transferredAt?: undefined | string;

The time the zone was transferred.

property ttl

ttl?: undefined | number;

The time to live (TTL) of the zone.

property type

type?: undefined | string;

The type of the zone. Can either be PRIMARY or SECONDARY.

property updatedAt

updatedAt?: undefined | string;

The time the zone was last updated.

property version

version?: undefined | number;

The version of the zone.

interface GetDnsZoneResult

interface GetDnsZoneResult

A collection of values returned by getDnsZone.

property attributes

attributes: {[key: string]: any};

Attributes of the DNS Service scheduler.

property createdAt

createdAt: string;

The time the zone was created.

property description

description?: undefined | string;

See Argument Reference above.

property email

email?: undefined | string;

See Argument Reference above.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property masters

masters: string[];

An array of master DNS servers. When type is SECONDARY.

property name

name?: undefined | string;

See Argument Reference above.

property poolId

poolId: string;

The ID of the pool hosting the zone.

property projectId

projectId: string;

The project ID that owns the zone.

property region

region: string;

See Argument Reference above.

property serial

serial: number;

The serial number of the zone.

property status

status?: undefined | string;

See Argument Reference above.

property transferredAt

transferredAt: string;

The time the zone was transferred.

property ttl

ttl?: undefined | number;

See Argument Reference above.

property type

type?: undefined | string;

See Argument Reference above.

property updatedAt

updatedAt: string;

The time the zone was last updated.

property version

version: number;

The version of the zone.

interface RecordSetArgs

interface RecordSetArgs

The set of arguments for constructing a RecordSet resource.

property description

description?: pulumi.Input<string>;

A description of the record set.

property name

name?: pulumi.Input<string>;

The name of the record set. Note the . at the end of the name. Changing this creates a new DNS record set.

property records

records?: pulumi.Input<pulumi.Input<string>[]>;

An array of DNS records. Note: if an IPv6 address contains brackets ([ ]), the brackets will be stripped and the modified address will be recorded in the state.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 DNS client. If omitted, the region argument of the provider is used. Changing this creates a new DNS record set.

property ttl

ttl?: pulumi.Input<number>;

The time to live (TTL) of the record set.

property type

type?: pulumi.Input<string>;

The type of record set. Examples: “A”, “MX”. Changing this creates a new DNS record set.

property valueSpecs

valueSpecs?: pulumi.Input<{[key: string]: any}>;

Map of additional options. Changing this creates a new record set.

property zoneId

zoneId: pulumi.Input<string>;

The ID of the zone in which to create the record set. Changing this creates a new DNS record set.

interface RecordSetState

interface RecordSetState

Input properties used for looking up and filtering RecordSet resources.

property description

description?: pulumi.Input<string>;

A description of the record set.

property name

name?: pulumi.Input<string>;

The name of the record set. Note the . at the end of the name. Changing this creates a new DNS record set.

property records

records?: pulumi.Input<pulumi.Input<string>[]>;

An array of DNS records. Note: if an IPv6 address contains brackets ([ ]), the brackets will be stripped and the modified address will be recorded in the state.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 DNS client. If omitted, the region argument of the provider is used. Changing this creates a new DNS record set.

property ttl

ttl?: pulumi.Input<number>;

The time to live (TTL) of the record set.

property type

type?: pulumi.Input<string>;

The type of record set. Examples: “A”, “MX”. Changing this creates a new DNS record set.

property valueSpecs

valueSpecs?: pulumi.Input<{[key: string]: any}>;

Map of additional options. Changing this creates a new record set.

property zoneId

zoneId?: pulumi.Input<string>;

The ID of the zone in which to create the record set. Changing this creates a new DNS record set.

interface ZoneArgs

interface ZoneArgs

The set of arguments for constructing a Zone resource.

property attributes

attributes?: pulumi.Input<{[key: string]: any}>;

Attributes for the DNS Service scheduler. Changing this creates a new zone.

property description

description?: pulumi.Input<string>;

A description of the zone.

property email

email?: pulumi.Input<string>;

The email contact for the zone record.

property masters

masters?: pulumi.Input<pulumi.Input<string>[]>;

An array of master DNS servers. For when type is SECONDARY.

property name

name?: pulumi.Input<string>;

The name of the zone. Note the . at the end of the name. Changing this creates a new DNS zone.

property region

region?: pulumi.Input<string>;

property ttl

ttl?: pulumi.Input<number>;

The time to live (TTL) of the zone.

property type

type?: pulumi.Input<string>;

The type of zone. Can either be PRIMARY or SECONDARY. Changing this creates a new zone.

property valueSpecs

valueSpecs?: pulumi.Input<{[key: string]: any}>;

Map of additional options. Changing this creates a new zone.

interface ZoneState

interface ZoneState

Input properties used for looking up and filtering Zone resources.

property attributes

attributes?: pulumi.Input<{[key: string]: any}>;

Attributes for the DNS Service scheduler. Changing this creates a new zone.

property description

description?: pulumi.Input<string>;

A description of the zone.

property email

email?: pulumi.Input<string>;

The email contact for the zone record.

property masters

masters?: pulumi.Input<pulumi.Input<string>[]>;

An array of master DNS servers. For when type is SECONDARY.

property name

name?: pulumi.Input<string>;

The name of the zone. Note the . at the end of the name. Changing this creates a new DNS zone.

property region

region?: pulumi.Input<string>;

property ttl

ttl?: pulumi.Input<number>;

The time to live (TTL) of the zone.

property type

type?: pulumi.Input<string>;

The type of zone. Can either be PRIMARY or SECONDARY. Changing this creates a new zone.

property valueSpecs

valueSpecs?: pulumi.Input<{[key: string]: any}>;

Map of additional options. Changing this creates a new zone.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module dns

Resources

Functions

Others

Resources

Example Usage

Automatically detect the correct network

Example Usage

Automatically detect the correct network

Functions

Example Usage

Others