1. Docs
  2. Reference
  3. API
  4. @pulumi/digitalocean
  5. types
  6. input

Module types/input

This page documents the language specification for the digitalocean package. If you're looking for help working with the inputs, outputs, or functions of digitalocean resources in a Pulumi program, please see the resource documentation for examples and API reference.

APIs

APIs

interface DatabaseClusterMaintenanceWindow

interface DatabaseClusterMaintenanceWindow

property day

day: pulumi.Input<string>;

The day of the week on which to apply maintenance updates.

property hour

hour: pulumi.Input<string>;

The hour in UTC at which maintenance updates will be applied in 24 hour format.

interface DatabaseFirewallRule

interface DatabaseFirewallRule

property createdAt

createdAt?: pulumi.Input<string>;

The date and time when the firewall rule was created.

property type

type: pulumi.Input<string>;

property uuid

uuid?: pulumi.Input<string>;

A unique identifier for the firewall rule.

property value

value: pulumi.Input<string>;

interface FirewallInboundRule

interface FirewallInboundRule

property portRange

portRange?: pulumi.Input<string>;

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.

property protocol

protocol: pulumi.Input<string>;

The type of traffic to be allowed. This may be one of “tcp”, “udp”, or “icmp”.

property sourceAddresses

sourceAddresses?: pulumi.Input<pulumi.Input<string>[]>;

An array of strings containing the IPv4 addresses, IPv6 addresses, IPv4 CIDRs, and/or IPv6 CIDRs from which the inbound traffic will be accepted.

property sourceDropletIds

sourceDropletIds?: pulumi.Input<pulumi.Input<number>[]>;

An array containing the IDs of the Droplets from which the inbound traffic will be accepted.

property sourceLoadBalancerUids

sourceLoadBalancerUids?: pulumi.Input<pulumi.Input<string>[]>;

An array containing the IDs of the Load Balancers from which the inbound traffic will be accepted.

property sourceTags

sourceTags?: pulumi.Input<pulumi.Input<string>[]>;

An array containing the names of Tags corresponding to groups of Droplets from which the inbound traffic will be accepted.

interface FirewallOutboundRule

interface FirewallOutboundRule

property destinationAddresses

destinationAddresses?: pulumi.Input<pulumi.Input<string>[]>;

An array of strings containing the IPv4 addresses, IPv6 addresses, IPv4 CIDRs, and/or IPv6 CIDRs to which the outbound traffic will be allowed.

property destinationDropletIds

destinationDropletIds?: pulumi.Input<pulumi.Input<number>[]>;

An array containing the IDs of the Droplets to which the outbound traffic will be allowed.

property destinationLoadBalancerUids

destinationLoadBalancerUids?: pulumi.Input<pulumi.Input<string>[]>;

An array containing the IDs of the Load Balancers to which the outbound traffic will be allowed.

property destinationTags

destinationTags?: pulumi.Input<pulumi.Input<string>[]>;

An array containing the names of Tags corresponding to groups of Droplets to which the outbound traffic will be allowed. traffic.

property portRange

portRange?: pulumi.Input<string>;

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.

property protocol

protocol: pulumi.Input<string>;

The type of traffic to be allowed. This may be one of “tcp”, “udp”, or “icmp”.

interface FirewallPendingChange

interface FirewallPendingChange

property dropletId

dropletId?: pulumi.Input<number>;

property removing

removing?: pulumi.Input<boolean>;

property status

status?: pulumi.Input<string>;

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

interface GetDropletsFilter

interface GetDropletsFilter

property key

key: string;

Filter the Droplets by this key. This may be one of ‘backups, createdAt, disk, id, image, ipv4Address, ipv4AddressPrivate, ipv6, ipv6Address, ipv6AddressPrivate, locked, memory, monitoring, name, priceHourly, priceMonthly, privateNetworking, region, size, status, tags, urn, vcpus, volumeIds, or vpcUuid’.

property values

values: string[];

A list of values to match against the key field. Only retrieves Droplets where the key field takes on one or more of the values provided here.

interface GetDropletsSort

interface GetDropletsSort

property direction

direction?: undefined | string;

The sort direction. This may be either asc or desc.

property key

key: string;

Sort the Droplets by this key. This may be one of backups, createdAt, disk, id, image, ipv4Address, ipv4AddressPrivate, ipv6, ipv6Address, ipv6AddressPrivate, locked, memory, monitoring, name, priceHourly, priceMonthly, privateNetworking, region, size, status, urn, vcpus, or vpcUuid.

interface GetImagesFilter

interface GetImagesFilter

property key

key: string;

Filter the images by this key. This may be one of distribution, errorMessage, id, image, minDiskSize, name, private, regions, sizeGigabytes, slug, status, tags, or type.

property values

values: string[];

A list of values to match against the key field. Only retrieves images where the key field takes on one or more of the values provided here.

interface GetImagesSort

interface GetImagesSort

property direction

direction?: undefined | string;

The sort direction. This may be either asc or desc.

property key

key: string;

Sort the images by this key. This may be one of distribution, errorMessage, id, image, minDiskSize, name, private, sizeGigabytes, slug, status, or type.

