astra logo
astra v1.0.35, Jul 27 22

astra.PrivateLink

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 private_link resource is created in Astra it must be linked to an endpoint within your vpc, use astra.PrivateLinkEndpoint to do this.

Example Usage

using Pulumi;
using Astra = Pulumiverse.Astra;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Astra.PrivateLink("example", new Astra.PrivateLinkArgs
        {
            AllowedPrincipals = 
            {
                "arn:aws:iam::111708290731:user/sebastian.estevez",
            },
            DatabaseId = "a6bc9c26-e7ce-424f-84c7-0a00afb12588",
            DatacenterId = "a6bc9c26-e7ce-424f-84c7-0a00afb12588-1",
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-astra/sdk/go/astra"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := astra.NewPrivateLink(ctx, "example", &astra.PrivateLinkArgs{
			AllowedPrincipals: pulumi.StringArray{
				pulumi.String("arn:aws:iam::111708290731:user/sebastian.estevez"),
			},
			DatabaseId:   pulumi.String("a6bc9c26-e7ce-424f-84c7-0a00afb12588"),
			DatacenterId: pulumi.String("a6bc9c26-e7ce-424f-84c7-0a00afb12588-1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.astra.PrivateLink;
import com.pulumi.astra.PrivateLinkArgs;
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 example = new PrivateLink("example", PrivateLinkArgs.builder()        
            .allowedPrincipals("arn:aws:iam::111708290731:user/sebastian.estevez")
            .databaseId("a6bc9c26-e7ce-424f-84c7-0a00afb12588")
            .datacenterId("a6bc9c26-e7ce-424f-84c7-0a00afb12588-1")
            .build());

    }
}
import pulumi
import pulumiverse_astra as astra

example = astra.PrivateLink("example",
    allowed_principals=["arn:aws:iam::111708290731:user/sebastian.estevez"],
    database_id="a6bc9c26-e7ce-424f-84c7-0a00afb12588",
    datacenter_id="a6bc9c26-e7ce-424f-84c7-0a00afb12588-1")
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-1",
});
resources:
  example:
    type: astra:PrivateLink
    properties:
      allowedPrincipals:
        - arn:aws:iam::111708290731:user/sebastian.estevez
      databaseId: a6bc9c26-e7ce-424f-84c7-0a00afb12588
      datacenterId: a6bc9c26-e7ce-424f-84c7-0a00afb12588-1

Create PrivateLink Resource

new PrivateLink(name: string, args: PrivateLinkArgs, opts?: CustomResourceOptions);
@overload
def PrivateLink(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                allowed_principals: Optional[Sequence[str]] = None,
                database_id: Optional[str] = None,
                datacenter_id: Optional[str] = None)
@overload
def PrivateLink(resource_name: str,
                args: PrivateLinkArgs,
                opts: Optional[ResourceOptions] = None)
func NewPrivateLink(ctx *Context, name string, args PrivateLinkArgs, opts ...ResourceOption) (*PrivateLink, error)
public PrivateLink(string name, PrivateLinkArgs args, CustomResourceOptions? opts = null)
public PrivateLink(String name, PrivateLinkArgs args)
public PrivateLink(String name, PrivateLinkArgs args, CustomResourceOptions options)
type: astra:PrivateLink
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args PrivateLinkArgs
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 PrivateLinkArgs
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 PrivateLinkArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args PrivateLinkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args PrivateLinkArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

PrivateLink 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 PrivateLink resource accepts the following input properties:

AllowedPrincipals List<string>

List of service principals to apply to the Private Link (i.e. arn:aws:iam::123456789012:role/admin).

DatabaseId string

Astra database where private link will be enabled.

DatacenterId string

Astra datacenter in the region where the private link will be created.

AllowedPrincipals []string

List of service principals to apply to the Private Link (i.e. arn:aws:iam::123456789012:role/admin).

DatabaseId string

Astra database where private link will be enabled.

DatacenterId string

Astra datacenter in the region where the private link will be created.

allowedPrincipals List<String>

List of service principals to apply to the Private Link (i.e. arn:aws:iam::123456789012:role/admin).

databaseId String

Astra database where private link will be enabled.

datacenterId String

Astra datacenter in the region where the private link will be created.

allowedPrincipals string[]

List of service principals to apply to the Private Link (i.e. arn:aws:iam::123456789012:role/admin).

databaseId string

