Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. CockroachDB Cloud
  3. API Docs
  4. PrivateEndpointConnection
CockroachDB v0.6.0 published on Friday, Nov 1, 2024 by pulumiverse
pulumiverse/pulumi-cockroach

cockroach.PrivateEndpointConnection

Explore with Pulumi AI

cockroach logo
CockroachDB v0.6.0 published on Friday, Nov 1, 2024 by pulumiverse
pulumiverse/pulumi-cockroach

    Private endpoint connections allow customer applications to connect to a CockroachDB Cloud cluster without traversing the public internet. All application-database traffic remains within the cloud-provider network.

    Create PrivateEndpointConnection Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PrivateEndpointConnection(name: string, args: PrivateEndpointConnectionArgs, opts?: CustomResourceOptions);
    @overload
def PrivateEndpointConnection(resource_name: str,
                              args: PrivateEndpointConnectionArgs,
                              opts: Optional[ResourceOptions] = None)

@overload
def PrivateEndpointConnection(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              cluster_id: Optional[str] = None,
                              endpoint_id: Optional[str] = None)
    func NewPrivateEndpointConnection(ctx *Context, name string, args PrivateEndpointConnectionArgs, opts ...ResourceOption) (*PrivateEndpointConnection, error)
    public PrivateEndpointConnection(string name, PrivateEndpointConnectionArgs args, CustomResourceOptions? opts = null)
    public PrivateEndpointConnection(String name, PrivateEndpointConnectionArgs args)
public PrivateEndpointConnection(String name, PrivateEndpointConnectionArgs args, CustomResourceOptions options)

    type: cockroach:PrivateEndpointConnection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

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

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var privateEndpointConnectionResource = new Cockroach.PrivateEndpointConnection("privateEndpointConnectionResource", new()
{
    ClusterId = "string",
    EndpointId = "string",
});

    example, err := cockroach.NewPrivateEndpointConnection(ctx, "privateEndpointConnectionResource", &cockroach.PrivateEndpointConnectionArgs{
	ClusterId:  pulumi.String("string"),
	EndpointId: pulumi.String("string"),
})

    var privateEndpointConnectionResource = new PrivateEndpointConnection("privateEndpointConnectionResource", PrivateEndpointConnectionArgs.builder()
    .clusterId("string")
    .endpointId("string")
    .build());

    private_endpoint_connection_resource = cockroach.PrivateEndpointConnection("privateEndpointConnectionResource",
    cluster_id="string",
    endpoint_id="string")

    const privateEndpointConnectionResource = new cockroach.PrivateEndpointConnection("privateEndpointConnectionResource", {
    clusterId: "string",
    endpointId: "string",
});

    type: cockroach:PrivateEndpointConnection
