generated from pulumi/pulumi-tf-provider-boilerplate
/
getSecurityZone.go
199 lines (171 loc) · 8.42 KB
/
getSecurityZone.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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
// Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***
package cloudguard
import (
"context"
"reflect"
"github.com/pulumi/pulumi-oci/sdk/go/oci/internal"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
// This data source provides details about a specific Security Zone resource in Oracle Cloud Infrastructure Cloud Guard service.
//
// Gets a security zone by its identifier. A security zone is associated with a security zone recipe and enforces all security zone policies in the recipe. Any actions in the zone's compartments that violate a policy are denied.
//
// ## Example Usage
//
// ```go
// package main
//
// import (
//
// "github.com/pulumi/pulumi-oci/sdk/go/oci/CloudGuard"
// "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//
// )
//
// func main() {
// pulumi.Run(func(ctx *pulumi.Context) error {
// _, err := CloudGuard.GetSecurityZone(ctx, &cloudguard.GetSecurityZoneArgs{
// SecurityZoneId: testSecurityZoneOciCloudGuardSecurityZone.Id,
// }, nil)
// if err != nil {
// return err
// }
// return nil
// })
// }
//
// ```
func LookupSecurityZone(ctx *pulumi.Context, args *LookupSecurityZoneArgs, opts ...pulumi.InvokeOption) (*LookupSecurityZoneResult, error) {
opts = internal.PkgInvokeDefaultOpts(opts)
var rv LookupSecurityZoneResult
err := ctx.Invoke("oci:CloudGuard/getSecurityZone:getSecurityZone", args, &rv, opts...)
if err != nil {
return nil, err
}
return &rv, nil
}
// A collection of arguments for invoking getSecurityZone.
type LookupSecurityZoneArgs struct {
// The unique identifier of the security zone (`SecurityZone`)
SecurityZoneId string `pulumi:"securityZoneId"`
}
// A collection of values returned by getSecurityZone.
type LookupSecurityZoneResult struct {
// The OCID of the compartment for the security zone
CompartmentId string `pulumi:"compartmentId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`
DefinedTags map[string]interface{} `pulumi:"definedTags"`
// The security zone's description
Description string `pulumi:"description"`
// The security zone's name
DisplayName string `pulumi:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
FreeformTags map[string]interface{} `pulumi:"freeformTags"`
// Unique identifier that is immutable on creation
Id string `pulumi:"id"`
// List of inherited compartments
InheritedByCompartments []string `pulumi:"inheritedByCompartments"`
// A message describing the current state in more detail. For example, this can be used to provide actionable information for a zone in the `Failed` state.
LifecycleDetails string `pulumi:"lifecycleDetails"`
SecurityZoneId string `pulumi:"securityZoneId"`
// The OCID of the recipe (`SecurityRecipe`) for the security zone
SecurityZoneRecipeId string `pulumi:"securityZoneRecipeId"`
// The OCID of the target associated with the security zone
SecurityZoneTargetId string `pulumi:"securityZoneTargetId"`
// The current state of the security zone
State string `pulumi:"state"`
// The time the security zone was created. An RFC3339 formatted datetime string.
TimeCreated string `pulumi:"timeCreated"`
// The time the security zone was last updated. An RFC3339 formatted datetime string.
TimeUpdated string `pulumi:"timeUpdated"`
}
func LookupSecurityZoneOutput(ctx *pulumi.Context, args LookupSecurityZoneOutputArgs, opts ...pulumi.InvokeOption) LookupSecurityZoneResultOutput {
return pulumi.ToOutputWithContext(context.Background(), args).
ApplyT(func(v interface{}) (LookupSecurityZoneResult, error) {
args := v.(LookupSecurityZoneArgs)
r, err := LookupSecurityZone(ctx, &args, opts...)
var s LookupSecurityZoneResult
if r != nil {
s = *r
}
return s, err
}).(LookupSecurityZoneResultOutput)
}
// A collection of arguments for invoking getSecurityZone.
type LookupSecurityZoneOutputArgs struct {
// The unique identifier of the security zone (`SecurityZone`)
SecurityZoneId pulumi.StringInput `pulumi:"securityZoneId"`
}
func (LookupSecurityZoneOutputArgs) ElementType() reflect.Type {
return reflect.TypeOf((*LookupSecurityZoneArgs)(nil)).Elem()
}
// A collection of values returned by getSecurityZone.
type LookupSecurityZoneResultOutput struct{ *pulumi.OutputState }
func (LookupSecurityZoneResultOutput) ElementType() reflect.Type {
return reflect.TypeOf((*LookupSecurityZoneResult)(nil)).Elem()
}
func (o LookupSecurityZoneResultOutput) ToLookupSecurityZoneResultOutput() LookupSecurityZoneResultOutput {
return o
}
func (o LookupSecurityZoneResultOutput) ToLookupSecurityZoneResultOutputWithContext(ctx context.Context) LookupSecurityZoneResultOutput {
return o
}
// The OCID of the compartment for the security zone
func (o LookupSecurityZoneResultOutput) CompartmentId() pulumi.StringOutput {
return o.ApplyT(func(v LookupSecurityZoneResult) string { return v.CompartmentId }).(pulumi.StringOutput)
}
// Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}`
func (o LookupSecurityZoneResultOutput) DefinedTags() pulumi.MapOutput {
return o.ApplyT(func(v LookupSecurityZoneResult) map[string]interface{} { return v.DefinedTags }).(pulumi.MapOutput)
}
// The security zone's description
func (o LookupSecurityZoneResultOutput) Description() pulumi.StringOutput {
return o.ApplyT(func(v LookupSecurityZoneResult) string { return v.Description }).(pulumi.StringOutput)
}
// The security zone's name
func (o LookupSecurityZoneResultOutput) DisplayName() pulumi.StringOutput {
return o.ApplyT(func(v LookupSecurityZoneResult) string { return v.DisplayName }).(pulumi.StringOutput)
}
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
func (o LookupSecurityZoneResultOutput) FreeformTags() pulumi.MapOutput {
return o.ApplyT(func(v LookupSecurityZoneResult) map[string]interface{} { return v.FreeformTags }).(pulumi.MapOutput)
}
// Unique identifier that is immutable on creation
func (o LookupSecurityZoneResultOutput) Id() pulumi.StringOutput {
return o.ApplyT(func(v LookupSecurityZoneResult) string { return v.Id }).(pulumi.StringOutput)
}
// List of inherited compartments
func (o LookupSecurityZoneResultOutput) InheritedByCompartments() pulumi.StringArrayOutput {
return o.ApplyT(func(v LookupSecurityZoneResult) []string { return v.InheritedByCompartments }).(pulumi.StringArrayOutput)
}
// A message describing the current state in more detail. For example, this can be used to provide actionable information for a zone in the `Failed` state.
func (o LookupSecurityZoneResultOutput) LifecycleDetails() pulumi.StringOutput {
return o.ApplyT(func(v LookupSecurityZoneResult) string { return v.LifecycleDetails }).(pulumi.StringOutput)
}
func (o LookupSecurityZoneResultOutput) SecurityZoneId() pulumi.StringOutput {
return o.ApplyT(func(v LookupSecurityZoneResult) string { return v.SecurityZoneId }).(pulumi.StringOutput)
}
// The OCID of the recipe (`SecurityRecipe`) for the security zone
func (o LookupSecurityZoneResultOutput) SecurityZoneRecipeId() pulumi.StringOutput {
return o.ApplyT(func(v LookupSecurityZoneResult) string { return v.SecurityZoneRecipeId }).(pulumi.StringOutput)
}
// The OCID of the target associated with the security zone
func (o LookupSecurityZoneResultOutput) SecurityZoneTargetId() pulumi.StringOutput {
return o.ApplyT(func(v LookupSecurityZoneResult) string { return v.SecurityZoneTargetId }).(pulumi.StringOutput)
}
// The current state of the security zone
func (o LookupSecurityZoneResultOutput) State() pulumi.StringOutput {
return o.ApplyT(func(v LookupSecurityZoneResult) string { return v.State }).(pulumi.StringOutput)
}
// The time the security zone was created. An RFC3339 formatted datetime string.
func (o LookupSecurityZoneResultOutput) TimeCreated() pulumi.StringOutput {
return o.ApplyT(func(v LookupSecurityZoneResult) string { return v.TimeCreated }).(pulumi.StringOutput)
}
// The time the security zone was last updated. An RFC3339 formatted datetime string.
func (o LookupSecurityZoneResultOutput) TimeUpdated() pulumi.StringOutput {
return o.ApplyT(func(v LookupSecurityZoneResult) string { return v.TimeUpdated }).(pulumi.StringOutput)
}
func init() {
pulumi.RegisterOutputType(LookupSecurityZoneResultOutput{})
}