@mapped/pulumi-astra
Version:
A Pulumi package for creating and managing astra cloud resources.
103 lines (102 loc) • 4.23 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* `astra.PrivateLink` provides a private link resource. Private Link is a private network endpoint that can be created to connect from your vpc to Astra without using a publicly routable IP address. `astra.PrivateLink` resources are associated with a database id. Once the privateLink resource is created in Astra it must be linked to an endpoint within your vpc, use `astra.PrivateLinkEndpoint` to do this.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as astra from "@pulumi/astra";
*
* const example = new astra.PrivateLink("example", {
* allowedPrincipals: ["arn:aws:iam::111708290731:user/sebastian.estevez"],
* databaseId: "a6bc9c26-e7ce-424f-84c7-0a00afb12588",
* datacenterId: "a6bc9c26-e7ce-424f-84c7-0a00afb12588",
* });
* ```
*
* ## Import
*
* ```sh
* $ pulumi import astra:index/privateLink:PrivateLink example a6bc9c26-e7ce-424f-84c7-0a00afb12588/datacenter/a6bc9c26-e7ce-424f-84c7-0a00afb12588/serviceNames/svc-name-here
* ```
*/
export declare class PrivateLink extends pulumi.CustomResource {
/**
* Get an existing PrivateLink 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?: PrivateLinkState, opts?: pulumi.CustomResourceOptions): PrivateLink;
/**
* Returns true if the given object is an instance of PrivateLink. 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 PrivateLink;
/**
* List of service principals to apply to the Private Link (i.e. arn:aws:iam::123456789012:role/admin).
*/
readonly allowedPrincipals: pulumi.Output<string[]>;
/**
* Astra database where private link will be enabled.
*/
readonly databaseId: pulumi.Output<string>;
/**
* Astra datacenter in the region where the private link will be created.
*/
readonly datacenterId: pulumi.Output<string>;
/**
* Name of the endpoint service for private link generated by the cloud provider.
*/
readonly serviceName: pulumi.Output<string>;
/**
* Create a PrivateLink 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: PrivateLinkArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering PrivateLink resources.
*/
export interface PrivateLinkState {
/**
* List of service principals to apply to the Private Link (i.e. arn:aws:iam::123456789012:role/admin).
*/
allowedPrincipals?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Astra database where private link will be enabled.
*/
databaseId?: pulumi.Input<string>;
/**
* Astra datacenter in the region where the private link will be created.
*/
datacenterId?: pulumi.Input<string>;
/**
* Name of the endpoint service for private link generated by the cloud provider.
*/
serviceName?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a PrivateLink resource.
*/
export interface PrivateLinkArgs {
/**
* List of service principals to apply to the Private Link (i.e. arn:aws:iam::123456789012:role/admin).
*/
allowedPrincipals: pulumi.Input<pulumi.Input<string>[]>;
/**
* Astra database where private link will be enabled.
*/
databaseId: pulumi.Input<string>;
/**
* Astra datacenter in the region where the private link will be created.
*/
datacenterId: pulumi.Input<string>;
}