Pulumi DigitalOcean

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-digitalocean repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-digitalocean repo.

class pulumi_digitalocean.AwaitableGetAccountResult(droplet_limit=None, email=None, email_verified=None, floating_ip_limit=None, status=None, status_message=None, uuid=None, id=None)
class pulumi_digitalocean.AwaitableGetCertificateResult(domains=None, name=None, not_after=None, sha1_fingerprint=None, state=None, type=None, id=None)
class pulumi_digitalocean.AwaitableGetDatabaseClusterResult(database=None, engine=None, host=None, maintenance_windows=None, name=None, node_count=None, password=None, port=None, private_host=None, private_uri=None, region=None, size=None, tags=None, uri=None, urn=None, user=None, version=None, id=None)
class pulumi_digitalocean.AwaitableGetDomainResult(name=None, ttl=None, urn=None, zone_file=None, id=None)
class pulumi_digitalocean.AwaitableGetDropletResult(backups=None, created_at=None, disk=None, image=None, ipv4_address=None, ipv4_address_private=None, ipv6=None, ipv6_address=None, ipv6_address_private=None, locked=None, memory=None, monitoring=None, name=None, price_hourly=None, price_monthly=None, private_networking=None, region=None, size=None, status=None, tag=None, tags=None, urn=None, vcpus=None, volume_ids=None, id=None)
class pulumi_digitalocean.AwaitableGetDropletSnapshotResult(created_at=None, droplet_id=None, min_disk_size=None, most_recent=None, name=None, name_regex=None, region=None, regions=None, size=None, id=None)
class pulumi_digitalocean.AwaitableGetFloatingIpResult(droplet_id=None, ip_address=None, region=None, urn=None, id=None)
class pulumi_digitalocean.AwaitableGetImageResult(distribution=None, image=None, min_disk_size=None, name=None, private=None, regions=None, slug=None, type=None, id=None)
class pulumi_digitalocean.AwaitableGetKubernetesClusterResult(cluster_subnet=None, created_at=None, endpoint=None, ipv4_address=None, kube_configs=None, name=None, node_pools=None, region=None, service_subnet=None, status=None, tags=None, updated_at=None, version=None, id=None)
class pulumi_digitalocean.AwaitableGetLoadBalancerResult(algorithm=None, droplet_ids=None, droplet_tag=None, enable_proxy_protocol=None, forwarding_rules=None, healthcheck=None, ip=None, name=None, redirect_http_to_https=None, region=None, status=None, sticky_sessions=None, urn=None, id=None)
class pulumi_digitalocean.AwaitableGetRecordResult(data=None, domain=None, flags=None, name=None, port=None, priority=None, tag=None, ttl=None, type=None, weight=None, id=None)
class pulumi_digitalocean.AwaitableGetSizesResult(filters=None, sizes=None, sorts=None, id=None)
class pulumi_digitalocean.AwaitableGetSshKeyResult(fingerprint=None, name=None, public_key=None, id=None)
class pulumi_digitalocean.AwaitableGetTagResult(name=None, id=None)
class pulumi_digitalocean.AwaitableGetVolumeResult(description=None, droplet_ids=None, filesystem_label=None, filesystem_type=None, name=None, region=None, size=None, urn=None, id=None)
class pulumi_digitalocean.AwaitableGetVolumeSnapshotResult(created_at=None, min_disk_size=None, most_recent=None, name=None, name_regex=None, region=None, regions=None, size=None, volume_id=None, id=None)
class pulumi_digitalocean.Cdn(resource_name, opts=None, certificate_id=None, custom_domain=None, origin=None, ttl=None, __props__=None, __name__=None, __opts__=None)

Provides a DigitalOcean CDN Endpoint resource for use with Spaces.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • custom_domain (pulumi.Input[str]) – The fully qualified domain name (FQDN) of the custom subdomain used with the CDN Endpoint.

  • origin (pulumi.Input[str]) – The fully qualified domain name, (FQDN) for a Space.

  • ttl (pulumi.Input[float]) – The time to live for the CDN Endpoint, in seconds. Default is 3600 seconds.

* `certificate_id`- (Optional) The ID of a DigitalOcean managed TLS certificate used for SSL when a custom subdomain is provided.
created_at = None

The date and time when the CDN Endpoint was created.

custom_domain = None

The fully qualified domain name (FQDN) of the custom subdomain used with the CDN Endpoint.

endpoint = None

The fully qualified domain name (FQDN) from which the CDN-backed content is served.

origin = None

The fully qualified domain name, (FQDN) for a Space.

ttl = None

The time to live for the CDN Endpoint, in seconds. Default is 3600 seconds.

  • certificate_id- (Optional) The ID of a DigitalOcean managed TLS certificate used for SSL when a custom subdomain is provided.

static get(resource_name, id, opts=None, certificate_id=None, created_at=None, custom_domain=None, endpoint=None, origin=None, ttl=None)

Get an existing Cdn resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • created_at (pulumi.Input[str]) – The date and time when the CDN Endpoint was created.

  • custom_domain (pulumi.Input[str]) – The fully qualified domain name (FQDN) of the custom subdomain used with the CDN Endpoint.

  • endpoint (pulumi.Input[str]) – The fully qualified domain name (FQDN) from which the CDN-backed content is served.

  • origin (pulumi.Input[str]) – The fully qualified domain name, (FQDN) for a Space.

  • ttl (pulumi.Input[float]) – The time to live for the CDN Endpoint, in seconds. Default is 3600 seconds.

* `certificate_id`- (Optional) The ID of a DigitalOcean managed TLS certificate used for SSL when a custom subdomain is provided.
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_digitalocean.Certificate(resource_name, opts=None, certificate_chain=None, domains=None, leaf_certificate=None, name=None, private_key=None, type=None, __props__=None, __name__=None, __opts__=None)

Provides a DigitalOcean Certificate resource that allows you to manage certificates for configuring TLS termination in Load Balancers. Certificates created with this resource can be referenced in your Load Balancer configuration via their ID. The certificate can either be a custom one provided by you or automatically generated one with Let’s Encrypt.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • certificate_chain (pulumi.Input[str]) – The full PEM-formatted trust chain between the certificate authority’s certificate and your domain’s TLS certificate. Only valid when type is custom.

  • domains (pulumi.Input[list]) – List of fully qualified domain names (FQDNs) for which the certificate will be issued. The domains must be managed using DigitalOcean’s DNS. Only valid when type is lets_encrypt.

  • leaf_certificate (pulumi.Input[str]) – The contents of a PEM-formatted public TLS certificate. Only valid when type is custom.

  • name (pulumi.Input[str]) – The name of the certificate for identification.

  • private_key (pulumi.Input[str]) – The contents of a PEM-formatted private-key corresponding to the SSL certificate. Only valid when type is custom.

  • type (pulumi.Input[str]) – The type of certificate to provision. Can be either custom or lets_encrypt. Defaults to custom.

certificate_chain = None

The full PEM-formatted trust chain between the certificate authority’s certificate and your domain’s TLS certificate. Only valid when type is custom.

domains = None

List of fully qualified domain names (FQDNs) for which the certificate will be issued. The domains must be managed using DigitalOcean’s DNS. Only valid when type is lets_encrypt.

leaf_certificate = None

The contents of a PEM-formatted public TLS certificate. Only valid when type is custom.

name = None

The name of the certificate for identification.

not_after = None

The expiration date of the certificate

private_key = None

The contents of a PEM-formatted private-key corresponding to the SSL certificate. Only valid when type is custom.

sha1_fingerprint = None

The SHA-1 fingerprint of the certificate

type = None

The type of certificate to provision. Can be either custom or lets_encrypt. Defaults to custom.

static get(resource_name, id, opts=None, certificate_chain=None, domains=None, leaf_certificate=None, name=None, not_after=None, private_key=None, sha1_fingerprint=None, state=None, type=None)

Get an existing Certificate resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • certificate_chain (pulumi.Input[str]) – The full PEM-formatted trust chain between the certificate authority’s certificate and your domain’s TLS certificate. Only valid when type is custom.

  • domains (pulumi.Input[list]) – List of fully qualified domain names (FQDNs) for which the certificate will be issued. The domains must be managed using DigitalOcean’s DNS. Only valid when type is lets_encrypt.

  • leaf_certificate (pulumi.Input[str]) – The contents of a PEM-formatted public TLS certificate. Only valid when type is custom.

  • name (pulumi.Input[str]) – The name of the certificate for identification.

  • not_after (pulumi.Input[str]) – The expiration date of the certificate

  • private_key (pulumi.Input[str]) – The contents of a PEM-formatted private-key corresponding to the SSL certificate. Only valid when type is custom.

  • sha1_fingerprint (pulumi.Input[str]) – The SHA-1 fingerprint of the certificate

  • type (pulumi.Input[str]) – The type of certificate to provision. Can be either custom or lets_encrypt. Defaults to custom.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_digitalocean.DatabaseCluster(resource_name, opts=None, engine=None, maintenance_windows=None, name=None, node_count=None, region=None, size=None, tags=None, version=None, __props__=None, __name__=None, __opts__=None)

Provides a DigitalOcean database cluster resource.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • engine (pulumi.Input[str]) – Database engine used by the cluster (ex. pg for PostreSQL, mysql for MySQL, or redis for Redis).

  • maintenance_windows (pulumi.Input[list]) – Defines when the automatic maintenance should be performed for the database cluster.

  • name (pulumi.Input[str]) – The name of the database cluster.

  • node_count (pulumi.Input[float]) – Number of nodes that will be included in the cluster.

  • region (pulumi.Input[str]) – DigitalOcean region where the cluster will reside.

  • size (pulumi.Input[str]) – Database droplet size associated with the cluster (ex. db-s-1vcpu-1gb).

  • tags (pulumi.Input[list]) – A list of tag names to be applied to the database cluster.

  • version (pulumi.Input[str]) – Engine version used by the cluster (ex. 11 for PostgreSQL 11).

The maintenance_windows object supports the following:

  • day (pulumi.Input[str]) - The day of the week on which to apply maintenance updates.

  • hour (pulumi.Input[str]) - The hour in UTC at which maintenance updates will be applied in 24 hour format.

database = None

Name of the cluster’s default database.

engine = None

Database engine used by the cluster (ex. pg for PostreSQL, mysql for MySQL, or redis for Redis).

host = None

Database cluster’s hostname.

maintenance_windows = None

Defines when the automatic maintenance should be performed for the database cluster.

  • day (str) - The day of the week on which to apply maintenance updates.

  • hour (str) - The hour in UTC at which maintenance updates will be applied in 24 hour format.

name = None

The name of the database cluster.

node_count = None

Number of nodes that will be included in the cluster.

password = None

Password for the cluster’s default user.

port = None

Network port that the database cluster is listening on.

private_host = None

Same as host, but only accessible from resources within the account and in the same region.

private_uri = None

Same as uri, but only accessible from resources within the account and in the same region.

region = None

DigitalOcean region where the cluster will reside.

size = None

Database droplet size associated with the cluster (ex. db-s-1vcpu-1gb).

tags = None

A list of tag names to be applied to the database cluster.

uri = None

The full URI for connecting to the database cluster.

urn = None

The uniform resource name of the database cluster.

user = None

Username for the cluster’s default user.

version = None

Engine version used by the cluster (ex. 11 for PostgreSQL 11).

static get(resource_name, id, opts=None, database=None, engine=None, host=None, maintenance_windows=None, name=None, node_count=None, password=None, port=None, private_host=None, private_uri=None, region=None, size=None, tags=None, uri=None, urn=None, user=None, version=None)

Get an existing DatabaseCluster resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • database (pulumi.Input[str]) – Name of the cluster’s default database.

  • engine (pulumi.Input[str]) – Database engine used by the cluster (ex. pg for PostreSQL, mysql for MySQL, or redis for Redis).

  • host (pulumi.Input[str]) – Database cluster’s hostname.

  • maintenance_windows (pulumi.Input[list]) – Defines when the automatic maintenance should be performed for the database cluster.

  • name (pulumi.Input[str]) – The name of the database cluster.

  • node_count (pulumi.Input[float]) – Number of nodes that will be included in the cluster.

  • password (pulumi.Input[str]) – Password for the cluster’s default user.

  • port (pulumi.Input[float]) – Network port that the database cluster is listening on.

  • private_host (pulumi.Input[str]) – Same as host, but only accessible from resources within the account and in the same region.

  • private_uri (pulumi.Input[str]) – Same as uri, but only accessible from resources within the account and in the same region.

  • region (pulumi.Input[str]) – DigitalOcean region where the cluster will reside.

  • size (pulumi.Input[str]) – Database droplet size associated with the cluster (ex. db-s-1vcpu-1gb).

  • tags (pulumi.Input[list]) – A list of tag names to be applied to the database cluster.

  • uri (pulumi.Input[str]) – The full URI for connecting to the database cluster.

  • urn (pulumi.Input[str]) – The uniform resource name of the database cluster.

  • user (pulumi.Input[str]) – Username for the cluster’s default user.

  • version (pulumi.Input[str]) – Engine version used by the cluster (ex. 11 for PostgreSQL 11).

