Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Clickhouse
  3. API Docs
  4. ServicePrivateEndpoints
  5. Attachment
Clickhouse v1.0.1 published on Thursday, Sep 5, 2024 by pulumiverse
pulumiverse/pulumi-clickhouse

clickhouse.ServicePrivateEndpoints.Attachment

Explore with Pulumi AI

clickhouse logo
Clickhouse v1.0.1 published on Thursday, Sep 5, 2024 by pulumiverse
pulumiverse/pulumi-clickhouse

    Use the clickhouse_service_private_endpoints_attachment resource to attach a ClickHouse service to a Private Endpoint.

    See private_endpoint_registration for how to create a private endpoint.

    See full example on GitHub.

    Create Attachment Resource

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

    Constructor syntax

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

@overload
def Attachment(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               private_endpoint_ids: Optional[Sequence[str]] = None,
               service_id: Optional[str] = None)
    func NewAttachment(ctx *Context, name string, args *AttachmentArgs, opts ...ResourceOption) (*Attachment, error)
    public Attachment(string name, AttachmentArgs? args = null, CustomResourceOptions? opts = null)
    public Attachment(String name, AttachmentArgs args)
public Attachment(String name, AttachmentArgs args, CustomResourceOptions options)

    type: clickhouse:ServicePrivateEndpoints:Attachment
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 AttachmentArgs
    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 AttachmentArgs
    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 AttachmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AttachmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AttachmentArgs
    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 attachmentResource = new Clickhouse.ServicePrivateEndpoints.Attachment("attachmentResource", new()
{
    PrivateEndpointIds = new[]
    {
        "string",
    },
    ServiceId = "string",
});

    example, err := ServicePrivateEndpoints.NewAttachment(ctx, "attachmentResource", &ServicePrivateEndpoints.AttachmentArgs{
	PrivateEndpointIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	ServiceId: pulumi.String("string"),
})

    var attachmentResource = new Attachment("attachmentResource", AttachmentArgs.builder()
    .privateEndpointIds("string")
    .serviceId("string")
    .build());

    attachment_resource = clickhouse.service_private_endpoints.Attachment("attachmentResource",
    private_endpoint_ids=["string"],
    service_id="string")

    const attachmentResource = new clickhouse.serviceprivateendpoints.Attachment("attachmentResource", {
    privateEndpointIds: ["string"],
    serviceId: "string",
});

    type: clickhouse:ServicePrivateEndpoints:Attachment
properties:
    privateEndpointIds:
        - string
    serviceId: string

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

    PrivateEndpointIds List<string>
    List of private endpoint IDs
    ServiceId string
    ClickHouse Servie ID
    PrivateEndpointIds []string
    List of private endpoint IDs
    ServiceId string
    ClickHouse Servie ID
    privateEndpointIds List<String>
    List of private endpoint IDs
    serviceId String
    ClickHouse Servie ID
    privateEndpointIds string[]
    List of private endpoint IDs
    serviceId string
    ClickHouse Servie ID
    private_endpoint_ids Sequence[str]
    List of private endpoint IDs
    service_id str
    ClickHouse Servie ID
    privateEndpointIds List<String>
    List of private endpoint IDs
    serviceId String
    ClickHouse Servie ID

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Attachment Resource

    Get an existing Attachment 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?: AttachmentState, opts?: CustomResourceOptions): Attachment
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        private_endpoint_ids: Optional[Sequence[str]] = None,
        service_id: Optional[str] = None) -> Attachment
    func GetAttachment(ctx *Context, name string, id IDInput, state *AttachmentState, opts ...ResourceOption) (*Attachment, error)
    public static Attachment Get(string name, Input<string> id, AttachmentState? state, CustomResourceOptions? opts = null)
    public static Attachment get(String name, Output<String> id, AttachmentState 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:
    PrivateEndpointIds List<string>
    List of private endpoint IDs
    ServiceId string
    ClickHouse Servie ID
    PrivateEndpointIds []string
    List of private endpoint IDs
    ServiceId string
    ClickHouse Servie ID
    privateEndpointIds List<String>
    List of private endpoint IDs
    serviceId String
    ClickHouse Servie ID
    privateEndpointIds string[]
    List of private endpoint IDs
    serviceId string
    ClickHouse Servie ID
    private_endpoint_ids Sequence[str]
    List of private endpoint IDs
    service_id str
    ClickHouse Servie ID
    privateEndpointIds List<String>
    List of private endpoint IDs
    serviceId String
    ClickHouse Servie ID

    Import

    Endpoint Attachments can be imported by specifying the clickhouse service UUID

    $ pulumi import clickhouse:ServicePrivateEndpoints/attachment:Attachment example xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

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

    Package Details

    Repository
    clickhouse pulumiverse/pulumi-clickhouse
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the clickhouse Terraform Provider.
    clickhouse logo
    Clickhouse v1.0.1 published on Thursday, Sep 5, 2024 by pulumiverse
    pulumiverse/pulumi-clickhouse