delete-dns-entry¶

Description¶

Delete a DNS entry.

Synopsis¶

  delete-dns-entry
--environment-crn <value>
--dns-target <value>
[--endpoint <value>]
[--remove-wildcard | --no-remove-wildcard]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--environment-crn (string)

The CRN of the environment, for which the DNS entry is to be deleted.

--dns-target (object)

DnsTarget represents the target of a DNS entry, which can be a set of IPs, a CNAME, or an AWS ELB DNS target.

targetIPs -> (object)

IPs holds a list of IP addresses for a DNS entry.

ips -> (array)

IP addresses for a DNS entry.

item -> (string)

targetCname -> (string)

CNAME target for the DNS entry, e.g. “example.com”.

targetAWSELBDns -> (object)

AWSElbDnsTarget represents an AWS ELB (e.g. ALB/NLB) alias target for a DNS entry.

dnsName -> (string)

The DNS name of the AWS ELB, e.g. “my-alb-123.elb.eu-west-1.amazonaws.com”.

hostedZoneId -> (string)

The Route53 hosted zone id of the AWS ELB.

Shorthand Syntax:

targetIPs={ips=[string,string]},targetCname=string,targetAWSELBDns={dnsName=string,hostedZoneId=string}

JSON Syntax:

{
  "targetIPs": {
    "ips": ["string", ...]
  },
  "targetCname": "string",
  "targetAWSELBDns": {
    "dnsName": "string",
    "hostedZoneId": "string"
  }
}

--endpoint (string)

The endpoint for this cluster.

--remove-wildcard | --no-remove-wildcard (boolean)

Removes the wildcard entry if TRUE.

--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¶

Form Factors¶

public