-
Notifications
You must be signed in to change notification settings - Fork 82
/
steering_policy_summary.go
161 lines (137 loc) · 8.32 KB
/
steering_policy_summary.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
// Copyright (c) 2016, 2018, 2021, Oracle and/or its affiliates. All rights reserved.
// This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
// Code generated. DO NOT EDIT.
// DNS API
//
// API for the DNS service. Use this API to manage DNS zones, records, and other DNS resources.
// For more information, see Overview of the DNS Service (https://docs.cloud.oracle.com/iaas/Content/DNS/Concepts/dnszonemanagement.htm).
//
package dns
import (
"github.com/oracle/oci-go-sdk/v43/common"
)
// SteeringPolicySummary A DNS steering policy.
// **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
type SteeringPolicySummary struct {
// The OCID of the compartment containing the steering policy.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name for the steering policy. Does not have to be unique and can be changed.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The Time To Live (TTL) for responses from the steering policy, in seconds.
// If not specified during creation, a value of 30 seconds will be used.
Ttl *int `mandatory:"true" json:"ttl"`
// A set of predefined rules based on the desired purpose of the steering policy. Each
// template utilizes Traffic Management's rules in a different order to produce the desired
// results when answering DNS queries.
//
// **Example:** The `FAILOVER` template determines answers by filtering the policy's answers
// using the `FILTER` rule first, then the following rules in succession: `HEALTH`, `PRIORITY`,
// and `LIMIT`. This gives the domain dynamic failover capability.
//
// It is **strongly recommended** to use a template other than `CUSTOM` when creating
// a steering policy.
//
// All templates require the rule order to begin with an unconditional `FILTER` rule that keeps
// answers contingent upon `answer.isDisabled != true`, except for `CUSTOM`. A defined
// `HEALTH` rule must follow the `FILTER` rule if the policy references a `healthCheckMonitorId`.
// The last rule of a template must must be a `LIMIT` rule. For more information about templates
// and code examples, see Traffic Management API Guide (https://docs.cloud.oracle.com/iaas/Content/TrafficManagement/Concepts/trafficmanagementapi.htm).
// **Template Types**
// * `FAILOVER` - Uses health check information on your endpoints to determine which DNS answers
// to serve. If an endpoint fails a health check, the answer for that endpoint will be removed
// from the list of available answers until the endpoint is detected as healthy.
//
// * `LOAD_BALANCE` - Distributes web traffic to specified endpoints based on defined weights.
//
// * `ROUTE_BY_GEO` - Answers DNS queries based on the query's geographic location. For a list of geographic
// locations to route by, see Traffic Management Geographic Locations (https://docs.cloud.oracle.com/iaas/Content/TrafficManagement/Reference/trafficmanagementgeo.htm).
//
// * `ROUTE_BY_ASN` - Answers DNS queries based on the query's originating ASN.
//
// * `ROUTE_BY_IP` - Answers DNS queries based on the query's IP address.
//
// * `CUSTOM` - Allows a customized configuration of rules.
Template SteeringPolicySummaryTemplateEnum `mandatory:"true" json:"template"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
//
// **Example:** `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
//
// **Example:** `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`
// The canonical absolute URL of the resource.
Self *string `mandatory:"true" json:"self"`
// The OCID of the resource.
Id *string `mandatory:"true" json:"id"`
// The date and time the resource was created, expressed in RFC 3339 timestamp format.
// **Example:** `2016-07-22T17:23:59:60Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the resource.
LifecycleState SteeringPolicySummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The OCID of the health check monitor providing health data about the answers of the
// steering policy. A steering policy answer with `rdata` matching a monitored endpoint
// will use the health data of that endpoint. A steering policy answer with `rdata` not
// matching any monitored endpoint will be assumed healthy.
//
// **Note:** To use the Health Check monitoring feature in a steering policy, a monitor
// must be created using the Health Checks service first. For more information on how to
// create a monitor, please see Managing Health Checks (https://docs.cloud.oracle.com/iaas/Content/HealthChecks/Tasks/managinghealthchecks.htm).
HealthCheckMonitorId *string `mandatory:"false" json:"healthCheckMonitorId"`
}
func (m SteeringPolicySummary) String() string {
return common.PointerString(m)
}
// SteeringPolicySummaryTemplateEnum Enum with underlying type: string
type SteeringPolicySummaryTemplateEnum string
// Set of constants representing the allowable values for SteeringPolicySummaryTemplateEnum
const (
SteeringPolicySummaryTemplateFailover SteeringPolicySummaryTemplateEnum = "FAILOVER"
SteeringPolicySummaryTemplateLoadBalance SteeringPolicySummaryTemplateEnum = "LOAD_BALANCE"
SteeringPolicySummaryTemplateRouteByGeo SteeringPolicySummaryTemplateEnum = "ROUTE_BY_GEO"
SteeringPolicySummaryTemplateRouteByAsn SteeringPolicySummaryTemplateEnum = "ROUTE_BY_ASN"
SteeringPolicySummaryTemplateRouteByIp SteeringPolicySummaryTemplateEnum = "ROUTE_BY_IP"
SteeringPolicySummaryTemplateCustom SteeringPolicySummaryTemplateEnum = "CUSTOM"
)
var mappingSteeringPolicySummaryTemplate = map[string]SteeringPolicySummaryTemplateEnum{
"FAILOVER": SteeringPolicySummaryTemplateFailover,
"LOAD_BALANCE": SteeringPolicySummaryTemplateLoadBalance,
"ROUTE_BY_GEO": SteeringPolicySummaryTemplateRouteByGeo,
"ROUTE_BY_ASN": SteeringPolicySummaryTemplateRouteByAsn,
"ROUTE_BY_IP": SteeringPolicySummaryTemplateRouteByIp,
"CUSTOM": SteeringPolicySummaryTemplateCustom,
}
// GetSteeringPolicySummaryTemplateEnumValues Enumerates the set of values for SteeringPolicySummaryTemplateEnum
func GetSteeringPolicySummaryTemplateEnumValues() []SteeringPolicySummaryTemplateEnum {
values := make([]SteeringPolicySummaryTemplateEnum, 0)
for _, v := range mappingSteeringPolicySummaryTemplate {
values = append(values, v)
}
return values
}
// SteeringPolicySummaryLifecycleStateEnum Enum with underlying type: string
type SteeringPolicySummaryLifecycleStateEnum string
// Set of constants representing the allowable values for SteeringPolicySummaryLifecycleStateEnum
const (
SteeringPolicySummaryLifecycleStateActive SteeringPolicySummaryLifecycleStateEnum = "ACTIVE"
SteeringPolicySummaryLifecycleStateCreating SteeringPolicySummaryLifecycleStateEnum = "CREATING"
SteeringPolicySummaryLifecycleStateDeleted SteeringPolicySummaryLifecycleStateEnum = "DELETED"
SteeringPolicySummaryLifecycleStateDeleting SteeringPolicySummaryLifecycleStateEnum = "DELETING"
)
var mappingSteeringPolicySummaryLifecycleState = map[string]SteeringPolicySummaryLifecycleStateEnum{
"ACTIVE": SteeringPolicySummaryLifecycleStateActive,
"CREATING": SteeringPolicySummaryLifecycleStateCreating,
"DELETED": SteeringPolicySummaryLifecycleStateDeleted,
"DELETING": SteeringPolicySummaryLifecycleStateDeleting,
}
// GetSteeringPolicySummaryLifecycleStateEnumValues Enumerates the set of values for SteeringPolicySummaryLifecycleStateEnum
func GetSteeringPolicySummaryLifecycleStateEnumValues() []SteeringPolicySummaryLifecycleStateEnum {
values := make([]SteeringPolicySummaryLifecycleStateEnum, 0)
for _, v := range mappingSteeringPolicySummaryLifecycleState {
values = append(values, v)
}
return values
}