The maintenance_windows object supports the following:

  • day (pulumi.Input[str]) - The day of the week on which to apply maintenance updates.

  • hour (pulumi.Input[str]) - The hour in UTC at which maintenance updates will be applied in 24 hour format.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_digitalocean.DatabaseConnectionPool(resource_name, opts=None, cluster_id=None, db_name=None, mode=None, name=None, size=None, user=None, __props__=None, __name__=None, __opts__=None)

Provides a DigitalOcean database connection pool resource.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cluster_id (pulumi.Input[str]) – The ID of the source database cluster. Note: This must be a PostgreSQL cluster.

  • db_name (pulumi.Input[str]) – The database for use with the connection pool.

  • mode (pulumi.Input[str]) – The PGBouncer transaction mode for the connection pool. The allowed values are session, transaction, and statement.

  • name (pulumi.Input[str]) – The name for the database connection pool.

  • size (pulumi.Input[float]) – The desired size of the PGBouncer connection pool.

  • user (pulumi.Input[str]) – The name of the database user for use with the connection pool.

cluster_id = None

The ID of the source database cluster. Note: This must be a PostgreSQL cluster.

db_name = None

The database for use with the connection pool.

host = None

The hostname used to connect to the database connection pool.

mode = None

The PGBouncer transaction mode for the connection pool. The allowed values are session, transaction, and statement.

name = None

The name for the database connection pool.

password = None

Password for the connection pool’s user.

port = None

Network port that the database connection pool is listening on.

private_host = None

Same as host, but only accessible from resources within the account and in the same region.

private_uri = None

Same as uri, but only accessible from resources within the account and in the same region.

size = None

The desired size of the PGBouncer connection pool.

uri = None

The full URI for connecting to the database connection pool.

user = None

The name of the database user for use with the connection pool.

static get(resource_name, id, opts=None, cluster_id=None, db_name=None, host=None, mode=None, name=None, password=None, port=None, private_host=None, private_uri=None, size=None, uri=None, user=None)

Get an existing DatabaseConnectionPool resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cluster_id (pulumi.Input[str]) – The ID of the source database cluster. Note: This must be a PostgreSQL cluster.

  • db_name (pulumi.Input[str]) – The database for use with the connection pool.

  • host (pulumi.Input[str]) – The hostname used to connect to the database connection pool.

  • mode (pulumi.Input[str]) – The PGBouncer transaction mode for the connection pool. The allowed values are session, transaction, and statement.

  • name (pulumi.Input[str]) – The name for the database connection pool.

  • password (pulumi.Input[str]) – Password for the connection pool’s user.

  • port (pulumi.Input[float]) – Network port that the database connection pool is listening on.

  • private_host (pulumi.Input[str]) – Same as host, but only accessible from resources within the account and in the same region.

  • private_uri (pulumi.Input[str]) – Same as uri, but only accessible from resources within the account and in the same region.

  • size (pulumi.Input[float]) – The desired size of the PGBouncer connection pool.

  • uri (pulumi.Input[str]) – The full URI for connecting to the database connection pool.

  • user (pulumi.Input[str]) – The name of the database user for use with the connection pool.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_digitalocean.DatabaseDb(resource_name, opts=None, cluster_id=None, name=None, __props__=None, __name__=None, __opts__=None)

Provides a DigitalOcean database resource. When creating a new database cluster, a default database with name defaultdb will be created. Then, this resource can be used to provide additional database inside the cluster.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cluster_id (pulumi.Input[str]) – The ID of the original source database cluster.

  • name (pulumi.Input[str]) – The name for the database.

cluster_id = None

The ID of the original source database cluster.

name = None

The name for the database.

static get(resource_name, id, opts=None, cluster_id=None, name=None)

Get an existing DatabaseDb resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cluster_id (pulumi.Input[str]) – The ID of the original source database cluster.

  • name (pulumi.Input[str]) – The name for the database.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_digitalocean.DatabaseReplica(resource_name, opts=None, cluster_id=None, name=None, region=None, size=None, tags=None, __props__=None, __name__=None, __opts__=None)

Provides a DigitalOcean database replica resource.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cluster_id (pulumi.Input[str]) – The ID of the original source database cluster.

  • name (pulumi.Input[str]) – The name for the database replica.

  • region (pulumi.Input[str]) – DigitalOcean region where the replica will reside.

  • size (pulumi.Input[str]) – Database Droplet size associated with the replica (ex. db-s-1vcpu-1gb).

cluster_id = None

The ID of the original source database cluster.

database = None

Name of the replica’s default database.

host = None

Database replica’s hostname.

name = None

The name for the database replica.

password = None

Password for the replica’s default user.

port = None

Network port that the database replica is listening on.

private_host = None

Same as host, but only accessible from resources within the account and in the same region.

private_uri = None

Same as uri, but only accessible from resources within the account and in the same region.

region = None

DigitalOcean region where the replica will reside.

size = None

Database Droplet size associated with the replica (ex. db-s-1vcpu-1gb).

uri = None

The full URI for connecting to the database replica.

user = None

Username for the replica’s default user.

static get(resource_name, id, opts=None, cluster_id=None, database=None, host=None, name=None, password=None, port=None, private_host=None, private_uri=None, region=None, size=None, tags=None, uri=None, user=None)

Get an existing DatabaseReplica resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cluster_id (pulumi.Input[str]) – The ID of the original source database cluster.

  • database (pulumi.Input[str]) – Name of the replica’s default database.

  • host (pulumi.Input[str]) – Database replica’s hostname.

  • name (pulumi.Input[str]) – The name for the database replica.

  • password (pulumi.Input[str]) – Password for the replica’s default user.

  • port (pulumi.Input[float]) – Network port that the database replica is listening on.

  • private_host (pulumi.Input[str]) – Same as host, but only accessible from resources within the account and in the same region.

  • private_uri (pulumi.Input[str]) – Same as uri, but only accessible from resources within the account and in the same region.

  • region (pulumi.Input[str]) – DigitalOcean region where the replica will reside.

  • size (pulumi.Input[str]) – Database Droplet size associated with the replica (ex. db-s-1vcpu-1gb).

  • uri (pulumi.Input[str]) – The full URI for connecting to the database replica.

  • user (pulumi.Input[str]) – Username for the replica’s default user.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_digitalocean.DatabaseUser(resource_name, opts=None, cluster_id=None, name=None, __props__=None, __name__=None, __opts__=None)

Provides a DigitalOcean database user resource. When creating a new database cluster, a default admin user with name doadmin will be created. Then, this resource can be used to provide additional normal users inside the cluster.

NOTE: Any new users created will always have normal role, only the default user that comes with database cluster creation has primary role. Additional permissions must be managed manually.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cluster_id (pulumi.Input[str]) – The ID of the original source database cluster.

  • name (pulumi.Input[str]) – The name for the database user.

cluster_id = None

The ID of the original source database cluster.

name = None

The name for the database user.

password = None

Password for the database user.

role = None

Role for the database user. The value will be either “primary” or “normal”.

static get(resource_name, id, opts=None, cluster_id=None, name=None, password=None, role=None)

Get an existing DatabaseUser resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cluster_id (pulumi.Input[str]) – The ID of the original source database cluster.

  • name (pulumi.Input[str]) – The name for the database user.

  • password (pulumi.Input[str]) – Password for the database user.

  • role (pulumi.Input[str]) – Role for the database user. The value will be either “primary” or “normal”.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_digitalocean.DnsRecord(resource_name, opts=None, domain=None, flags=None, name=None, port=None, priority=None, tag=None, ttl=None, type=None, value=None, weight=None, __props__=None, __name__=None, __opts__=None)

Provides a DigitalOcean DNS record resource.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • domain (pulumi.Input[str]) – The domain to add the record to.

  • flags (pulumi.Input[float]) – The flags of the record. Only valid when type is CAA. Must be between 0 and 255.

  • name (pulumi.Input[str]) – The name of the record.

  • port (pulumi.Input[float]) – The port of the record. Only valid when type is SRV. Must be between 1 and 65535.

  • priority (pulumi.Input[float]) – The priority of the record. Only valid when type is MX or SRV. Must be between 0 and 65535.

  • tag (pulumi.Input[str]) – The tag of the record. Only valid when type is CAA. Must be one of issue, issuewild, or iodef.

  • ttl (pulumi.Input[float]) – The time to live for the record, in seconds. Must be at least 0.

  • type (pulumi.Input[str]) – The type of record. Must be one of A, AAAA, CAA, CNAME, MX, NS, TXT, or SRV.

  • value (pulumi.Input[str]) – The value of the record.

  • weight (pulumi.Input[float]) – The weight of the record. Only valid when type is SRV. Must be between 0 and 65535.

domain = None

The domain to add the record to.

flags = None

The flags of the record. Only valid when type is CAA. Must be between 0 and 255.

fqdn = None

The FQDN of the record

name = None

The name of the record.

port = None

The port of the record. Only valid when type is SRV. Must be between 1 and 65535.

priority = None

The priority of the record. Only valid when type is MX or SRV. Must be between 0 and 65535.

tag = None

The tag of the record. Only valid when type is CAA. Must be one of issue, issuewild, or iodef.

ttl = None

The time to live for the record, in seconds. Must be at least 0.

type = None

The type of record. Must be one of A, AAAA, CAA, CNAME, MX, NS, TXT, or SRV.

value = None

The value of the record.

weight = None

The weight of the record. Only valid when type is SRV. Must be between 0 and 65535.

static get(resource_name, id, opts=None, domain=None, flags=None, fqdn=None, name=None, port=None, priority=None, tag=None, ttl=None, type=None, value=None, weight=None)

Get an existing DnsRecord resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • domain (pulumi.Input[str]) – The domain to add the record to.

  • flags (pulumi.Input[float]) – The flags of the record. Only valid when type is CAA. Must be between 0 and 255.

  • fqdn (pulumi.Input[str]) – The FQDN of the record

  • name (pulumi.Input[str]) – The name of the record.

  • port (pulumi.Input[float]) – The port of the record. Only valid when type is SRV. Must be between 1 and 65535.

  • priority (pulumi.Input[float]) – The priority of the record. Only valid when type is MX or SRV. Must be between 0 and 65535.

  • tag (pulumi.Input[str]) – The tag of the record. Only valid when type is CAA. Must be one of issue, issuewild, or iodef.

  • ttl (pulumi.Input[float]) – The time to live for the record, in seconds. Must be at least 0.

  • type (pulumi.Input[str]) – The type of record. Must be one of A, AAAA, CAA, CNAME, MX, NS, TXT, or SRV.

  • value (pulumi.Input[str]) – The value of the record.

  • weight (pulumi.Input[float]) – The weight of the record. Only valid when type is SRV. Must be between 0 and 65535.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_digitalocean.Domain(resource_name, opts=None, ip_address=None, name=None, __props__=None, __name__=None, __opts__=None)

Provides a DigitalOcean domain resource.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • ip_address (pulumi.Input[str]) – The IP address of the domain. If specified, this IP is used to created an initial A record for the domain.

  • name (pulumi.Input[str]) – The name of the domain

ip_address = None

The IP address of the domain. If specified, this IP is used to created an initial A record for the domain.

name = None

The name of the domain

urn = None

The uniform resource name of the domain

static get(resource_name, id, opts=None, ip_address=None, name=None, urn=None)

