astra logo
astra v1.0.35, Jul 27 22

astra.PrivateLinkEndpoint

astra.PrivateLinkEndpoint completes the creation of a private link endpoint by associating it with your endpoint.

Create PrivateLinkEndpoint Resource

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

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

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

DatabaseId string

The ID of the Astra database.

DatacenterId string

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

EndpointId string

Endpoint created in your cloud provider account example: "vpce-svc-1148ea04af8675309"

DatabaseId string

The ID of the Astra database.

DatacenterId string

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

EndpointId string

Endpoint created in your cloud provider account example: "vpce-svc-1148ea04af8675309"

databaseId String

The ID of the Astra database.

datacenterId String

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

endpointId String

Endpoint created in your cloud provider account example: "vpce-svc-1148ea04af8675309"

databaseId string

The ID of the Astra database.

datacenterId string

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

endpointId string

Endpoint created in your cloud provider account example: "vpce-svc-1148ea04af8675309"

database_id str

The ID of the Astra database.

datacenter_id str

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

endpoint_id str

Endpoint created in your cloud provider account example: "vpce-svc-1148ea04af8675309"

databaseId String

The ID of the Astra database.

datacenterId String

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

endpointId String

Endpoint created in your cloud provider account example: "vpce-svc-1148ea04af8675309"

Outputs

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

AstraEndpointId string

Endpoint ID for referencing within Astra. May be different than the endpoint_id of this resource.

Id string

The provider-assigned unique ID for this managed resource.

AstraEndpointId string

Endpoint ID for referencing within Astra. May be different than the endpoint_id of this resource.

Id string

The provider-assigned unique ID for this managed resource.

astraEndpointId String

Endpoint ID for referencing within Astra. May be different than the endpoint_id of this resource.

id String

The provider-assigned unique ID for this managed resource.

astraEndpointId string

Endpoint ID for referencing within Astra. May be different than the endpoint_id of this resource.

id string

The provider-assigned unique ID for this managed resource.

astra_endpoint_id str

Endpoint ID for referencing within Astra. May be different than the endpoint_id of this resource.

id str

The provider-assigned unique ID for this managed resource.

astraEndpointId String

Endpoint ID for referencing within Astra. May be different than the endpoint_id of this resource.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing PrivateLinkEndpoint Resource

Get an existing PrivateLinkEndpoint 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?: PrivateLinkEndpointState, opts?: CustomResourceOptions): PrivateLinkEndpoint
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        astra_endpoint_id: Optional[str] = None,
        database_id: Optional[str] = None,
        datacenter_id: Optional[str] = None,
        endpoint_id: Optional[str] = None) -> PrivateLinkEndpoint
func GetPrivateLinkEndpoint(ctx *Context, name string, id IDInput, state *PrivateLinkEndpointState, opts ...ResourceOption) (*PrivateLinkEndpoint, error)
public static PrivateLinkEndpoint Get(string name, Input<string> id, PrivateLinkEndpointState? state, CustomResourceOptions? opts = null)
public static PrivateLinkEndpoint get(String name, Output<String> id, PrivateLinkEndpointState 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:
AstraEndpointId string

Endpoint ID for referencing within Astra. May be different than the endpoint_id of this resource.

DatabaseId string

The ID of the Astra database.

DatacenterId string

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

EndpointId string

Endpoint created in your cloud provider account example: "vpce-svc-1148ea04af8675309"

AstraEndpointId string

Endpoint ID for referencing within Astra. May be different than the endpoint_id of this resource.

DatabaseId string

The ID of the Astra database.

DatacenterId string

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

EndpointId string

Endpoint created in your cloud provider account example: "vpce-svc-1148ea04af8675309"

astraEndpointId String

Endpoint ID for referencing within Astra. May be different than the endpoint_id of this resource.

databaseId String

The ID of the Astra database.

datacenterId String

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

endpointId String

Endpoint created in your cloud provider account example: "vpce-svc-1148ea04af8675309"

astraEndpointId string

Endpoint ID for referencing within Astra. May be different than the endpoint_id of this resource.

databaseId string

The ID of the Astra database.

datacenterId string

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

endpointId string

Endpoint created in your cloud provider account example: "vpce-svc-1148ea04af8675309"

astra_endpoint_id str

Endpoint ID for referencing within Astra. May be different than the endpoint_id of this resource.

database_id str

The ID of the Astra database.

datacenter_id str

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

endpoint_id str

Endpoint created in your cloud provider account example: "vpce-svc-1148ea04af8675309"

astraEndpointId String

Endpoint ID for referencing within Astra. May be different than the endpoint_id of this resource.

databaseId String

The ID of the Astra database.

datacenterId String

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

endpointId String

Endpoint created in your cloud provider account example: "vpce-svc-1148ea04af8675309"

Import

Amazon AWS example

 $ pulumi import astra:index/privateLinkEndpoint:PrivateLinkEndpoint example a6bc9c26-e7ce-424f-84c7-0a00afb12588/datacenter/a6bc9c26-e7ce-424f-84c7-0a00afb12588-1/endpoint/vpce-0f7aed6e7a18a1791

Google GCP example

 $ pulumi import astra:index/privateLinkEndpoint:PrivateLinkEndpoint example a6bc9c26-e7ce-424f-84c7-0a00afb12588/datacenter/a6bc9c26-e7ce-424f-84c7-0a00afb12588-1/endpoint/13585698993864708

Azure EKS example

 $ pulumi import astra:index/privateLinkEndpoint:PrivateLinkEndpoint example a6bc9c26-e7ce-424f-84c7-0a00afb12588/datacenter/a6bc9c26-e7ce-424f-84c7-0a00afb12588-1/endpoint/dc5ee5b1-4fc2-463e-a56b-ff54dd38b879/providers/Microsoft.Network/privateEndpoints/private-endpoint-example

Package Details

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

This Pulumi package is based on the astra Terraform Provider.