Skip to content

Latest commit

 

History

History
277 lines (166 loc) · 8.24 KB

README.md

File metadata and controls

277 lines (166 loc) · 8.24 KB
Raw

TF::DigitalOcean::Droplet

Provides a DigitalOcean Droplet resource. This can be used to create, modify, and delete Droplets. Droplets also support provisioning.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
    "Type" : "TF::DigitalOcean::Droplet",
    "Properties" : {
        "Backups" : Boolean,
        "Image" : String,
        "Ipv6" : Boolean,
        "Monitoring" : Boolean,
        "Name" : String,
        "PrivateNetworking" : Boolean,
        "Region" : String,
        "ResizeDisk" : Boolean,
        "Size" : String,
        "SshKeys" : [ String, ... ],
        "Tags" : [ String, ... ],
        "UserData" : String,
        "VolumeIds" : [ String, ... ],
        "VpcUuid" : String
    }
}

YAML

Type: TF::DigitalOcean::Droplet
Properties:
    Backups: Boolean
    Image: String
    Ipv6: Boolean
    Monitoring: Boolean
    Name: String
    PrivateNetworking: Boolean
    Region: String
    ResizeDisk: Boolean
    Size: String
    SshKeys: 
      - String
    Tags: 
      - String
    UserData: String
    VolumeIds: 
      - String
    VpcUuid: String

Properties

Backups

Boolean controlling if backups are made. Defaults to false.

Required: No

Type: Boolean

Update requires: No interruption

Image

The Droplet image ID or slug.

Required: Yes

Type: String

Update requires: No interruption

Ipv6

Boolean controlling if IPv6 is enabled. Defaults to false.

Required: No

Type: Boolean

Update requires: No interruption

Monitoring

Boolean controlling whether monitoring agent is installed. Defaults to false.

Required: No

Type: Boolean

Update requires: No interruption

Name

The Droplet name.

Required: Yes

Type: String

Update requires: No interruption

PrivateNetworking

Boolean controlling if private networking is enabled. When VPC is enabled on an account, this will provision the Droplet inside of your account's default VPC for the region. Use the vpc_uuid attribute to specify a different VPC.

Required: No

Type: Boolean

Update requires: No interruption

Region

The region to start in.

Required: Yes

Type: String

Update requires: No interruption

ResizeDisk

Boolean controlling whether to increase the disk size when resizing a Droplet. It defaults to true. When set to false, only the Droplet's RAM and CPU will be resized. Increasing a Droplet's disk size is a permanent change. Increasing only RAM and CPU is reversible.

Required: No

Type: Boolean

Update requires: No interruption

Size

The unique slug that indentifies the type of Droplet. You can find a list of available slugs on DigitalOcean API documentation.

Required: Yes

Type: String

Update requires: No interruption

SshKeys

A list of SSH key IDs or fingerprints to enable in the format [12345, 123456]. To retrieve this info, use the DigitalOcean API or CLI (doctl compute ssh-key list). Once a Droplet is created keys can not be added or removed via this provider. Modifying this field will prompt you to destroy and recreate the Droplet.

Required: No

Type: List of String

Update requires: No interruption

Tags

A list of the tags to be applied to this Droplet.

Required: No

Type: List of String

Update requires: No interruption

UserData

Required: No

Type: String

Update requires: No interruption

VolumeIds

Required: No

Type: List of String

Update requires: No interruption

VpcUuid

The ID of the VPC where the Droplet will be located.

Required: No

Type: String

Update requires: No interruption

Return Values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the tfcfnid.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

tfcfnid

Internal identifier for tracking resource changes. Do not use.

CreatedAt

Returns the CreatedAt value.

Disk

Returns the Disk value.

Id

Returns the Id value.

Ipv4Address

Returns the Ipv4Address value.

Ipv4AddressPrivate

Returns the Ipv4AddressPrivate value.

Ipv6Address

Returns the Ipv6Address value.

Locked

Returns the Locked value.

Memory

Returns the Memory value.

PriceHourly

Returns the PriceHourly value.

PriceMonthly

Returns the PriceMonthly value.

Status

Returns the Status value.

Urn

Returns the Urn value.

Vcpus

Returns the Vcpus value.