Get an existing Domain resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • ip_address (pulumi.Input[str]) – The IP address of the domain. If specified, this IP is used to created an initial A record for the domain.

  • name (pulumi.Input[str]) – The name of the domain

  • urn (pulumi.Input[str]) – The uniform resource name of the domain

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_digitalocean.Droplet(resource_name, opts=None, backups=None, image=None, ipv6=None, monitoring=None, name=None, private_networking=None, region=None, resize_disk=None, size=None, ssh_keys=None, tags=None, user_data=None, volume_ids=None, __props__=None, __name__=None, __opts__=None)

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

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • backups (pulumi.Input[bool]) – Boolean controlling if backups are made. Defaults to false.

  • image (pulumi.Input[str]) – The Droplet image ID or slug.

  • ipv6 (pulumi.Input[bool]) – Boolean controlling if IPv6 is enabled. Defaults to false.

  • monitoring (pulumi.Input[bool]) – Boolean controlling whether monitoring agent is installed. Defaults to false.

  • name (pulumi.Input[str]) – The Droplet name.

  • private_networking (pulumi.Input[bool]) – Boolean controlling if private networks are enabled. Defaults to false.

  • region (pulumi.Input[str]) – The region to start in.

  • resize_disk (pulumi.Input[bool]) – 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.

  • size (pulumi.Input[str]) – The unique slug that indentifies the type of Droplet. You can find a list of available slugs on DigitalOcean API documentation.

  • ssh_keys (pulumi.Input[list]) – A list of SSH IDs or fingerprints to enable in the format [12345, 123456]. To retrieve this info, use a tool such as curl with the DigitalOcean API, to retrieve them.

  • tags (pulumi.Input[list]) – A list of the tags to be applied to this Droplet.

  • user_data (pulumi.Input[str]) – A string of the desired User Data for the Droplet.

  • volume_ids (pulumi.Input[list]) – A list of the IDs of each block storage volume to be attached to the Droplet.

backups = None

Boolean controlling if backups are made. Defaults to false.

disk = None

The size of the instance’s disk in GB

image = None

The Droplet image ID or slug.

ipv4_address = None

The IPv4 address

ipv4_address_private = None

The private networking IPv4 address

ipv6 = None

Boolean controlling if IPv6 is enabled. Defaults to false.

ipv6_address = None

The IPv6 address

locked = None

Is the Droplet locked

monitoring = None

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

name = None

The Droplet name.

price_hourly = None

Droplet hourly price

price_monthly = None

Droplet monthly price

private_networking = None

Boolean controlling if private networks are enabled. Defaults to false.

region = None

The region to start in.

resize_disk = None

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.

size = None

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

ssh_keys = None

A list of SSH IDs or fingerprints to enable in the format [12345, 123456]. To retrieve this info, use a tool such as curl with the DigitalOcean API, to retrieve them.

status = None

The status of the Droplet

tags = None

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

urn = None

The uniform resource name of the Droplet

  • name- The name of the Droplet

user_data = None

A string of the desired User Data for the Droplet.

vcpus = None

The number of the instance’s virtual CPUs

volume_ids = None

A list of the IDs of each block storage volume to be attached to the Droplet.

static get(resource_name, id, opts=None, backups=None, created_at=None, disk=None, image=None, ipv4_address=None, ipv4_address_private=None, ipv6=None, ipv6_address=None, locked=None, memory=None, monitoring=None, name=None, price_hourly=None, price_monthly=None, private_networking=None, region=None, resize_disk=None, size=None, ssh_keys=None, status=None, tags=None, urn=None, user_data=None, vcpus=None, volume_ids=None)

Get an existing Droplet resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • backups (pulumi.Input[bool]) – Boolean controlling if backups are made. Defaults to false.

  • disk (pulumi.Input[float]) – The size of the instance’s disk in GB

  • image (pulumi.Input[str]) – The Droplet image ID or slug.

  • ipv4_address (pulumi.Input[str]) – The IPv4 address

  • ipv4_address_private (pulumi.Input[str]) – The private networking IPv4 address

  • ipv6 (pulumi.Input[bool]) – Boolean controlling if IPv6 is enabled. Defaults to false.

  • ipv6_address (pulumi.Input[str]) – The IPv6 address

  • locked (pulumi.Input[bool]) – Is the Droplet locked

  • monitoring (pulumi.Input[bool]) – Boolean controlling whether monitoring agent is installed. Defaults to false.

  • name (pulumi.Input[str]) – The Droplet name.

  • price_hourly (pulumi.Input[float]) – Droplet hourly price

  • price_monthly (pulumi.Input[float]) – Droplet monthly price

  • private_networking (pulumi.Input[bool]) – Boolean controlling if private networks are enabled. Defaults to false.

  • region (pulumi.Input[str]) – The region to start in.

  • resize_disk (pulumi.Input[bool]) – 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.

  • size (pulumi.Input[str]) –

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

  • ssh_keys (pulumi.Input[list]) –

    A list of SSH IDs or fingerprints to enable in the format [12345, 123456]. To retrieve this info, use a tool such as curl with the DigitalOcean API, to retrieve them.

  • status (pulumi.Input[str]) – The status of the Droplet

  • tags (pulumi.Input[list]) – A list of the tags to be applied to this Droplet.

  • urn (pulumi.Input[str]) – The uniform resource name of the Droplet

* `name`- The name of the Droplet
Parameters
  • user_data (pulumi.Input[str]) – A string of the desired User Data for the Droplet.

  • vcpus (pulumi.Input[float]) – The number of the instance’s virtual CPUs

  • volume_ids (pulumi.Input[list]) –

    A list of the IDs of each block storage volume to be attached to the Droplet.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_digitalocean.DropletSnapshot(resource_name, opts=None, droplet_id=None, name=None, __props__=None, __name__=None, __opts__=None)

Provides a resource which can be used to create a snapshot from an existing DigitalOcean Droplet.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • droplet_id (pulumi.Input[str]) – The ID of the Droplet from which the snapshot will be taken.

  • name (pulumi.Input[str]) – A name for the Droplet snapshot.

created_at = None

The date and time the Droplet snapshot was created.

droplet_id = None

The ID of the Droplet from which the snapshot will be taken.

min_disk_size = None

The minimum size in gigabytes required for a Droplet to be created based on this snapshot.

name = None

A name for the Droplet snapshot.

regions = None

A list of DigitalOcean region “slugs” indicating where the droplet snapshot is available.

size = None

The billable size of the Droplet snapshot in gigabytes.

static get(resource_name, id, opts=None, created_at=None, droplet_id=None, min_disk_size=None, name=None, regions=None, size=None)

Get an existing DropletSnapshot resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • created_at (pulumi.Input[str]) – The date and time the Droplet snapshot was created.

  • droplet_id (pulumi.Input[str]) – The ID of the Droplet from which the snapshot will be taken.

  • min_disk_size (pulumi.Input[float]) – The minimum size in gigabytes required for a Droplet to be created based on this snapshot.

  • name (pulumi.Input[str]) – A name for the Droplet snapshot.

  • regions (pulumi.Input[list]) – A list of DigitalOcean region “slugs” indicating where the droplet snapshot is available.

  • size (pulumi.Input[float]) – The billable size of the Droplet snapshot in gigabytes.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_digitalocean.Firewall(resource_name, opts=None, droplet_ids=None, inbound_rules=None, name=None, outbound_rules=None, tags=None, __props__=None, __name__=None, __opts__=None)

Provides a DigitalOcean Cloud Firewall resource. This can be used to create, modify, and delete Firewalls.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • droplet_ids (pulumi.Input[list]) – The list of the IDs of the Droplets assigned to the Firewall.

  • inbound_rules (pulumi.Input[list]) – The inbound access rule block for the Firewall. The inbound_rule block is documented below.

  • name (pulumi.Input[str]) – The Firewall name

  • outbound_rules (pulumi.Input[list]) – The outbound access rule block for the Firewall. The outbound_rule block is documented below.

  • tags (pulumi.Input[list]) – The names of the Tags assigned to the Firewall.

The inbound_rules object supports the following:

  • portRange (pulumi.Input[str]) - The ports on which traffic will be allowed specified as a string containing a single port, a range (e.g. “8000-9000”), or “1-65535” to open all ports for a protocol. Required for when protocol is tcp or udp.

  • protocol (pulumi.Input[str]) - The type of traffic to be allowed. This may be one of “tcp”, “udp”, or “icmp”.

  • sourceAddresses (pulumi.Input[list]) - An array of strings containing the IPv4 addresses, IPv6 addresses, IPv4 CIDRs, and/or IPv6 CIDRs from which the inbound traffic will be accepted.

  • sourceDropletIds (pulumi.Input[list]) - An array containing the IDs of the Droplets from which the inbound traffic will be accepted.

  • sourceLoadBalancerUids (pulumi.Input[list]) - An array containing the IDs of the Load Balancers from which the inbound traffic will be accepted.

  • sourceTags (pulumi.Input[list]) - An array containing the names of Tags corresponding to groups of Droplets from which the inbound traffic will be accepted.

The outbound_rules object supports the following:

  • destinationAddresses (pulumi.Input[list]) - An array of strings containing the IPv4 addresses, IPv6 addresses, IPv4 CIDRs, and/or IPv6 CIDRs to which the outbound traffic will be allowed.

  • destinationDropletIds (pulumi.Input[list]) - An array containing the IDs of the Droplets to which the outbound traffic will be allowed.

  • destinationLoadBalancerUids (pulumi.Input[list]) - An array containing the IDs of the Load Balancers to which the outbound traffic will be allowed.

  • destinationTags (pulumi.Input[list]) - An array containing the names of Tags corresponding to groups of Droplets to which the outbound traffic will be allowed. traffic.

  • portRange (pulumi.Input[str]) - The ports on which traffic will be allowed specified as a string containing a single port, a range (e.g. “8000-9000”), or “1-65535” to open all ports for a protocol. Required for when protocol is tcp or udp.

  • protocol (pulumi.Input[str]) - The type of traffic to be allowed. This may be one of “tcp”, “udp”, or “icmp”.

created_at = None

A time value given in ISO8601 combined date and time format that represents when the Firewall was created.

droplet_ids = None

The list of the IDs of the Droplets assigned to the Firewall.

inbound_rules = None

The inbound access rule block for the Firewall. The inbound_rule block is documented below.

  • portRange (str) - The ports on which traffic will be allowed specified as a string containing a single port, a range (e.g. “8000-9000”), or “1-65535” to open all ports for a protocol. Required for when protocol is tcp or udp.

  • protocol (str) - The type of traffic to be allowed. This may be one of “tcp”, “udp”, or “icmp”.

  • sourceAddresses (list) - An array of strings containing the IPv4 addresses, IPv6 addresses, IPv4 CIDRs, and/or IPv6 CIDRs from which the inbound traffic will be accepted.

  • sourceDropletIds (list) - An array containing the IDs of the Droplets from which the inbound traffic will be accepted.

  • sourceLoadBalancerUids (list) - An array containing the IDs of the Load Balancers from which the inbound traffic will be accepted.

  • sourceTags (list) - An array containing the names of Tags corresponding to groups of Droplets from which the inbound traffic will be accepted.

name = None

The Firewall name

outbound_rules = None

The outbound access rule block for the Firewall. The outbound_rule block is documented below.

  • destinationAddresses (list) - An array of strings containing the IPv4 addresses, IPv6 addresses, IPv4 CIDRs, and/or IPv6 CIDRs to which the outbound traffic will be allowed.

  • destinationDropletIds (list) - An array containing the IDs of the Droplets to which the outbound traffic will be allowed.

  • destinationLoadBalancerUids (list) - An array containing the IDs of the Load Balancers to which the outbound traffic will be allowed.

  • destinationTags (list) - An array containing the names of Tags corresponding to groups of Droplets to which the outbound traffic will be allowed. traffic.

  • portRange (str) - The ports on which traffic will be allowed specified as a string containing a single port, a range (e.g. “8000-9000”), or “1-65535” to open all ports for a protocol. Required for when protocol is tcp or udp.

  • protocol (str) - The type of traffic to be allowed. This may be one of “tcp”, “udp”, or “icmp”.

pending_changes = None

An list of object containing the fields, “droplet_id”, “removing”, and “status”. It is provided to detail exactly which Droplets are having their security policies updated. When empty, all changes have been successfully applied.

  • droplet_id (float)

  • removing (bool)

  • status (str) - A status string indicating the current state of the Firewall. This can be “waiting”, “succeeded”, or “failed”.

status = None

A status string indicating the current state of the Firewall. This can be “waiting”, “succeeded”, or “failed”.

tags = None

The names of the Tags assigned to the Firewall.

static get(resource_name, id, opts=None, created_at=None, droplet_ids=None, inbound_rules=None, name=None, outbound_rules=None, pending_changes=None, status=None, tags=None)

