-
Notifications
You must be signed in to change notification settings - Fork 17
/
RecordSetOptions.go
66 lines (63 loc) · 2.47 KB
/
RecordSetOptions.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
package awsroute53
import (
"github.com/aws/aws-cdk-go/awscdk/v2"
)
// Options for a RecordSet.
//
// Example:
// // The code below shows an example of how to instantiate this type.
// // The values are placeholders you should change.
// import cdk "github.com/aws/aws-cdk-go/awscdk"
// import "github.com/aws/aws-cdk-go/awscdk"
//
// var geoLocation geoLocation
// var hostedZone hostedZone
//
// recordSetOptions := &RecordSetOptions{
// Zone: hostedZone,
//
// // the properties below are optional
// Comment: jsii.String("comment"),
// DeleteExisting: jsii.Boolean(false),
// GeoLocation: geoLocation,
// RecordName: jsii.String("recordName"),
// Ttl: cdk.Duration_Minutes(jsii.Number(30)),
// }
//
type RecordSetOptions struct {
// The hosted zone in which to define the new record.
Zone IHostedZone `field:"required" json:"zone" yaml:"zone"`
// A comment to add on the record.
// Default: no comment.
//
Comment *string `field:"optional" json:"comment" yaml:"comment"`
// Whether to delete the same record set in the hosted zone if it already exists (dangerous!).
//
// This allows to deploy a new record set while minimizing the downtime because the
// new record set will be created immediately after the existing one is deleted. It
// also avoids "manual" actions to delete existing record sets.
//
// > **N.B.:** this feature is dangerous, use with caution! It can only be used safely when
// > `deleteExisting` is set to `true` as soon as the resource is added to the stack. Changing
// > an existing Record Set's `deleteExisting` property from `false -> true` after deployment
// > will delete the record!
// Default: false.
//
DeleteExisting *bool `field:"optional" json:"deleteExisting" yaml:"deleteExisting"`
// The geographical origin for this record to return DNS records based on the user's location.
GeoLocation GeoLocation `field:"optional" json:"geoLocation" yaml:"geoLocation"`
// The subdomain name for this record. This should be relative to the zone root name.
//
// For example, if you want to create a record for acme.example.com, specify
// "acme".
//
// You can also specify the fully qualified domain name which terminates with a
// ".". For example, "acme.example.com.".
// Default: zone root.
//
RecordName *string `field:"optional" json:"recordName" yaml:"recordName"`
// The resource record cache time to live (TTL).
// Default: Duration.minutes(30)
//
Ttl awscdk.Duration `field:"optional" json:"ttl" yaml:"ttl"`
}