-
Notifications
You must be signed in to change notification settings - Fork 626
/
api_op_UpdateDomainName.go
328 lines (268 loc) · 12.5 KB
/
api_op_UpdateDomainName.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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package apigateway
import (
"context"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/internal/awsutil"
"github.com/aws/aws-sdk-go-v2/private/protocol"
)
// A request to change information about the DomainName resource.
type UpdateDomainNameInput struct {
_ struct{} `type:"structure"`
// [Required] The name of the DomainName resource to be changed.
//
// DomainName is a required field
DomainName *string `location:"uri" locationName:"domain_name" type:"string" required:"true"`
// A list of update operations to be applied to the specified resource and in
// the order specified in this list.
PatchOperations []PatchOperation `locationName:"patchOperations" type:"list"`
}
// String returns the string representation
func (s UpdateDomainNameInput) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *UpdateDomainNameInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "UpdateDomainNameInput"}
if s.DomainName == nil {
invalidParams.Add(aws.NewErrParamRequired("DomainName"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s UpdateDomainNameInput) MarshalFields(e protocol.FieldEncoder) error {
e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/json"), protocol.Metadata{})
if s.PatchOperations != nil {
v := s.PatchOperations
metadata := protocol.Metadata{}
ls0 := e.List(protocol.BodyTarget, "patchOperations", metadata)
ls0.Start()
for _, v1 := range v {
ls0.ListAddFields(v1)
}
ls0.End()
}
if s.DomainName != nil {
v := *s.DomainName
metadata := protocol.Metadata{}
e.SetValue(protocol.PathTarget, "domain_name", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
return nil
}
// Represents a custom domain name as a user-friendly host name of an API (RestApi).
//
// When you deploy an API, API Gateway creates a default host name for the API.
// This default API host name is of the {restapi-id}.execute-api.{region}.amazonaws.com
// format. With the default host name, you can access the API's root resource
// with the URL of https://{restapi-id}.execute-api.{region}.amazonaws.com/{stage}/.
// When you set up a custom domain name of apis.example.com for this API, you
// can then access the same resource using the URL of the https://apis.examples.com/myApi,
// where myApi is the base path mapping (BasePathMapping) of your API under
// the custom domain name.
//
// Set a Custom Host Name for an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)
type UpdateDomainNameOutput struct {
_ struct{} `type:"structure"`
// The reference to an AWS-managed certificate that will be used by edge-optimized
// endpoint for this domain name. AWS Certificate Manager is the only supported
// source.
CertificateArn *string `locationName:"certificateArn" type:"string"`
// The name of the certificate that will be used by edge-optimized endpoint
// for this domain name.
CertificateName *string `locationName:"certificateName" type:"string"`
// The timestamp when the certificate that was used by edge-optimized endpoint
// for this domain name was uploaded.
CertificateUploadDate *time.Time `locationName:"certificateUploadDate" type:"timestamp"`
// The domain name of the Amazon CloudFront distribution associated with this
// custom domain name for an edge-optimized endpoint. You set up this association
// when adding a DNS record pointing the custom domain name to this distribution
// name. For more information about CloudFront distributions, see the Amazon
// CloudFront documentation (https://aws.amazon.com/documentation/cloudfront/).
DistributionDomainName *string `locationName:"distributionDomainName" type:"string"`
// The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized
// endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more
// information, see Set up a Regional Custom Domain Name (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html)
// and AWS Regions and Endpoints for API Gateway (https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region).
DistributionHostedZoneId *string `locationName:"distributionHostedZoneId" type:"string"`
// The custom domain name as an API host name, for example, my-api.example.com.
DomainName *string `locationName:"domainName" type:"string"`
// The status of the DomainName migration. The valid values are AVAILABLE and
// UPDATING. If the status is UPDATING, the domain cannot be modified further
// until the existing operation is complete. If it is AVAILABLE, the domain
// can be updated.
DomainNameStatus DomainNameStatus `locationName:"domainNameStatus" type:"string" enum:"true"`
// An optional text message containing detailed information about status of
// the DomainName migration.
DomainNameStatusMessage *string `locationName:"domainNameStatusMessage" type:"string"`
// The endpoint configuration of this DomainName showing the endpoint types
// of the domain name.
EndpointConfiguration *EndpointConfiguration `locationName:"endpointConfiguration" type:"structure"`
// The reference to an AWS-managed certificate that will be used for validating
// the regional domain name. AWS Certificate Manager is the only supported source.
RegionalCertificateArn *string `locationName:"regionalCertificateArn" type:"string"`
// The name of the certificate that will be used for validating the regional
// domain name.
RegionalCertificateName *string `locationName:"regionalCertificateName" type:"string"`
// The domain name associated with the regional endpoint for this custom domain
// name. You set up this association by adding a DNS record that points the
// custom domain name to this regional domain name. The regional domain name
// is returned by API Gateway when you create a regional endpoint.
RegionalDomainName *string `locationName:"regionalDomainName" type:"string"`
// The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.
// For more information, see Set up a Regional Custom Domain Name (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html)
// and AWS Regions and Endpoints for API Gateway (https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region).
RegionalHostedZoneId *string `locationName:"regionalHostedZoneId" type:"string"`
// The Transport Layer Security (TLS) version + cipher suite for this DomainName.
// The valid values are TLS_1_0 and TLS_1_2.
SecurityPolicy SecurityPolicy `locationName:"securityPolicy" type:"string" enum:"true"`
// The collection of tags. Each tag element is associated with a given resource.
Tags map[string]string `locationName:"tags" type:"map"`
}
// String returns the string representation
func (s UpdateDomainNameOutput) String() string {
return awsutil.Prettify(s)
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s UpdateDomainNameOutput) MarshalFields(e protocol.FieldEncoder) error {
if s.CertificateArn != nil {
v := *s.CertificateArn
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "certificateArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.CertificateName != nil {
v := *s.CertificateName
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "certificateName", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.CertificateUploadDate != nil {
v := *s.CertificateUploadDate
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "certificateUploadDate",
protocol.TimeValue{V: v, Format: protocol.UnixTimeFormatName, QuotedFormatTime: true}, metadata)
}
if s.DistributionDomainName != nil {
v := *s.DistributionDomainName
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "distributionDomainName", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.DistributionHostedZoneId != nil {
v := *s.DistributionHostedZoneId
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "distributionHostedZoneId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.DomainName != nil {
v := *s.DomainName
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "domainName", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if len(s.DomainNameStatus) > 0 {
v := s.DomainNameStatus
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "domainNameStatus", protocol.QuotedValue{ValueMarshaler: v}, metadata)
}
if s.DomainNameStatusMessage != nil {
v := *s.DomainNameStatusMessage
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "domainNameStatusMessage", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.EndpointConfiguration != nil {
v := s.EndpointConfiguration
metadata := protocol.Metadata{}
e.SetFields(protocol.BodyTarget, "endpointConfiguration", v, metadata)
}
if s.RegionalCertificateArn != nil {
v := *s.RegionalCertificateArn
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "regionalCertificateArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.RegionalCertificateName != nil {
v := *s.RegionalCertificateName
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "regionalCertificateName", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.RegionalDomainName != nil {
v := *s.RegionalDomainName
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "regionalDomainName", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.RegionalHostedZoneId != nil {
v := *s.RegionalHostedZoneId
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "regionalHostedZoneId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if len(s.SecurityPolicy) > 0 {
v := s.SecurityPolicy
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "securityPolicy", protocol.QuotedValue{ValueMarshaler: v}, metadata)
}
if s.Tags != nil {
v := s.Tags
metadata := protocol.Metadata{}
ms0 := e.Map(protocol.BodyTarget, "tags", metadata)
ms0.Start()
for k1, v1 := range v {
ms0.MapSetValue(k1, protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v1)})
}
ms0.End()
}
return nil
}
const opUpdateDomainName = "UpdateDomainName"
// UpdateDomainNameRequest returns a request value for making API operation for
// Amazon API Gateway.
//
// Changes information about the DomainName resource.
//
// // Example sending a request using UpdateDomainNameRequest.
// req := client.UpdateDomainNameRequest(params)
// resp, err := req.Send(context.TODO())
// if err == nil {
// fmt.Println(resp)
// }
func (c *Client) UpdateDomainNameRequest(input *UpdateDomainNameInput) UpdateDomainNameRequest {
op := &aws.Operation{
Name: opUpdateDomainName,
HTTPMethod: "PATCH",
HTTPPath: "/domainnames/{domain_name}",
}
if input == nil {
input = &UpdateDomainNameInput{}
}
req := c.newRequest(op, input, &UpdateDomainNameOutput{})
return UpdateDomainNameRequest{Request: req, Input: input, Copy: c.UpdateDomainNameRequest}
}
// UpdateDomainNameRequest is the request type for the
// UpdateDomainName API operation.
type UpdateDomainNameRequest struct {
*aws.Request
Input *UpdateDomainNameInput
Copy func(*UpdateDomainNameInput) UpdateDomainNameRequest
}
// Send marshals and sends the UpdateDomainName API request.
func (r UpdateDomainNameRequest) Send(ctx context.Context) (*UpdateDomainNameResponse, error) {
r.Request.SetContext(ctx)
err := r.Request.Send()
if err != nil {
return nil, err
}
resp := &UpdateDomainNameResponse{
UpdateDomainNameOutput: r.Request.Data.(*UpdateDomainNameOutput),
response: &aws.Response{Request: r.Request},
}
return resp, nil
}
// UpdateDomainNameResponse is the response type for the
// UpdateDomainName API operation.
type UpdateDomainNameResponse struct {
*UpdateDomainNameOutput
response *aws.Response
}
// SDKResponseMetdata returns the response metadata for the
// UpdateDomainName request.
func (r *UpdateDomainNameResponse) SDKResponseMetdata() *aws.Response {
return r.response
}