Get an existing Firewall resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • created_at (pulumi.Input[str]) – A time value given in ISO8601 combined date and time format that represents when the Firewall was created.

  • droplet_ids (pulumi.Input[list]) – The list of the IDs of the Droplets assigned to the Firewall.

  • inbound_rules (pulumi.Input[list]) – The inbound access rule block for the Firewall. The inbound_rule block is documented below.

  • name (pulumi.Input[str]) – The Firewall name

  • outbound_rules (pulumi.Input[list]) – The outbound access rule block for the Firewall. The outbound_rule block is documented below.

  • pending_changes (pulumi.Input[list]) – An list of object containing the fields, “droplet_id”, “removing”, and “status”. It is provided to detail exactly which Droplets are having their security policies updated. When empty, all changes have been successfully applied.

  • status (pulumi.Input[str]) – A status string indicating the current state of the Firewall. This can be “waiting”, “succeeded”, or “failed”.

  • tags (pulumi.Input[list]) – The names of the Tags assigned to the Firewall.

The inbound_rules object supports the following:

  • portRange (pulumi.Input[str]) - The ports on which traffic will be allowed specified as a string containing a single port, a range (e.g. “8000-9000”), or “1-65535” to open all ports for a protocol. Required for when protocol is tcp or udp.

  • protocol (pulumi.Input[str]) - The type of traffic to be allowed. This may be one of “tcp”, “udp”, or “icmp”.

  • sourceAddresses (pulumi.Input[list]) - An array of strings containing the IPv4 addresses, IPv6 addresses, IPv4 CIDRs, and/or IPv6 CIDRs from which the inbound traffic will be accepted.

  • sourceDropletIds (pulumi.Input[list]) - An array containing the IDs of the Droplets from which the inbound traffic will be accepted.

  • sourceLoadBalancerUids (pulumi.Input[list]) - An array containing the IDs of the Load Balancers from which the inbound traffic will be accepted.

  • sourceTags (pulumi.Input[list]) - An array containing the names of Tags corresponding to groups of Droplets from which the inbound traffic will be accepted.

The outbound_rules object supports the following:

  • destinationAddresses (pulumi.Input[list]) - An array of strings containing the IPv4 addresses, IPv6 addresses, IPv4 CIDRs, and/or IPv6 CIDRs to which the outbound traffic will be allowed.

  • destinationDropletIds (pulumi.Input[list]) - An array containing the IDs of the Droplets to which the outbound traffic will be allowed.

  • destinationLoadBalancerUids (pulumi.Input[list]) - An array containing the IDs of the Load Balancers to which the outbound traffic will be allowed.

  • destinationTags (pulumi.Input[list]) - An array containing the names of Tags corresponding to groups of Droplets to which the outbound traffic will be allowed. traffic.

  • portRange (pulumi.Input[str]) - The ports on which traffic will be allowed specified as a string containing a single port, a range (e.g. “8000-9000”), or “1-65535” to open all ports for a protocol. Required for when protocol is tcp or udp.

  • protocol (pulumi.Input[str]) - The type of traffic to be allowed. This may be one of “tcp”, “udp”, or “icmp”.

The pending_changes object supports the following:

  • droplet_id (pulumi.Input[float])

  • removing (pulumi.Input[bool])

  • status (pulumi.Input[str]) - A status string indicating the current state of the Firewall. This can be “waiting”, “succeeded”, or “failed”.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_digitalocean.FloatingIp(resource_name, opts=None, droplet_id=None, ip_address=None, region=None, __props__=None, __name__=None, __opts__=None)

Provides a DigitalOcean Floating IP to represent a publicly-accessible static IP addresses that can be mapped to one of your Droplets.

NOTE: Floating IPs can be assigned to a Droplet either directly on the .FloatingIp resource by setting a droplet_id or using the .FloatingIpAssignment resource, but the two cannot be used together.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • droplet_id (pulumi.Input[float]) – The ID of Droplet that the Floating IP will be assigned to.

  • ip_address (pulumi.Input[str]) – The IP Address of the resource

  • region (pulumi.Input[str]) – The region that the Floating IP is reserved to.

droplet_id = None

The ID of Droplet that the Floating IP will be assigned to.

ip_address = None

The IP Address of the resource

region = None

The region that the Floating IP is reserved to.

urn = None

The uniform resource name of the floating ip

static get(resource_name, id, opts=None, droplet_id=None, ip_address=None, region=None, urn=None)

Get an existing FloatingIp resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • droplet_id (pulumi.Input[float]) – The ID of Droplet that the Floating IP will be assigned to.

  • ip_address (pulumi.Input[str]) – The IP Address of the resource

  • region (pulumi.Input[str]) – The region that the Floating IP is reserved to.

  • urn (pulumi.Input[str]) – The uniform resource name of the floating ip

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_digitalocean.FloatingIpAssignment(resource_name, opts=None, droplet_id=None, ip_address=None, __props__=None, __name__=None, __opts__=None)

Provides a resource for assigning an existing DigitalOcean Floating IP to a Droplet. This makes it easy to provision floating IP addresses that are not tied to the lifecycle of your Droplet.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • droplet_id (pulumi.Input[float]) – The ID of Droplet that the Floating IP will be assigned to.

  • ip_address (pulumi.Input[str]) – The Floating IP to assign to the Droplet.

droplet_id = None

The ID of Droplet that the Floating IP will be assigned to.

ip_address = None

The Floating IP to assign to the Droplet.

static get(resource_name, id, opts=None, droplet_id=None, ip_address=None)

Get an existing FloatingIpAssignment resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • droplet_id (pulumi.Input[float]) – The ID of Droplet that the Floating IP will be assigned to.

  • ip_address (pulumi.Input[str]) – The Floating IP to assign to the Droplet.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_digitalocean.GetAccountResult(droplet_limit=None, email=None, email_verified=None, floating_ip_limit=None, status=None, status_message=None, uuid=None, id=None)

A collection of values returned by getAccount.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_digitalocean.GetCertificateResult(domains=None, name=None, not_after=None, sha1_fingerprint=None, state=None, type=None, id=None)

A collection of values returned by getCertificate.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_digitalocean.GetDatabaseClusterResult(database=None, engine=None, host=None, maintenance_windows=None, name=None, node_count=None, password=None, port=None, private_host=None, private_uri=None, region=None, size=None, tags=None, uri=None, urn=None, user=None, version=None, id=None)

A collection of values returned by getDatabaseCluster.

database = None

Name of the cluster’s default database.

engine = None

Database engine used by the cluster (ex. pg for PostreSQL).

host = None

Database cluster’s hostname.

maintenance_windows = None

Defines when the automatic maintenance should be performed for the database cluster.

node_count = None

Number of nodes that will be included in the cluster.

password = None

Password for the cluster’s default user.

port = None

Network port that the database cluster is listening on.

private_host = None

Same as host, but only accessible from resources within the account and in the same region.

private_uri = None

Same as uri, but only accessible from resources within the account and in the same region.

region = None

DigitalOcean region where the cluster will reside.

size = None

Database droplet size associated with the cluster (ex. db-s-1vcpu-1gb).

uri = None

The full URI for connecting to the database cluster.

urn = None

The uniform resource name of the database cluster.

user = None

Username for the cluster’s default user.

version = None

Engine version used by the cluster (ex. 11 for PostgreSQL 11).

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_digitalocean.GetDomainResult(name=None, ttl=None, urn=None, zone_file=None, id=None)

A collection of values returned by getDomain.

urn = None

The uniform resource name of the domain

  • zone_file: The zone file of the domain.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_digitalocean.GetDropletResult(backups=None, created_at=None, disk=None, image=None, ipv4_address=None, ipv4_address_private=None, ipv6=None, ipv6_address=None, ipv6_address_private=None, locked=None, memory=None, monitoring=None, name=None, price_hourly=None, price_monthly=None, private_networking=None, region=None, size=None, status=None, tag=None, tags=None, urn=None, vcpus=None, volume_ids=None, id=None)

A collection of values returned by getDroplet.

backups = None

Whether backups are enabled.

disk = None

The size of the Droplets disk in GB.

image = None

The Droplet image ID or slug.

ipv4_address = None

The Droplets public IPv4 address

ipv4_address_private = None

The Droplets private IPv4 address

ipv6 = None

Whether IPv6 is enabled.

ipv6_address = None

The Droplets public IPv6 address

ipv6_address_private = None

The Droplets private IPv6 address

locked = None

Whether the Droplet is locked.

memory = None

The amount of the Droplets memory in MB.

monitoring = None

Whether monitoring agent is installed.

price_hourly = None

Droplet hourly price.

price_monthly = None

Droplet monthly price.

private_networking = None

Whether private networks are enabled.

region = None

The region the Droplet is running in.

size = None

The unique slug that indentifies the type of Droplet.

status = None

The status of the Droplet.

tags = None

A list of the tags associated to the Droplet.

urn = None

The uniform resource name of the Droplet

vcpus = None

The number of the Droplets virtual CPUs.

volume_ids = None

List of the IDs of each volumes attached to the Droplet.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_digitalocean.GetDropletSnapshotResult(created_at=None, droplet_id=None, min_disk_size=None, most_recent=None, name=None, name_regex=None, region=None, regions=None, size=None, id=None)

A collection of values returned by getDropletSnapshot.

created_at = None

The date and time the Droplet snapshot was created.

droplet_id = None

The ID of the Droplet from which the Droplet snapshot originated.

min_disk_size = None

The minimum size in gigabytes required for a Droplet to be created based on this Droplet snapshot.

regions = None

A list of DigitalOcean region “slugs” indicating where the Droplet snapshot is available.

size = None

The billable size of the Droplet snapshot in gigabytes.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_digitalocean.GetFloatingIpResult(droplet_id=None, ip_address=None, region=None, urn=None, id=None)

A collection of values returned by getFloatingIp.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_digitalocean.GetImageResult(distribution=None, image=None, min_disk_size=None, name=None, private=None, regions=None, slug=None, type=None, id=None)

A collection of values returned by getImage.

distribution = None

The name of the distribution of the OS of the image.

  • min_disk_size: The minimum ‘disk’ required for the image.

image = None

The id of the image.

private = None

Is image a public image or not. Public images represent Linux distributions or One-Click Applications, while non-public images represent snapshots and backups and are only available within your account.

  • regions: The regions that the image is available in.

  • type: Type of the image.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_digitalocean.GetKubernetesClusterResult(cluster_subnet=None, created_at=None, endpoint=None, ipv4_address=None, kube_configs=None, name=None, node_pools=None, region=None, service_subnet=None, status=None, tags=None, updated_at=None, version=None, id=None)

A collection of values returned by getKubernetesCluster.

cluster_subnet = None

The range of IP addresses in the overlay network of the Kubernetes cluster.

created_at = None

The date and time when the Kubernetes cluster was created.

endpoint = None

The base URL of the API server on the Kubernetes master node.

ipv4_address = None

The public IPv4 address of the Kubernetes master node.

node_pools = None

A list of node pools associated with the cluster. Each node pool exports the following attributes:

  • id - The unique ID that can be used to identify and reference the node pool.

  • name - The name of the node pool.

  • size - The slug identifier for the type of Droplet used as workers in the node pool.

  • node_count - The number of Droplet instances in the node pool.

  • actual_node_count - The actual number of nodes in the node pool, which is especially useful when auto-scaling is enabled.

  • auto_scale - A boolean indicating whether auto-scaling is enabled on the node pool.

  • min_nodes - If auto-scaling is enabled, this represents the minimum number of nodes that the node pool can be scaled down to.

  • max_nodes - If auto-scaling is enabled, this represents the maximum number of nodes that the node pool can be scaled up to.

  • tags - A list of tag names applied to the node pool.

  • nodes - A list of nodes in the pool. Each node exports the following attributes:

  • id - A unique ID that can be used to identify and reference the node.

  • name - The auto-generated name for the node.

  • status - A string indicating the current status of the individual node.

  • created_at - The date and time when the node was created.

  • updated_at - The date and time when the node was last updated.

region = None

The slug identifier for the region where the Kubernetes cluster is located.

service_subnet = None

The range of assignable IP addresses for services running in the Kubernetes cluster.

status = None

A string indicating the current status of the cluster. Potential values include running, provisioning, and errored.

tags = None

A list of tag names to be applied to the Kubernetes cluster.

updated_at = None

The date and time when the Kubernetes cluster was last updated.

  • kube_config.0 - A representation of the Kubernetes cluster’s kubeconfig with the following attributes:

  • raw_config - The full contents of the Kubernetes cluster’s kubeconfig file.

  • host - The URL of the API server on the Kubernetes master node.

  • cluster_ca_certificate - The base64 encoded public certificate for the cluster’s certificate authority.

  • token - The DigitalOcean API access token used by clients to access the cluster.

  • client_key - The base64 encoded private key used by clients to access the cluster. Only available if token authentication is not supported on your cluster.

  • client_certificate - The base64 encoded public certificate used by clients to access the cluster. Only available if token authentication is not supported on your cluster.

  • expires_at - The date and time when the credentials will expire and need to be regenerated.

