Destination class

'Manage Multicloud Data Transfer Destinations'

To get more information about Destination, see:

Example Usage

Network Connectivity Destination Basic

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

const config = new gcp.networkconnectivity.MulticloudDataTransferConfig("config", {
    name: "basic-config",
    location: "europe-west4",
    description: "A basic multicloud data transfer config for the destination example",
});
const example = new gcp.networkconnectivity.Destination("example", {
    name: "basic-destination",
    location: "europe-west4",
    multicloudDataTransferConfig: config.name,
    description: "A basic destination",
    labels: {
        foo: "bar",
    },
    ipPrefix: "10.0.0.0/8",
    endpoints: [{
        asn: "14618",
        csp: "AWS",
    }],
});
import pulumi
import pulumi_gcp as gcp

config = gcp.networkconnectivity.MulticloudDataTransferConfig("config",
    name="basic-config",
    location="europe-west4",
    description="A basic multicloud data transfer config for the destination example")
example = gcp.networkconnectivity.Destination("example",
    name="basic-destination",
    location="europe-west4",
    multicloud_data_transfer_config=config.name,
    description="A basic destination",
    labels={
        "foo": "bar",
    },
    ip_prefix="10.0.0.0/8",
    endpoints=[{
        "asn": "14618",
        "csp": "AWS",
    }])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var config = new Gcp.NetworkConnectivity.MulticloudDataTransferConfig("config", new()
    {
        Name = "basic-config",
        Location = "europe-west4",
        Description = "A basic multicloud data transfer config for the destination example",
    });

    var example = new Gcp.NetworkConnectivity.Destination("example", new()
    {
        Name = "basic-destination",
        Location = "europe-west4",
        MulticloudDataTransferConfig = config.Name,
        Description = "A basic destination",
        Labels =
        {
            { "foo", "bar" },
        },
        IpPrefix = "10.0.0.0/8",
        Endpoints = new[]
        {
            new Gcp.NetworkConnectivity.Inputs.DestinationEndpointArgs
            {
                Asn = "14618",
                Csp = "AWS",
            },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/networkconnectivity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		config, err := networkconnectivity.NewMulticloudDataTransferConfig(ctx, "config", &networkconnectivity.MulticloudDataTransferConfigArgs{
			Name:        pulumi.String("basic-config"),
			Location:    pulumi.String("europe-west4"),
			Description: pulumi.String("A basic multicloud data transfer config for the destination example"),
		})
		if err != nil {
			return err
		}
		_, err = networkconnectivity.NewDestination(ctx, "example", &networkconnectivity.DestinationArgs{
			Name:                         pulumi.String("basic-destination"),
			Location:                     pulumi.String("europe-west4"),
			MulticloudDataTransferConfig: config.Name,
			Description:                  pulumi.String("A basic destination"),
			Labels: pulumi.StringMap{
				"foo": pulumi.String("bar"),
			},
			IpPrefix: pulumi.String("10.0.0.0/8"),
			Endpoints: networkconnectivity.DestinationEndpointArray{
				&networkconnectivity.DestinationEndpointArgs{
					Asn: pulumi.String("14618"),
					Csp: pulumi.String("AWS"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_networkconnectivity_multiclouddatatransferconfig" "config" {
  name        = "basic-config"
  location    = "europe-west4"
  description = "A basic multicloud data transfer config for the destination example"
}
resource "gcp_networkconnectivity_destination" "example" {
  name                            = "basic-destination"
  location                        = "europe-west4"
  multicloud_data_transfer_config = gcp_networkconnectivity_multiclouddatatransferconfig.config.name
  description                     = "A basic destination"
  labels = {
    "foo" = "bar"
  }
  ip_prefix = "10.0.0.0/8"
  endpoints {
    asn = "14618"
    csp = "AWS"
  }
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.networkconnectivity.MulticloudDataTransferConfig;
import com.pulumi.gcp.networkconnectivity.MulticloudDataTransferConfigArgs;
import com.pulumi.gcp.networkconnectivity.Destination;
import com.pulumi.gcp.networkconnectivity.DestinationArgs;
import com.pulumi.gcp.networkconnectivity.inputs.DestinationEndpointArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 config = new MulticloudDataTransferConfig("config", MulticloudDataTransferConfigArgs.builder()
            .name("basic-config")
            .location("europe-west4")
            .description("A basic multicloud data transfer config for the destination example")
            .build());

        var example = new Destination("example", DestinationArgs.builder()
            .name("basic-destination")
            .location("europe-west4")
            .multicloudDataTransferConfig(config.name())
            .description("A basic destination")
            .labels(Map.of("foo", "bar"))
            .ipPrefix("10.0.0.0/8")
            .endpoints(DestinationEndpointArgs.builder()
                .asn("14618")
                .csp("AWS")
                .build())
            .build());

    }
}
resources:
  config:
    type: gcp:networkconnectivity:MulticloudDataTransferConfig
    properties:
      name: basic-config
      location: europe-west4
      description: A basic multicloud data transfer config for the destination example
  example:
    type: gcp:networkconnectivity:Destination
    properties:
      name: basic-destination
      location: europe-west4
      multicloudDataTransferConfig: ${config.name}
      description: A basic destination
      labels:
        foo: bar
      ipPrefix: 10.0.0.0/8
      endpoints:
        - asn: '14618'
          csp: AWS

Import

Destination can be imported using any of these accepted formats:

  • projects/{{project}}/locations/{{location}}/multicloudDataTransferConfigs/{{multicloud_data_transfer_config}}/destinations/{{name}}
  • {{project}}/{{location}}/{{multicloud_data_transfer_config}}/{{name}}
  • {{location}}/{{multicloud_data_transfer_config}}/{{name}}

When using the pulumi import command, Destination can be imported using one of the formats above. For example:

$ pulumi import gcp:networkconnectivity/destination:Destination default projects/{{project}}/locations/{{location}}/multicloudDataTransferConfigs/{{multicloud_data_transfer_config}}/destinations/{{name}}
$ pulumi import gcp:networkconnectivity/destination:Destination default {{project}}/{{location}}/{{multicloud_data_transfer_config}}/{{name}}
$ pulumi import gcp:networkconnectivity/destination:Destination default {{location}}/{{multicloud_data_transfer_config}}/{{name}}

Constructors

Destination(String name, {DestinationArgs? args, CustomResourceOptions? options})
Creates a new Destination. name The Pulumi resource name. args Arguments used to configure this Destination. The set of arguments for Destination. options Resource options controlling this resource's behavior.
Destination.reference(String urn)
Creates a typed reference to an existing Destination resource.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
createTime ↔ Output<String>
Time when the Destination resource was created.
latefinal
deletionPolicy ↔ Output<String>
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
latefinal
description ↔ Output<String?>
A description of this resource.
latefinal
effectiveLabels ↔ Output<Map<String, String>>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
latefinal
endpoints ↔ Output<List<DestinationEndpoint>>
The list of DestinationEndpoint resources configured for the IP prefix. Structure is documented below.
latefinal
etag ↔ Output<String>
The etag is computed by the server, and might be sent with update and delete requests so that the client has an up-to-date value before proceeding.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
ipPrefix ↔ Output<String>
The IP prefix that represents your workload on another CSP.
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
labels ↔ Output<Map<String, String>?>
User-defined labels.
latefinal
location ↔ Output<String>
The location of the destination.
latefinal
multicloudDataTransferConfig ↔ Output<String>
The multicloud data transfer config of the destination.
latefinal
name ↔ Output<String>
The name of the destination.
latefinal
project ↔ Output<String>
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
latefinal
pulumiLabels ↔ Output<Map<String, String>>
The combination of labels configured directly on the resource and default labels configured on the provider.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stateTimelines ↔ Output<List<DestinationStateTimeline>>
The timeline of the expected Destination states or the current rest state. If a state change is expected, the value is ADDING, DELETING or SUSPENDING, depending on the action specified. Structure is documented below.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
uid ↔ Output<String>
The Google-generated unique ID for the Destination resource. This value is unique across all Destination resources. If a resource is deleted and another with the same name is created, the new resource is assigned a different and unique ID.
latefinal
updateTime ↔ Output<String>
Time when the Destination resource was updated.
latefinal
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {DestinationState? state, CustomResourceOptions? options}) → Destination
Gets an existing Destination resource's state with the given name and id.