generated from pulumi/pulumi-tf-provider-boilerplate
/
getUsagePlan.go
178 lines (153 loc) · 7.97 KB
/
getUsagePlan.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
// 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 apigateway
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 Usage Plan resource in Oracle Cloud Infrastructure API Gateway service.
//
// Gets a usage plan by identifier.
//
// ## Example Usage
//
// ```go
// package main
//
// import (
//
// "github.com/pulumi/pulumi-oci/sdk/go/oci/ApiGateway"
// "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//
// )
//
// func main() {
// pulumi.Run(func(ctx *pulumi.Context) error {
// _, err := ApiGateway.GetUsagePlan(ctx, &apigateway.GetUsagePlanArgs{
// UsagePlanId: testUsagePlanOciApigatewayUsagePlan.Id,
// }, nil)
// if err != nil {
// return err
// }
// return nil
// })
// }
//
// ```
func LookupUsagePlan(ctx *pulumi.Context, args *LookupUsagePlanArgs, opts ...pulumi.InvokeOption) (*LookupUsagePlanResult, error) {
opts = internal.PkgInvokeDefaultOpts(opts)
var rv LookupUsagePlanResult
err := ctx.Invoke("oci:ApiGateway/getUsagePlan:getUsagePlan", args, &rv, opts...)
if err != nil {
return nil, err
}
return &rv, nil
}
// A collection of arguments for invoking getUsagePlan.
type LookupUsagePlanArgs struct {
// The ocid of the usage plan.
UsagePlanId string `pulumi:"usagePlanId"`
}
// A collection of values returned by getUsagePlan.
type LookupUsagePlanResult struct {
// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the resource is created.
CompartmentId string `pulumi:"compartmentId"`
// 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]interface{} `pulumi:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource`
DisplayName string `pulumi:"displayName"`
// A collection of entitlements currently assigned to the usage plan.
Entitlements []GetUsagePlanEntitlement `pulumi:"entitlements"`
// 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]interface{} `pulumi:"freeformTags"`
// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a usage plan resource.
Id string `pulumi:"id"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
LifecycleDetails string `pulumi:"lifecycleDetails"`
// The current state of the usage plan.
State string `pulumi:"state"`
// The time this resource was created. An RFC3339 formatted datetime string.
TimeCreated string `pulumi:"timeCreated"`
// The time this resource was last updated. An RFC3339 formatted datetime string.
TimeUpdated string `pulumi:"timeUpdated"`
UsagePlanId string `pulumi:"usagePlanId"`
}
func LookupUsagePlanOutput(ctx *pulumi.Context, args LookupUsagePlanOutputArgs, opts ...pulumi.InvokeOption) LookupUsagePlanResultOutput {
return pulumi.ToOutputWithContext(context.Background(), args).
ApplyT(func(v interface{}) (LookupUsagePlanResult, error) {
args := v.(LookupUsagePlanArgs)
r, err := LookupUsagePlan(ctx, &args, opts...)
var s LookupUsagePlanResult
if r != nil {
s = *r
}
return s, err
}).(LookupUsagePlanResultOutput)
}
// A collection of arguments for invoking getUsagePlan.
type LookupUsagePlanOutputArgs struct {
// The ocid of the usage plan.
UsagePlanId pulumi.StringInput `pulumi:"usagePlanId"`
}
func (LookupUsagePlanOutputArgs) ElementType() reflect.Type {
return reflect.TypeOf((*LookupUsagePlanArgs)(nil)).Elem()
}
// A collection of values returned by getUsagePlan.
type LookupUsagePlanResultOutput struct{ *pulumi.OutputState }
func (LookupUsagePlanResultOutput) ElementType() reflect.Type {
return reflect.TypeOf((*LookupUsagePlanResult)(nil)).Elem()
}
func (o LookupUsagePlanResultOutput) ToLookupUsagePlanResultOutput() LookupUsagePlanResultOutput {
return o
}
func (o LookupUsagePlanResultOutput) ToLookupUsagePlanResultOutputWithContext(ctx context.Context) LookupUsagePlanResultOutput {
return o
}
// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the resource is created.
func (o LookupUsagePlanResultOutput) CompartmentId() pulumi.StringOutput {
return o.ApplyT(func(v LookupUsagePlanResult) string { return v.CompartmentId }).(pulumi.StringOutput)
}
// 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"}`
func (o LookupUsagePlanResultOutput) DefinedTags() pulumi.MapOutput {
return o.ApplyT(func(v LookupUsagePlanResult) map[string]interface{} { return v.DefinedTags }).(pulumi.MapOutput)
}
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource`
func (o LookupUsagePlanResultOutput) DisplayName() pulumi.StringOutput {
return o.ApplyT(func(v LookupUsagePlanResult) string { return v.DisplayName }).(pulumi.StringOutput)
}
// A collection of entitlements currently assigned to the usage plan.
func (o LookupUsagePlanResultOutput) Entitlements() GetUsagePlanEntitlementArrayOutput {
return o.ApplyT(func(v LookupUsagePlanResult) []GetUsagePlanEntitlement { return v.Entitlements }).(GetUsagePlanEntitlementArrayOutput)
}
// 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"}`
func (o LookupUsagePlanResultOutput) FreeformTags() pulumi.MapOutput {
return o.ApplyT(func(v LookupUsagePlanResult) map[string]interface{} { return v.FreeformTags }).(pulumi.MapOutput)
}
// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a usage plan resource.
func (o LookupUsagePlanResultOutput) Id() pulumi.StringOutput {
return o.ApplyT(func(v LookupUsagePlanResult) string { return v.Id }).(pulumi.StringOutput)
}
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
func (o LookupUsagePlanResultOutput) LifecycleDetails() pulumi.StringOutput {
return o.ApplyT(func(v LookupUsagePlanResult) string { return v.LifecycleDetails }).(pulumi.StringOutput)
}
// The current state of the usage plan.
func (o LookupUsagePlanResultOutput) State() pulumi.StringOutput {
return o.ApplyT(func(v LookupUsagePlanResult) string { return v.State }).(pulumi.StringOutput)
}
// The time this resource was created. An RFC3339 formatted datetime string.
func (o LookupUsagePlanResultOutput) TimeCreated() pulumi.StringOutput {
return o.ApplyT(func(v LookupUsagePlanResult) string { return v.TimeCreated }).(pulumi.StringOutput)
}
// The time this resource was last updated. An RFC3339 formatted datetime string.
func (o LookupUsagePlanResultOutput) TimeUpdated() pulumi.StringOutput {
return o.ApplyT(func(v LookupUsagePlanResult) string { return v.TimeUpdated }).(pulumi.StringOutput)
}
func (o LookupUsagePlanResultOutput) UsagePlanId() pulumi.StringOutput {
return o.ApplyT(func(v LookupUsagePlanResult) string { return v.UsagePlanId }).(pulumi.StringOutput)
}
func init() {
pulumi.RegisterOutputType(LookupUsagePlanResultOutput{})
}