version = None

The slug identifier for the version of Kubernetes used for the cluster.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_digitalocean.GetLoadBalancerResult(algorithm=None, droplet_ids=None, droplet_tag=None, enable_proxy_protocol=None, forwarding_rules=None, healthcheck=None, ip=None, name=None, redirect_http_to_https=None, region=None, status=None, sticky_sessions=None, urn=None, id=None)

A collection of values returned by getLoadBalancer.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_digitalocean.GetRecordResult(data=None, domain=None, flags=None, name=None, port=None, priority=None, tag=None, ttl=None, type=None, weight=None, id=None)

A collection of values returned by getRecord.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_digitalocean.GetSizesResult(filters=None, sizes=None, sorts=None, id=None)

A collection of values returned by getSizes.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_digitalocean.GetSshKeyResult(fingerprint=None, name=None, public_key=None, id=None)

A collection of values returned by getSshKey.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_digitalocean.GetTagResult(name=None, id=None)

A collection of values returned by getTag.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_digitalocean.GetVolumeResult(description=None, droplet_ids=None, filesystem_label=None, filesystem_type=None, name=None, region=None, size=None, urn=None, id=None)

A collection of values returned by getVolume.

description = None

Text describing a block storage volume.

droplet_ids = None

A list of associated Droplet ids.

filesystem_label = None

Filesystem label currently in-use on the block storage volume.

filesystem_type = None

Filesystem type currently in-use on the block storage volume.

size = None

The size of the block storage volume in GiB.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_digitalocean.GetVolumeSnapshotResult(created_at=None, min_disk_size=None, most_recent=None, name=None, name_regex=None, region=None, regions=None, size=None, volume_id=None, id=None)

A collection of values returned by getVolumeSnapshot.

created_at = None

The date and time the volume snapshot was created.

min_disk_size = None

The minimum size in gigabytes required for a volume to be created based on this volume snapshot.

regions = None

A list of DigitalOcean region “slugs” indicating where the volume snapshot is available.

size = None

The billable size of the volume snapshot in gigabytes.

volume_id = None

The ID of the volume from which the volume snapshot originated.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_digitalocean.KubernetesCluster(resource_name, opts=None, name=None, node_pool=None, region=None, tags=None, version=None, __props__=None, __name__=None, __opts__=None)

Provides a DigitalOcean Kubernetes cluster resource. This can be used to create, delete, and modify clusters. For more information see the official documentation.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – A name for the Kubernetes cluster.

  • node_pool (pulumi.Input[dict]) – A block representing the cluster’s default node pool. Additional node pools may be added to the cluster using the .KubernetesNodePool resource. The following arguments may be specified:

- `name` - (Required) A name for the node pool.
- `size` - (Required) The slug identifier for the type of Droplet to be used as workers in the node pool.
- `node_count` - (Optional) The number of Droplet instances in the node pool. If auto-scaling is enabled, this should only be set if the desired result is to explicitly reset the number of nodes to this value. If auto-scaling is enabled, and the node count is outside of the given min/max range, it will use the min nodes value.
- `auto_scale` - (Optional) Enable auto-scaling of the number of nodes in the node pool within the given min/max range.
- `min_nodes` - (Optional) If auto-scaling is enabled, this represents the minimum number of nodes that the node pool can be scaled down to.
- `max_nodes` - (Optional) If auto-scaling is enabled, this represents the maximum number of nodes that the node pool can be scaled up to.
- `tags` - (Optional) A list of tag names to be applied to the Kubernetes cluster.
Parameters
  • region (pulumi.Input[str]) – The slug identifier for the region where the Kubernetes cluster will be created.

  • tags (pulumi.Input[list]) – A list of tag names to be applied to the Kubernetes cluster.

  • version (pulumi.Input[str]) – The slug identifier for the version of Kubernetes used for the cluster. Use doctl to find the available versions doctl kubernetes options versions. (Note: A cluster may only be upgraded to newer versions in-place. If the version is decreased, a new resource will be created.)

The node_pool object supports the following:

  • actual_node_count (pulumi.Input[float])

  • auto_scale (pulumi.Input[bool])

  • id (pulumi.Input[str]) - A unique ID that can be used to identify and reference a Kubernetes cluster.

  • max_nodes (pulumi.Input[float])

  • min_nodes (pulumi.Input[float])

  • name (pulumi.Input[str]) - A name for the Kubernetes cluster.

  • node_count (pulumi.Input[float])

  • nodes (pulumi.Input[list])

    • created_at (pulumi.Input[str]) - The date and time when the Kubernetes cluster was created.

    • id (pulumi.Input[str]) - A unique ID that can be used to identify and reference a Kubernetes cluster.

    • name (pulumi.Input[str]) - A name for the Kubernetes cluster.

    • status (pulumi.Input[str]) - A string indicating the current status of the cluster. Potential values include running, provisioning, and errored.

    • updated_at (pulumi.Input[str]) - The date and time when the Kubernetes cluster was last updated.

      • kube_config.0 - A representation of the Kubernetes cluster’s kubeconfig with the following attributes:

      • raw_config - The full contents of the Kubernetes cluster’s kubeconfig file.

      • host - The URL of the API server on the Kubernetes master node.

      • cluster_ca_certificate - The base64 encoded public certificate for the cluster’s certificate authority.

      • token - The DigitalOcean API access token used by clients to access the cluster.

      • client_key - The base64 encoded private key used by clients to access the cluster. Only available if token authentication is not supported on your cluster.

      • client_certificate - The base64 encoded public certificate used by clients to access the cluster. Only available if token authentication is not supported on your cluster.

      • expires_at - The date and time when the credentials will expire and need to be regenerated.

  • size (pulumi.Input[str])

  • tags (pulumi.Input[list]) - A list of tag names to be applied to the Kubernetes cluster.

cluster_subnet = None

The range of IP addresses in the overlay network of the Kubernetes cluster.

created_at = None

The date and time when the Kubernetes cluster was created.

endpoint = None

The base URL of the API server on the Kubernetes master node.

ipv4_address = None

The public IPv4 address of the Kubernetes master node.

name = None

A name for the Kubernetes cluster.

node_pool = None

A block representing the cluster’s default node pool. Additional node pools may be added to the cluster using the .KubernetesNodePool resource. The following arguments may be specified:

  • name - (Required) A name for the node pool.

  • size - (Required) The slug identifier for the type of Droplet to be used as workers in the node pool.

  • node_count - (Optional) The number of Droplet instances in the node pool. If auto-scaling is enabled, this should only be set if the desired result is to explicitly reset the number of nodes to this value. If auto-scaling is enabled, and the node count is outside of the given min/max range, it will use the min nodes value.

  • auto_scale - (Optional) Enable auto-scaling of the number of nodes in the node pool within the given min/max range.

  • min_nodes - (Optional) If auto-scaling is enabled, this represents the minimum number of nodes that the node pool can be scaled down to.

  • max_nodes - (Optional) If auto-scaling is enabled, this represents the maximum number of nodes that the node pool can be scaled up to.

  • tags - (Optional) A list of tag names to be applied to the Kubernetes cluster.

    • actual_node_count (float)

    • auto_scale (bool)

    • id (str) - A unique ID that can be used to identify and reference a Kubernetes cluster.

    • max_nodes (float)

    • min_nodes (float)

    • name (str) - A name for the Kubernetes cluster.

    • node_count (float)

    • nodes (list)

      • created_at (str) - The date and time when the Kubernetes cluster was created.

      • id (str) - A unique ID that can be used to identify and reference a Kubernetes cluster.

      • name (str) - A name for the Kubernetes cluster.

      • status (str) - A string indicating the current status of the cluster. Potential values include running, provisioning, and errored.

      • updated_at (str) - The date and time when the Kubernetes cluster was last updated.

        • kube_config.0 - A representation of the Kubernetes cluster’s kubeconfig with the following attributes:

        • raw_config - The full contents of the Kubernetes cluster’s kubeconfig file.

        • host - The URL of the API server on the Kubernetes master node.

        • cluster_ca_certificate - The base64 encoded public certificate for the cluster’s certificate authority.

        • token - The DigitalOcean API access token used by clients to access the cluster.

        • client_key - The base64 encoded private key used by clients to access the cluster. Only available if token authentication is not supported on your cluster.

        • client_certificate - The base64 encoded public certificate used by clients to access the cluster. Only available if token authentication is not supported on your cluster.

        • expires_at - The date and time when the credentials will expire and need to be regenerated.

    • size (str)

    • tags (list) - A list of tag names to be applied to the Kubernetes cluster.

region = None

The slug identifier for the region where the Kubernetes cluster will be created.

service_subnet = None

The range of assignable IP addresses for services running in the Kubernetes cluster.

status = None

A string indicating the current status of the cluster. Potential values include running, provisioning, and errored.

tags = None

A list of tag names to be applied to the Kubernetes cluster.

updated_at = None

The date and time when the Kubernetes cluster was last updated.

  • kube_config.0 - A representation of the Kubernetes cluster’s kubeconfig with the following attributes:

  • raw_config - The full contents of the Kubernetes cluster’s kubeconfig file.

  • host - The URL of the API server on the Kubernetes master node.

  • cluster_ca_certificate - The base64 encoded public certificate for the cluster’s certificate authority.

  • token - The DigitalOcean API access token used by clients to access the cluster.

  • client_key - The base64 encoded private key used by clients to access the cluster. Only available if token authentication is not supported on your cluster.

  • client_certificate - The base64 encoded public certificate used by clients to access the cluster. Only available if token authentication is not supported on your cluster.

  • expires_at - The date and time when the credentials will expire and need to be regenerated.

version = None

The slug identifier for the version of Kubernetes used for the cluster. Use doctl to find the available versions doctl kubernetes options versions. (Note: A cluster may only be upgraded to newer versions in-place. If the version is decreased, a new resource will be created.)

static get(resource_name, id, opts=None, cluster_subnet=None, created_at=None, endpoint=None, ipv4_address=None, kube_configs=None, name=None, node_pool=None, region=None, service_subnet=None, status=None, tags=None, updated_at=None, version=None)

Get an existing KubernetesCluster resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cluster_subnet (pulumi.Input[str]) – The range of IP addresses in the overlay network of the Kubernetes cluster.

  • created_at (pulumi.Input[str]) – The date and time when the Kubernetes cluster was created.

  • endpoint (pulumi.Input[str]) – The base URL of the API server on the Kubernetes master node.

  • ipv4_address (pulumi.Input[str]) – The public IPv4 address of the Kubernetes master node.

  • name (pulumi.Input[str]) – A name for the Kubernetes cluster.

  • node_pool (pulumi.Input[dict]) – A block representing the cluster’s default node pool. Additional node pools may be added to the cluster using the .KubernetesNodePool resource. The following arguments may be specified:

- `name` - (Required) A name for the node pool.
- `size` - (Required) The slug identifier for the type of Droplet to be used as workers in the node pool.
- `node_count` - (Optional) The number of Droplet instances in the node pool. If auto-scaling is enabled, this should only be set if the desired result is to explicitly reset the number of nodes to this value. If auto-scaling is enabled, and the node count is outside of the given min/max range, it will use the min nodes value.
- `auto_scale` - (Optional) Enable auto-scaling of the number of nodes in the node pool within the given min/max range.
- `min_nodes` - (Optional) If auto-scaling is enabled, this represents the minimum number of nodes that the node pool can be scaled down to.
- `max_nodes` - (Optional) If auto-scaling is enabled, this represents the maximum number of nodes that the node pool can be scaled up to.
- `tags` - (Optional) A list of tag names to be applied to the Kubernetes cluster.
Parameters
  • region (pulumi.Input[str]) – The slug identifier for the region where the Kubernetes cluster will be created.

  • service_subnet (pulumi.Input[str]) – The range of assignable IP addresses for services running in the Kubernetes cluster.

  • status (pulumi.Input[str]) – A string indicating the current status of the cluster. Potential values include running, provisioning, and errored.

  • tags (pulumi.Input[list]) – A list of tag names to be applied to the Kubernetes cluster.

  • updated_at (pulumi.Input[str]) – The date and time when the Kubernetes cluster was last updated.

