Creates a new attachment between a steering policy and a domain, giving the policy permission to answer queries for the specified domain. A steering policy must be attached to a domain for the policy to answer DNS queries for that domain.

For the purposes of access control, the attachment is automatically placed into the same compartment as the domain’s zone.


oci dns steering-policy-attachment create [OPTIONS]

Required Parameters

--domain-name [text]

The attached domain within the attached zone.

--steering-policy-id [text]

The OCID of the attached steering policy.

--zone-id [text]

The OCID of the attached zone.

Optional Parameters

--display-name [text]

A user-friendly name for the steering policy attachment. Does not have to be unique and can be changed. Avoid entering confidential information.

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link:

--max-wait-seconds [integer]

The maximum time to wait for the resource to reach the lifecycle state defined by --wait-for-state. Defaults to 1200 seconds.

--scope [text]

Specifies to operate only on resources that have a matching DNS scope.

Accepted values are:

--wait-for-state [text]

This operation creates, modifies or deletes a resource that has a defined lifecycle state. Specify this option to perform the action and then wait until the resource reaches a given lifecycle state. Multiple states can be specified, returning on the first state. For example, --wait-for-state SUCCEEDED --wait-for-state FAILED would return on whichever lifecycle state is reached first. If timeout is reached, a return code of 2 is returned. For any other error, a return code of 1 is returned.

Accepted values are:

--wait-interval-seconds [integer]

Check every --wait-interval-seconds to see whether the resource has reached the lifecycle state defined by --wait-for-state. Defaults to 30 seconds.

Example using required parameter

Copy the following CLI commands into a file named Run the command by typing “bash” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.

    export compartment_id=<substitute-value-of-compartment_id> #
    export display_name=<substitute-value-of-display_name> #
    export template=<substitute-value-of-template> #
    export name=<substitute-value-of-name> #
    export zone_type=<substitute-value-of-zone_type> #
    export domain_name=<substitute-value-of-domain_name> #

    steering_policy_id=$(oci dns steering-policy create --compartment-id $compartment_id --display-name $display_name --template $template --query --raw-output)

    zone_id=$(oci dns zone create --compartment-id $compartment_id --name $name --zone-type $zone_type --query --raw-output)

    oci dns steering-policy-attachment create --domain-name $domain_name --steering-policy-id $steering_policy_id --zone-id $zone_id