@pulumi/gcp/networkconnectivity/destination.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * 'Manage Multicloud Data Transfer Destinations'
 *
 * To get more information about Destination, see:
 *
 * * [API documentation](https://docs.cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest/v1/projects.locations.multicloudDataTransferConfigs.destinations)
 * * How-to Guides
 *     * [QUICKSTART_TITLE](https://docs.cloud.google.com/data-transfer-essentials/docs/create-resources)
 *
 * ## Example Usage
 *
 * ### Network Connectivity Destination Basic
 *
 * ```typescript
 * 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
 *
 * 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:
 *
 * ```sh
 * $ 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}}
 * ```
 */
export declare class Destination extends pulumi.CustomResource {
    /**
     * Get an existing Destination resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DestinationState, opts?: pulumi.CustomResourceOptions): Destination;
    /**
     * Returns true if the given object is an instance of Destination.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is Destination;
    /**
     * Time when the `Destination` resource was created.
     */
    readonly createTime: pulumi.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.
     */
    readonly deletionPolicy: pulumi.Output<string>;
    /**
     * A description of this resource.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
     */
    readonly effectiveLabels: pulumi.Output<{
        [key: string]: string;
    }>;
    /**
     * The list of DestinationEndpoint resources configured for the IP prefix.
     * Structure is documented below.
     */
    readonly endpoints: pulumi.Output<outputs.networkconnectivity.DestinationEndpoint[]>;
    /**
     * 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.
     */
    readonly etag: pulumi.Output<string>;
    /**
     * The IP prefix that represents your workload on another CSP.
     */
    readonly ipPrefix: pulumi.Output<string>;
    /**
     * User-defined labels.
     *
     * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
     * Please refer to the field `effectiveLabels` for all of the labels present on the resource.
     */
    readonly labels: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * The location of the destination.
     */
    readonly location: pulumi.Output<string>;
    /**
     * The multicloud data transfer config of the destination.
     */
    readonly multicloudDataTransferConfig: pulumi.Output<string>;
    /**
     * The name of the destination.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    readonly project: pulumi.Output<string>;
    /**
     * The combination of labels configured directly on the resource
     *  and default labels configured on the provider.
     */
    readonly pulumiLabels: pulumi.Output<{
        [key: string]: string;
    }>;
    /**
     * 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.
     */
    readonly stateTimelines: pulumi.Output<outputs.networkconnectivity.DestinationStateTimeline[]>;
    /**
     * 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.
     */
    readonly uid: pulumi.Output<string>;
    /**
     * Time when the `Destination` resource was updated.
     */
    readonly updateTime: pulumi.Output<string>;
    /**
     * Create a Destination resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: DestinationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Destination resources.
 */
export interface DestinationState {
    /**
     * Time when the `Destination` resource was created.
     */
    createTime?: pulumi.Input<string | undefined>;
    /**
     * 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.
     */
    deletionPolicy?: pulumi.Input<string | undefined>;
    /**
     * A description of this resource.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
     */
    effectiveLabels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * The list of DestinationEndpoint resources configured for the IP prefix.
     * Structure is documented below.
     */
    endpoints?: pulumi.Input<pulumi.Input<inputs.networkconnectivity.DestinationEndpoint>[] | undefined>;
    /**
     * 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.
     */
    etag?: pulumi.Input<string | undefined>;
    /**
     * The IP prefix that represents your workload on another CSP.
     */
    ipPrefix?: pulumi.Input<string | undefined>;
    /**
     * User-defined labels.
     *
     * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
     * Please refer to the field `effectiveLabels` for all of the labels present on the resource.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * The location of the destination.
     */
    location?: pulumi.Input<string | undefined>;
    /**
     * The multicloud data transfer config of the destination.
     */
    multicloudDataTransferConfig?: pulumi.Input<string | undefined>;
    /**
     * The name of the destination.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string | undefined>;
    /**
     * The combination of labels configured directly on the resource
     *  and default labels configured on the provider.
     */
    pulumiLabels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * 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.
     */
    stateTimelines?: pulumi.Input<pulumi.Input<inputs.networkconnectivity.DestinationStateTimeline>[] | undefined>;
    /**
     * 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.
     */
    uid?: pulumi.Input<string | undefined>;
    /**
     * Time when the `Destination` resource was updated.
     */
    updateTime?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a Destination resource.
 */
export interface DestinationArgs {
    /**
     * 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.
     */
    deletionPolicy?: pulumi.Input<string | undefined>;
    /**
     * A description of this resource.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * The list of DestinationEndpoint resources configured for the IP prefix.
     * Structure is documented below.
     */
    endpoints: pulumi.Input<pulumi.Input<inputs.networkconnectivity.DestinationEndpoint>[]>;
    /**
     * The IP prefix that represents your workload on another CSP.
     */
    ipPrefix: pulumi.Input<string>;
    /**
     * User-defined labels.
     *
     * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
     * Please refer to the field `effectiveLabels` for all of the labels present on the resource.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * The location of the destination.
     */
    location: pulumi.Input<string>;
    /**
     * The multicloud data transfer config of the destination.
     */
    multicloudDataTransferConfig: pulumi.Input<string>;
    /**
     * The name of the destination.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=destination.d.ts.map