docs(api): Default value for deleteOnTermination

State default value for both deleteOnTermination and
rootVolumeDeleteOnTermination equals to true
This commit is contained in:
Gabriel Tiossi 2019-12-05 20:00:30 -03:00
parent 35071ccaff
commit dfd7fa9b2a
3 changed files with 18 additions and 6 deletions

View File

@ -106,7 +106,9 @@ type InstanceGroupSpec struct {
RootVolumeIops *int32 `json:"rootVolumeIops,omitempty"`
// RootVolumeOptimization enables EBS optimization for an instance
RootVolumeOptimization *bool `json:"rootVolumeOptimization,omitempty"`
// RootVolumeDeleteOnTermination states if the root volume will be deleted after instance termination
// RootVolumeDeleteOnTermination configures root volume retention policy upon instance termination.
// The root volume is deleted by default. Cluster deletion does not remove retained root volumes.
// NOTE: This setting applies only to the Launch Configuration and does not affect Launch Templates.
RootVolumeDeleteOnTermination *bool `json:"rootVolumeDeleteOnTermination,omitempty"`
// Volumes is a collection of additional volumes to create for instances within this InstanceGroup
Volumes []*VolumeSpec `json:"volumes,omitempty"`
@ -200,7 +202,9 @@ type UserData struct {
// VolumeSpec defined the spec for an additional volume attached to the instance group
type VolumeSpec struct {
// DeleteOnTermination states if the volume will be deleted after instance termination
// DeleteOnTermination configures volume retention policy upon instance termination.
// The volume is deleted by default. Cluster deletion does not remove retained volumes.
// NOTE: This setting applies only to the Launch Configuration and does not affect Launch Templates.
DeleteOnTermination *bool `json:"deleteOnTermination,omitempty"`
// Device is an optional device name of the block device
Device string `json:"device,omitempty"`

View File

@ -94,7 +94,9 @@ type InstanceGroupSpec struct {
RootVolumeIops *int32 `json:"rootVolumeIops,omitempty"`
// RootVolumeOptimization enables EBS optimization for an instance
RootVolumeOptimization *bool `json:"rootVolumeOptimization,omitempty"`
// RootVolumeDeleteOnTermination states if the root volume will be deleted after instance termination
// RootVolumeDeleteOnTermination configures root volume retention policy upon instance termination.
// The root volume is deleted by default. Cluster deletion does not remove retained root volumes.
// NOTE: This setting applies only to the Launch Configuration and does not affect Launch Templates.
RootVolumeDeleteOnTermination *bool `json:"rootVolumeDeleteOnTermination,omitempty"`
// Volumes is a collection of additional volumes to create for instances within this InstanceGroup
Volumes []*VolumeSpec `json:"volumes,omitempty"`
@ -195,7 +197,9 @@ type UserData struct {
// VolumeSpec defined the spec for an additional volume attached to the instance group
type VolumeSpec struct {
// DeleteOnTermination states if the volume will be deleted after instance termination
// DeleteOnTermination configures volume retention policy upon instance termination.
// The volume is deleted by default. Cluster deletion does not remove retained volumes.
// NOTE: This setting applies only to the Launch Configuration and does not affect Launch Templates.
DeleteOnTermination *bool `json:"deleteOnTermination,omitempty"`
// Device is an optional device name of the block device
Device string `json:"device,omitempty"`

View File

@ -99,7 +99,9 @@ type InstanceGroupSpec struct {
RootVolumeIops *int32 `json:"rootVolumeIops,omitempty"`
// RootVolumeOptimization enables EBS optimization for an instance
RootVolumeOptimization *bool `json:"rootVolumeOptimization,omitempty"`
// RootVolumeDeleteOnTermination states if the root volume will be deleted after instance termination
// RootVolumeDeleteOnTermination configures root volume retention policy upon instance termination.
// The root volume is deleted by default. Cluster deletion does not remove retained root volumes.
// NOTE: This setting applies only to the Launch Configuration and does not affect Launch Templates.
RootVolumeDeleteOnTermination *bool `json:"rootVolumeDeleteOnTermination,omitempty"`
// Volumes is a collection of additional volumes to create for instances within this InstanceGroup
Volumes []*VolumeSpec `json:"volumes,omitempty"`
@ -194,7 +196,9 @@ type UserData struct {
// VolumeSpec defined the spec for an additional volume attached to the instance group
type VolumeSpec struct {
// DeleteOnTermination states if the volume will be deleted after instance termination
// DeleteOnTermination configures volume retention policy upon instance termination.
// The volume is deleted by default. Cluster deletion does not remove retained volumes.
// NOTE: This setting applies only to the Launch Configuration and does not affect Launch Templates.
DeleteOnTermination *bool `json:"deleteOnTermination,omitempty"`
// Device is an optional device name of the block device
Device string `json:"device,omitempty"`