* `kube_config.0` - A representation of the Kubernetes cluster's kubeconfig with the following attributes:
- `raw_config` - The full contents of the Kubernetes cluster's kubeconfig file.
- `host` - The URL of the API server on the Kubernetes master node.
- `cluster_ca_certificate` - The base64 encoded public certificate for the cluster's certificate authority.
- `token` - The DigitalOcean API access token used by clients to access the cluster.
- `client_key` - The base64 encoded private key used by clients to access the cluster. Only available if token authentication is not supported on your cluster.
- `client_certificate` - The base64 encoded public certificate used by clients to access the cluster. Only available if token authentication is not supported on your cluster.
- `expires_at` - The date and time when the credentials will expire and need to be regenerated.
Parameters

version (pulumi.Input[str]) –

The slug identifier for the version of Kubernetes used for the cluster. Use doctl to find the available versions doctl kubernetes options versions. (Note: A cluster may only be upgraded to newer versions in-place. If the version is decreased, a new resource will be created.)

The kube_configs object supports the following:

  • clientCertificate (pulumi.Input[str])

  • clientKey (pulumi.Input[str])

  • clusterCaCertificate (pulumi.Input[str])

  • expiresAt (pulumi.Input[str])

  • host (pulumi.Input[str])

  • rawConfig (pulumi.Input[str])

  • token (pulumi.Input[str])

The node_pool object supports the following:

  • actual_node_count (pulumi.Input[float])

  • auto_scale (pulumi.Input[bool])

  • id (pulumi.Input[str]) - A unique ID that can be used to identify and reference a Kubernetes cluster.

  • max_nodes (pulumi.Input[float])

  • min_nodes (pulumi.Input[float])

  • name (pulumi.Input[str]) - A name for the Kubernetes cluster.

  • node_count (pulumi.Input[float])

  • nodes (pulumi.Input[list])

    • created_at (pulumi.Input[str]) - The date and time when the Kubernetes cluster was created.

    • id (pulumi.Input[str]) - A unique ID that can be used to identify and reference a Kubernetes cluster.

    • name (pulumi.Input[str]) - A name for the Kubernetes cluster.

    • status (pulumi.Input[str]) - A string indicating the current status of the cluster. Potential values include running, provisioning, and errored.

    • updated_at (pulumi.Input[str]) - The date and time when the Kubernetes cluster was last updated.

      • kube_config.0 - A representation of the Kubernetes cluster’s kubeconfig with the following attributes:

      • raw_config - The full contents of the Kubernetes cluster’s kubeconfig file.

      • host - The URL of the API server on the Kubernetes master node.

      • cluster_ca_certificate - The base64 encoded public certificate for the cluster’s certificate authority.

      • token - The DigitalOcean API access token used by clients to access the cluster.

      • client_key - The base64 encoded private key used by clients to access the cluster. Only available if token authentication is not supported on your cluster.

      • client_certificate - The base64 encoded public certificate used by clients to access the cluster. Only available if token authentication is not supported on your cluster.

      • expires_at - The date and time when the credentials will expire and need to be regenerated.

  • size (pulumi.Input[str])

  • tags (pulumi.Input[list]) - A list of tag names to be applied to the Kubernetes cluster.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_digitalocean.KubernetesNodePool(resource_name, opts=None, auto_scale=None, cluster_id=None, max_nodes=None, min_nodes=None, name=None, node_count=None, size=None, tags=None, __props__=None, __name__=None, __opts__=None)

Provides a DigitalOcean Kubernetes node pool resource. While the default node pool must be defined in the .KubernetesCluster resource, this resource can be used to add additional ones to a cluster.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • auto_scale (pulumi.Input[bool]) – Enable auto-scaling of the number of nodes in the node pool within the given min/max range.

  • cluster_id (pulumi.Input[str]) – The ID of the Kubernetes cluster to which the node pool is associated.

  • max_nodes (pulumi.Input[float]) – If auto-scaling is enabled, this represents the maximum number of nodes that the node pool can be scaled up to.

  • min_nodes (pulumi.Input[float]) – If auto-scaling is enabled, this represents the minimum number of nodes that the node pool can be scaled down to.

  • name (pulumi.Input[str]) – A name for the node pool.

  • node_count (pulumi.Input[float]) – The number of Droplet instances in the node pool. If auto-scaling is enabled, this should only be set if the desired result is to explicitly reset the number of nodes to this value. If auto-scaling is enabled, and the node count is outside of the given min/max range, it will use the min nodes value.

  • size (pulumi.Input[str]) – The slug identifier for the type of Droplet to be used as workers in the node pool.

  • tags (pulumi.Input[list]) – A list of tag names to be applied to the Kubernetes cluster.

actual_node_count = None

A computed field representing the actual number of nodes in the node pool, which is especially useful when auto-scaling is enabled.

auto_scale = None

Enable auto-scaling of the number of nodes in the node pool within the given min/max range.

cluster_id = None

The ID of the Kubernetes cluster to which the node pool is associated.

max_nodes = None

If auto-scaling is enabled, this represents the maximum number of nodes that the node pool can be scaled up to.

min_nodes = None

If auto-scaling is enabled, this represents the minimum number of nodes that the node pool can be scaled down to.

name = None

A name for the node pool.

node_count = None

The number of Droplet instances in the node pool. If auto-scaling is enabled, this should only be set if the desired result is to explicitly reset the number of nodes to this value. If auto-scaling is enabled, and the node count is outside of the given min/max range, it will use the min nodes value.

nodes = None

A list of nodes in the pool. Each node exports the following attributes:

  • id - A unique ID that can be used to identify and reference the node.

  • name - The auto-generated name for the node.

  • status - A string indicating the current status of the individual node.

  • created_at - The date and time when the node was created.

  • updated_at - The date and time when the node was last updated.

    • created_at (str)

    • id (str) - A unique ID that can be used to identify and reference the node pool.

    • name (str) - A name for the node pool.

    • status (str)

    • updated_at (str)

size = None

The slug identifier for the type of Droplet to be used as workers in the node pool.

tags = None

A list of tag names to be applied to the Kubernetes cluster.

static get(resource_name, id, opts=None, actual_node_count=None, auto_scale=None, cluster_id=None, max_nodes=None, min_nodes=None, name=None, node_count=None, nodes=None, size=None, tags=None)

Get an existing KubernetesNodePool resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • actual_node_count (pulumi.Input[float]) – A computed field representing the actual number of nodes in the node pool, which is especially useful when auto-scaling is enabled.

  • auto_scale (pulumi.Input[bool]) – Enable auto-scaling of the number of nodes in the node pool within the given min/max range.

  • cluster_id (pulumi.Input[str]) – The ID of the Kubernetes cluster to which the node pool is associated.

  • max_nodes (pulumi.Input[float]) – If auto-scaling is enabled, this represents the maximum number of nodes that the node pool can be scaled up to.

  • min_nodes (pulumi.Input[float]) – If auto-scaling is enabled, this represents the minimum number of nodes that the node pool can be scaled down to.

  • name (pulumi.Input[str]) – A name for the node pool.

  • node_count (pulumi.Input[float]) – The number of Droplet instances in the node pool. If auto-scaling is enabled, this should only be set if the desired result is to explicitly reset the number of nodes to this value. If auto-scaling is enabled, and the node count is outside of the given min/max range, it will use the min nodes value.

  • nodes (pulumi.Input[list]) – A list of nodes in the pool. Each node exports the following attributes:

- `id` -  A unique ID that can be used to identify and reference the node.
- `name` - The auto-generated name for the node.
- `status` -  A string indicating the current status of the individual node.
- `created_at` - The date and time when the node was created.
- `updated_at` - The date and time when the node was last updated.
Parameters
  • size (pulumi.Input[str]) – The slug identifier for the type of Droplet to be used as workers in the node pool.

  • tags (pulumi.Input[list]) – A list of tag names to be applied to the Kubernetes cluster.

