Docs Packages
  1. Packages
  2. CockroachDB Cloud
  3. API Docs
  4. PrivateEndpointServices
CockroachDB v0.2.3 published on Monday, May 27, 2024 by pulumiverse
pulumiverse/pulumi-cockroach

cockroach.PrivateEndpointServices

Explore with Pulumi AI

cockroach logo
CockroachDB v0.2.3 published on Monday, May 27, 2024 by pulumiverse
pulumiverse/pulumi-cockroach

    PrivateEndpointServices contains services that allow for VPC communication, either via PrivateLink (AWS) or Peering (GCP).

    Create PrivateEndpointServices Resource

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

    Constructor syntax

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

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

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

    Example

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

    var privateEndpointServicesResource = new Cockroach.PrivateEndpointServices("privateEndpointServicesResource", new()
{
    ClusterId = "string",
});

    example, err := cockroach.NewPrivateEndpointServices(ctx, "privateEndpointServicesResource", &cockroach.PrivateEndpointServicesArgs{
	ClusterId: pulumi.String("string"),
})

    var privateEndpointServicesResource = new PrivateEndpointServices("privateEndpointServicesResource", PrivateEndpointServicesArgs.builder()
    .clusterId("string")
    .build());

    private_endpoint_services_resource = cockroach.PrivateEndpointServices("privateEndpointServicesResource", cluster_id="string")

    const privateEndpointServicesResource = new cockroach.PrivateEndpointServices("privateEndpointServicesResource", {clusterId: "string"});

    type: cockroach:PrivateEndpointServices
properties:
    clusterId: string

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

    ClusterId string
    ClusterId string
    clusterId String
    clusterId string
    clusterId String

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Services List<Pulumiverse.Cockroach.Outputs.PrivateEndpointServicesService>
    Id string
    The provider-assigned unique ID for this managed resource.
    Services []PrivateEndpointServicesService
    id String
    The provider-assigned unique ID for this managed resource.
    services List<PrivateEndpointServicesService>
    id string
    The provider-assigned unique ID for this managed resource.
    services PrivateEndpointServicesService[]
    id str
    The provider-assigned unique ID for this managed resource.
    services Sequence[PrivateEndpointServicesService]
    id String
    The provider-assigned unique ID for this managed resource.
    services List<Property Map>

    Look up Existing PrivateEndpointServices Resource

    Get an existing PrivateEndpointServices 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?: PrivateEndpointServicesState, opts?: CustomResourceOptions): PrivateEndpointServices
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_id: Optional[str] = None,
        services: Optional[Sequence[PrivateEndpointServicesServiceArgs]] = None) -> PrivateEndpointServices
    func GetPrivateEndpointServices(ctx *Context, name string, id IDInput, state *PrivateEndpointServicesState, opts ...ResourceOption) (*PrivateEndpointServices, error)
    public static PrivateEndpointServices Get(string name, Input<string> id, PrivateEndpointServicesState? state, CustomResourceOptions? opts = null)
    public static PrivateEndpointServices get(String name, Output<String> id, PrivateEndpointServicesState 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.

    Supporting Types

    PrivateEndpointServicesService, PrivateEndpointServicesServiceArgs

    Aws Pulumiverse.Cockroach.Inputs.PrivateEndpointServicesServiceAws
    CloudProvider string
    Cloud provider associated with this service.
    RegionName string
    Cloud provider region code associated with this service.
    Status string
    Operation status of the service.
    Aws PrivateEndpointServicesServiceAws
    CloudProvider string
    Cloud provider associated with this service.
    RegionName string
    Cloud provider region code associated with this service.
    Status string
    Operation status of the service.
    aws PrivateEndpointServicesServiceAws
    cloudProvider String
    Cloud provider associated with this service.
    regionName String
    Cloud provider region code associated with this service.
    status String
    Operation status of the service.
    aws PrivateEndpointServicesServiceAws
    cloudProvider string
    Cloud provider associated with this service.
    regionName string
    Cloud provider region code associated with this service.
    status string
    Operation status of the service.
    aws PrivateEndpointServicesServiceAws
    cloud_provider str
    Cloud provider associated with this service.
    region_name str
    Cloud provider region code associated with this service.
    status str
    Operation status of the service.
    aws Property Map
    cloudProvider String
    Cloud provider associated with this service.
    regionName String
    Cloud provider region code associated with this service.
    status String
    Operation status of the service.

    PrivateEndpointServicesServiceAws, PrivateEndpointServicesServiceAwsArgs

    AvailabilityZoneIds List<string>
    AZ IDs users should create their VPCs in to minimize their cost.
    ServiceId string
    Server side ID of the PrivateLink connection.
    ServiceName string
    AWS service name used to create endpoints.
    AvailabilityZoneIds []string
    AZ IDs users should create their VPCs in to minimize their cost.
    ServiceId string
    Server side ID of the PrivateLink connection.
    ServiceName string
    AWS service name used to create endpoints.
    availabilityZoneIds List<String>
    AZ IDs users should create their VPCs in to minimize their cost.
    serviceId String
    Server side ID of the PrivateLink connection.
    serviceName String
    AWS service name used to create endpoints.
    availabilityZoneIds string[]
    AZ IDs users should create their VPCs in to minimize their cost.
    serviceId string
    Server side ID of the PrivateLink connection.
    serviceName string
    AWS service name used to create endpoints.
    availability_zone_ids Sequence[str]
    AZ IDs users should create their VPCs in to minimize their cost.
    service_id str
    Server side ID of the PrivateLink connection.
    service_name str
    AWS service name used to create endpoints.
    availabilityZoneIds List<String>
    AZ IDs users should create their VPCs in to minimize their cost.
    serviceId String
    Server side ID of the PrivateLink connection.
    serviceName String
    AWS service name used to create endpoints.

    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.2.3 published on Monday, May 27, 2024 by pulumiverse
    pulumiverse/pulumi-cockroach