/
vcn.go
175 lines (144 loc) · 8.24 KB
/
vcn.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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
// Copyright (c) 2016, 2018, 2024, 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.
// Core Services API
//
// Use the Core Services API to manage resources such as virtual cloud networks (VCNs),
// compute instances, and block storage volumes. For more information, see the console
// documentation for the Networking (https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/overview.htm),
// Compute (https://docs.cloud.oracle.com/iaas/Content/Compute/Concepts/computeoverview.htm), and
// Block Volume (https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/overview.htm) services.
// The required permissions are documented in the
// Details for the Core Services (https://docs.cloud.oracle.com/iaas/Content/Identity/Reference/corepolicyreference.htm) article.
//
package core
import (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"strings"
)
// Vcn A virtual cloud network (VCN). For more information, see
// Overview of the Networking Service (https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/overview.htm).
// To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,
// talk to an administrator. If you're an administrator who needs to write policies to give users access, see
// Getting Started with Policies (https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type Vcn struct {
// Deprecated. The first CIDR IP address from cidrBlocks.
// Example: `172.16.0.0/16`
CidrBlock *string `mandatory:"true" json:"cidrBlock"`
// The list of IPv4 CIDR blocks the VCN will use.
CidrBlocks []string `mandatory:"true" json:"cidrBlocks"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the VCN.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The VCN's Oracle ID (OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
Id *string `mandatory:"true" json:"id"`
// The VCN's current state.
LifecycleState VcnLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The list of BYOIPv6 prefixes required to create a VCN that uses BYOIPv6 ranges.
Byoipv6CidrBlocks []string `mandatory:"false" json:"byoipv6CidrBlocks"`
// For an IPv6-enabled VCN, this is the list of Private IPv6 prefixes for the VCN's IP address space.
Ipv6PrivateCidrBlocks []string `mandatory:"false" json:"ipv6PrivateCidrBlocks"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the VCN's default set of DHCP options.
DefaultDhcpOptionsId *string `mandatory:"false" json:"defaultDhcpOptionsId"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the VCN's default route table.
DefaultRouteTableId *string `mandatory:"false" json:"defaultRouteTableId"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the VCN's default security list.
DefaultSecurityListId *string `mandatory:"false" json:"defaultSecurityListId"`
// 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/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A DNS label for the VCN, used in conjunction with the VNIC's hostname and
// subnet's DNS label to form a fully qualified domain name (FQDN) for each VNIC
// within this subnet (for example, `bminstance1.subnet123.vcn1.oraclevcn.com`).
// Must be an alphanumeric string that begins with a letter.
// The value cannot be changed.
// The absence of this parameter means the Internet and VCN Resolver will
// not work for this VCN.
// For more information, see
// DNS in Your Virtual Cloud Network (https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).
// Example: `vcn1`
DnsLabel *string `mandatory:"false" json:"dnsLabel"`
// 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/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// For an IPv6-enabled VCN, this is the list of IPv6 prefixes for the VCN's IP address space.
// The prefixes are provided by Oracle and the sizes are always /56.
Ipv6CidrBlocks []string `mandatory:"false" json:"ipv6CidrBlocks"`
// The date and time the VCN was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The VCN's domain name, which consists of the VCN's DNS label, and the
// `oraclevcn.com` domain.
// For more information, see
// DNS in Your Virtual Cloud Network (https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).
// Example: `vcn1.oraclevcn.com`
VcnDomainName *string `mandatory:"false" json:"vcnDomainName"`
}
func (m Vcn) String() string {
return common.PointerString(m)
}
// ValidateEnumValue returns an error when providing an unsupported enum value
// This function is being called during constructing API request process
// Not recommended for calling this function directly
func (m Vcn) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingVcnLifecycleStateEnum(string(m.LifecycleState)); !ok && m.LifecycleState != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for LifecycleState: %s. Supported values are: %s.", m.LifecycleState, strings.Join(GetVcnLifecycleStateEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// VcnLifecycleStateEnum Enum with underlying type: string
type VcnLifecycleStateEnum string
// Set of constants representing the allowable values for VcnLifecycleStateEnum
const (
VcnLifecycleStateProvisioning VcnLifecycleStateEnum = "PROVISIONING"
VcnLifecycleStateAvailable VcnLifecycleStateEnum = "AVAILABLE"
VcnLifecycleStateTerminating VcnLifecycleStateEnum = "TERMINATING"
VcnLifecycleStateTerminated VcnLifecycleStateEnum = "TERMINATED"
VcnLifecycleStateUpdating VcnLifecycleStateEnum = "UPDATING"
)
var mappingVcnLifecycleStateEnum = map[string]VcnLifecycleStateEnum{
"PROVISIONING": VcnLifecycleStateProvisioning,
"AVAILABLE": VcnLifecycleStateAvailable,
"TERMINATING": VcnLifecycleStateTerminating,
"TERMINATED": VcnLifecycleStateTerminated,
"UPDATING": VcnLifecycleStateUpdating,
}
var mappingVcnLifecycleStateEnumLowerCase = map[string]VcnLifecycleStateEnum{
"provisioning": VcnLifecycleStateProvisioning,
"available": VcnLifecycleStateAvailable,
"terminating": VcnLifecycleStateTerminating,
"terminated": VcnLifecycleStateTerminated,
"updating": VcnLifecycleStateUpdating,
}
// GetVcnLifecycleStateEnumValues Enumerates the set of values for VcnLifecycleStateEnum
func GetVcnLifecycleStateEnumValues() []VcnLifecycleStateEnum {
values := make([]VcnLifecycleStateEnum, 0)
for _, v := range mappingVcnLifecycleStateEnum {
values = append(values, v)
}
return values
}
// GetVcnLifecycleStateEnumStringValues Enumerates the set of values in String for VcnLifecycleStateEnum
func GetVcnLifecycleStateEnumStringValues() []string {
return []string{
"PROVISIONING",
"AVAILABLE",
"TERMINATING",
"TERMINATED",
"UPDATING",
}
}
// GetMappingVcnLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingVcnLifecycleStateEnum(val string) (VcnLifecycleStateEnum, bool) {
enum, ok := mappingVcnLifecycleStateEnumLowerCase[strings.ToLower(val)]
return enum, ok
}