1. Packages
  2. Databricks
  3. API Docs
  4. MwsVpcEndpoint
Databricks v1.37.0 published on Thursday, Apr 25, 2024 by Pulumi

databricks.MwsVpcEndpoint

Explore with Pulumi AI

databricks logo
Databricks v1.37.0 published on Thursday, Apr 25, 2024 by Pulumi

    Import

    -> Note Importing this resource is not currently supported.

    Create MwsVpcEndpoint Resource

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

    Constructor syntax

    new MwsVpcEndpoint(name: string, args: MwsVpcEndpointArgs, opts?: CustomResourceOptions);
    @overload
    def MwsVpcEndpoint(resource_name: str,
                       args: MwsVpcEndpointArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def MwsVpcEndpoint(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       vpc_endpoint_name: Optional[str] = None,
                       account_id: Optional[str] = None,
                       aws_account_id: Optional[str] = None,
                       aws_endpoint_service_id: Optional[str] = None,
                       aws_vpc_endpoint_id: Optional[str] = None,
                       gcp_vpc_endpoint_info: Optional[MwsVpcEndpointGcpVpcEndpointInfoArgs] = None,
                       region: Optional[str] = None,
                       state: Optional[str] = None,
                       use_case: Optional[str] = None,
                       vpc_endpoint_id: Optional[str] = None)
    func NewMwsVpcEndpoint(ctx *Context, name string, args MwsVpcEndpointArgs, opts ...ResourceOption) (*MwsVpcEndpoint, error)
    public MwsVpcEndpoint(string name, MwsVpcEndpointArgs args, CustomResourceOptions? opts = null)
    public MwsVpcEndpoint(String name, MwsVpcEndpointArgs args)
    public MwsVpcEndpoint(String name, MwsVpcEndpointArgs args, CustomResourceOptions options)
    
    type: databricks:MwsVpcEndpoint
    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 MwsVpcEndpointArgs
    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 MwsVpcEndpointArgs
    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 MwsVpcEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MwsVpcEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MwsVpcEndpointArgs
    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 mwsVpcEndpointResource = new Databricks.MwsVpcEndpoint("mwsVpcEndpointResource", new()
    {
        VpcEndpointName = "string",
        AccountId = "string",
        AwsAccountId = "string",
        AwsEndpointServiceId = "string",
        AwsVpcEndpointId = "string",
        GcpVpcEndpointInfo = new Databricks.Inputs.MwsVpcEndpointGcpVpcEndpointInfoArgs
        {
            EndpointRegion = "string",
            ProjectId = "string",
            PscEndpointName = "string",
            PscConnectionId = "string",
            ServiceAttachmentId = "string",
        },
        Region = "string",
        State = "string",
        UseCase = "string",
        VpcEndpointId = "string",
    });
    
    example, err := databricks.NewMwsVpcEndpoint(ctx, "mwsVpcEndpointResource", &databricks.MwsVpcEndpointArgs{
    	VpcEndpointName:      pulumi.String("string"),
    	AccountId:            pulumi.String("string"),
    	AwsAccountId:         pulumi.String("string"),
    	AwsEndpointServiceId: pulumi.String("string"),
    	AwsVpcEndpointId:     pulumi.String("string"),
    	GcpVpcEndpointInfo: &databricks.MwsVpcEndpointGcpVpcEndpointInfoArgs{
    		EndpointRegion:      pulumi.String("string"),
    		ProjectId:           pulumi.String("string"),
    		PscEndpointName:     pulumi.String("string"),
    		PscConnectionId:     pulumi.String("string"),
    		ServiceAttachmentId: pulumi.String("string"),
    	},
    	Region:        pulumi.String("string"),
    	State:         pulumi.String("string"),
    	UseCase:       pulumi.String("string"),
    	VpcEndpointId: pulumi.String("string"),
    })
    
    var mwsVpcEndpointResource = new MwsVpcEndpoint("mwsVpcEndpointResource", MwsVpcEndpointArgs.builder()        
        .vpcEndpointName("string")
        .accountId("string")
        .awsAccountId("string")
        .awsEndpointServiceId("string")
        .awsVpcEndpointId("string")
        .gcpVpcEndpointInfo(MwsVpcEndpointGcpVpcEndpointInfoArgs.builder()
            .endpointRegion("string")
            .projectId("string")
            .pscEndpointName("string")
            .pscConnectionId("string")
            .serviceAttachmentId("string")
            .build())
        .region("string")
        .state("string")
        .useCase("string")
        .vpcEndpointId("string")
        .build());
    
    mws_vpc_endpoint_resource = databricks.MwsVpcEndpoint("mwsVpcEndpointResource",
        vpc_endpoint_name="string",
        account_id="string",
        aws_account_id="string",
        aws_endpoint_service_id="string",
        aws_vpc_endpoint_id="string",
        gcp_vpc_endpoint_info=databricks.MwsVpcEndpointGcpVpcEndpointInfoArgs(
            endpoint_region="string",
            project_id="string",
            psc_endpoint_name="string",
            psc_connection_id="string",
            service_attachment_id="string",
        ),
        region="string",
        state="string",
        use_case="string",
        vpc_endpoint_id="string")
    
    const mwsVpcEndpointResource = new databricks.MwsVpcEndpoint("mwsVpcEndpointResource", {
        vpcEndpointName: "string",
        accountId: "string",
        awsAccountId: "string",
        awsEndpointServiceId: "string",
        awsVpcEndpointId: "string",
        gcpVpcEndpointInfo: {
            endpointRegion: "string",
            projectId: "string",
            pscEndpointName: "string",
            pscConnectionId: "string",
            serviceAttachmentId: "string",
        },
        region: "string",
        state: "string",
        useCase: "string",
        vpcEndpointId: "string",
    });
    
    type: databricks:MwsVpcEndpoint
    properties:
        accountId: string
        awsAccountId: string
        awsEndpointServiceId: string
        awsVpcEndpointId: string
        gcpVpcEndpointInfo:
            endpointRegion: string
            projectId: string
            pscConnectionId: string
            pscEndpointName: string
            serviceAttachmentId: string
        region: string
        state: string
        useCase: string
        vpcEndpointId: string
        vpcEndpointName: string
    

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

    VpcEndpointName string
    Name of VPC Endpoint in Databricks Account
    AccountId string
    Account Id that could be found in the Accounts Console for AWS or GCP
    AwsAccountId string
    AwsEndpointServiceId string
    (AWS Only) The ID of the Databricks endpoint service that this VPC endpoint is connected to. Please find the list of endpoint service IDs for each supported region in the Databricks PrivateLink documentation
    AwsVpcEndpointId string
    ID of configured aws_vpc_endpoint
    GcpVpcEndpointInfo MwsVpcEndpointGcpVpcEndpointInfo
    a block consists of Google Cloud specific information for this PSC endpoint. It has the following fields:
    Region string
    Region of AWS VPC
    State string
    (AWS Only) State of VPC Endpoint
    UseCase string
    VpcEndpointId string
    Canonical unique identifier of VPC Endpoint in Databricks Account
    VpcEndpointName string
    Name of VPC Endpoint in Databricks Account
    AccountId string
    Account Id that could be found in the Accounts Console for AWS or GCP
    AwsAccountId string
    AwsEndpointServiceId string
    (AWS Only) The ID of the Databricks endpoint service that this VPC endpoint is connected to. Please find the list of endpoint service IDs for each supported region in the Databricks PrivateLink documentation
    AwsVpcEndpointId string
    ID of configured aws_vpc_endpoint
    GcpVpcEndpointInfo MwsVpcEndpointGcpVpcEndpointInfoArgs
    a block consists of Google Cloud specific information for this PSC endpoint. It has the following fields:
    Region string
    Region of AWS VPC
    State string
    (AWS Only) State of VPC Endpoint
    UseCase string
    VpcEndpointId string
    Canonical unique identifier of VPC Endpoint in Databricks Account
    vpcEndpointName String
    Name of VPC Endpoint in Databricks Account
    accountId String
    Account Id that could be found in the Accounts Console for AWS or GCP
    awsAccountId String
    awsEndpointServiceId String
    (AWS Only) The ID of the Databricks endpoint service that this VPC endpoint is connected to. Please find the list of endpoint service IDs for each supported region in the Databricks PrivateLink documentation
    awsVpcEndpointId String
    ID of configured aws_vpc_endpoint
    gcpVpcEndpointInfo MwsVpcEndpointGcpVpcEndpointInfo
    a block consists of Google Cloud specific information for this PSC endpoint. It has the following fields:
    region String
    Region of AWS VPC
    state String
    (AWS Only) State of VPC Endpoint
    useCase String
    vpcEndpointId String
    Canonical unique identifier of VPC Endpoint in Databricks Account
    vpcEndpointName string
    Name of VPC Endpoint in Databricks Account
    accountId string
    Account Id that could be found in the Accounts Console for AWS or GCP
    awsAccountId string
    awsEndpointServiceId string
    (AWS Only) The ID of the Databricks endpoint service that this VPC endpoint is connected to. Please find the list of endpoint service IDs for each supported region in the Databricks PrivateLink documentation
    awsVpcEndpointId string
    ID of configured aws_vpc_endpoint
    gcpVpcEndpointInfo MwsVpcEndpointGcpVpcEndpointInfo
    a block consists of Google Cloud specific information for this PSC endpoint. It has the following fields:
    region string
    Region of AWS VPC
    state string
    (AWS Only) State of VPC Endpoint
    useCase string
    vpcEndpointId string
    Canonical unique identifier of VPC Endpoint in Databricks Account
    vpc_endpoint_name str
    Name of VPC Endpoint in Databricks Account
    account_id str
    Account Id that could be found in the Accounts Console for AWS or GCP
    aws_account_id str
    aws_endpoint_service_id str
    (AWS Only) The ID of the Databricks endpoint service that this VPC endpoint is connected to. Please find the list of endpoint service IDs for each supported region in the Databricks PrivateLink documentation
    aws_vpc_endpoint_id str
    ID of configured aws_vpc_endpoint
    gcp_vpc_endpoint_info MwsVpcEndpointGcpVpcEndpointInfoArgs
    a block consists of Google Cloud specific information for this PSC endpoint. It has the following fields:
    region str
    Region of AWS VPC
    state str
    (AWS Only) State of VPC Endpoint
    use_case str
    vpc_endpoint_id str
    Canonical unique identifier of VPC Endpoint in Databricks Account
    vpcEndpointName String
    Name of VPC Endpoint in Databricks Account
    accountId String
    Account Id that could be found in the Accounts Console for AWS or GCP
    awsAccountId String
    awsEndpointServiceId String
    (AWS Only) The ID of the Databricks endpoint service that this VPC endpoint is connected to. Please find the list of endpoint service IDs for each supported region in the Databricks PrivateLink documentation
    awsVpcEndpointId String
    ID of configured aws_vpc_endpoint
    gcpVpcEndpointInfo Property Map
    a block consists of Google Cloud specific information for this PSC endpoint. It has the following fields:
    region String
    Region of AWS VPC
    state String
    (AWS Only) State of VPC Endpoint
    useCase String
    vpcEndpointId String
    Canonical unique identifier of VPC Endpoint in Databricks Account

    Outputs

    All input properties are implicitly available as output properties. Additionally, the MwsVpcEndpoint 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 MwsVpcEndpoint Resource

    Get an existing MwsVpcEndpoint 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?: MwsVpcEndpointState, opts?: CustomResourceOptions): MwsVpcEndpoint
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = None,
            aws_account_id: Optional[str] = None,
            aws_endpoint_service_id: Optional[str] = None,
            aws_vpc_endpoint_id: Optional[str] = None,
            gcp_vpc_endpoint_info: Optional[MwsVpcEndpointGcpVpcEndpointInfoArgs] = None,
            region: Optional[str] = None,
            state: Optional[str] = None,
            use_case: Optional[str] = None,
            vpc_endpoint_id: Optional[str] = None,
            vpc_endpoint_name: Optional[str] = None) -> MwsVpcEndpoint
    func GetMwsVpcEndpoint(ctx *Context, name string, id IDInput, state *MwsVpcEndpointState, opts ...ResourceOption) (*MwsVpcEndpoint, error)
    public static MwsVpcEndpoint Get(string name, Input<string> id, MwsVpcEndpointState? state, CustomResourceOptions? opts = null)
    public static MwsVpcEndpoint get(String name, Output<String> id, MwsVpcEndpointState 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:
    AccountId string
    Account Id that could be found in the Accounts Console for AWS or GCP
    AwsAccountId string
    AwsEndpointServiceId string
    (AWS Only) The ID of the Databricks endpoint service that this VPC endpoint is connected to. Please find the list of endpoint service IDs for each supported region in the Databricks PrivateLink documentation
    AwsVpcEndpointId string
    ID of configured aws_vpc_endpoint
    GcpVpcEndpointInfo MwsVpcEndpointGcpVpcEndpointInfo
    a block consists of Google Cloud specific information for this PSC endpoint. It has the following fields:
    Region string
    Region of AWS VPC
    State string
    (AWS Only) State of VPC Endpoint
    UseCase string
    VpcEndpointId string
    Canonical unique identifier of VPC Endpoint in Databricks Account
    VpcEndpointName string
    Name of VPC Endpoint in Databricks Account
    AccountId string
    Account Id that could be found in the Accounts Console for AWS or GCP
    AwsAccountId string
    AwsEndpointServiceId string
    (AWS Only) The ID of the Databricks endpoint service that this VPC endpoint is connected to. Please find the list of endpoint service IDs for each supported region in the Databricks PrivateLink documentation
    AwsVpcEndpointId string
    ID of configured aws_vpc_endpoint
    GcpVpcEndpointInfo MwsVpcEndpointGcpVpcEndpointInfoArgs
    a block consists of Google Cloud specific information for this PSC endpoint. It has the following fields:
    Region string
    Region of AWS VPC
    State string
    (AWS Only) State of VPC Endpoint
    UseCase string
    VpcEndpointId string
    Canonical unique identifier of VPC Endpoint in Databricks Account
    VpcEndpointName string
    Name of VPC Endpoint in Databricks Account
    accountId String
    Account Id that could be found in the Accounts Console for AWS or GCP
    awsAccountId String
    awsEndpointServiceId String
    (AWS Only) The ID of the Databricks endpoint service that this VPC endpoint is connected to. Please find the list of endpoint service IDs for each supported region in the Databricks PrivateLink documentation
    awsVpcEndpointId String
    ID of configured aws_vpc_endpoint
    gcpVpcEndpointInfo MwsVpcEndpointGcpVpcEndpointInfo
    a block consists of Google Cloud specific information for this PSC endpoint. It has the following fields:
    region String
    Region of AWS VPC
    state String
    (AWS Only) State of VPC Endpoint
    useCase String
    vpcEndpointId String
    Canonical unique identifier of VPC Endpoint in Databricks Account
    vpcEndpointName String
    Name of VPC Endpoint in Databricks Account
    accountId string
    Account Id that could be found in the Accounts Console for AWS or GCP
    awsAccountId string
    awsEndpointServiceId string
    (AWS Only) The ID of the Databricks endpoint service that this VPC endpoint is connected to. Please find the list of endpoint service IDs for each supported region in the Databricks PrivateLink documentation
    awsVpcEndpointId string
    ID of configured aws_vpc_endpoint
    gcpVpcEndpointInfo MwsVpcEndpointGcpVpcEndpointInfo
    a block consists of Google Cloud specific information for this PSC endpoint. It has the following fields:
    region string
    Region of AWS VPC
    state string
    (AWS Only) State of VPC Endpoint
    useCase string
    vpcEndpointId string
    Canonical unique identifier of VPC Endpoint in Databricks Account
    vpcEndpointName string
    Name of VPC Endpoint in Databricks Account
    account_id str
    Account Id that could be found in the Accounts Console for AWS or GCP
    aws_account_id str
    aws_endpoint_service_id str
    (AWS Only) The ID of the Databricks endpoint service that this VPC endpoint is connected to. Please find the list of endpoint service IDs for each supported region in the Databricks PrivateLink documentation
    aws_vpc_endpoint_id str
    ID of configured aws_vpc_endpoint
    gcp_vpc_endpoint_info MwsVpcEndpointGcpVpcEndpointInfoArgs
    a block consists of Google Cloud specific information for this PSC endpoint. It has the following fields:
    region str
    Region of AWS VPC
    state str
    (AWS Only) State of VPC Endpoint
    use_case str
    vpc_endpoint_id str
    Canonical unique identifier of VPC Endpoint in Databricks Account
    vpc_endpoint_name str
    Name of VPC Endpoint in Databricks Account
    accountId String
    Account Id that could be found in the Accounts Console for AWS or GCP
    awsAccountId String
    awsEndpointServiceId String
    (AWS Only) The ID of the Databricks endpoint service that this VPC endpoint is connected to. Please find the list of endpoint service IDs for each supported region in the Databricks PrivateLink documentation
    awsVpcEndpointId String
    ID of configured aws_vpc_endpoint
    gcpVpcEndpointInfo Property Map
    a block consists of Google Cloud specific information for this PSC endpoint. It has the following fields:
    region String
    Region of AWS VPC
    state String
    (AWS Only) State of VPC Endpoint
    useCase String
    vpcEndpointId String
    Canonical unique identifier of VPC Endpoint in Databricks Account
    vpcEndpointName String
    Name of VPC Endpoint in Databricks Account

    Supporting Types

    MwsVpcEndpointGcpVpcEndpointInfo, MwsVpcEndpointGcpVpcEndpointInfoArgs

    EndpointRegion string
    Region of the PSC endpoint.
    ProjectId string
    The Google Cloud project ID of the VPC network where the PSC connection resides.
    PscEndpointName string
    The name of the PSC endpoint in the Google Cloud project.
    PscConnectionId string
    The unique ID of this PSC connection.
    ServiceAttachmentId string
    The service attachment this PSC connection connects to.
    EndpointRegion string
    Region of the PSC endpoint.
    ProjectId string
    The Google Cloud project ID of the VPC network where the PSC connection resides.
    PscEndpointName string
    The name of the PSC endpoint in the Google Cloud project.
    PscConnectionId string
    The unique ID of this PSC connection.
    ServiceAttachmentId string
    The service attachment this PSC connection connects to.
    endpointRegion String
    Region of the PSC endpoint.
    projectId String
    The Google Cloud project ID of the VPC network where the PSC connection resides.
    pscEndpointName String
    The name of the PSC endpoint in the Google Cloud project.
    pscConnectionId String
    The unique ID of this PSC connection.
    serviceAttachmentId String
    The service attachment this PSC connection connects to.
    endpointRegion string
    Region of the PSC endpoint.
    projectId string
    The Google Cloud project ID of the VPC network where the PSC connection resides.
    pscEndpointName string
    The name of the PSC endpoint in the Google Cloud project.
    pscConnectionId string
    The unique ID of this PSC connection.
    serviceAttachmentId string
    The service attachment this PSC connection connects to.
    endpoint_region str
    Region of the PSC endpoint.
    project_id str
    The Google Cloud project ID of the VPC network where the PSC connection resides.
    psc_endpoint_name str
    The name of the PSC endpoint in the Google Cloud project.
    psc_connection_id str
    The unique ID of this PSC connection.
    service_attachment_id str
    The service attachment this PSC connection connects to.
    endpointRegion String
    Region of the PSC endpoint.
    projectId String
    The Google Cloud project ID of the VPC network where the PSC connection resides.
    pscEndpointName String
    The name of the PSC endpoint in the Google Cloud project.
    pscConnectionId String
    The unique ID of this PSC connection.
    serviceAttachmentId String
    The service attachment this PSC connection connects to.

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Databricks v1.37.0 published on Thursday, Apr 25, 2024 by Pulumi