The nodes object supports the following:

  • created_at (pulumi.Input[str])

  • id (pulumi.Input[str]) - A unique ID that can be used to identify and reference the node pool.

  • name (pulumi.Input[str]) - A name for the node pool.

  • status (pulumi.Input[str])

  • updated_at (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_digitalocean.LoadBalancer(resource_name, opts=None, algorithm=None, droplet_ids=None, droplet_tag=None, enable_proxy_protocol=None, forwarding_rules=None, healthcheck=None, name=None, redirect_http_to_https=None, region=None, sticky_sessions=None, __props__=None, __name__=None, __opts__=None)

Provides a DigitalOcean Load Balancer resource. This can be used to create, modify, and delete Load Balancers.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • algorithm (pulumi.Input[str]) – The load balancing algorithm used to determine which backend Droplet will be selected by a client. It must be either round_robin or least_connections. The default value is round_robin.

  • droplet_ids (pulumi.Input[list]) – A list of the IDs of each droplet to be attached to the Load Balancer.

  • droplet_tag (pulumi.Input[str]) – The name of a Droplet tag corresponding to Droplets to be assigned to the Load Balancer.

  • enable_proxy_protocol (pulumi.Input[bool]) – A boolean value indicating whether PROXY Protocol should be used to pass information from connecting client requests to the backend service. Default value is false.

  • forwarding_rules (pulumi.Input[list]) – A list of forwarding_rule to be assigned to the Load Balancer. The forwarding_rule block is documented below.

  • healthcheck (pulumi.Input[dict]) – A healthcheck block to be assigned to the Load Balancer. The healthcheck block is documented below. Only 1 healthcheck is allowed.

  • name (pulumi.Input[str]) – The Load Balancer name

  • redirect_http_to_https (pulumi.Input[bool]) – A boolean value indicating whether HTTP requests to the Load Balancer on port 80 will be redirected to HTTPS on port 443. Default value is false.

  • region (pulumi.Input[str]) – The region to start in

  • sticky_sessions (pulumi.Input[dict]) – A sticky_sessions block to be assigned to the Load Balancer. The sticky_sessions block is documented below. Only 1 sticky_sessions block is allowed.

The forwarding_rules object supports the following:

  • certificate_id (pulumi.Input[str]) - The ID of the TLS certificate to be used for SSL termination.

  • entryPort (pulumi.Input[float]) - An integer representing the port on which the Load Balancer instance will listen.

  • entryProtocol (pulumi.Input[str]) - The protocol used for traffic to the Load Balancer. The possible values are: http, https, http2 or tcp.

  • targetPort (pulumi.Input[float]) - An integer representing the port on the backend Droplets to which the Load Balancer will send traffic.

  • targetProtocol (pulumi.Input[str]) - The protocol used for traffic from the Load Balancer to the backend Droplets. The possible values are: http, https, http2 or tcp.

  • tlsPassthrough (pulumi.Input[bool]) - A boolean value indicating whether SSL encrypted traffic will be passed through to the backend Droplets. The default value is false.

The healthcheck object supports the following:

  • checkIntervalSeconds (pulumi.Input[float]) - The number of seconds between between two consecutive health checks. If not specified, the default value is 10.

  • healthyThreshold (pulumi.Input[float]) - The number of times a health check must pass for a backend Droplet to be marked “healthy” and be re-added to the pool. If not specified, the default value is 5.

  • path (pulumi.Input[str]) - The path on the backend Droplets to which the Load Balancer instance will send a request.

  • port (pulumi.Input[float]) - An integer representing the port on the backend Droplets on which the health check will attempt a connection.

  • protocol (pulumi.Input[str]) - The protocol used for health checks sent to the backend Droplets. The possible values are http or tcp.

  • responseTimeoutSeconds (pulumi.Input[float]) - The number of seconds the Load Balancer instance will wait for a response until marking a health check as failed. If not specified, the default value is 5.

  • unhealthyThreshold (pulumi.Input[float]) - The number of times a health check must fail for a backend Droplet to be marked “unhealthy” and be removed from the pool. If not specified, the default value is 3.

The sticky_sessions object supports the following:

  • cookieName (pulumi.Input[str]) - The name to be used for the cookie sent to the client. This attribute is required when using cookies for the sticky sessions type.

  • cookieTtlSeconds (pulumi.Input[float]) - The number of seconds until the cookie set by the Load Balancer expires. This attribute is required when using cookies for the sticky sessions type.

  • type (pulumi.Input[str]) - An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are cookies or none. If not specified, the default value is none.

algorithm = None

The load balancing algorithm used to determine which backend Droplet will be selected by a client. It must be either round_robin or least_connections. The default value is round_robin.

droplet_ids = None

A list of the IDs of each droplet to be attached to the Load Balancer.

droplet_tag = None

The name of a Droplet tag corresponding to Droplets to be assigned to the Load Balancer.

enable_proxy_protocol = None

A boolean value indicating whether PROXY Protocol should be used to pass information from connecting client requests to the backend service. Default value is false.

forwarding_rules = None

A list of forwarding_rule to be assigned to the Load Balancer. The forwarding_rule block is documented below.

  • certificate_id (str) - The ID of the TLS certificate to be used for SSL termination.

  • entryPort (float) - An integer representing the port on which the Load Balancer instance will listen.

  • entryProtocol (str) - The protocol used for traffic to the Load Balancer. The possible values are: http, https, http2 or tcp.

  • targetPort (float) - An integer representing the port on the backend Droplets to which the Load Balancer will send traffic.

  • targetProtocol (str) - The protocol used for traffic from the Load Balancer to the backend Droplets. The possible values are: http, https, http2 or tcp.

  • tlsPassthrough (bool) - A boolean value indicating whether SSL encrypted traffic will be passed through to the backend Droplets. The default value is false.

healthcheck = None

A healthcheck block to be assigned to the Load Balancer. The healthcheck block is documented below. Only 1 healthcheck is allowed.

  • checkIntervalSeconds (float) - The number of seconds between between two consecutive health checks. If not specified, the default value is 10.

  • healthyThreshold (float) - The number of times a health check must pass for a backend Droplet to be marked “healthy” and be re-added to the pool. If not specified, the default value is 5.

  • path (str) - The path on the backend Droplets to which the Load Balancer instance will send a request.

  • port (float) - An integer representing the port on the backend Droplets on which the health check will attempt a connection.

  • protocol (str) - The protocol used for health checks sent to the backend Droplets. The possible values are http or tcp.

  • responseTimeoutSeconds (float) - The number of seconds the Load Balancer instance will wait for a response until marking a health check as failed. If not specified, the default value is 5.

  • unhealthyThreshold (float) - The number of times a health check must fail for a backend Droplet to be marked “unhealthy” and be removed from the pool. If not specified, the default value is 3.

name = None

The Load Balancer name

redirect_http_to_https = None

A boolean value indicating whether HTTP requests to the Load Balancer on port 80 will be redirected to HTTPS on port 443. Default value is false.

region = None

The region to start in

sticky_sessions = None

A sticky_sessions block to be assigned to the Load Balancer. The sticky_sessions block is documented below. Only 1 sticky_sessions block is allowed.

  • cookieName (str) - The name to be used for the cookie sent to the client. This attribute is required when using cookies for the sticky sessions type.

  • cookieTtlSeconds (float) - The number of seconds until the cookie set by the Load Balancer expires. This attribute is required when using cookies for the sticky sessions type.

  • type (str) - An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are cookies or none. If not specified, the default value is none.

urn = None

The uniform resource name for the Load Balancer

static get(resource_name, id, opts=None, algorithm=None, droplet_ids=None, droplet_tag=None, enable_proxy_protocol=None, forwarding_rules=None, healthcheck=None, ip=None, name=None, redirect_http_to_https=None, region=None, status=None, sticky_sessions=None, urn=None)

Get an existing LoadBalancer resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • algorithm (pulumi.Input[str]) – The load balancing algorithm used to determine which backend Droplet will be selected by a client. It must be either round_robin or least_connections. The default value is round_robin.

  • droplet_ids (pulumi.Input[list]) – A list of the IDs of each droplet to be attached to the Load Balancer.

  • droplet_tag (pulumi.Input[str]) – The name of a Droplet tag corresponding to Droplets to be assigned to the Load Balancer.

  • enable_proxy_protocol (pulumi.Input[bool]) – A boolean value indicating whether PROXY Protocol should be used to pass information from connecting client requests to the backend service. Default value is false.

  • forwarding_rules (pulumi.Input[list]) – A list of forwarding_rule to be assigned to the Load Balancer. The forwarding_rule block is documented below.

  • healthcheck (pulumi.Input[dict]) – A healthcheck block to be assigned to the Load Balancer. The healthcheck block is documented below. Only 1 healthcheck is allowed.

  • name (pulumi.Input[str]) – The Load Balancer name

  • redirect_http_to_https (pulumi.Input[bool]) – A boolean value indicating whether HTTP requests to the Load Balancer on port 80 will be redirected to HTTPS on port 443. Default value is false.

  • region (pulumi.Input[str]) – The region to start in

  • sticky_sessions (pulumi.Input[dict]) – A sticky_sessions block to be assigned to the Load Balancer. The sticky_sessions block is documented below. Only 1 sticky_sessions block is allowed.

  • urn (pulumi.Input[str]) – The uniform resource name for the Load Balancer

The forwarding_rules object supports the following:

  • certificate_id (pulumi.Input[str]) - The ID of the TLS certificate to be used for SSL termination.

  • entryPort (pulumi.Input[float]) - An integer representing the port on which the Load Balancer instance will listen.

  • entryProtocol (pulumi.Input[str]) - The protocol used for traffic to the Load Balancer. The possible values are: http, https, http2 or tcp.

  • targetPort (pulumi.Input[float]) - An integer representing the port on the backend Droplets to which the Load Balancer will send traffic.

  • targetProtocol (pulumi.Input[str]) - The protocol used for traffic from the Load Balancer to the backend Droplets. The possible values are: http, https, http2 or tcp.

  • tlsPassthrough (pulumi.Input[bool]) - A boolean value indicating whether SSL encrypted traffic will be passed through to the backend Droplets. The default value is false.

The healthcheck object supports the following:

  • checkIntervalSeconds (pulumi.Input[float]) - The number of seconds between between two consecutive health checks. If not specified, the default value is 10.

  • healthyThreshold (pulumi.Input[float]) - The number of times a health check must pass for a backend Droplet to be marked “healthy” and be re-added to the pool. If not specified, the default value is 5.

  • path (pulumi.Input[str]) - The path on the backend Droplets to which the Load Balancer instance will send a request.

  • port (pulumi.Input[float]) - An integer representing the port on the backend Droplets on which the health check will attempt a connection.

  • protocol (pulumi.Input[str]) - The protocol used for health checks sent to the backend Droplets. The possible values are http or tcp.

  • responseTimeoutSeconds (pulumi.Input[float]) - The number of seconds the Load Balancer instance will wait for a response until marking a health check as failed. If not specified, the default value is 5.

  • unhealthyThreshold (pulumi.Input[float]) - The number of times a health check must fail for a backend Droplet to be marked “unhealthy” and be removed from the pool. If not specified, the default value is 3.

The sticky_sessions object supports the following:

  • cookieName (pulumi.Input[str]) - The name to be used for the cookie sent to the client. This attribute is required when using cookies for the sticky sessions type.

  • cookieTtlSeconds (pulumi.Input[float]) - The number of seconds until the cookie set by the Load Balancer expires. This attribute is required when using cookies for the sticky sessions type.

  • type (pulumi.Input[str]) - An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are cookies or none. If not specified, the default value is none.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_digitalocean.Project(resource_name, opts=None, description=None, environment=None, name=None, purpose=None, resources=None, __props__=None, __name__=None, __opts__=None)

Provides a DigitalOcean Project resource.

Projects allow you to organize your resources into groups that fit the way you work. You can group resources (like Droplets, Spaces, Load Balancers, domains, and Floating IPs) in ways that align with the applications you host on DigitalOcean.

The following resources can be associated with a project:

  • Droplet

  • Load Balancer

  • Domain

  • Volume

  • Floating IP

  • Spaces Bucket

Note: A Terrafrom managed project cannot be set as a default project.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • description (pulumi.Input[str]) – the description of the project

  • environment (pulumi.Input[str]) – the environment of the project’s resources. The possible values are: Development, Staging, Production)

  • name (pulumi.Input[str]) – The name of the Project

  • purpose (pulumi.Input[str]) – the purpose of the project, (Default: “Web Application”)

  • resources (pulumi.Input[list]) – a list of uniform resource names (URNs) for the resources associated with the project

created_at = None

the date and time when the project was created, (ISO8601)

description = None

the description of the project

environment = None

the environment of the project’s resources. The possible values are: Development, Staging, Production)

name = None

The name of the Project

owner_id = None

the id of the project owner.

owner_uuid = None

the unique universal identifier of the project owner.

purpose = None

the purpose of the project, (Default: “Web Application”)

resources = None

a list of uniform resource names (URNs) for the resources associated with the project

updated_at = None

the date and time when the project was last updated, (ISO8601)

static get(resource_name, id, opts=None, created_at=None, description=None, environment=None, name=None, owner_id=None, owner_uuid=None, purpose=None, resources=None, updated_at=None)

Get an existing Project resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • created_at (pulumi.Input[str]) – the date and time when the project was created, (ISO8601)

  • description (pulumi.Input[str]) – the description of the project

  • environment (pulumi.Input[str]) – the environment of the project’s resources. The possible values are: Development, Staging, Production)

  • name (pulumi.Input[str]) – The name of the Project

  • owner_id (pulumi.Input[float]) – the id of the project owner.

  • owner_uuid (pulumi.Input[str]) – the unique universal identifier of the project owner.

  • purpose (pulumi.Input[str]) – the purpose of the project, (Default: “Web Application”)

  • resources (pulumi.Input[list]) – a list of uniform resource names (URNs) for the resources associated with the project

  • updated_at (pulumi.Input[str]) – the date and time when the project was last updated, (ISO8601)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_digitalocean.Provider(resource_name, opts=None, api_endpoint=None, spaces_access_id=None, spaces_secret_key=None, token=None, __props__=None, __name__=None, __opts__=None)

The provider type for the digitalocean package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

static get(resource_name, id, opts=None)

Get an existing Provider resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_digitalocean.SpacesBucket(resource_name, opts=None, acl=None, cors_rules=None, force_destroy=None, name=None, region=None, __props__=None, __name__=None, __opts__=None)

Provides a bucket resource for Spaces, DigitalOcean’s object storage product.

The Spaces API was designed to be interoperable with Amazon’s AWS S3 API. This allows users to interact with the service while using the tools they already know. Spaces mirrors S3’s authentication framework and requests to Spaces require a key pair similar to Amazon’s Access ID and Secret Key.

The authentication requirement can be met by either setting the SPACES_ACCESS_KEY_ID and SPACES_SECRET_ACCESS_KEY environment variables or the provider’s spaces_access_id and spaces_secret_key arguments to the access ID and secret you generate via the DigitalOcean control panel. For example:

For more information, See An Introduction to DigitalOcean Spaces

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • acl (pulumi.Input[str]) – Canned ACL applied on bucket creation (private or public-read)

  • force_destroy (pulumi.Input[bool]) – Unless true, the bucket will only be destroyed if empty (Defaults to false)

  • name (pulumi.Input[str]) – The name of the bucket

  • region (pulumi.Input[str]) – The region where the bucket resides (Defaults to nyc3)

