This page documents the language specification for the openstack package. If you're looking for help working with the inputs, outputs, or functions of openstack resources in a Pulumi program, please see the resource documentation for examples and API reference.
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.
- class
pulumi_openstack.dns.AwaitableGetDnsZoneResult(attributes=None, created_at=None, description=None, email=None, id=None, masters=None, name=None, pool_id=None, project_id=None, region=None, serial=None, status=None, transferred_at=None, ttl=None, type=None, updated_at=None, version=None)¶
- class
pulumi_openstack.dns.GetDnsZoneResult(attributes=None, created_at=None, description=None, email=None, id=None, masters=None, name=None, pool_id=None, project_id=None, region=None, serial=None, status=None, transferred_at=None, ttl=None, type=None, updated_at=None, version=None)¶ A collection of values returned by getDnsZone.
attributes= None¶Attributes of the DNS Service scheduler.
created_at= None¶The time the zone was created.
description= None¶See Argument Reference above.
email= None¶See Argument Reference above.
id= None¶The provider-assigned unique ID for this managed resource.
masters= None¶An array of master DNS servers. When
typeisSECONDARY.
name= None¶See Argument Reference above.
pool_id= None¶The ID of the pool hosting the zone.
project_id= None¶The project ID that owns the zone.
region= None¶See Argument Reference above.
serial= None¶The serial number of the zone.
status= None¶See Argument Reference above.
transferred_at= None¶The time the zone was transferred.
ttl= None¶See Argument Reference above.
type= None¶See Argument Reference above.
updated_at= None¶The time the zone was last updated.
version= None¶The version of the zone.
- class
pulumi_openstack.dns.RecordSet(resource_name, opts=None, description=None, name=None, records=None, region=None, ttl=None, type=None, value_specs=None, zone_id=None, __props__=None, __name__=None, __opts__=None)¶ Manages a DNS record set in the OpenStack DNS Service.
import pulumi import pulumi_openstack as openstack example_zone = openstack.dns.Zone("exampleZone", description="a zone", email="email2@example.com", ttl=6000, type="PRIMARY") rs_example_com = openstack.dns.RecordSet("rsExampleCom", description="An example record set", records=["10.0.0.1"], ttl=3000, type="A", zone_id=example_zone.id)
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – A description of the record set.
name (pulumi.Input[str]) – The name of the record set. Note the
.at the end of the name. Changing this creates a new DNS record set.records (pulumi.Input[list]) – 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.region (pulumi.Input[str]) – The region in which to obtain the V2 DNS client. If omitted, the
regionargument of the provider is used. Changing this creates a new DNS record set.ttl (pulumi.Input[float]) – The time to live (TTL) of the record set.
type (pulumi.Input[str]) – The type of record set. Examples: “A”, “MX”. Changing this creates a new DNS record set.
value_specs (pulumi.Input[dict]) – Map of additional options. Changing this creates a new record set.
zone_id (pulumi.Input[str]) – The ID of the zone in which to create the record set. Changing this creates a new DNS record set.
description: pulumi.Output[str] = None¶A description of the record set.
name: pulumi.Output[str] = None¶The name of the record set. Note the
.at the end of the name. Changing this creates a new DNS record set.
records: pulumi.Output[list] = None¶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.
region: pulumi.Output[str] = None¶The region in which to obtain the V2 DNS client. If omitted, the
regionargument of the provider is used. Changing this creates a new DNS record set.
ttl: pulumi.Output[float] = None¶The time to live (TTL) of the record set.
type: pulumi.Output[str] = None¶The type of record set. Examples: “A”, “MX”. Changing this creates a new DNS record set.
value_specs: pulumi.Output[dict] = None¶Map of additional options. Changing this creates a new record set.
zone_id: pulumi.Output[str] = None¶The ID of the zone in which to create the record set. Changing this creates a new DNS record set.
- static
get(resource_name, id, opts=None, description=None, name=None, records=None, region=None, ttl=None, type=None, value_specs=None, zone_id=None)¶ Get an existing RecordSet resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – A description of the record set.
name (pulumi.Input[str]) – The name of the record set. Note the
.at the end of the name. Changing this creates a new DNS record set.records (pulumi.Input[list]) – 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.region (pulumi.Input[str]) – The region in which to obtain the V2 DNS client. If omitted, the
regionargument of the provider is used. Changing this creates a new DNS record set.ttl (pulumi.Input[float]) – The time to live (TTL) of the record set.
type (pulumi.Input[str]) – The type of record set. Examples: “A”, “MX”. Changing this creates a new DNS record set.
value_specs (pulumi.Input[dict]) – Map of additional options. Changing this creates a new record set.
zone_id (pulumi.Input[str]) – The ID of the zone in which to create the record set. Changing this creates a new DNS record set.
translate_output_property(prop)¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop)¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
- class
pulumi_openstack.dns.Zone(resource_name, opts=None, attributes=None, description=None, email=None, masters=None, name=None, region=None, ttl=None, type=None, value_specs=None, __props__=None, __name__=None, __opts__=None)¶ Manages a DNS zone in the OpenStack DNS Service.
import pulumi import pulumi_openstack as openstack example_com = openstack.dns.Zone("example.com", description="An example zone", email="jdoe@example.com", ttl=3000, type="PRIMARY")
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
attributes (pulumi.Input[dict]) – Attributes for the DNS Service scheduler. Changing this creates a new zone.
description (pulumi.Input[str]) – A description of the zone.
email (pulumi.Input[str]) – The email contact for the zone record.
masters (pulumi.Input[list]) – An array of master DNS servers. For when
typeisSECONDARY.name (pulumi.Input[str]) – The name of the zone. Note the
.at the end of the name. Changing this creates a new DNS zone.region (pulumi.Input[str]) – 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
regionargument of the provider is used. Changing this creates a new DNS zone.ttl (pulumi.Input[float]) – The time to live (TTL) of the zone.
type (pulumi.Input[str]) – The type of zone. Can either be
PRIMARYorSECONDARY. Changing this creates a new zone.value_specs (pulumi.Input[dict]) – Map of additional options. Changing this creates a new zone.
attributes: pulumi.Output[dict] = None¶Attributes for the DNS Service scheduler. Changing this creates a new zone.
description: pulumi.Output[str] = None¶A description of the zone.
email: pulumi.Output[str] = None¶The email contact for the zone record.
masters: pulumi.Output[list] = None¶An array of master DNS servers. For when
typeisSECONDARY.
name: pulumi.Output[str] = None¶The name of the zone. Note the
.at the end of the name. Changing this creates a new DNS zone.
region: pulumi.Output[str] = None¶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
regionargument of the provider is used. Changing this creates a new DNS zone.
ttl: pulumi.Output[float] = None¶The time to live (TTL) of the zone.
type: pulumi.Output[str] = None¶The type of zone. Can either be
PRIMARYorSECONDARY. Changing this creates a new zone.
value_specs: pulumi.Output[dict] = None¶Map of additional options. Changing this creates a new zone.
- static
get(resource_name, id, opts=None, attributes=None, description=None, email=None, masters=None, name=None, region=None, ttl=None, type=None, value_specs=None)¶ Get an existing Zone resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
attributes (pulumi.Input[dict]) – Attributes for the DNS Service scheduler. Changing this creates a new zone.
description (pulumi.Input[str]) – A description of the zone.
email (pulumi.Input[str]) – The email contact for the zone record.
masters (pulumi.Input[list]) – An array of master DNS servers. For when
typeisSECONDARY.name (pulumi.Input[str]) – The name of the zone. Note the
.at the end of the name. Changing this creates a new DNS zone.region (pulumi.Input[str]) – 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
regionargument of the provider is used. Changing this creates a new DNS zone.ttl (pulumi.Input[float]) – The time to live (TTL) of the zone.
type (pulumi.Input[str]) – The type of zone. Can either be
PRIMARYorSECONDARY. Changing this creates a new zone.value_specs (pulumi.Input[dict]) – Map of additional options. Changing this creates a new zone.
translate_output_property(prop)¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop)¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
pulumi_openstack.dns.get_dns_zone(attributes=None, created_at=None, description=None, email=None, masters=None, name=None, pool_id=None, project_id=None, region=None, serial=None, status=None, transferred_at=None, ttl=None, type=None, updated_at=None, version=None, opts=None)¶Use this data source to get the ID of an available OpenStack DNS zone.
import pulumi import pulumi_openstack as openstack zone1 = openstack.dns.get_dns_zone(name="example.com")
- Parameters
attributes (dict) – Attributes of the DNS Service scheduler.
created_at (str) – The time the zone was created.
description (str) – A description of the zone.
email (str) – The email contact for the zone record.
masters (list) – An array of master DNS servers. When
typeisSECONDARY.name (str) – The name of the zone.
pool_id (str) – The ID of the pool hosting the zone.
project_id (str) – The project ID that owns the zone.
region (str) – The region in which to obtain the V2 DNS client. A DNS client is needed to retrieve zone ids. If omitted, the
regionargument of the provider is used.serial (float) – The serial number of the zone.
status (str) – The zone’s status.
transferred_at (str) – The time the zone was transferred.
ttl (float) – The time to live (TTL) of the zone.
type (str) – The type of the zone. Can either be
PRIMARYorSECONDARY.updated_at (str) – The time the zone was last updated.
version (float) – The version of the zone.