properties:
    clusterId: string
    endpointId: string

    PrivateEndpointConnection Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PrivateEndpointConnection resource accepts the following input properties:

    ClusterId string
    EndpointId string
    Client side ID of the Private Endpoint Connection.
    ClusterId string
    EndpointId string
    Client side ID of the Private Endpoint Connection.
    clusterId String
    endpointId String
    Client side ID of the Private Endpoint Connection.
    clusterId string
    endpointId string
    Client side ID of the Private Endpoint Connection.
    cluster_id str
    endpoint_id str
    Client side ID of the Private Endpoint Connection.
    clusterId String
    endpointId String
    Client side ID of the Private Endpoint Connection.

    Outputs

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

    CloudProvider string
    Cloud provider associated with this connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    RegionName string
    Cloud provider region code associated with this connection.
    ServiceId string
    Server side ID of the Private Endpoint Connection.
    CloudProvider string
    Cloud provider associated with this connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    RegionName string
    Cloud provider region code associated with this connection.
    ServiceId string
    Server side ID of the Private Endpoint Connection.
    cloudProvider String
    Cloud provider associated with this connection.
    id String
    The provider-assigned unique ID for this managed resource.
    regionName String
    Cloud provider region code associated with this connection.
    serviceId String
    Server side ID of the Private Endpoint Connection.
    cloudProvider string
    Cloud provider associated with this connection.
    id string
    The provider-assigned unique ID for this managed resource.
    regionName string
    Cloud provider region code associated with this connection.
    serviceId string
    Server side ID of the Private Endpoint Connection.
    cloud_provider str
    Cloud provider associated with this connection.
    id str
    The provider-assigned unique ID for this managed resource.
    region_name str
    Cloud provider region code associated with this connection.
    service_id str
    Server side ID of the Private Endpoint Connection.
    cloudProvider String
    Cloud provider associated with this connection.
    id String
    The provider-assigned unique ID for this managed resource.
    regionName String
    Cloud provider region code associated with this connection.
    serviceId String
    Server side ID of the Private Endpoint Connection.

    Look up Existing PrivateEndpointConnection Resource

    Get an existing PrivateEndpointConnection 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?: PrivateEndpointConnectionState, opts?: CustomResourceOptions): PrivateEndpointConnection
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cloud_provider: Optional[str] = None,
        cluster_id: Optional[str] = None,
        endpoint_id: Optional[str] = None,
        region_name: Optional[str] = None,
        service_id: Optional[str] = None) -> PrivateEndpointConnection
    func GetPrivateEndpointConnection(ctx *Context, name string, id IDInput, state *PrivateEndpointConnectionState, opts ...ResourceOption) (*PrivateEndpointConnection, error)
    public static PrivateEndpointConnection Get(string name, Input<string> id, PrivateEndpointConnectionState? state, CustomResourceOptions? opts = null)
    public static PrivateEndpointConnection get(String name, Output<String> id, PrivateEndpointConnectionState 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:
    CloudProvider string
    Cloud provider associated with this connection.
    ClusterId string
    EndpointId string
    Client side ID of the Private Endpoint Connection.
    RegionName string
    Cloud provider region code associated with this connection.
    ServiceId string
    Server side ID of the Private Endpoint Connection.
    CloudProvider string
    Cloud provider associated with this connection.
    ClusterId string
    EndpointId string
    Client side ID of the Private Endpoint Connection.
    RegionName string
    Cloud provider region code associated with this connection.
    ServiceId string
    Server side ID of the Private Endpoint Connection.
    cloudProvider String
    Cloud provider associated with this connection.
    clusterId String
    endpointId String
    Client side ID of the Private Endpoint Connection.
    regionName String
    Cloud provider region code associated with this connection.
    serviceId String
    Server side ID of the Private Endpoint Connection.
    cloudProvider string
    Cloud provider associated with this connection.
    clusterId string
    endpointId string
    Client side ID of the Private Endpoint Connection.
    regionName string
    Cloud provider region code associated with this connection.
    serviceId string
    Server side ID of the Private Endpoint Connection.
    cloud_provider str
    Cloud provider associated with this connection.
    cluster_id str
    endpoint_id str
    Client side ID of the Private Endpoint Connection.
    region_name str
    Cloud provider region code associated with this connection.
    service_id str
    Server side ID of the Private Endpoint Connection.
    cloudProvider String
    Cloud provider associated with this connection.
    clusterId String
    endpointId String
    Client side ID of the Private Endpoint Connection.
    regionName String
    Cloud provider region code associated with this connection.
    serviceId String
    Server side ID of the Private Endpoint Connection.

    Import

    format: :

    $ pulumi import cockroach:index/privateEndpointConnection:PrivateEndpointConnection resource_name 1f69fdd2-600a-4cfc-a9ba-16995df0d77d:vpce-0c1308d7312217abc

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    cockroach pulumiverse/pulumi-cockroach
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cockroach Terraform Provider.
    cockroach logo
    CockroachDB v0.6.0 published on Friday, Nov 1, 2024 by pulumiverse
    pulumiverse/pulumi-cockroach