create-private-link-endpoint¶

Description¶

Creates the PrivateLink Endpoints for specified CDP service components.

Synopsis¶

  create-private-link-endpoint
--cloud-service-provider <value>
[--enable-private-dns | --no-enable-private-dns]
[--service-group <value>]
[--aws-account-details <value>]
[--azure-account-details <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--cloud-service-provider (string)

Supported cloud providers AWS - A value indicating AWS as supported cloud provider for creating privatelinks. AZURE - A value indicating Azure as supported cloud provider for creating privatelinks.

Possible values:

• AWS

• AZURE

--enable-private-dns | --no-enable-private-dns (boolean)

Enable Private DNS for PrivateLink endpoint.

--service-group (string)

CDP service group.

--aws-account-details (object)

Details of the cloud network and the cross-account role required to create the PrivateLink endpoint.

cloudAccountId -> (string)

Account ID to authorize access for PrivateLink.

crossAccountRoleDetails -> (object)

Customer cross account role details.

crossAccountRole -> (string)

Cross-account role.

externalId -> (string)

External ID associated with the cross-account role.

credentialCrn -> (string)

CDP Credential CRN to fetch the AWS cross-account RoleArn for the account where the endpoint gets deleted.

region -> (string)

Region in which VPC exists.

vpcId -> (string)

VPC ID in which the private link should be created.

subnetIds -> (array)

IDs of the private subnets in which the private link should be created.

item -> (string)

Shorthand Syntax:

cloudAccountId=string,crossAccountRoleDetails={crossAccountRole=string,externalId=string},credentialCrn=string,region=string,vpcId=string,subnetIds=string,string

JSON Syntax:

{
  "cloudAccountId": "string",
  "crossAccountRoleDetails": {
    "crossAccountRole": "string",
    "externalId": "string"
  },
  "credentialCrn": "string",
  "region": "string",
  "vpcId": "string",
  "subnetIds": ["string", ...]
}

--azure-account-details (object)

Details of the cloud network and the cross-account role required to create the PrivateLink endpoint.

azureClientSecretCredential -> (object)

Azure client secret credential, either this or credential CRN should be passed.

clientId -> (string)

The client (application) ID of the service principal

clientSecret -> (string)

A client secret that was generated for the App Registration used to authenticate the client.

tenantId -> (string)

The Azure Active Directory tenant (directory) Id of the service principal.

credentialCrn -> (string)

CDP Credential CRN to fetch the Azure client secret credentials, either this or AzureClientSecretCredential should be passed.

subscriptionId -> (string)

The Subscription for which the Private link service to be allowed/accessible.

resourceGroup -> (string)

The Resource group under which the Private endpoint to be created.

location -> (string)

Azure location where endpoint should be created.

vNetId -> (string)

vNet ID in which the private link should be created.

subnetId -> (string)

ID of the private subnet in which the private link should be created.

Shorthand Syntax:

azureClientSecretCredential={clientId=string,clientSecret=string,tenantId=string},credentialCrn=string,subscriptionId=string,resourceGroup=string,location=string,vNetId=string,subnetId=string

JSON Syntax:

{
  "azureClientSecretCredential": {
    "clientId": "string",
    "clientSecret": "string",
    "tenantId": "string"
  },
  "credentialCrn": "string",
  "subscriptionId": "string",
  "resourceGroup": "string",
  "location": "string",
  "vNetId": "string",
  "subnetId": "string"
}

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

trackingId -> (string)

Tracking ID of the create endpoint request.

Form Factors¶

public