1. Packages
  2. OpenStack
  3. API Docs
  4. dns
  5. TransferRequest
OpenStack v4.0.0 published on Tuesday, May 21, 2024 by Pulumi

openstack.dns.TransferRequest

Explore with Pulumi AI

openstack logo
OpenStack v4.0.0 published on Tuesday, May 21, 2024 by Pulumi

    Manages a DNS zone transfer request 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("example_zone", {
        name: "example.com.",
        email: "jdoe@example.com",
        description: "An example zone",
        ttl: 3000,
        type: "PRIMARY",
    });
    const request1 = new openstack.dns.TransferRequest("request_1", {
        zoneId: exampleZone.id,
        description: "a transfer request",
    });
    
    import pulumi
    import pulumi_openstack as openstack
    
    example_zone = openstack.dns.Zone("example_zone",
        name="example.com.",
        email="jdoe@example.com",
        description="An example zone",
        ttl=3000,
        type="PRIMARY")
    request1 = openstack.dns.TransferRequest("request_1",
        zone_id=example_zone.id,
        description="a transfer request")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-openstack/sdk/v4/go/openstack/dns"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleZone, err := dns.NewZone(ctx, "example_zone", &dns.ZoneArgs{
    			Name:        pulumi.String("example.com."),
    			Email:       pulumi.String("jdoe@example.com"),
    			Description: pulumi.String("An example zone"),
    			Ttl:         pulumi.Int(3000),
    			Type:        pulumi.String("PRIMARY"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = dns.NewTransferRequest(ctx, "request_1", &dns.TransferRequestArgs{
    			ZoneId:      exampleZone.ID(),
    			Description: pulumi.String("a transfer request"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using OpenStack = Pulumi.OpenStack;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleZone = new OpenStack.Dns.Zone("example_zone", new()
        {
            Name = "example.com.",
            Email = "jdoe@example.com",
            Description = "An example zone",
            Ttl = 3000,
            Type = "PRIMARY",
        });
    
        var request1 = new OpenStack.Dns.TransferRequest("request_1", new()
        {
            ZoneId = exampleZone.Id,
            Description = "a transfer request",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.openstack.dns.Zone;
    import com.pulumi.openstack.dns.ZoneArgs;
    import com.pulumi.openstack.dns.TransferRequest;
    import com.pulumi.openstack.dns.TransferRequestArgs;
    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) {
            var exampleZone = new Zone("exampleZone", ZoneArgs.builder()        
                .name("example.com.")
                .email("jdoe@example.com")
                .description("An example zone")
                .ttl(3000)
                .type("PRIMARY")
                .build());
    
            var request1 = new TransferRequest("request1", TransferRequestArgs.builder()        
                .zoneId(exampleZone.id())
                .description("a transfer request")
                .build());
    
        }
    }
    
    resources:
      exampleZone:
        type: openstack:dns:Zone
        name: example_zone
        properties:
          name: example.com.
          email: jdoe@example.com
          description: An example zone
          ttl: 3000
          type: PRIMARY
      request1:
        type: openstack:dns:TransferRequest
        name: request_1
        properties:
          zoneId: ${exampleZone.id}
          description: a transfer request
    

    Create TransferRequest Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new TransferRequest(name: string, args: TransferRequestArgs, opts?: CustomResourceOptions);
    @overload
    def TransferRequest(resource_name: str,
                        args: TransferRequestArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def TransferRequest(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        zone_id: Optional[str] = None,
                        description: Optional[str] = None,
                        disable_status_check: Optional[bool] = None,
                        key: Optional[str] = None,
                        region: Optional[str] = None,
                        target_project_id: Optional[str] = None,
                        value_specs: Optional[Mapping[str, Any]] = None)
    func NewTransferRequest(ctx *Context, name string, args TransferRequestArgs, opts ...ResourceOption) (*TransferRequest, error)
    public TransferRequest(string name, TransferRequestArgs args, CustomResourceOptions? opts = null)
    public TransferRequest(String name, TransferRequestArgs args)
    public TransferRequest(String name, TransferRequestArgs args, CustomResourceOptions options)
    
    type: openstack:dns:TransferRequest
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args TransferRequestArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args TransferRequestArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args TransferRequestArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TransferRequestArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TransferRequestArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var transferRequestResource = new OpenStack.Dns.TransferRequest("transferRequestResource", new()
    {
        ZoneId = "string",
        Description = "string",
        DisableStatusCheck = false,
        Key = "string",
        Region = "string",
        TargetProjectId = "string",
        ValueSpecs = 
        {
            { "string", "any" },
        },
    });
    
    example, err := dns.NewTransferRequest(ctx, "transferRequestResource", &dns.TransferRequestArgs{
    	ZoneId:             pulumi.String("string"),
    	Description:        pulumi.String("string"),
    	DisableStatusCheck: pulumi.Bool(false),
    	Key:                pulumi.String("string"),
    	Region:             pulumi.String("string"),
    	TargetProjectId:    pulumi.String("string"),
    	ValueSpecs: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    })
    
    var transferRequestResource = new TransferRequest("transferRequestResource", TransferRequestArgs.builder()
        .zoneId("string")
        .description("string")
        .disableStatusCheck(false)
        .key("string")
        .region("string")
        .targetProjectId("string")
        .valueSpecs(Map.of("string", "any"))
        .build());
    
    transfer_request_resource = openstack.dns.TransferRequest("transferRequestResource",
        zone_id="string",
        description="string",
        disable_status_check=False,
        key="string",
        region="string",
        target_project_id="string",
        value_specs={
            "string": "any",
        })
    
    const transferRequestResource = new openstack.dns.TransferRequest("transferRequestResource", {
        zoneId: "string",
        description: "string",
        disableStatusCheck: false,
        key: "string",
        region: "string",
        targetProjectId: "string",
        valueSpecs: {
            string: "any",
        },
    });
    
    type: openstack:dns:TransferRequest
    properties:
        description: string
        disableStatusCheck: false
        key: string
        region: string
        targetProjectId: string
        valueSpecs:
            string: any
        zoneId: string
    

    TransferRequest Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The TransferRequest resource accepts the following input properties:

    ZoneId string
    The ID of the zone for which to create the transfer request.
    Description string
    A description of the zone tranfer request.
    DisableStatusCheck bool
    Disable wait for zone to reach ACTIVE status. The check is enabled by default. If this argument is true, zone will be considered as created/updated if OpenStack request returned success.
    Key string
    Region 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.
    TargetProjectId string
    The target Project ID to transfer to.
    ValueSpecs Dictionary<string, object>
    Map of additional options. Changing this creates a new transfer request.
    ZoneId string
    The ID of the zone for which to create the transfer request.
    Description string
    A description of the zone tranfer request.
    DisableStatusCheck bool
    Disable wait for zone to reach ACTIVE status. The check is enabled by default. If this argument is true, zone will be considered as created/updated if OpenStack request returned success.
    Key string
    Region 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.
    TargetProjectId string
    The target Project ID to transfer to.
    ValueSpecs map[string]interface{}
    Map of additional options. Changing this creates a new transfer request.
    zoneId String
    The ID of the zone for which to create the transfer request.
    description String
    A description of the zone tranfer request.
    disableStatusCheck Boolean
    Disable wait for zone to reach ACTIVE status. The check is enabled by default. If this argument is true, zone will be considered as created/updated if OpenStack request returned success.
    key String
    region 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.
    targetProjectId String
    The target Project ID to transfer to.
    valueSpecs Map<String,Object>
    Map of additional options. Changing this creates a new transfer request.
    zoneId string
    The ID of the zone for which to create the transfer request.
    description string
    A description of the zone tranfer request.
    disableStatusCheck boolean
    Disable wait for zone to reach ACTIVE status. The check is enabled by default. If this argument is true, zone will be considered as created/updated if OpenStack request returned success.
    key string
    region 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.
    targetProjectId string
    The target Project ID to transfer to.
    valueSpecs {[key: string]: any}
    Map of additional options. Changing this creates a new transfer request.
    zone_id str
    The ID of the zone for which to create the transfer request.
    description str
    A description of the zone tranfer request.
    disable_status_check bool
    Disable wait for zone to reach ACTIVE status. The check is enabled by default. If this argument is true, zone will be considered as created/updated if OpenStack request returned success.
    key str
    region 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 region argument of the provider is used. Changing this creates a new DNS zone.
    target_project_id str
    The target Project ID to transfer to.
    value_specs Mapping[str, Any]
    Map of additional options. Changing this creates a new transfer request.
    zoneId String
    The ID of the zone for which to create the transfer request.
    description String
    A description of the zone tranfer request.
    disableStatusCheck Boolean
    Disable wait for zone to reach ACTIVE status. The check is enabled by default. If this argument is true, zone will be considered as created/updated if OpenStack request returned success.
    key String
    region 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.
    targetProjectId String
    The target Project ID to transfer to.
    valueSpecs Map<Any>
    Map of additional options. Changing this creates a new transfer request.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TransferRequest resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing TransferRequest Resource

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

    public static get(name: string, id: Input<ID>, state?: TransferRequestState, opts?: CustomResourceOptions): TransferRequest
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            disable_status_check: Optional[bool] = None,
            key: Optional[str] = None,
            region: Optional[str] = None,
            target_project_id: Optional[str] = None,
            value_specs: Optional[Mapping[str, Any]] = None,
            zone_id: Optional[str] = None) -> TransferRequest
    func GetTransferRequest(ctx *Context, name string, id IDInput, state *TransferRequestState, opts ...ResourceOption) (*TransferRequest, error)
    public static TransferRequest Get(string name, Input<string> id, TransferRequestState? state, CustomResourceOptions? opts = null)
    public static TransferRequest get(String name, Output<String> id, TransferRequestState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    A description of the zone tranfer request.
    DisableStatusCheck bool
    Disable wait for zone to reach ACTIVE status. The check is enabled by default. If this argument is true, zone will be considered as created/updated if OpenStack request returned success.
    Key string
    Region 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.
    TargetProjectId string
    The target Project ID to transfer to.
    ValueSpecs Dictionary<string, object>
    Map of additional options. Changing this creates a new transfer request.
    ZoneId string
    The ID of the zone for which to create the transfer request.
    Description string
    A description of the zone tranfer request.
    DisableStatusCheck bool
    Disable wait for zone to reach ACTIVE status. The check is enabled by default. If this argument is true, zone will be considered as created/updated if OpenStack request returned success.
    Key string
    Region 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.
    TargetProjectId string
    The target Project ID to transfer to.
    ValueSpecs map[string]interface{}
    Map of additional options. Changing this creates a new transfer request.
    ZoneId string
    The ID of the zone for which to create the transfer request.
    description String
    A description of the zone tranfer request.
    disableStatusCheck Boolean
    Disable wait for zone to reach ACTIVE status. The check is enabled by default. If this argument is true, zone will be considered as created/updated if OpenStack request returned success.
    key String
    region 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.
    targetProjectId String
    The target Project ID to transfer to.
    valueSpecs Map<String,Object>
    Map of additional options. Changing this creates a new transfer request.
    zoneId String
    The ID of the zone for which to create the transfer request.
    description string
    A description of the zone tranfer request.
    disableStatusCheck boolean
    Disable wait for zone to reach ACTIVE status. The check is enabled by default. If this argument is true, zone will be considered as created/updated if OpenStack request returned success.
    key string
    region 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.
    targetProjectId string
    The target Project ID to transfer to.
    valueSpecs {[key: string]: any}
    Map of additional options. Changing this creates a new transfer request.
    zoneId string
    The ID of the zone for which to create the transfer request.
    description str
    A description of the zone tranfer request.
    disable_status_check bool
    Disable wait for zone to reach ACTIVE status. The check is enabled by default. If this argument is true, zone will be considered as created/updated if OpenStack request returned success.
    key str
    region 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 region argument of the provider is used. Changing this creates a new DNS zone.
    target_project_id str
    The target Project ID to transfer to.
    value_specs Mapping[str, Any]
    Map of additional options. Changing this creates a new transfer request.
    zone_id str
    The ID of the zone for which to create the transfer request.
    description String
    A description of the zone tranfer request.
    disableStatusCheck Boolean
    Disable wait for zone to reach ACTIVE status. The check is enabled by default. If this argument is true, zone will be considered as created/updated if OpenStack request returned success.
    key String
    region 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.
    targetProjectId String
    The target Project ID to transfer to.
    valueSpecs Map<Any>
    Map of additional options. Changing this creates a new transfer request.
    zoneId String
    The ID of the zone for which to create the transfer request.

    Import

    This resource can be imported by specifying the transferRequest ID:

    $ pulumi import openstack:dns/transferRequest:TransferRequest request_1 request_id
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    OpenStack pulumi/pulumi-openstack
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the openstack Terraform Provider.
    openstack logo
    OpenStack v4.0.0 published on Tuesday, May 21, 2024 by Pulumi