Astra database where private link will be enabled.

datacenterId string

Astra datacenter in the region where the private link will be created.

allowed_principals Sequence[str]

List of service principals to apply to the Private Link (i.e. arn:aws:iam::123456789012:role/admin).

database_id str

Astra database where private link will be enabled.

datacenter_id str

Astra datacenter in the region where the private link will be created.

allowedPrincipals List<String>

List of service principals to apply to the Private Link (i.e. arn:aws:iam::123456789012:role/admin).

databaseId String

Astra database where private link will be enabled.

datacenterId String

Astra datacenter in the region where the private link will be created.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

ServiceName string

Name of the endpoint service for private link generated by the cloud provider.

Id string

The provider-assigned unique ID for this managed resource.

ServiceName string

Name of the endpoint service for private link generated by the cloud provider.

id String

The provider-assigned unique ID for this managed resource.

serviceName String

Name of the endpoint service for private link generated by the cloud provider.

id string

The provider-assigned unique ID for this managed resource.

serviceName string

Name of the endpoint service for private link generated by the cloud provider.

id str

The provider-assigned unique ID for this managed resource.

service_name str

Name of the endpoint service for private link generated by the cloud provider.

id String

The provider-assigned unique ID for this managed resource.

serviceName String

Name of the endpoint service for private link generated by the cloud provider.

Look up Existing PrivateLink Resource

Get an existing PrivateLink 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?: PrivateLinkState, opts?: CustomResourceOptions): PrivateLink
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allowed_principals: Optional[Sequence[str]] = None,
        database_id: Optional[str] = None,
        datacenter_id: Optional[str] = None,
        service_name: Optional[str] = None) -> PrivateLink
func GetPrivateLink(ctx *Context, name string, id IDInput, state *PrivateLinkState, opts ...ResourceOption) (*PrivateLink, error)
public static PrivateLink Get(string name, Input<string> id, PrivateLinkState? state, CustomResourceOptions? opts = null)
public static PrivateLink get(String name, Output<String> id, PrivateLinkState 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:
AllowedPrincipals List<string>

List of service principals to apply to the Private Link (i.e. arn:aws:iam::123456789012:role/admin).

DatabaseId string

Astra database where private link will be enabled.

DatacenterId string

Astra datacenter in the region where the private link will be created.

ServiceName string

Name of the endpoint service for private link generated by the cloud provider.

AllowedPrincipals []string

List of service principals to apply to the Private Link (i.e. arn:aws:iam::123456789012:role/admin).

DatabaseId string

Astra database where private link will be enabled.

DatacenterId string

Astra datacenter in the region where the private link will be created.

ServiceName string

Name of the endpoint service for private link generated by the cloud provider.

allowedPrincipals List<String>

List of service principals to apply to the Private Link (i.e. arn:aws:iam::123456789012:role/admin).

databaseId String

Astra database where private link will be enabled.

datacenterId String

Astra datacenter in the region where the private link will be created.

serviceName String

Name of the endpoint service for private link generated by the cloud provider.

allowedPrincipals string[]

List of service principals to apply to the Private Link (i.e. arn:aws:iam::123456789012:role/admin).

databaseId string

Astra database where private link will be enabled.

datacenterId string

Astra datacenter in the region where the private link will be created.

serviceName string

Name of the endpoint service for private link generated by the cloud provider.

allowed_principals Sequence[str]

List of service principals to apply to the Private Link (i.e. arn:aws:iam::123456789012:role/admin).

database_id str

Astra database where private link will be enabled.

datacenter_id str

Astra datacenter in the region where the private link will be created.

service_name str

Name of the endpoint service for private link generated by the cloud provider.

allowedPrincipals List<String>

List of service principals to apply to the Private Link (i.e. arn:aws:iam::123456789012:role/admin).

databaseId String

Astra database where private link will be enabled.

datacenterId String

Astra datacenter in the region where the private link will be created.

serviceName String

Name of the endpoint service for private link generated by the cloud provider.

Import

 $ pulumi import astra:index/privateLink:PrivateLink example a6bc9c26-e7ce-424f-84c7-0a00afb12588/datacenter/a6bc9c26-e7ce-424f-84c7-0a00afb12588/serviceNames/svc-name-here

Package Details

Repository
astra pulumiverse/pulumi-astra
License
Apache-2.0
Notes

This Pulumi package is based on the astra Terraform Provider.