interface GetProjectsFilter

interface GetProjectsFilter

property key

key: string;

Filter the projects by this key. This may be one of name, purpose, description, environment, or isDefault.

property values

values: string[];

A list of values to match against the key field. Only retrieves projects where the key field takes on one or more of the values provided here.

interface GetProjectsSort

interface GetProjectsSort

property direction

direction?: undefined | string;

The sort direction. This may be either asc or desc.

property key

key: string;

Sort the projects by this key. This may be one of name, purpose, description, or environment.

interface GetRegionsFilter

interface GetRegionsFilter

property key

key: string;

Filter the regions by this key. This may be one of slug, name, available, features, or sizes.

property values

values: string[];

A list of values to match against the key field. Only retrieves regions where the key field takes on one or more of the values provided here.

interface GetRegionsSort

interface GetRegionsSort

property direction

direction?: undefined | string;

The sort direction. This may be either asc or desc.

property key

key: string;

Sort the regions by this key. This may be one of slug, name, or available.

interface GetSizesFilter

interface GetSizesFilter

property key

key: string;

Filter the sizes by this key. This may be one of slug, regions, memory, vcpus, disk, transfer, priceMonthly, priceHourly, or available.

property values

values: string[];

Only retrieves images which keys has value that matches one of the values provided here.

interface GetSizesSort

interface GetSizesSort

property direction

direction?: undefined | string;

The sort direction. This may be either asc or desc.

property key

key: string;

Sort the sizes by this key. This may be one of slug, memory, vcpus, disk, transfer, priceMonthly, or priceHourly.

interface GetSpacesBucketsFilter

interface GetSpacesBucketsFilter

property key

key: string;

Filter the images by this key. This may be one of bucketDomainName, name, region, or urn.

property values

values: string[];

A list of values to match against the key field. Only retrieves images where the key field takes on one or more of the values provided here.

interface GetSpacesBucketsSort

interface GetSpacesBucketsSort

property direction

direction?: undefined | string;

The sort direction. This may be either asc or desc.

property key

key: string;

Sort the images by this key. This may be one of bucketDomainName, name, region, or urn.

interface KubernetesClusterKubeConfig

interface KubernetesClusterKubeConfig

property clientCertificate

clientCertificate?: pulumi.Input<string>;

property clientKey

clientKey?: pulumi.Input<string>;

property clusterCaCertificate

clusterCaCertificate?: pulumi.Input<string>;

property expiresAt

expiresAt?: pulumi.Input<string>;

property host

host?: pulumi.Input<string>;

property rawConfig

rawConfig?: pulumi.Input<string>;

property token

token?: pulumi.Input<string>;

interface KubernetesClusterNodePool

interface KubernetesClusterNodePool

property actualNodeCount

actualNodeCount?: pulumi.Input<number>;

property autoScale

autoScale?: pulumi.Input<boolean>;

property id

id?: pulumi.Input<string>;

A unique ID that can be used to identify and reference a Kubernetes cluster.

property labels

labels?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

property maxNodes

maxNodes?: pulumi.Input<number>;

property minNodes

minNodes?: pulumi.Input<number>;

property name

name: pulumi.Input<string>;

A name for the Kubernetes cluster.

property nodeCount

nodeCount?: pulumi.Input<number>;

property nodes

nodes?: pulumi.Input<pulumi.Input<KubernetesClusterNodePoolNode>[]>;

property size

size: pulumi.Input<string>;

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

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

interface KubernetesClusterNodePoolNode

interface KubernetesClusterNodePoolNode

property createdAt

createdAt?: pulumi.Input<string>;

The date and time when the Kubernetes cluster was created.

property dropletId

dropletId?: pulumi.Input<string>;

property id

id?: pulumi.Input<string>;

A unique ID that can be used to identify and reference a Kubernetes cluster.

property name

name?: pulumi.Input<string>;

A name for the Kubernetes cluster.

property status

status?: pulumi.Input<string>;

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

property updatedAt

updatedAt?: pulumi.Input<string>;

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: - rawConfig - The full contents of the Kubernetes cluster’s kubeconfig file. - host - The URL of the API server on the Kubernetes master node. - clusterCaCertificate - The base64 encoded public certificate for the cluster’s certificate authority. - token - The DigitalOcean API access token used by clients to access the cluster. - clientKey - The base64 encoded private key used by clients to access the cluster. Only available if token authentication is not supported on your cluster. - clientCertificate - The base64 encoded public certificate used by clients to access the cluster. Only available if token authentication is not supported on your cluster. - expiresAt - The date and time when the credentials will expire and need to be regenerated.

interface KubernetesNodePoolNode

interface KubernetesNodePoolNode

property createdAt

createdAt?: pulumi.Input<string>;

property dropletId

dropletId?: pulumi.Input<string>;

property id

id?: pulumi.Input<string>;

A unique ID that can be used to identify and reference the node pool.

property name

name?: pulumi.Input<string>;

A name for the node pool.

property status

status?: pulumi.Input<string>;

property updatedAt

updatedAt?: pulumi.Input<string>;

