steering_policy_attachments

Creates, updates, deletes, gets or lists a steering_policy_attachments resource.

Overview

Name	`steering_policy_attachments`
Type	Resource
Id	`oci.dns.steering_policy_attachments`

Fields

The following fields are returned by SELECT queries:

get
list

A response containing a single steering policy attachment object.

Name	Datatype	Description
`id`	`string`	The OCID of the resource.
`compartmentId`	`string`	The OCID of the compartment containing the steering policy attachment.
`displayName`	`string`	A user-friendly name for the steering policy attachment. Does not have to be unique and can be changed. Avoid entering confidential information.
`domainName`	`string`	The attached domain within the attached zone.
`lifecycleState`	`string`	The current state of the resource. (CREATING, ACTIVE, DELETING)
`rtypes`	`array`	The record types covered by the attachment at the domain. The set of record types is determined by aggregating the record types from the answers defined in the steering policy.
`self`	`string (url)`	The canonical absolute URL of the resource.
`steeringPolicyId`	`string`	The OCID of the attached steering policy.
`timeCreated`	`string (date-time)`	The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: `2016-07-22T17:23:59:60Z`
`zoneId`	`string`	The OCID of the attached zone. Must be a public zone.

An attachment between a steering policy and a domain.

Name	Datatype	Description
`id`	`string`	The OCID of the resource.
`compartmentId`	`string`	The OCID of the compartment containing the steering policy attachment.
`displayName`	`string`	A user-friendly name for the steering policy attachment. Does not have to be unique and can be changed. Avoid entering confidential information.
`domainName`	`string`	The attached domain within the attached zone.
`lifecycleState`	`string`	The current state of the resource. (CREATING, ACTIVE, DELETING)
`rtypes`	`array`	The record types covered by the attachment at the domain. The set of record types is determined by aggregating the record types from the answers defined in the steering policy.
`self`	`string (url)`	The canonical absolute URL of the resource.
`steeringPolicyId`	`string`	The OCID of the attached steering policy.
`timeCreated`	`string (date-time)`	The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: `2016-07-22T17:23:59:60Z`
`zoneId`	`string`	The OCID of the attached zone. Must be a public zone.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`steeringPolicyAttachmentId`, `region`	`If-None-Match`, `If-Modified-Since`, `opc-request-id`, `scope`	Gets information about the specified steering policy attachment.<br />
`list`	`select`	`compartmentId`, `region`	`opc-request-id`, `limit`, `page`, `id`, `displayName`, `steeringPolicyId`, `zoneId`, `domain`, `domainContains`, `timeCreatedGreaterThanOrEqualTo`, `timeCreatedLessThan`, `lifecycleState`, `sortBy`, `sortOrder`, `scope`	Lists the steering policy attachments in the specified compartment.<br />
`create`	`insert`	`region`, `steeringPolicyId`, `zoneId`, `domainName`	`opc-retry-token`, `opc-request-id`, `scope`	Creates a new attachment between a steering policy and a domain, giving the<br />policy permission to answer queries for the specified domain. A steering policy must<br />be attached to a domain for the policy to answer DNS queries for that domain.<br /><br />For the purposes of access control, the attachment is automatically placed<br />into the same compartment as the domain's zone.<br /><br />Attachments cannot be created for private zones.<br />
`update`	`update`	`steeringPolicyAttachmentId`, `region`	`If-Match`, `If-Unmodified-Since`, `opc-request-id`, `scope`	Updates the specified steering policy attachment with your new information.<br />
`delete`	`delete`	`steeringPolicyAttachmentId`, `region`	`If-Match`, `If-Unmodified-Since`, `opc-request-id`, `scope`	Deletes the specified steering policy attachment.<br />A `204` response indicates that the delete has been successful.<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`compartmentId`	`string`	The OCID of the compartment the resource belongs to.
`region`	`string`	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
`steeringPolicyAttachmentId`	`string`	The OCID of the target steering policy attachment.
`If-Match`	`string`	The `If-Match` header field makes the request method conditional on the existence of at least one current representation of the target resource, when the field-value is `*`, or having a current representation of the target resource that has an entity-tag matching a member of the list of entity-tags provided in the field-value.
`If-Modified-Since`	`string`	The `If-Modified-Since` header field makes a GET or HEAD request method conditional on the selected representation's modification date being more recent than the date provided in the field-value. Transfer of the selected representation's data is avoided if that data has not changed.
`If-None-Match`	`string`	The `If-None-Match` header field makes the request method conditional on the absence of any current representation of the target resource, when the field-value is `*`, or having a selected representation with an entity-tag that does not match any of those listed in the field-value.
`If-Unmodified-Since`	`string`	The `If-Unmodified-Since` header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. This field accomplishes the same purpose as If-Match for cases where the user agent does not have an entity-tag for the representation.
`displayName`	`string`	The displayName of a resource.
`domain`	`string`	Search by domain. Will match any record whose domain (case-insensitive) equals the provided value.
`domainContains`	`string`	Search by domain. Will match any record whose domain (case-insensitive) contains the provided value.
`id`	`string`	The OCID of a resource.
`lifecycleState`	`string`	The state of a resource.
`limit`	`integer (int64)`	The maximum number of items to return in a page of the collection.
`opc-request-id`	`string`	Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc-retry-token`	`string`	A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`page`	`string`	The value of the `opc-next-page` response header from the previous "List" call.
`scope`	`string`	Specifies to operate only on resources that have a matching DNS scope.
`sortBy`	`string`	The field by which to sort steering policy attachments. If unspecified, defaults to `timeCreated`.
`sortOrder`	`string`	The order to sort the resources.
`steeringPolicyId`	`string`	Search by steering policy OCID. Will match any resource whose steering policy ID matches the provided value.
`timeCreatedGreaterThanOrEqualTo`	`string (date-time)`	An [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp that states all returned resources were created on or after the indicated time.
`timeCreatedLessThan`	`string (date-time)`	An [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp that states all returned resources were created before the indicated time.
`zoneId`	`string`	Search by zone OCID. Will match any resource whose zone ID matches the provided value.

`SELECT` examples

get
list

Gets information about the specified steering policy attachment.

SELECT
id,
compartmentId,
displayName,
domainName,
lifecycleState,
rtypes,
self,
steeringPolicyId,
timeCreated,
zoneId
FROM oci.dns.steering_policy_attachments
WHERE steeringPolicyAttachmentId = '{{ steeringPolicyAttachmentId }}' -- required
AND region = '{{ region }}' -- required
AND If-None-Match = '{{ If-None-Match }}'
AND If-Modified-Since = '{{ If-Modified-Since }}'
AND opc-request-id = '{{ opc-request-id }}'
AND scope = '{{ scope }}'
;

Lists the steering policy attachments in the specified compartment.

SELECT
id,
compartmentId,
displayName,
domainName,
lifecycleState,
rtypes,
self,
steeringPolicyId,
timeCreated,
zoneId
FROM oci.dns.steering_policy_attachments
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND id = '{{ id }}'
AND displayName = '{{ displayName }}'
AND steeringPolicyId = '{{ steeringPolicyId }}'
AND zoneId = '{{ zoneId }}'
AND domain = '{{ domain }}'
AND domainContains = '{{ domainContains }}'
AND timeCreatedGreaterThanOrEqualTo = '{{ timeCreatedGreaterThanOrEqualTo }}'
AND timeCreatedLessThan = '{{ timeCreatedLessThan }}'
AND lifecycleState = '{{ lifecycleState }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND scope = '{{ scope }}'
;

`INSERT` examples

create
Manifest

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. Attachments cannot be created for private zones.

INSERT INTO oci.dns.steering_policy_attachments (
displayName,
domainName,
steeringPolicyId,
zoneId,
region,
opc-retry-token,
opc-request-id,
scope
)
SELECT 
'{{ displayName }}',
'{{ domainName }}' /* required */,
'{{ steeringPolicyId }}' /* required */,
'{{ zoneId }}' /* required */,
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}',
'{{ scope }}'
RETURNING
id,
compartmentId,
displayName,
domainName,
lifecycleState,
rtypes,
self,
steeringPolicyId,
timeCreated,
zoneId
;

# Description fields are for documentation purposes
- name: steering_policy_attachments
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the steering_policy_attachments resource.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      A user-friendly name for the steering policy attachment.
      Does not have to be unique and can be changed.
      Avoid entering confidential information.
  - name: domainName
    value: "{{ domainName }}"
    description: |
      The attached domain within the attached zone.
  - name: steeringPolicyId
    value: "{{ steeringPolicyId }}"
    description: |
      The OCID of the attached steering policy.
  - name: zoneId
    value: "{{ zoneId }}"
    description: |
      The OCID of the attached zone. Must be a public zone.
  - name: opc-retry-token
    value: "{{ opc-retry-token }}"
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
  - name: opc-request-id
    value: "{{ opc-request-id }}"
    description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 
    description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 
  - name: scope
    value: "{{ scope }}"
    description: Specifies to operate only on resources that have a matching DNS scope. 
    description: Specifies to operate only on resources that have a matching DNS scope. 

`UPDATE` examples

update

Updates the specified steering policy attachment with your new information.

UPDATE oci.dns.steering_policy_attachments
SET 
displayName = '{{ displayName }}'
WHERE 
steeringPolicyAttachmentId = '{{ steeringPolicyAttachmentId }}' --required
AND region = '{{ region }}' --required
AND If-Match = '{{ If-Match}}'
AND If-Unmodified-Since = '{{ If-Unmodified-Since}}'
AND opc-request-id = '{{ opc-request-id}}'
AND scope = '{{ scope}}'
RETURNING
id,
compartmentId,
displayName,
domainName,
lifecycleState,
rtypes,
self,
steeringPolicyId,
timeCreated,
zoneId;

`DELETE` examples

delete

Deletes the specified steering policy attachment. A 204 response indicates that the delete has been successful.

DELETE FROM oci.dns.steering_policy_attachments
WHERE steeringPolicyAttachmentId = '{{ steeringPolicyAttachmentId }}' --required
AND region = '{{ region }}' --required
AND If-Match = '{{ If-Match }}'
AND If-Unmodified-Since = '{{ If-Unmodified-Since }}'
AND opc-request-id = '{{ opc-request-id }}'
AND scope = '{{ scope }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​