The cors_rules object supports the following:

  • allowedHeaders (pulumi.Input[list]) - A list of headers that will be included in the CORS preflight request’s Access-Control-Request-Headers. A header may contain one wildcard (e.g. x-amz-*).

  • allowedMethods (pulumi.Input[list]) - A list of HTTP methods (e.g. GET) which are allowed from the specified origin.

  • allowedOrigins (pulumi.Input[list]) - A list of hosts from which requests using the specified methods are allowed. A host may contain one wildcard (e.g. http://*.example.com).

  • maxAgeSeconds (pulumi.Input[float]) - The time in seconds that browser can cache the response for a preflight request.

acl = None

Canned ACL applied on bucket creation (private or public-read)

bucket_domain_name = None

The FQDN of the bucket (e.g. bucket-name.nyc3.digitaloceanspaces.com)

force_destroy = None

Unless true, the bucket will only be destroyed if empty (Defaults to false)

name = None

The name of the bucket

region = None

The region where the bucket resides (Defaults to nyc3)

urn = None

The uniform resource name for the bucket

static get(resource_name, id, opts=None, acl=None, bucket_domain_name=None, cors_rules=None, force_destroy=None, name=None, region=None, urn=None)

Get an existing SpacesBucket resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • acl (pulumi.Input[str]) – Canned ACL applied on bucket creation (private or public-read)

  • bucket_domain_name (pulumi.Input[str]) – The FQDN of the bucket (e.g. bucket-name.nyc3.digitaloceanspaces.com)

  • force_destroy (pulumi.Input[bool]) – Unless true, the bucket will only be destroyed if empty (Defaults to false)

  • name (pulumi.Input[str]) – The name of the bucket

  • region (pulumi.Input[str]) – The region where the bucket resides (Defaults to nyc3)

  • urn (pulumi.Input[str]) – The uniform resource name for the bucket

The cors_rules object supports the following:

  • allowedHeaders (pulumi.Input[list]) - A list of headers that will be included in the CORS preflight request’s Access-Control-Request-Headers. A header may contain one wildcard (e.g. x-amz-*).

  • allowedMethods (pulumi.Input[list]) - A list of HTTP methods (e.g. GET) which are allowed from the specified origin.

  • allowedOrigins (pulumi.Input[list]) - A list of hosts from which requests using the specified methods are allowed. A host may contain one wildcard (e.g. http://*.example.com).

  • maxAgeSeconds (pulumi.Input[float]) - The time in seconds that browser can cache the response for a preflight request.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_digitalocean.SshKey(resource_name, opts=None, name=None, public_key=None, __props__=None, __name__=None, __opts__=None)

Provides a DigitalOcean SSH key resource to allow you to manage SSH keys for Droplet access. Keys created with this resource can be referenced in your Droplet configuration via their ID or fingerprint.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – The name of the SSH key for identification

  • public_key (pulumi.Input[str]) – The public key. If this is a file, it can be read using the file interpolation function

fingerprint = None

The fingerprint of the SSH key

name = None

The name of the SSH key for identification

public_key = None

The public key. If this is a file, it can be read using the file interpolation function

static get(resource_name, id, opts=None, fingerprint=None, name=None, public_key=None)

Get an existing SshKey resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • fingerprint (pulumi.Input[str]) – The fingerprint of the SSH key

  • name (pulumi.Input[str]) – The name of the SSH key for identification

  • public_key (pulumi.Input[str]) – The public key. If this is a file, it can be read using the file interpolation function

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_digitalocean.Tag(resource_name, opts=None, name=None, __props__=None, __name__=None, __opts__=None)

Provides a DigitalOcean Tag resource. A Tag is a label that can be applied to a Droplet resource in order to better organize or facilitate the lookups and actions on it. Tags created with this resource can be referenced in your Droplet configuration via their ID or name.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – The name of the tag

name = None

The name of the tag

static get(resource_name, id, opts=None, name=None)

Get an existing Tag resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – The name of the tag

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_digitalocean.Volume(resource_name, opts=None, description=None, filesystem_type=None, initial_filesystem_label=None, initial_filesystem_type=None, name=None, region=None, size=None, snapshot_id=None, __props__=None, __name__=None, __opts__=None)

Provides a DigitalOcean Block Storage volume which can be attached to a Droplet in order to provide expanded storage.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • description (pulumi.Input[str]) – A free-form text field up to a limit of 1024 bytes to describe a block storage volume.

  • filesystem_type (pulumi.Input[str]) – Filesystem type (xfs or ext4) for the block storage volume.

  • initial_filesystem_label (pulumi.Input[str]) – Initial filesystem label for the block storage volume.

  • initial_filesystem_type (pulumi.Input[str]) – Initial filesystem type (xfs or ext4) for the block storage volume.

  • name (pulumi.Input[str]) – A name for the block storage volume. Must be lowercase and be composed only of numbers, letters and “-“, up to a limit of 64 characters.

  • region (pulumi.Input[str]) – The region that the block storage volume will be created in.

  • size (pulumi.Input[float]) – The size of the block storage volume in GiB. If updated, can only be expanded.

  • snapshot_id (pulumi.Input[str]) – The ID of an existing volume snapshot from which the new volume will be created. If supplied, the region and size will be limitied on creation to that of the referenced snapshot

description = None

A free-form text field up to a limit of 1024 bytes to describe a block storage volume.

droplet_ids = None

A list of associated droplet ids.

filesystem_label = None

Filesystem label for the block storage volume.

filesystem_type = None

Filesystem type (xfs or ext4) for the block storage volume.

initial_filesystem_label = None

Initial filesystem label for the block storage volume.

initial_filesystem_type = None

Initial filesystem type (xfs or ext4) for the block storage volume.

name = None

A name for the block storage volume. Must be lowercase and be composed only of numbers, letters and “-“, up to a limit of 64 characters.

region = None

The region that the block storage volume will be created in.

size = None

The size of the block storage volume in GiB. If updated, can only be expanded.

snapshot_id = None

The ID of an existing volume snapshot from which the new volume will be created. If supplied, the region and size will be limitied on creation to that of the referenced snapshot

static get(resource_name, id, opts=None, description=None, droplet_ids=None, filesystem_label=None, filesystem_type=None, initial_filesystem_label=None, initial_filesystem_type=None, name=None, region=None, size=None, snapshot_id=None, urn=None)

Get an existing Volume resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • description (pulumi.Input[str]) – A free-form text field up to a limit of 1024 bytes to describe a block storage volume.

  • droplet_ids (pulumi.Input[list]) – A list of associated droplet ids.

  • filesystem_label (pulumi.Input[str]) – Filesystem label for the block storage volume.

  • filesystem_type (pulumi.Input[str]) – Filesystem type (xfs or ext4) for the block storage volume.

  • initial_filesystem_label (pulumi.Input[str]) – Initial filesystem label for the block storage volume.

  • initial_filesystem_type (pulumi.Input[str]) – Initial filesystem type (xfs or ext4) for the block storage volume.

  • name (pulumi.Input[str]) – A name for the block storage volume. Must be lowercase and be composed only of numbers, letters and “-“, up to a limit of 64 characters.

  • region (pulumi.Input[str]) – The region that the block storage volume will be created in.

  • size (pulumi.Input[float]) – The size of the block storage volume in GiB. If updated, can only be expanded.

  • snapshot_id (pulumi.Input[str]) – The ID of an existing volume snapshot from which the new volume will be created. If supplied, the region and size will be limitied on creation to that of the referenced snapshot

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_digitalocean.VolumeAttachment(resource_name, opts=None, droplet_id=None, volume_id=None, __props__=None, __name__=None, __opts__=None)

Manages attaching a Volume to a Droplet.

NOTE: Volumes can be attached either directly on the .Droplet resource, or using the .VolumeAttachment resource - but the two cannot be used together. If both are used against the same Droplet, the volume attachments will constantly drift.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • droplet_id (pulumi.Input[float]) – ID of the Droplet to attach the volume to.

  • volume_id (pulumi.Input[str]) – ID of the Volume to be attached to the Droplet.

droplet_id = None

ID of the Droplet to attach the volume to.

volume_id = None

ID of the Volume to be attached to the Droplet.

static get(resource_name, id, opts=None, droplet_id=None, volume_id=None)

Get an existing VolumeAttachment resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • droplet_id (pulumi.Input[float]) – ID of the Droplet to attach the volume to.

  • volume_id (pulumi.Input[str]) – ID of the Volume to be attached to the Droplet.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_digitalocean.VolumeSnapshot(resource_name, opts=None, name=None, volume_id=None, __props__=None, __name__=None, __opts__=None)

Provides a DigitalOcean Volume Snapshot which can be used to create a snapshot from an existing volume.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – A name for the volume snapshot.

  • volume_id (pulumi.Input[str]) – The ID of the volume from which the volume snapshot originated.

created_at = None

The date and time the volume snapshot was created.

min_disk_size = None

The minimum size in gigabytes required for a volume to be created based on this volume snapshot.

name = None

A name for the volume snapshot.

regions = None

A list of DigitalOcean region “slugs” indicating where the volume snapshot is available.

size = None

The billable size of the volume snapshot in gigabytes.

volume_id = None

The ID of the volume from which the volume snapshot originated.

static get(resource_name, id, opts=None, created_at=None, min_disk_size=None, name=None, regions=None, size=None, volume_id=None)

Get an existing VolumeSnapshot resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • created_at (pulumi.Input[str]) – The date and time the volume snapshot was created.

  • min_disk_size (pulumi.Input[float]) – The minimum size in gigabytes required for a volume to be created based on this volume snapshot.

  • name (pulumi.Input[str]) – A name for the volume snapshot.

  • regions (pulumi.Input[list]) – A list of DigitalOcean region “slugs” indicating where the volume snapshot is available.

  • size (pulumi.Input[float]) – The billable size of the volume snapshot in gigabytes.

  • volume_id (pulumi.Input[str]) – The ID of the volume from which the volume snapshot originated.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

pulumi_digitalocean.get_account(opts=None)

Get information on your DigitalOcean account.

pulumi_digitalocean.get_certificate(name=None, opts=None)

Use this data source to access information about an existing resource.

Parameters

name (str) – The name of certificate.

pulumi_digitalocean.get_database_cluster(name=None, tags=None, opts=None)

Provides information on a DigitalOcean database cluster resource.

Parameters

name (str) – The name of the database cluster.

pulumi_digitalocean.get_domain(name=None, opts=None)

Use this data source to access information about an existing resource.

Parameters

name (str) – The name of the domain.

pulumi_digitalocean.get_droplet(name=None, tag=None, opts=None)

Use this data source to access information about an existing resource.

Parameters
  • name (str) – The name of Droplet.

  • tag (str) – A tag applied to the Droplet.

pulumi_digitalocean.get_droplet_snapshot(most_recent=None, name=None, name_regex=None, region=None, opts=None)

Droplet snapshots are saved instances of a Droplet. Use this data source to retrieve the ID of a DigitalOcean Droplet snapshot for use in other resources.

Parameters
  • most_recent (bool) – If more than one result is returned, use the most recent Droplet snapshot.

  • name (str) – The name of the Droplet snapshot.

  • name_regex (str) – A regex string to apply to the Droplet snapshot list returned by DigitalOcean. This allows more advanced filtering not supported from the DigitalOcean API. This filtering is done locally on what DigitalOcean returns.

  • region (str) – A “slug” representing a DigitalOcean region (e.g. nyc1). If set, only Droplet snapshots available in the region will be returned.

pulumi_digitalocean.get_floating_ip(ip_address=None, opts=None)

Use this data source to access information about an existing resource.

Parameters

ip_address (str) – The allocated IP address of the specific floating IP to retrieve.

pulumi_digitalocean.get_image(name=None, slug=None, opts=None)

Use this data source to access information about an existing resource.

Parameters
  • name (str) – The name of the private image.

  • slug (str) – The slug of the official image.

pulumi_digitalocean.get_kubernetes_cluster(name=None, tags=None, opts=None)

Use this data source to access information about an existing resource.

Parameters

name (str) – The name of Kubernetes cluster.

pulumi_digitalocean.get_load_balancer(name=None, opts=None)

Use this data source to access information about an existing resource.

Parameters

name (str) – The name of load balancer.

pulumi_digitalocean.get_record(domain=None, name=None, opts=None)

Use this data source to access information about an existing resource.

Parameters
  • domain (str) – The domain name of the record.

  • name (str) – The name of the record.

pulumi_digitalocean.get_sizes(filters=None, sorts=None, opts=None)

Retrieves information about droplet sizes that DigitalOcean supports. This data source provides all of droplet size properties, with the ability to filter and sort the results.

Parameters
  • filters (list) – Filter the results. The filter block is documented below.

  • sorts (list) – Sort the results. The sort block is documented below.

The filters object supports the following:

  • key (str) - Sort the sizes by this key. This may be one of slug, memory, vcpus, disk, transfer, price_monthly, or price_hourly.

  • values (list) - Only retrieves images which keys has value that matches one of the values provided here.

The sorts object supports the following:

  • direction (str) - The sort direction. This may be either asc or desc.

  • key (str) - Sort the sizes by this key. This may be one of slug, memory, vcpus, disk, transfer, price_monthly, or price_hourly.

pulumi_digitalocean.get_ssh_key(name=None, opts=None)

Use this data source to access information about an existing resource.

Parameters

name (str) – The name of the ssh key.

pulumi_digitalocean.get_tag(name=None, opts=None)

Use this data source to access information about an existing resource.

Parameters

name (str) – The name of the tag.

pulumi_digitalocean.get_volume(description=None, name=None, region=None, opts=None)

Use this data source to access information about an existing resource.

Parameters
  • name (str) – The name of block storage volume.

  • region (str) – The region the block storage volume is provisioned in.

pulumi_digitalocean.get_volume_snapshot(most_recent=None, name=None, name_regex=None, region=None, opts=None)

Volume snapshots are saved instances of a block storage volume. Use this data source to retrieve the ID of a DigitalOcean volume snapshot for use in other resources.

Parameters
  • most_recent (bool) – If more than one result is returned, use the most recent volume snapshot.

  • name (str) – The name of the volume snapshot.

  • name_regex (str) – A regex string to apply to the volume snapshot list returned by DigitalOcean. This allows more advanced filtering not supported from the DigitalOcean API. This filtering is done locally on what DigitalOcean returns.

  • region (str) – A “slug” representing a DigitalOcean region (e.g. nyc1). If set, only volume snapshots available in the region will be returned.