interface LoadBalancerForwardingRule

interface LoadBalancerForwardingRule

property certificateId

certificateId?: pulumi.Input<string>;

The ID of the TLS certificate to be used for SSL termination.

property entryPort

entryPort: pulumi.Input<number>;

An integer representing the port on which the Load Balancer instance will listen.

property entryProtocol

entryProtocol: pulumi.Input<string>;

The protocol used for traffic to the Load Balancer. The possible values are: http, https, http2 or tcp.

property targetPort

targetPort: pulumi.Input<number>;

An integer representing the port on the backend Droplets to which the Load Balancer will send traffic.

property targetProtocol

targetProtocol: pulumi.Input<string>;

The protocol used for traffic from the Load Balancer to the backend Droplets. The possible values are: http, https, http2 or tcp.

property tlsPassthrough

tlsPassthrough?: pulumi.Input<boolean>;

A boolean value indicating whether SSL encrypted traffic will be passed through to the backend Droplets. The default value is false.

interface LoadBalancerHealthcheck

interface LoadBalancerHealthcheck

property checkIntervalSeconds

checkIntervalSeconds?: pulumi.Input<number>;

The number of seconds between between two consecutive health checks. If not specified, the default value is 10.

property healthyThreshold

healthyThreshold?: pulumi.Input<number>;

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.

property path

path?: pulumi.Input<string>;

The path on the backend Droplets to which the Load Balancer instance will send a request.

property port

port: pulumi.Input<number>;

An integer representing the port on the backend Droplets on which the health check will attempt a connection.

property protocol

protocol: pulumi.Input<string>;

The protocol used for health checks sent to the backend Droplets. The possible values are http or tcp.

property responseTimeoutSeconds

responseTimeoutSeconds?: pulumi.Input<number>;

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.

property unhealthyThreshold

unhealthyThreshold?: pulumi.Input<number>;

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.

interface LoadBalancerStickySessions

interface LoadBalancerStickySessions

property cookieName

cookieName?: pulumi.Input<string>;

The name to be used for the cookie sent to the client. This attribute is required when using cookies for the sticky sessions type.

property cookieTtlSeconds

cookieTtlSeconds?: pulumi.Input<number>;

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.

property type

type?: pulumi.Input<string>;

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.

interface SpacesBucketCorsRule

interface SpacesBucketCorsRule

property allowedHeaders

allowedHeaders?: pulumi.Input<pulumi.Input<string>[]>;

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-*).

property allowedMethods

allowedMethods: pulumi.Input<pulumi.Input<string>[]>;

A list of HTTP methods (e.g. GET) which are allowed from the specified origin.

property allowedOrigins

allowedOrigins: pulumi.Input<pulumi.Input<string>[]>;

A list of hosts from which requests using the specified methods are allowed. A host may contain one wildcard (e.g. http://*.example.com).

property maxAgeSeconds

maxAgeSeconds?: pulumi.Input<number>;

The time in seconds that browser can cache the response for a preflight request.

interface SpacesBucketLifecycleRule

interface SpacesBucketLifecycleRule

property abortIncompleteMultipartUploadDays

abortIncompleteMultipartUploadDays?: pulumi.Input<number>;

Specifies the number of days after initiating a multipart upload when the multipart upload must be completed or else Spaces will abort the upload.

property enabled

enabled: pulumi.Input<boolean>;

Specifies lifecycle rule status.

property expiration

expiration?: pulumi.Input<SpacesBucketLifecycleRuleExpiration>;

Specifies a time period after which applicable objects expire (documented below).

property id

id?: pulumi.Input<string>;

Unique identifier for the rule.

property noncurrentVersionExpiration

noncurrentVersionExpiration?: pulumi.Input<SpacesBucketLifecycleRuleNoncurrentVersionExpiration>;

Specifies when non-current object versions expire (documented below).

property prefix

prefix?: pulumi.Input<string>;

Object key prefix identifying one or more objects to which the rule applies.

interface SpacesBucketLifecycleRuleExpiration

interface SpacesBucketLifecycleRuleExpiration

property date

date?: pulumi.Input<string>;

Specifies the date/time after which you want applicable objects to expire. The argument uses RFC3339 format, e.g. “2020-03-22T15:03:55Z” or parts thereof e.g. “2019-02-28”.

property days

days?: pulumi.Input<number>;

Specifies the number of days after object creation when the applicable objects will expire.

property expiredObjectDeleteMarker

expiredObjectDeleteMarker?: pulumi.Input<boolean>;

On a versioned bucket (versioning-enabled or versioning-suspended bucket), setting this to true directs Spaces to delete expired object delete markers.

interface SpacesBucketLifecycleRuleNoncurrentVersionExpiration

interface SpacesBucketLifecycleRuleNoncurrentVersionExpiration

property days

days?: pulumi.Input<number>;

Specifies the number of days after which an object’s non-current versions expire.

interface SpacesBucketVersioning

interface SpacesBucketVersioning

property enabled

enabled?: pulumi.Input<boolean>;

Enable versioning. Once you version-enable a bucket, it can never return to an unversioned state. You can, however, suspend versioning on that bucket.