Module types/output
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
- DatabaseClusterMaintenanceWindow
- DatabaseFirewallRule
- FirewallInboundRule
- FirewallOutboundRule
- FirewallPendingChange
- GetDatabaseClusterMaintenanceWindow
- GetDropletsDroplet
- GetDropletsFilter
- GetDropletsSort
- GetImagesFilter
- GetImagesImage
- GetImagesSort
- GetKubernetesClusterKubeConfig
- GetKubernetesClusterNodePool
- GetKubernetesClusterNodePoolNode
- GetLoadBalancerForwardingRule
- GetLoadBalancerHealthcheck
- GetLoadBalancerStickySessions
- GetProjectsFilter
- GetProjectsProject
- GetProjectsSort
- GetRegionsFilter
- GetRegionsRegion
- GetRegionsSort
- GetSizesFilter
- GetSizesSize
- GetSizesSort
- GetSpacesBucketsBucket
- GetSpacesBucketsFilter
- GetSpacesBucketsSort
- KubernetesClusterKubeConfig
- KubernetesClusterNodePool
- KubernetesClusterNodePoolNode
- KubernetesNodePoolNode
- LoadBalancerForwardingRule
- LoadBalancerHealthcheck
- LoadBalancerStickySessions
- SpacesBucketCorsRule
- SpacesBucketLifecycleRule
- SpacesBucketLifecycleRuleExpiration
- SpacesBucketLifecycleRuleNoncurrentVersionExpiration
- SpacesBucketVersioning
APIs
interface DatabaseClusterMaintenanceWindow
interface DatabaseClusterMaintenanceWindowproperty day
day: string;The day of the week on which to apply maintenance updates.
property hour
hour: string;The hour in UTC at which maintenance updates will be applied in 24 hour format.
interface DatabaseFirewallRule
interface DatabaseFirewallRuleproperty createdAt
createdAt: string;The date and time when the firewall rule was created.
property type
type: string;property uuid
uuid: string;A unique identifier for the firewall rule.
property value
value: string;interface FirewallInboundRule
interface FirewallInboundRuleproperty portRange
portRange?: undefined | 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: string;The type of traffic to be allowed. This may be one of “tcp”, “udp”, or “icmp”.
property sourceAddresses
sourceAddresses?: 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?: number[];An array containing the IDs of the Droplets from which the inbound traffic will be accepted.
property sourceLoadBalancerUids
sourceLoadBalancerUids?: string[];An array containing the IDs of the Load Balancers from which the inbound traffic will be accepted.
property sourceTags
sourceTags?: string[];An array containing the names of Tags corresponding to groups of Droplets from which the inbound traffic will be accepted.
interface FirewallOutboundRule
interface FirewallOutboundRuleproperty destinationAddresses
destinationAddresses?: 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?: number[];An array containing the IDs of the Droplets to which the outbound traffic will be allowed.
property destinationLoadBalancerUids
destinationLoadBalancerUids?: string[];An array containing the IDs of the Load Balancers to which the outbound traffic will be allowed.
property destinationTags
destinationTags?: 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?: undefined | 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: string;The type of traffic to be allowed. This may be one of “tcp”, “udp”, or “icmp”.
interface FirewallPendingChange
interface FirewallPendingChangeproperty dropletId
dropletId?: undefined | number;property removing
removing?: undefined | false | true;property status
status?: undefined | string;A status string indicating the current state of the Firewall. This can be “waiting”, “succeeded”, or “failed”.
interface GetDatabaseClusterMaintenanceWindow
interface GetDatabaseClusterMaintenanceWindowproperty day
day: string;The day of the week on which to apply maintenance updates.
property hour
hour: string;The hour in UTC at which maintenance updates will be applied in 24 hour format.
interface GetDropletsDroplet
interface GetDropletsDropletproperty backups
backups: boolean;property createdAt
createdAt: string;property disk
disk: number;property id
id: number;property image
image: string;property ipv4Address
ipv4Address: string;property ipv4AddressPrivate
ipv4AddressPrivate: string;property ipv6
ipv6: boolean;property ipv6Address
ipv6Address: string;property ipv6AddressPrivate
ipv6AddressPrivate: string;property locked
locked: boolean;property memory
memory: number;property monitoring
monitoring: boolean;property name
name: string;property priceHourly
priceHourly: number;property priceMonthly
priceMonthly: number;property privateNetworking
privateNetworking: boolean;property region
region: string;property size
size: string;property status
status: string;property tags
tags: string[];property urn
urn: string;property vcpus
vcpus: number;property volumeIds
volumeIds: string[];property vpcUuid
vpcUuid: string;interface GetDropletsFilter
interface GetDropletsFilterproperty 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 GetDropletsSortproperty 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 GetImagesFilterproperty 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 GetImagesImage
interface GetImagesImageproperty created
created: string;property distribution
distribution: string;property errorMessage
errorMessage: string;property id
id: number;property image
image: string;property minDiskSize
minDiskSize: number;property name
name: string;property private
private: boolean;property regions
regions: string[];property sizeGigabytes
sizeGigabytes: number;property slug
slug: string;property status
status: string;property tags
tags: string[];property type
type: string;interface GetImagesSort
interface GetImagesSortproperty 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 GetKubernetesClusterKubeConfig
interface GetKubernetesClusterKubeConfigproperty clientCertificate
clientCertificate: string;property clientKey
clientKey: string;property clusterCaCertificate
clusterCaCertificate: string;property expiresAt
expiresAt: string;property host
host: string;property rawConfig
rawConfig: string;property token
token: string;interface GetKubernetesClusterNodePool
interface GetKubernetesClusterNodePoolproperty actualNodeCount
actualNodeCount: number;property autoScale
autoScale: boolean;property id
id: string;The unique ID that can be used to identify and reference a Kubernetes cluster.
property labels
labels: {[key: string]: string};property maxNodes
maxNodes: number;property minNodes
minNodes: number;property name
name: string;The name of Kubernetes cluster.
property nodeCount
nodeCount: number;property nodes
nodes: GetKubernetesClusterNodePoolNode[];property size
size: string;property tags
tags?: string[];A list of tag names to be applied to the Kubernetes cluster.
interface GetKubernetesClusterNodePoolNode
interface GetKubernetesClusterNodePoolNodeproperty createdAt
createdAt: string;The date and time when the Kubernetes cluster was created.
property dropletId
dropletId: string;property id
id: string;The unique ID that can be used to identify and reference a Kubernetes cluster.
property name
name: string;The name of Kubernetes cluster.
property status
status: string;A string indicating the current status of the cluster. Potential values include running, provisioning, and errored.
property updatedAt
updatedAt: 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 GetLoadBalancerForwardingRule
interface GetLoadBalancerForwardingRuleproperty certificateId
certificateId: string;property entryPort
entryPort: number;property entryProtocol
entryProtocol: string;property targetPort
targetPort: number;property targetProtocol
targetProtocol: string;property tlsPassthrough
tlsPassthrough: boolean;interface GetLoadBalancerHealthcheck
interface GetLoadBalancerHealthcheckproperty checkIntervalSeconds
checkIntervalSeconds: number;property healthyThreshold
healthyThreshold: number;property path
path: string;property port
port: number;property protocol
protocol: string;property responseTimeoutSeconds
responseTimeoutSeconds: number;property unhealthyThreshold
unhealthyThreshold: number;interface GetLoadBalancerStickySessions
interface GetLoadBalancerStickySessionsproperty cookieName
cookieName: string;property cookieTtlSeconds
cookieTtlSeconds: number;property type
type: string;interface GetProjectsFilter
interface GetProjectsFilterproperty 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 GetProjectsProject
interface GetProjectsProjectproperty createdAt
createdAt: string;property description
description: string;property environment
environment: string;property id
id: string;property isDefault
isDefault: boolean;property name
name: string;property ownerId
ownerId: number;property ownerUuid
ownerUuid: string;property purpose
purpose: string;property resources
resources: string[];property updatedAt
updatedAt: string;interface GetProjectsSort
interface GetProjectsSortproperty 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 GetRegionsFilterproperty 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 GetRegionsRegion
interface GetRegionsRegionproperty available
available: boolean;property features
features: string[];property name
name: string;property sizes
sizes: string[];property slug
slug: string;interface GetRegionsSort
interface GetRegionsSortproperty 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 GetSizesFilterproperty 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 GetSizesSize
interface GetSizesSizeproperty available
available: boolean;This represents whether new Droplets can be created with this size.
property disk
disk: number;The amount of disk space set aside for Droplets of this size. The value is measured in gigabytes.
property memory
memory: number;The amount of RAM allocated to Droplets created of this size. The value is measured in megabytes.
property priceHourly
priceHourly: number;The hourly cost of Droplets created in this size as measured hourly. The value is measured in US dollars.
property priceMonthly
priceMonthly: number;The monthly cost of Droplets created in this size if they are kept for an entire month. The value is measured in US dollars.
property regions
regions: string[];List of region slugs where Droplets can be created in this size.
property slug
slug: string;A human-readable string that is used to uniquely identify each size.
property transfer
transfer: number;The amount of transfer bandwidth that is available for Droplets created in this size. This only counts traffic on the public interface. The value is given in terabytes.
property vcpus
vcpus: number;The number of CPUs allocated to Droplets of this size.
interface GetSizesSort
interface GetSizesSortproperty 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 GetSpacesBucketsBucket
interface GetSpacesBucketsBucketproperty bucketDomainName
bucketDomainName: string;property name
name: string;property region
region: string;property urn
urn: string;interface GetSpacesBucketsFilter
interface GetSpacesBucketsFilterproperty 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 GetSpacesBucketsSortproperty 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 KubernetesClusterKubeConfigproperty clientCertificate
clientCertificate: string;property clientKey
clientKey: string;property clusterCaCertificate
clusterCaCertificate: string;property expiresAt
expiresAt: string;property host
host: string;property rawConfig
rawConfig: string;property token
token: string;interface KubernetesClusterNodePool
interface KubernetesClusterNodePoolproperty actualNodeCount
actualNodeCount: number;property autoScale
autoScale?: undefined | false | true;property id
id: string;A unique ID that can be used to identify and reference a Kubernetes cluster.
property labels
labels?: undefined | {[key: string]: string};property maxNodes
maxNodes?: undefined | number;property minNodes
minNodes?: undefined | number;property name
name: string;A name for the Kubernetes cluster.
property nodeCount
nodeCount?: undefined | number;property nodes
nodes: KubernetesClusterNodePoolNode[];property size
size: string;property tags
tags?: string[];A list of tag names to be applied to the Kubernetes cluster.
interface KubernetesClusterNodePoolNode
interface KubernetesClusterNodePoolNodeproperty createdAt
createdAt: string;The date and time when the Kubernetes cluster was created.
property dropletId
dropletId: string;property id
id: string;A unique ID that can be used to identify and reference a Kubernetes cluster.
property name
name: string;A name for the Kubernetes cluster.
property status
status: string;A string indicating the current status of the cluster. Potential values include running, provisioning, and errored.
property updatedAt
updatedAt: 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 KubernetesNodePoolNodeproperty createdAt
createdAt: string;property dropletId
dropletId: string;property id
id: string;A unique ID that can be used to identify and reference the node pool.
property name
name: string;A name for the node pool.
property status
status: string;property updatedAt
updatedAt: string;interface LoadBalancerForwardingRule
interface LoadBalancerForwardingRuleproperty certificateId
certificateId?: undefined | string;The ID of the TLS certificate to be used for SSL termination.
property entryPort
entryPort: number;An integer representing the port on which the Load Balancer instance will listen.
property entryProtocol
entryProtocol: string;The protocol used for traffic to the Load Balancer. The possible values are: http, https, http2 or tcp.
property targetPort
targetPort: number;An integer representing the port on the backend Droplets to which the Load Balancer will send traffic.
property targetProtocol
targetProtocol: 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?: undefined | false | true;A boolean value indicating whether SSL encrypted traffic will be passed through to the backend Droplets. The default value is false.
interface LoadBalancerHealthcheck
interface LoadBalancerHealthcheckproperty checkIntervalSeconds
checkIntervalSeconds?: undefined | number;The number of seconds between between two consecutive health checks. If not specified, the default value is 10.
property healthyThreshold
healthyThreshold?: undefined | 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?: undefined | string;The path on the backend Droplets to which the Load Balancer instance will send a request.
property port
port: number;An integer representing the port on the backend Droplets on which the health check will attempt a connection.
property protocol
protocol: string;The protocol used for health checks sent to the backend Droplets. The possible values are http or tcp.
property responseTimeoutSeconds
responseTimeoutSeconds?: undefined | 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?: undefined | 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 LoadBalancerStickySessionsproperty cookieName
cookieName?: undefined | 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?: undefined | 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?: undefined | 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 SpacesBucketCorsRuleproperty allowedHeaders
allowedHeaders?: 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: string[];A list of HTTP methods (e.g. GET) which are allowed from the specified origin.
property allowedOrigins
allowedOrigins: 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?: undefined | number;The time in seconds that browser can cache the response for a preflight request.
interface SpacesBucketLifecycleRule
interface SpacesBucketLifecycleRuleproperty abortIncompleteMultipartUploadDays
abortIncompleteMultipartUploadDays?: undefined | 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: boolean;Specifies lifecycle rule status.
property expiration
expiration?: outputs.SpacesBucketLifecycleRuleExpiration;Specifies a time period after which applicable objects expire (documented below).
property id
id: string;Unique identifier for the rule.
property noncurrentVersionExpiration
noncurrentVersionExpiration?: outputs.SpacesBucketLifecycleRuleNoncurrentVersionExpiration;Specifies when non-current object versions expire (documented below).
property prefix
prefix?: undefined | string;Object key prefix identifying one or more objects to which the rule applies.
interface SpacesBucketLifecycleRuleExpiration
interface SpacesBucketLifecycleRuleExpirationproperty date
date?: undefined | 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?: undefined | number;Specifies the number of days after object creation when the applicable objects will expire.
property expiredObjectDeleteMarker
expiredObjectDeleteMarker?: undefined | false | true;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 SpacesBucketLifecycleRuleNoncurrentVersionExpirationproperty days
days?: undefined | number;Specifies the number of days after which an object’s non-current versions expire.
interface SpacesBucketVersioning
interface SpacesBucketVersioningproperty enabled
enabled?: undefined | false | true;Enable versioning. Once you version-enable a bucket, it can never return to an unversioned state. You can, however, suspend versioning on that bucket.