spotinst.aws.Ocean
Scheduled Task
scheduled_task
- (Optional) Set scheduling object.shutdown_hours
- (Optional) Set shutdown hours for cluster object.is_enabled
- (Optional) Toggle the shutdown hours task. (Example:true
).time_windows
- (Required) Set time windows for shutdown hours. Specify a list oftimeWindows
with at least one time window Each string is in the format of:ddd:hh:mm-ddd:hh:mm
whereddd
= day of week = Sun | Mon | Tue | Wed | Thu | Fri | Sat,hh
= hour 24 = 0 -23,mm
= minute = 0 - 59. Time windows should not overlap. Required ifcluster.scheduling.isEnabled
istrue
. (Example:Fri:15:30-Wed:14:30
).
tasks
- (Optional) The scheduling tasks for the cluster.is_enabled
- (Required) Describes whether the task is enabled. When true the task should run when false it should not run. Required forcluster.scheduling.tasks
object.cron_expression
- (Required) A valid cron expression. The cron is running in UTC time zone and is in Unix cron format Cron Expression Validator Script. Only one offrequency
orcronExpression
should be used at a time. Required forcluster.scheduling.tasks
object. (Example:0 1 * * *
).task_type
- (Required) Valid values:clusterRoll
. Required forcluster.scheduling.tasks
object. (Example:clusterRoll
).
import * as pulumi from "@pulumi/pulumi";
import pulumi
using System.Collections.Generic;
using Pulumi;
return await Deployment.RunAsync(() =>
{
});
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
}
}
{}
Example Usage
using System.Collections.Generic;
using Pulumi;
return await Deployment.RunAsync(() =>
{
return new Dictionary<string, object?>
{
["oceanId"] = spotinst_ocean_aws.Example.Id,
};
});
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
ctx.Export("oceanId", spotinst_ocean_aws.Example.Id)
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.spotinst.aws.Ocean;
import com.pulumi.spotinst.aws.OceanArgs;
import com.pulumi.spotinst.aws.inputs.OceanClusterOrientationArgs;
import com.pulumi.spotinst.aws.inputs.OceanInstanceMetadataOptionsArgs;
import com.pulumi.spotinst.aws.inputs.OceanLoadBalancerArgs;
import com.pulumi.spotinst.aws.inputs.OceanLoggingArgs;
import com.pulumi.spotinst.aws.inputs.OceanLoggingExportArgs;
import com.pulumi.spotinst.aws.inputs.OceanTagArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Ocean("example", OceanArgs.builder()
.associatePublicIpAddress(true)
.clusterOrientations(OceanClusterOrientationArgs.builder()
.availabilityVsCost("balanced")
.build())
.controllerId("ocean-dev")
.desiredCapacity(2)
.drainingTimeout(120)
.ebsOptimized(true)
.fallbackToOndemand(true)
.gracePeriod(600)
.iamInstanceProfile("iam-profile")
.imageId("ami-123456")
.instanceTypes(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.instanceMetadataOptions(OceanInstanceMetadataOptionsArgs.builder()
.httpPutResponseHopLimit(10)
.httpTokens("required")
.build())
.keyName("fake key")
.loadBalancers(
OceanLoadBalancerArgs.builder()
.arn("arn:aws:elasticloadbalancing:us-west-2:fake-arn")
.type("TARGET_GROUP")
.build(),
OceanLoadBalancerArgs.builder()
.name("example")
.type("CLASSIC")
.build())
.logging(OceanLoggingArgs.builder()
.export(OceanLoggingExportArgs.builder()
.s3(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.build())
.build())
.maxSize(2)
.minSize(1)
.monitoring(true)
.region("us-west-2")
.rootVolumeSize(20)
.securityGroups("sg-987654321")
.spotPercentage(100)
.subnetIds("subnet-123456789")
.tags(OceanTagArgs.builder()
.key("fakeKey")
.value("fakeValue")
.build())
.useAsTemplateOnly(true)
.userData("echo hello world")
.utilizeCommitments(false)
.utilizeReservedInstances(false)
.build());
}
}
import pulumi
pulumi.export("oceanId", spotinst_ocean_aws["example"]["id"])
import * as pulumi from "@pulumi/pulumi";
export const oceanId = spotinst_ocean_aws.example.id;
resources:
example:
type: spotinst:aws:Ocean
properties:
associatePublicIpAddress: true
clusterOrientations:
- availabilityVsCost: balanced
controllerId: ocean-dev
desiredCapacity: 2
drainingTimeout: 120
ebsOptimized: true
# region STRATEGY
fallbackToOndemand: true
gracePeriod: 600
iamInstanceProfile: iam-profile
# region LAUNCH CONFIGURATION
imageId: ami-123456
instanceTypes:
- filters:
- architectures:
- x86_64
- i386
categories:
- Accelerated_computing
- Compute_optimized
diskTypes:
- EBS
- SSD
excludeFamilies:
- m*
excludeMetal: false
hypervisor:
- xen
includeFamilies:
- c*
- t*
isEnaSupported: false
maxGpu: 4
maxMemoryGib: 16
maxNetworkPerformance: 20
maxVcpu: 16
minEnis: 2
minGpu: 0
minMemoryGib: 8
minNetworkPerformance: 2
minVcpu: 2
rootDeviceTypes:
- ebs
virtualizationTypes:
- hvm
instanceMetadataOptions:
httpPutResponseHopLimit: 10
httpTokens: required
keyName: fake key
loadBalancers:
- arn: arn:aws:elasticloadbalancing:us-west-2:fake-arn
type: TARGET_GROUP
- name: example
type: CLASSIC
logging:
export:
s3:
- id: di-abcd123
maxSize: 2
minSize: 1
monitoring: true
region: us-west-2
rootVolumeSize: 20
securityGroups:
- sg-987654321
spotPercentage: 100
subnetIds:
- subnet-123456789
tags:
- key: fakeKey
value: fakeValue
useAsTemplateOnly: true
userData: echo hello world
utilizeCommitments: false
utilizeReservedInstances: false
using System.Collections.Generic;
using Pulumi;
return await Deployment.RunAsync(() =>
{
});
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
ctx.export("oceanId", spotinst_ocean_aws.example().id());
}
}
import pulumi
import * as pulumi from "@pulumi/pulumi";
outputs:
oceanId: ${spotinst_ocean_aws.example.id}
).
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
}
}
Coming soon!
Coming soon!
{}
Create Ocean Resource
new Ocean(name: string, args: OceanArgs, opts?: CustomResourceOptions);
@overload
def Ocean(resource_name: str,
opts: Optional[ResourceOptions] = None,
associate_public_ip_address: Optional[bool] = None,
autoscaler: Optional[OceanAutoscalerArgs] = None,
blacklists: Optional[Sequence[str]] = None,
cluster_orientations: Optional[Sequence[OceanClusterOrientationArgs]] = None,
controller_id: Optional[str] = None,
desired_capacity: Optional[int] = None,
draining_timeout: Optional[int] = None,
ebs_optimized: Optional[bool] = None,
fallback_to_ondemand: Optional[bool] = None,
filters: Optional[OceanFiltersArgs] = None,
grace_period: Optional[int] = None,
iam_instance_profile: Optional[str] = None,
image_id: Optional[str] = None,
instance_metadata_options: Optional[OceanInstanceMetadataOptionsArgs] = None,
key_name: Optional[str] = None,
load_balancers: Optional[Sequence[OceanLoadBalancerArgs]] = None,
logging: Optional[OceanLoggingArgs] = None,
max_size: Optional[int] = None,
min_size: Optional[int] = None,
monitoring: Optional[bool] = None,
name: Optional[str] = None,
region: Optional[str] = None,
root_volume_size: Optional[int] = None,
scheduled_tasks: Optional[Sequence[OceanScheduledTaskArgs]] = None,
security_groups: Optional[Sequence[str]] = None,
spot_percentage: Optional[int] = None,
subnet_ids: Optional[Sequence[str]] = None,
tags: Optional[Sequence[OceanTagArgs]] = None,
update_policy: Optional[OceanUpdatePolicyArgs] = None,
use_as_template_only: Optional[bool] = None,
user_data: Optional[str] = None,
utilize_commitments: Optional[bool] = None,
utilize_reserved_instances: Optional[bool] = None,
whitelists: Optional[Sequence[str]] = None)
@overload
def Ocean(resource_name: str,
args: OceanArgs,
opts: Optional[ResourceOptions] = None)
func NewOcean(ctx *Context, name string, args OceanArgs, opts ...ResourceOption) (*Ocean, error)
public Ocean(string name, OceanArgs args, CustomResourceOptions? opts = null)
type: spotinst:aws:Ocean
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OceanArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args OceanArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args OceanArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OceanArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args OceanArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Ocean Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Ocean resource accepts the following input properties:
- Security
Groups List<string> One or more security group ids.
- Subnet
Ids List<string> A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public IP.
- Associate
Public boolIp Address Configure public IP address allocation.
- Autoscaler
Pulumi.
Spot Inst. Aws. Inputs. Ocean Autoscaler Args Describes the Ocean Kubernetes Auto Scaler.
- Blacklists List<string>
Instance types not allowed in the Ocean cluster. Cannot be configured if
whitelist
is configured.- Cluster
Orientations List<Pulumi.Spot Inst. Aws. Inputs. Ocean Cluster Orientation Args> - Controller
Id string A unique identifier used for connecting the Ocean SaaS platform and the Kubernetes cluster. Typically, the cluster name is used as its identifier.
- Desired
Capacity int The number of instances to launch and maintain in the cluster.
- Draining
Timeout int The time in seconds, the instance is allowed to run while detached from the ELB. This is to allow the instance time to be drained from incoming TCP connections before terminating it, during a scale down operation.
- Ebs
Optimized bool Enable EBS optimized for cluster. Flag will enable optimized capacity for high bandwidth connectivity to the EB service for non EBS optimized instance types. For instances that are EBS optimized this flag will be ignored.
- Fallback
To boolOndemand If not Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
- Filters
Pulumi.
Spot Inst. Aws. Inputs. Ocean Filters Args List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. Cannot be configured together with whitelist/blacklist.
- Grace
Period int The amount of time, in seconds, after the instance has launched to start checking its health.
- Iam
Instance stringProfile The instance profile iam role.
- Image
Id string ID of the image used to launch the instances.
- Instance
Metadata Pulumi.Options Spot Inst. Aws. Inputs. Ocean Instance Metadata Options Args Ocean instance metadata options object for IMDSv2.
- Key
Name string The key pair to attach the instances.
- Load
Balancers List<Pulumi.Spot Inst. Aws. Inputs. Ocean Load Balancer Args> Array of load balancer objects to add to ocean cluster
- Logging
Pulumi.
Spot Inst. Aws. Inputs. Ocean Logging Args Logging configuration.
- Max
Size int The upper limit of instances the cluster can scale up to.
- Min
Size int The lower limit of instances the cluster can scale down to.
- Monitoring bool
Enable detailed monitoring for cluster. Flag will enable Cloud Watch detailed monitoring (one minute increments). Note: there are additional hourly costs for this service based on the region used.
- Name string
Required if type is set to
CLASSIC
- Region string
The region the cluster will run in.
- Root
Volume intSize The size (in Gb) to allocate for the root volume. Minimum
20
.- Scheduled
Tasks List<Pulumi.Spot Inst. Aws. Inputs. Ocean Scheduled Task Args> - Spot
Percentage int The percentage of Spot instances that would spin up from the
desired_capacity
number.- List<Pulumi.
Spot Inst. Aws. Inputs. Ocean Tag Args> Optionally adds tags to instances launched in an Ocean cluster.
- Update
Policy Pulumi.Spot Inst. Aws. Inputs. Ocean Update Policy Args - Use
As boolTemplate Only launch specification defined on the Ocean object will function only as a template for virtual node groups. When set to true, on Ocean resource creation please make sure your custom VNG has an initial_nodes parameter to create nodes for your VNG.
- User
Data string Base64-encoded MIME user data to make available to the instances.
- Utilize
Commitments bool If savings plans exist, Ocean will utilize them before launching Spot instances.
- Utilize
Reserved boolInstances If Reserved instances exist, Ocean will utilize them before launching Spot instances.
- Whitelists List<string>
Instance types allowed in the Ocean cluster. Cannot be configured if
blacklist
is configured.
- Security
Groups []string One or more security group ids.
- Subnet
Ids []string A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public IP.
- Associate
Public boolIp Address Configure public IP address allocation.
- Autoscaler
Ocean
Autoscaler Args Describes the Ocean Kubernetes Auto Scaler.
- Blacklists []string
Instance types not allowed in the Ocean cluster. Cannot be configured if
whitelist
is configured.- Cluster
Orientations []OceanCluster Orientation Args - Controller
Id string A unique identifier used for connecting the Ocean SaaS platform and the Kubernetes cluster. Typically, the cluster name is used as its identifier.
- Desired
Capacity int The number of instances to launch and maintain in the cluster.
- Draining
Timeout int The time in seconds, the instance is allowed to run while detached from the ELB. This is to allow the instance time to be drained from incoming TCP connections before terminating it, during a scale down operation.
- Ebs
Optimized bool Enable EBS optimized for cluster. Flag will enable optimized capacity for high bandwidth connectivity to the EB service for non EBS optimized instance types. For instances that are EBS optimized this flag will be ignored.
- Fallback
To boolOndemand If not Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
- Filters
Ocean
Filters Args List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. Cannot be configured together with whitelist/blacklist.
- Grace
Period int The amount of time, in seconds, after the instance has launched to start checking its health.
- Iam
Instance stringProfile The instance profile iam role.
- Image
Id string ID of the image used to launch the instances.
- Instance
Metadata OceanOptions Instance Metadata Options Args Ocean instance metadata options object for IMDSv2.
- Key
Name string The key pair to attach the instances.
- Load
Balancers []OceanLoad Balancer Args Array of load balancer objects to add to ocean cluster
- Logging
Ocean
Logging Args Logging configuration.
- Max
Size int The upper limit of instances the cluster can scale up to.
- Min
Size int The lower limit of instances the cluster can scale down to.
- Monitoring bool
Enable detailed monitoring for cluster. Flag will enable Cloud Watch detailed monitoring (one minute increments). Note: there are additional hourly costs for this service based on the region used.
- Name string
Required if type is set to
CLASSIC
- Region string
The region the cluster will run in.
- Root
Volume intSize The size (in Gb) to allocate for the root volume. Minimum
20
.- Scheduled
Tasks []OceanScheduled Task Args - Spot
Percentage int The percentage of Spot instances that would spin up from the
desired_capacity
number.- []Ocean
Tag Args Optionally adds tags to instances launched in an Ocean cluster.
- Update
Policy OceanUpdate Policy Args - Use
As boolTemplate Only launch specification defined on the Ocean object will function only as a template for virtual node groups. When set to true, on Ocean resource creation please make sure your custom VNG has an initial_nodes parameter to create nodes for your VNG.
- User
Data string Base64-encoded MIME user data to make available to the instances.
- Utilize
Commitments bool If savings plans exist, Ocean will utilize them before launching Spot instances.
- Utilize
Reserved boolInstances If Reserved instances exist, Ocean will utilize them before launching Spot instances.
- Whitelists []string
Instance types allowed in the Ocean cluster. Cannot be configured if
blacklist
is configured.
- security
Groups List<String> One or more security group ids.
- subnet
Ids List<String> A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public IP.
- associate
Public BooleanIp Address Configure public IP address allocation.
- autoscaler
Ocean
Autoscaler Args Describes the Ocean Kubernetes Auto Scaler.
- blacklists List<String>
Instance types not allowed in the Ocean cluster. Cannot be configured if
whitelist
is configured.- cluster
Orientations List<OceanCluster Orientation Args> - controller
Id String A unique identifier used for connecting the Ocean SaaS platform and the Kubernetes cluster. Typically, the cluster name is used as its identifier.
- desired
Capacity Integer The number of instances to launch and maintain in the cluster.
- draining
Timeout Integer The time in seconds, the instance is allowed to run while detached from the ELB. This is to allow the instance time to be drained from incoming TCP connections before terminating it, during a scale down operation.
- ebs
Optimized Boolean Enable EBS optimized for cluster. Flag will enable optimized capacity for high bandwidth connectivity to the EB service for non EBS optimized instance types. For instances that are EBS optimized this flag will be ignored.
- fallback
To BooleanOndemand If not Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
- filters
Ocean
Filters Args List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. Cannot be configured together with whitelist/blacklist.
- grace
Period Integer The amount of time, in seconds, after the instance has launched to start checking its health.
- iam
Instance StringProfile The instance profile iam role.
- image
Id String ID of the image used to launch the instances.
- instance
Metadata OceanOptions Instance Metadata Options Args Ocean instance metadata options object for IMDSv2.
- key
Name String The key pair to attach the instances.
- load
Balancers List<OceanLoad Balancer Args> Array of load balancer objects to add to ocean cluster
- logging
Ocean
Logging Args Logging configuration.
- max
Size Integer The upper limit of instances the cluster can scale up to.
- min
Size Integer The lower limit of instances the cluster can scale down to.
- monitoring Boolean
Enable detailed monitoring for cluster. Flag will enable Cloud Watch detailed monitoring (one minute increments). Note: there are additional hourly costs for this service based on the region used.
- name String
Required if type is set to
CLASSIC
- region String
The region the cluster will run in.
- root
Volume IntegerSize The size (in Gb) to allocate for the root volume. Minimum
20
.- scheduled
Tasks List<OceanScheduled Task Args> - spot
Percentage Integer The percentage of Spot instances that would spin up from the
desired_capacity
number.- List<Ocean
Tag Args> Optionally adds tags to instances launched in an Ocean cluster.
- update
Policy OceanUpdate Policy Args - use
As BooleanTemplate Only launch specification defined on the Ocean object will function only as a template for virtual node groups. When set to true, on Ocean resource creation please make sure your custom VNG has an initial_nodes parameter to create nodes for your VNG.
- user
Data String Base64-encoded MIME user data to make available to the instances.
- utilize
Commitments Boolean If savings plans exist, Ocean will utilize them before launching Spot instances.
- utilize
Reserved BooleanInstances If Reserved instances exist, Ocean will utilize them before launching Spot instances.
- whitelists List<String>
Instance types allowed in the Ocean cluster. Cannot be configured if
blacklist
is configured.
- security
Groups string[] One or more security group ids.
- subnet
Ids string[] A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public IP.
- associate
Public booleanIp Address Configure public IP address allocation.
- autoscaler
Ocean
Autoscaler Args Describes the Ocean Kubernetes Auto Scaler.
- blacklists string[]
Instance types not allowed in the Ocean cluster. Cannot be configured if
whitelist
is configured.- cluster
Orientations OceanCluster Orientation Args[] - controller
Id string A unique identifier used for connecting the Ocean SaaS platform and the Kubernetes cluster. Typically, the cluster name is used as its identifier.
- desired
Capacity number The number of instances to launch and maintain in the cluster.
- draining
Timeout number The time in seconds, the instance is allowed to run while detached from the ELB. This is to allow the instance time to be drained from incoming TCP connections before terminating it, during a scale down operation.
- ebs
Optimized boolean Enable EBS optimized for cluster. Flag will enable optimized capacity for high bandwidth connectivity to the EB service for non EBS optimized instance types. For instances that are EBS optimized this flag will be ignored.
- fallback
To booleanOndemand If not Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
- filters
Ocean
Filters Args List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. Cannot be configured together with whitelist/blacklist.
- grace
Period number The amount of time, in seconds, after the instance has launched to start checking its health.
- iam
Instance stringProfile The instance profile iam role.
- image
Id string ID of the image used to launch the instances.
- instance
Metadata OceanOptions Instance Metadata Options Args Ocean instance metadata options object for IMDSv2.
- key
Name string The key pair to attach the instances.
- load
Balancers OceanLoad Balancer Args[] Array of load balancer objects to add to ocean cluster
- logging
Ocean
Logging Args Logging configuration.
- max
Size number The upper limit of instances the cluster can scale up to.
- min
Size number The lower limit of instances the cluster can scale down to.
- monitoring boolean
Enable detailed monitoring for cluster. Flag will enable Cloud Watch detailed monitoring (one minute increments). Note: there are additional hourly costs for this service based on the region used.
- name string
Required if type is set to
CLASSIC
- region string
The region the cluster will run in.
- root
Volume numberSize The size (in Gb) to allocate for the root volume. Minimum
20
.- scheduled
Tasks OceanScheduled Task Args[] - spot
Percentage number The percentage of Spot instances that would spin up from the
desired_capacity
number.- Ocean
Tag Args[] Optionally adds tags to instances launched in an Ocean cluster.
- update
Policy OceanUpdate Policy Args - use
As booleanTemplate Only launch specification defined on the Ocean object will function only as a template for virtual node groups. When set to true, on Ocean resource creation please make sure your custom VNG has an initial_nodes parameter to create nodes for your VNG.
- user
Data string Base64-encoded MIME user data to make available to the instances.
- utilize
Commitments boolean If savings plans exist, Ocean will utilize them before launching Spot instances.
- utilize
Reserved booleanInstances If Reserved instances exist, Ocean will utilize them before launching Spot instances.
- whitelists string[]
Instance types allowed in the Ocean cluster. Cannot be configured if
blacklist
is configured.
- security_
groups Sequence[str] One or more security group ids.
- subnet_
ids Sequence[str] A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public IP.
- associate_
public_ boolip_ address Configure public IP address allocation.
- autoscaler
Ocean
Autoscaler Args Describes the Ocean Kubernetes Auto Scaler.
- blacklists Sequence[str]
Instance types not allowed in the Ocean cluster. Cannot be configured if
whitelist
is configured.- cluster_
orientations Sequence[OceanCluster Orientation Args] - controller_
id str A unique identifier used for connecting the Ocean SaaS platform and the Kubernetes cluster. Typically, the cluster name is used as its identifier.
- desired_
capacity int The number of instances to launch and maintain in the cluster.
- draining_
timeout int The time in seconds, the instance is allowed to run while detached from the ELB. This is to allow the instance time to be drained from incoming TCP connections before terminating it, during a scale down operation.
- ebs_
optimized bool Enable EBS optimized for cluster. Flag will enable optimized capacity for high bandwidth connectivity to the EB service for non EBS optimized instance types. For instances that are EBS optimized this flag will be ignored.
- fallback_
to_ boolondemand If not Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
- filters
Ocean
Filters Args List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. Cannot be configured together with whitelist/blacklist.
- grace_
period int The amount of time, in seconds, after the instance has launched to start checking its health.
- iam_
instance_ strprofile The instance profile iam role.
- image_
id str ID of the image used to launch the instances.
- instance_
metadata_ Oceanoptions Instance Metadata Options Args Ocean instance metadata options object for IMDSv2.
- key_
name str The key pair to attach the instances.
- load_
balancers Sequence[OceanLoad Balancer Args] Array of load balancer objects to add to ocean cluster
- logging
Ocean
Logging Args Logging configuration.
- max_
size int The upper limit of instances the cluster can scale up to.
- min_
size int The lower limit of instances the cluster can scale down to.
- monitoring bool
Enable detailed monitoring for cluster. Flag will enable Cloud Watch detailed monitoring (one minute increments). Note: there are additional hourly costs for this service based on the region used.
- name str
Required if type is set to
CLASSIC
- region str
The region the cluster will run in.
- root_
volume_ intsize The size (in Gb) to allocate for the root volume. Minimum
20
.- scheduled_
tasks Sequence[OceanScheduled Task Args] - spot_
percentage int The percentage of Spot instances that would spin up from the
desired_capacity
number.- Sequence[Ocean
Tag Args] Optionally adds tags to instances launched in an Ocean cluster.
- update_
policy OceanUpdate Policy Args - use_
as_ booltemplate_ only launch specification defined on the Ocean object will function only as a template for virtual node groups. When set to true, on Ocean resource creation please make sure your custom VNG has an initial_nodes parameter to create nodes for your VNG.
- user_
data str Base64-encoded MIME user data to make available to the instances.
- utilize_
commitments bool If savings plans exist, Ocean will utilize them before launching Spot instances.
- utilize_
reserved_ boolinstances If Reserved instances exist, Ocean will utilize them before launching Spot instances.
- whitelists Sequence[str]
Instance types allowed in the Ocean cluster. Cannot be configured if
blacklist
is configured.
- security
Groups List<String> One or more security group ids.
- subnet
Ids List<String> A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public IP.
- associate
Public BooleanIp Address Configure public IP address allocation.
- autoscaler Property Map
Describes the Ocean Kubernetes Auto Scaler.
- blacklists List<String>
Instance types not allowed in the Ocean cluster. Cannot be configured if
whitelist
is configured.- cluster
Orientations List<Property Map> - controller
Id String A unique identifier used for connecting the Ocean SaaS platform and the Kubernetes cluster. Typically, the cluster name is used as its identifier.
- desired
Capacity Number The number of instances to launch and maintain in the cluster.
- draining
Timeout Number The time in seconds, the instance is allowed to run while detached from the ELB. This is to allow the instance time to be drained from incoming TCP connections before terminating it, during a scale down operation.
- ebs
Optimized Boolean Enable EBS optimized for cluster. Flag will enable optimized capacity for high bandwidth connectivity to the EB service for non EBS optimized instance types. For instances that are EBS optimized this flag will be ignored.
- fallback
To BooleanOndemand If not Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
- filters Property Map
List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. Cannot be configured together with whitelist/blacklist.
- grace
Period Number The amount of time, in seconds, after the instance has launched to start checking its health.
- iam
Instance StringProfile The instance profile iam role.
- image
Id String ID of the image used to launch the instances.
- instance
Metadata Property MapOptions Ocean instance metadata options object for IMDSv2.
- key
Name String The key pair to attach the instances.
- load
Balancers List<Property Map> Array of load balancer objects to add to ocean cluster
- logging Property Map
Logging configuration.
- max
Size Number The upper limit of instances the cluster can scale up to.
- min
Size Number The lower limit of instances the cluster can scale down to.
- monitoring Boolean
Enable detailed monitoring for cluster. Flag will enable Cloud Watch detailed monitoring (one minute increments). Note: there are additional hourly costs for this service based on the region used.
- name String
Required if type is set to
CLASSIC
- region String
The region the cluster will run in.
- root
Volume NumberSize The size (in Gb) to allocate for the root volume. Minimum
20
.- scheduled
Tasks List<Property Map> - spot
Percentage Number The percentage of Spot instances that would spin up from the
desired_capacity
number.- List<Property Map>
Optionally adds tags to instances launched in an Ocean cluster.
- update
Policy Property Map - use
As BooleanTemplate Only launch specification defined on the Ocean object will function only as a template for virtual node groups. When set to true, on Ocean resource creation please make sure your custom VNG has an initial_nodes parameter to create nodes for your VNG.
- user
Data String Base64-encoded MIME user data to make available to the instances.
- utilize
Commitments Boolean If savings plans exist, Ocean will utilize them before launching Spot instances.
- utilize
Reserved BooleanInstances If Reserved instances exist, Ocean will utilize them before launching Spot instances.
- whitelists List<String>
Instance types allowed in the Ocean cluster. Cannot be configured if
blacklist
is configured.
Outputs
All input properties are implicitly available as output properties. Additionally, the Ocean resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Look up Existing Ocean Resource
Get an existing Ocean resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: OceanState, opts?: CustomResourceOptions): Ocean
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
associate_public_ip_address: Optional[bool] = None,
autoscaler: Optional[OceanAutoscalerArgs] = None,
blacklists: Optional[Sequence[str]] = None,
cluster_orientations: Optional[Sequence[OceanClusterOrientationArgs]] = None,
controller_id: Optional[str] = None,
desired_capacity: Optional[int] = None,
draining_timeout: Optional[int] = None,
ebs_optimized: Optional[bool] = None,
fallback_to_ondemand: Optional[bool] = None,
filters: Optional[OceanFiltersArgs] = None,
grace_period: Optional[int] = None,
iam_instance_profile: Optional[str] = None,
image_id: Optional[str] = None,
instance_metadata_options: Optional[OceanInstanceMetadataOptionsArgs] = None,
key_name: Optional[str] = None,
load_balancers: Optional[Sequence[OceanLoadBalancerArgs]] = None,
logging: Optional[OceanLoggingArgs] = None,
max_size: Optional[int] = None,
min_size: Optional[int] = None,
monitoring: Optional[bool] = None,
name: Optional[str] = None,
region: Optional[str] = None,
root_volume_size: Optional[int] = None,
scheduled_tasks: Optional[Sequence[OceanScheduledTaskArgs]] = None,
security_groups: Optional[Sequence[str]] = None,
spot_percentage: Optional[int] = None,
subnet_ids: Optional[Sequence[str]] = None,
tags: Optional[Sequence[OceanTagArgs]] = None,
update_policy: Optional[OceanUpdatePolicyArgs] = None,
use_as_template_only: Optional[bool] = None,
user_data: Optional[str] = None,
utilize_commitments: Optional[bool] = None,
utilize_reserved_instances: Optional[bool] = None,
whitelists: Optional[Sequence[str]] = None) -> Ocean
func GetOcean(ctx *Context, name string, id IDInput, state *OceanState, opts ...ResourceOption) (*Ocean, error)
public static Ocean Get(string name, Input<string> id, OceanState? state, CustomResourceOptions? opts = null)
public static Ocean get(String name, Output<String> id, OceanState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Associate
Public boolIp Address Configure public IP address allocation.
- Autoscaler
Pulumi.
Spot Inst. Aws. Inputs. Ocean Autoscaler Args Describes the Ocean Kubernetes Auto Scaler.
- Blacklists List<string>
Instance types not allowed in the Ocean cluster. Cannot be configured if
whitelist
is configured.- Cluster
Orientations List<Pulumi.Spot Inst. Aws. Inputs. Ocean Cluster Orientation Args> - Controller
Id string A unique identifier used for connecting the Ocean SaaS platform and the Kubernetes cluster. Typically, the cluster name is used as its identifier.
- Desired
Capacity int The number of instances to launch and maintain in the cluster.
- Draining
Timeout int The time in seconds, the instance is allowed to run while detached from the ELB. This is to allow the instance time to be drained from incoming TCP connections before terminating it, during a scale down operation.
- Ebs
Optimized bool Enable EBS optimized for cluster. Flag will enable optimized capacity for high bandwidth connectivity to the EB service for non EBS optimized instance types. For instances that are EBS optimized this flag will be ignored.
- Fallback
To boolOndemand If not Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
- Filters
Pulumi.
Spot Inst. Aws. Inputs. Ocean Filters Args List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. Cannot be configured together with whitelist/blacklist.
- Grace
Period int The amount of time, in seconds, after the instance has launched to start checking its health.
- Iam
Instance stringProfile The instance profile iam role.
- Image
Id string ID of the image used to launch the instances.
- Instance
Metadata Pulumi.Options Spot Inst. Aws. Inputs. Ocean Instance Metadata Options Args Ocean instance metadata options object for IMDSv2.
- Key
Name string The key pair to attach the instances.
- Load
Balancers List<Pulumi.Spot Inst. Aws. Inputs. Ocean Load Balancer Args> Array of load balancer objects to add to ocean cluster
- Logging
Pulumi.
Spot Inst. Aws. Inputs. Ocean Logging Args Logging configuration.
- Max
Size int The upper limit of instances the cluster can scale up to.
- Min
Size int The lower limit of instances the cluster can scale down to.
- Monitoring bool
Enable detailed monitoring for cluster. Flag will enable Cloud Watch detailed monitoring (one minute increments). Note: there are additional hourly costs for this service based on the region used.
- Name string
Required if type is set to
CLASSIC
- Region string
The region the cluster will run in.
- Root
Volume intSize The size (in Gb) to allocate for the root volume. Minimum
20
.- Scheduled
Tasks List<Pulumi.Spot Inst. Aws. Inputs. Ocean Scheduled Task Args> - Security
Groups List<string> One or more security group ids.
- Spot
Percentage int The percentage of Spot instances that would spin up from the
desired_capacity
number.- Subnet
Ids List<string> A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public IP.
- List<Pulumi.
Spot Inst. Aws. Inputs. Ocean Tag Args> Optionally adds tags to instances launched in an Ocean cluster.
- Update
Policy Pulumi.Spot Inst. Aws. Inputs. Ocean Update Policy Args - Use
As boolTemplate Only launch specification defined on the Ocean object will function only as a template for virtual node groups. When set to true, on Ocean resource creation please make sure your custom VNG has an initial_nodes parameter to create nodes for your VNG.
- User
Data string Base64-encoded MIME user data to make available to the instances.
- Utilize
Commitments bool If savings plans exist, Ocean will utilize them before launching Spot instances.
- Utilize
Reserved boolInstances If Reserved instances exist, Ocean will utilize them before launching Spot instances.
- Whitelists List<string>
Instance types allowed in the Ocean cluster. Cannot be configured if
blacklist
is configured.
- Associate
Public boolIp Address Configure public IP address allocation.
- Autoscaler
Ocean
Autoscaler Args Describes the Ocean Kubernetes Auto Scaler.
- Blacklists []string
Instance types not allowed in the Ocean cluster. Cannot be configured if
whitelist
is configured.- Cluster
Orientations []OceanCluster Orientation Args - Controller
Id string A unique identifier used for connecting the Ocean SaaS platform and the Kubernetes cluster. Typically, the cluster name is used as its identifier.
- Desired
Capacity int The number of instances to launch and maintain in the cluster.
- Draining
Timeout int The time in seconds, the instance is allowed to run while detached from the ELB. This is to allow the instance time to be drained from incoming TCP connections before terminating it, during a scale down operation.
- Ebs
Optimized bool Enable EBS optimized for cluster. Flag will enable optimized capacity for high bandwidth connectivity to the EB service for non EBS optimized instance types. For instances that are EBS optimized this flag will be ignored.
- Fallback
To boolOndemand If not Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
- Filters
Ocean
Filters Args List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. Cannot be configured together with whitelist/blacklist.
- Grace
Period int The amount of time, in seconds, after the instance has launched to start checking its health.
- Iam
Instance stringProfile The instance profile iam role.
- Image
Id string ID of the image used to launch the instances.
- Instance
Metadata OceanOptions Instance Metadata Options Args Ocean instance metadata options object for IMDSv2.
- Key
Name string The key pair to attach the instances.
- Load
Balancers []OceanLoad Balancer Args Array of load balancer objects to add to ocean cluster
- Logging
Ocean
Logging Args Logging configuration.
- Max
Size int The upper limit of instances the cluster can scale up to.
- Min
Size int The lower limit of instances the cluster can scale down to.
- Monitoring bool
Enable detailed monitoring for cluster. Flag will enable Cloud Watch detailed monitoring (one minute increments). Note: there are additional hourly costs for this service based on the region used.
- Name string
Required if type is set to
CLASSIC
- Region string
The region the cluster will run in.
- Root
Volume intSize The size (in Gb) to allocate for the root volume. Minimum
20
.- Scheduled
Tasks []OceanScheduled Task Args - Security
Groups []string One or more security group ids.
- Spot
Percentage int The percentage of Spot instances that would spin up from the
desired_capacity
number.- Subnet
Ids []string A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public IP.
- []Ocean
Tag Args Optionally adds tags to instances launched in an Ocean cluster.
- Update
Policy OceanUpdate Policy Args - Use
As boolTemplate Only launch specification defined on the Ocean object will function only as a template for virtual node groups. When set to true, on Ocean resource creation please make sure your custom VNG has an initial_nodes parameter to create nodes for your VNG.
- User
Data string Base64-encoded MIME user data to make available to the instances.
- Utilize
Commitments bool If savings plans exist, Ocean will utilize them before launching Spot instances.
- Utilize
Reserved boolInstances If Reserved instances exist, Ocean will utilize them before launching Spot instances.
- Whitelists []string
Instance types allowed in the Ocean cluster. Cannot be configured if
blacklist
is configured.
- associate
Public BooleanIp Address Configure public IP address allocation.
- autoscaler
Ocean
Autoscaler Args Describes the Ocean Kubernetes Auto Scaler.
- blacklists List<String>
Instance types not allowed in the Ocean cluster. Cannot be configured if
whitelist
is configured.- cluster
Orientations List<OceanCluster Orientation Args> - controller
Id String A unique identifier used for connecting the Ocean SaaS platform and the Kubernetes cluster. Typically, the cluster name is used as its identifier.
- desired
Capacity Integer The number of instances to launch and maintain in the cluster.
- draining
Timeout Integer The time in seconds, the instance is allowed to run while detached from the ELB. This is to allow the instance time to be drained from incoming TCP connections before terminating it, during a scale down operation.
- ebs
Optimized Boolean Enable EBS optimized for cluster. Flag will enable optimized capacity for high bandwidth connectivity to the EB service for non EBS optimized instance types. For instances that are EBS optimized this flag will be ignored.
- fallback
To BooleanOndemand If not Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
- filters
Ocean
Filters Args List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. Cannot be configured together with whitelist/blacklist.
- grace
Period Integer The amount of time, in seconds, after the instance has launched to start checking its health.
- iam
Instance StringProfile The instance profile iam role.
- image
Id String ID of the image used to launch the instances.
- instance
Metadata OceanOptions Instance Metadata Options Args Ocean instance metadata options object for IMDSv2.
- key
Name String The key pair to attach the instances.
- load
Balancers List<OceanLoad Balancer Args> Array of load balancer objects to add to ocean cluster
- logging
Ocean
Logging Args Logging configuration.
- max
Size Integer The upper limit of instances the cluster can scale up to.
- min
Size Integer The lower limit of instances the cluster can scale down to.
- monitoring Boolean
Enable detailed monitoring for cluster. Flag will enable Cloud Watch detailed monitoring (one minute increments). Note: there are additional hourly costs for this service based on the region used.
- name String
Required if type is set to
CLASSIC
- region String
The region the cluster will run in.
- root
Volume IntegerSize The size (in Gb) to allocate for the root volume. Minimum
20
.- scheduled
Tasks List<OceanScheduled Task Args> - security
Groups List<String> One or more security group ids.
- spot
Percentage Integer The percentage of Spot instances that would spin up from the
desired_capacity
number.- subnet
Ids List<String> A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public IP.
- List<Ocean
Tag Args> Optionally adds tags to instances launched in an Ocean cluster.
- update
Policy OceanUpdate Policy Args - use
As BooleanTemplate Only launch specification defined on the Ocean object will function only as a template for virtual node groups. When set to true, on Ocean resource creation please make sure your custom VNG has an initial_nodes parameter to create nodes for your VNG.
- user
Data String Base64-encoded MIME user data to make available to the instances.
- utilize
Commitments Boolean If savings plans exist, Ocean will utilize them before launching Spot instances.
- utilize
Reserved BooleanInstances If Reserved instances exist, Ocean will utilize them before launching Spot instances.
- whitelists List<String>
Instance types allowed in the Ocean cluster. Cannot be configured if
blacklist
is configured.
- associate
Public booleanIp Address Configure public IP address allocation.
- autoscaler
Ocean
Autoscaler Args Describes the Ocean Kubernetes Auto Scaler.
- blacklists string[]
Instance types not allowed in the Ocean cluster. Cannot be configured if
whitelist
is configured.- cluster
Orientations OceanCluster Orientation Args[] - controller
Id string A unique identifier used for connecting the Ocean SaaS platform and the Kubernetes cluster. Typically, the cluster name is used as its identifier.
- desired
Capacity number The number of instances to launch and maintain in the cluster.
- draining
Timeout number The time in seconds, the instance is allowed to run while detached from the ELB. This is to allow the instance time to be drained from incoming TCP connections before terminating it, during a scale down operation.
- ebs
Optimized boolean Enable EBS optimized for cluster. Flag will enable optimized capacity for high bandwidth connectivity to the EB service for non EBS optimized instance types. For instances that are EBS optimized this flag will be ignored.
- fallback
To booleanOndemand If not Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
- filters
Ocean
Filters Args List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. Cannot be configured together with whitelist/blacklist.
- grace
Period number The amount of time, in seconds, after the instance has launched to start checking its health.
- iam
Instance stringProfile The instance profile iam role.
- image
Id string ID of the image used to launch the instances.
- instance
Metadata OceanOptions Instance Metadata Options Args Ocean instance metadata options object for IMDSv2.
- key
Name string The key pair to attach the instances.
- load
Balancers OceanLoad Balancer Args[] Array of load balancer objects to add to ocean cluster
- logging
Ocean
Logging Args Logging configuration.
- max
Size number The upper limit of instances the cluster can scale up to.
- min
Size number The lower limit of instances the cluster can scale down to.
- monitoring boolean
Enable detailed monitoring for cluster. Flag will enable Cloud Watch detailed monitoring (one minute increments). Note: there are additional hourly costs for this service based on the region used.
- name string
Required if type is set to
CLASSIC
- region string
The region the cluster will run in.
- root
Volume numberSize The size (in Gb) to allocate for the root volume. Minimum
20
.- scheduled
Tasks OceanScheduled Task Args[] - security
Groups string[] One or more security group ids.
- spot
Percentage number The percentage of Spot instances that would spin up from the
desired_capacity
number.- subnet
Ids string[] A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public IP.
- Ocean
Tag Args[] Optionally adds tags to instances launched in an Ocean cluster.
- update
Policy OceanUpdate Policy Args - use
As booleanTemplate Only launch specification defined on the Ocean object will function only as a template for virtual node groups. When set to true, on Ocean resource creation please make sure your custom VNG has an initial_nodes parameter to create nodes for your VNG.
- user
Data string Base64-encoded MIME user data to make available to the instances.
- utilize
Commitments boolean If savings plans exist, Ocean will utilize them before launching Spot instances.
- utilize
Reserved booleanInstances If Reserved instances exist, Ocean will utilize them before launching Spot instances.
- whitelists string[]
Instance types allowed in the Ocean cluster. Cannot be configured if
blacklist
is configured.
- associate_
public_ boolip_ address Configure public IP address allocation.
- autoscaler
Ocean
Autoscaler Args Describes the Ocean Kubernetes Auto Scaler.
- blacklists Sequence[str]
Instance types not allowed in the Ocean cluster. Cannot be configured if
whitelist
is configured.- cluster_
orientations Sequence[OceanCluster Orientation Args] - controller_
id str A unique identifier used for connecting the Ocean SaaS platform and the Kubernetes cluster. Typically, the cluster name is used as its identifier.
- desired_
capacity int The number of instances to launch and maintain in the cluster.
- draining_
timeout int The time in seconds, the instance is allowed to run while detached from the ELB. This is to allow the instance time to be drained from incoming TCP connections before terminating it, during a scale down operation.
- ebs_
optimized bool Enable EBS optimized for cluster. Flag will enable optimized capacity for high bandwidth connectivity to the EB service for non EBS optimized instance types. For instances that are EBS optimized this flag will be ignored.
- fallback_
to_ boolondemand If not Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
- filters
Ocean
Filters Args List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. Cannot be configured together with whitelist/blacklist.
- grace_
period int The amount of time, in seconds, after the instance has launched to start checking its health.
- iam_
instance_ strprofile The instance profile iam role.
- image_
id str ID of the image used to launch the instances.
- instance_
metadata_ Oceanoptions Instance Metadata Options Args Ocean instance metadata options object for IMDSv2.
- key_
name str The key pair to attach the instances.
- load_
balancers Sequence[OceanLoad Balancer Args] Array of load balancer objects to add to ocean cluster
- logging
Ocean
Logging Args Logging configuration.
- max_
size int The upper limit of instances the cluster can scale up to.
- min_
size int The lower limit of instances the cluster can scale down to.
- monitoring bool
Enable detailed monitoring for cluster. Flag will enable Cloud Watch detailed monitoring (one minute increments). Note: there are additional hourly costs for this service based on the region used.
- name str
Required if type is set to
CLASSIC
- region str
The region the cluster will run in.
- root_
volume_ intsize The size (in Gb) to allocate for the root volume. Minimum
20
.- scheduled_
tasks Sequence[OceanScheduled Task Args] - security_
groups Sequence[str] One or more security group ids.
- spot_
percentage int The percentage of Spot instances that would spin up from the
desired_capacity
number.- subnet_
ids Sequence[str] A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public IP.
- Sequence[Ocean
Tag Args] Optionally adds tags to instances launched in an Ocean cluster.
- update_
policy OceanUpdate Policy Args - use_
as_ booltemplate_ only launch specification defined on the Ocean object will function only as a template for virtual node groups. When set to true, on Ocean resource creation please make sure your custom VNG has an initial_nodes parameter to create nodes for your VNG.
- user_
data str Base64-encoded MIME user data to make available to the instances.
- utilize_
commitments bool If savings plans exist, Ocean will utilize them before launching Spot instances.
- utilize_
reserved_ boolinstances If Reserved instances exist, Ocean will utilize them before launching Spot instances.
- whitelists Sequence[str]
Instance types allowed in the Ocean cluster. Cannot be configured if
blacklist
is configured.
- associate
Public BooleanIp Address Configure public IP address allocation.
- autoscaler Property Map
Describes the Ocean Kubernetes Auto Scaler.
- blacklists List<String>
Instance types not allowed in the Ocean cluster. Cannot be configured if
whitelist
is configured.- cluster
Orientations List<Property Map> - controller
Id String A unique identifier used for connecting the Ocean SaaS platform and the Kubernetes cluster. Typically, the cluster name is used as its identifier.
- desired
Capacity Number The number of instances to launch and maintain in the cluster.
- draining
Timeout Number The time in seconds, the instance is allowed to run while detached from the ELB. This is to allow the instance time to be drained from incoming TCP connections before terminating it, during a scale down operation.
- ebs
Optimized Boolean Enable EBS optimized for cluster. Flag will enable optimized capacity for high bandwidth connectivity to the EB service for non EBS optimized instance types. For instances that are EBS optimized this flag will be ignored.
- fallback
To BooleanOndemand If not Spot instance markets are available, enable Ocean to launch On-Demand instances instead.
- filters Property Map
List of filters. The Instance types that match with all filters compose the Ocean's whitelist parameter. Cannot be configured together with whitelist/blacklist.
- grace
Period Number The amount of time, in seconds, after the instance has launched to start checking its health.
- iam
Instance StringProfile The instance profile iam role.
- image
Id String ID of the image used to launch the instances.
- instance
Metadata Property MapOptions Ocean instance metadata options object for IMDSv2.
- key
Name String The key pair to attach the instances.
- load
Balancers List<Property Map> Array of load balancer objects to add to ocean cluster
- logging Property Map
Logging configuration.
- max
Size Number The upper limit of instances the cluster can scale up to.
- min
Size Number The lower limit of instances the cluster can scale down to.
- monitoring Boolean
Enable detailed monitoring for cluster. Flag will enable Cloud Watch detailed monitoring (one minute increments). Note: there are additional hourly costs for this service based on the region used.
- name String
Required if type is set to
CLASSIC
- region String
The region the cluster will run in.
- root
Volume NumberSize The size (in Gb) to allocate for the root volume. Minimum
20
.- scheduled
Tasks List<Property Map> - security
Groups List<String> One or more security group ids.
- spot
Percentage Number The percentage of Spot instances that would spin up from the
desired_capacity
number.- subnet
Ids List<String> A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public IP.
- List<Property Map>
Optionally adds tags to instances launched in an Ocean cluster.
- update
Policy Property Map - use
As BooleanTemplate Only launch specification defined on the Ocean object will function only as a template for virtual node groups. When set to true, on Ocean resource creation please make sure your custom VNG has an initial_nodes parameter to create nodes for your VNG.
- user
Data String Base64-encoded MIME user data to make available to the instances.
- utilize
Commitments Boolean If savings plans exist, Ocean will utilize them before launching Spot instances.
- utilize
Reserved BooleanInstances If Reserved instances exist, Ocean will utilize them before launching Spot instances.
- whitelists List<String>
Instance types allowed in the Ocean cluster. Cannot be configured if
blacklist
is configured.
Supporting Types
OceanAutoscaler
- Auto
Headroom intPercentage Set the auto headroom percentage (a number in the range [0, 200]) which controls the percentage of headroom from the cluster. Relevant only when
autoscale_is_auto_config
toggled on.- Autoscale
Cooldown int Cooldown period between scaling actions.
- Autoscale
Down Pulumi.Spot Inst. Aws. Inputs. Ocean Autoscaler Autoscale Down Auto Scaling scale down operations.
- Autoscale
Headroom Pulumi.Spot Inst. Aws. Inputs. Ocean Autoscaler Autoscale Headroom Spare resource capacity management enabling fast assignment of Pods without waiting for new resources to launch.
- Autoscale
Is boolAuto Config Automatically configure and optimize headroom resources.
- Autoscale
Is boolEnabled Enable the Ocean Kubernetes Auto Scaler.
- Enable
Automatic boolAnd Manual Headroom enables automatic and manual headroom to work in parallel. When set to false, automatic headroom overrides all other headroom definitions manually configured, whether they are at cluster or VNG level.
- Extended
Resource List<string>Definitions List of Ocean extended resource definitions to use in this cluster.
- Resource
Limits Pulumi.Spot Inst. Aws. Inputs. Ocean Autoscaler Resource Limits Optionally set upper and lower bounds on the resource usage of the cluster.
- Auto
Headroom intPercentage Set the auto headroom percentage (a number in the range [0, 200]) which controls the percentage of headroom from the cluster. Relevant only when
autoscale_is_auto_config
toggled on.- Autoscale
Cooldown int Cooldown period between scaling actions.
- Autoscale
Down OceanAutoscaler Autoscale Down Auto Scaling scale down operations.
- Autoscale
Headroom OceanAutoscaler Autoscale Headroom Spare resource capacity management enabling fast assignment of Pods without waiting for new resources to launch.
- Autoscale
Is boolAuto Config Automatically configure and optimize headroom resources.
- Autoscale
Is boolEnabled Enable the Ocean Kubernetes Auto Scaler.
- Enable
Automatic boolAnd Manual Headroom enables automatic and manual headroom to work in parallel. When set to false, automatic headroom overrides all other headroom definitions manually configured, whether they are at cluster or VNG level.
- Extended
Resource []stringDefinitions List of Ocean extended resource definitions to use in this cluster.
- Resource
Limits OceanAutoscaler Resource Limits Optionally set upper and lower bounds on the resource usage of the cluster.
- auto
Headroom IntegerPercentage Set the auto headroom percentage (a number in the range [0, 200]) which controls the percentage of headroom from the cluster. Relevant only when
autoscale_is_auto_config
toggled on.- autoscale
Cooldown Integer Cooldown period between scaling actions.
- autoscale
Down OceanAutoscaler Autoscale Down Auto Scaling scale down operations.
- autoscale
Headroom OceanAutoscaler Autoscale Headroom Spare resource capacity management enabling fast assignment of Pods without waiting for new resources to launch.
- autoscale
Is BooleanAuto Config Automatically configure and optimize headroom resources.
- autoscale
Is BooleanEnabled Enable the Ocean Kubernetes Auto Scaler.
- enable
Automatic BooleanAnd Manual Headroom enables automatic and manual headroom to work in parallel. When set to false, automatic headroom overrides all other headroom definitions manually configured, whether they are at cluster or VNG level.
- extended
Resource List<String>Definitions List of Ocean extended resource definitions to use in this cluster.
- resource
Limits OceanAutoscaler Resource Limits Optionally set upper and lower bounds on the resource usage of the cluster.
- auto
Headroom numberPercentage Set the auto headroom percentage (a number in the range [0, 200]) which controls the percentage of headroom from the cluster. Relevant only when
autoscale_is_auto_config
toggled on.- autoscale
Cooldown number Cooldown period between scaling actions.
- autoscale
Down OceanAutoscaler Autoscale Down Auto Scaling scale down operations.
- autoscale
Headroom OceanAutoscaler Autoscale Headroom Spare resource capacity management enabling fast assignment of Pods without waiting for new resources to launch.
- autoscale
Is booleanAuto Config Automatically configure and optimize headroom resources.
- autoscale
Is booleanEnabled Enable the Ocean Kubernetes Auto Scaler.
- enable
Automatic booleanAnd Manual Headroom enables automatic and manual headroom to work in parallel. When set to false, automatic headroom overrides all other headroom definitions manually configured, whether they are at cluster or VNG level.
- extended
Resource string[]Definitions List of Ocean extended resource definitions to use in this cluster.
- resource
Limits OceanAutoscaler Resource Limits Optionally set upper and lower bounds on the resource usage of the cluster.
- auto_
headroom_ intpercentage Set the auto headroom percentage (a number in the range [0, 200]) which controls the percentage of headroom from the cluster. Relevant only when
autoscale_is_auto_config
toggled on.- autoscale_
cooldown int Cooldown period between scaling actions.
- autoscale_
down OceanAutoscaler Autoscale Down Auto Scaling scale down operations.
- autoscale_
headroom OceanAutoscaler Autoscale Headroom Spare resource capacity management enabling fast assignment of Pods without waiting for new resources to launch.
- autoscale_
is_ boolauto_ config Automatically configure and optimize headroom resources.
- autoscale_
is_ boolenabled Enable the Ocean Kubernetes Auto Scaler.
- enable_
automatic_ booland_ manual_ headroom enables automatic and manual headroom to work in parallel. When set to false, automatic headroom overrides all other headroom definitions manually configured, whether they are at cluster or VNG level.
- extended_
resource_ Sequence[str]definitions List of Ocean extended resource definitions to use in this cluster.
- resource_
limits OceanAutoscaler Resource Limits Optionally set upper and lower bounds on the resource usage of the cluster.
- auto
Headroom NumberPercentage Set the auto headroom percentage (a number in the range [0, 200]) which controls the percentage of headroom from the cluster. Relevant only when
autoscale_is_auto_config
toggled on.- autoscale
Cooldown Number Cooldown period between scaling actions.
- autoscale
Down Property Map Auto Scaling scale down operations.
- autoscale
Headroom Property Map Spare resource capacity management enabling fast assignment of Pods without waiting for new resources to launch.
- autoscale
Is BooleanAuto Config Automatically configure and optimize headroom resources.
- autoscale
Is BooleanEnabled Enable the Ocean Kubernetes Auto Scaler.
- enable
Automatic BooleanAnd Manual Headroom enables automatic and manual headroom to work in parallel. When set to false, automatic headroom overrides all other headroom definitions manually configured, whether they are at cluster or VNG level.
- extended
Resource List<String>Definitions List of Ocean extended resource definitions to use in this cluster.
- resource
Limits Property Map Optionally set upper and lower bounds on the resource usage of the cluster.
OceanAutoscalerAutoscaleDown
- Evaluation
Periods int - Max
Scale doubleDown Percentage Would represent the maximum % to scale-down. Number between 1-100.
- Evaluation
Periods int - Max
Scale float64Down Percentage Would represent the maximum % to scale-down. Number between 1-100.
- evaluation
Periods Integer - max
Scale DoubleDown Percentage Would represent the maximum % to scale-down. Number between 1-100.
- evaluation
Periods number - max
Scale numberDown Percentage Would represent the maximum % to scale-down. Number between 1-100.
- evaluation_
periods int - max_
scale_ floatdown_ percentage Would represent the maximum % to scale-down. Number between 1-100.
- evaluation
Periods Number - max
Scale NumberDown Percentage Would represent the maximum % to scale-down. Number between 1-100.
OceanAutoscalerAutoscaleHeadroom
- Cpu
Per intUnit Optionally configure the number of CPUs to allocate the headroom. CPUs are denoted in millicores, where 1000 millicores = 1 vCPU.
- Gpu
Per intUnit Optionally configure the number of GPUs to allocate the headroom.
- Memory
Per intUnit Optionally configure the amount of memory (MB) to allocate the headroom.
- Num
Of intUnits The number of units to retain as headroom, where each unit has the defined headroom CPU and memory.
- Cpu
Per intUnit Optionally configure the number of CPUs to allocate the headroom. CPUs are denoted in millicores, where 1000 millicores = 1 vCPU.
- Gpu
Per intUnit Optionally configure the number of GPUs to allocate the headroom.
- Memory
Per intUnit Optionally configure the amount of memory (MB) to allocate the headroom.
- Num
Of intUnits The number of units to retain as headroom, where each unit has the defined headroom CPU and memory.
- cpu
Per IntegerUnit Optionally configure the number of CPUs to allocate the headroom. CPUs are denoted in millicores, where 1000 millicores = 1 vCPU.
- gpu
Per IntegerUnit Optionally configure the number of GPUs to allocate the headroom.
- memory
Per IntegerUnit Optionally configure the amount of memory (MB) to allocate the headroom.
- num
Of IntegerUnits The number of units to retain as headroom, where each unit has the defined headroom CPU and memory.
- cpu
Per numberUnit Optionally configure the number of CPUs to allocate the headroom. CPUs are denoted in millicores, where 1000 millicores = 1 vCPU.
- gpu
Per numberUnit Optionally configure the number of GPUs to allocate the headroom.
- memory
Per numberUnit Optionally configure the amount of memory (MB) to allocate the headroom.
- num
Of numberUnits The number of units to retain as headroom, where each unit has the defined headroom CPU and memory.
- cpu_
per_ intunit Optionally configure the number of CPUs to allocate the headroom. CPUs are denoted in millicores, where 1000 millicores = 1 vCPU.
- gpu_
per_ intunit Optionally configure the number of GPUs to allocate the headroom.
- memory_
per_ intunit Optionally configure the amount of memory (MB) to allocate the headroom.
- num_
of_ intunits The number of units to retain as headroom, where each unit has the defined headroom CPU and memory.
- cpu
Per NumberUnit Optionally configure the number of CPUs to allocate the headroom. CPUs are denoted in millicores, where 1000 millicores = 1 vCPU.
- gpu
Per NumberUnit Optionally configure the number of GPUs to allocate the headroom.
- memory
Per NumberUnit Optionally configure the amount of memory (MB) to allocate the headroom.
- num
Of NumberUnits The number of units to retain as headroom, where each unit has the defined headroom CPU and memory.
OceanAutoscalerResourceLimits
- Max
Memory intGib Maximum amount of Memory (GiB).
- Max
Vcpu int Maximum number of vcpus available.
- Max
Memory intGib Maximum amount of Memory (GiB).
- Max
Vcpu int Maximum number of vcpus available.
- max
Memory IntegerGib Maximum amount of Memory (GiB).
- max
Vcpu Integer Maximum number of vcpus available.
- max
Memory numberGib Maximum amount of Memory (GiB).
- max
Vcpu number Maximum number of vcpus available.
- max_
memory_ intgib Maximum amount of Memory (GiB).
- max_
vcpu int Maximum number of vcpus available.
- max
Memory NumberGib Maximum amount of Memory (GiB).
- max
Vcpu Number Maximum number of vcpus available.
OceanClusterOrientation
- Availability
Vs stringCost You can control the approach that Ocean takes while launching nodes by configuring this value. Possible values:
costOriented
,balanced
,cheapest
.
- Availability
Vs stringCost You can control the approach that Ocean takes while launching nodes by configuring this value. Possible values:
costOriented
,balanced
,cheapest
.
- availability
Vs StringCost You can control the approach that Ocean takes while launching nodes by configuring this value. Possible values:
costOriented
,balanced
,cheapest
.
- availability
Vs stringCost You can control the approach that Ocean takes while launching nodes by configuring this value. Possible values:
costOriented
,balanced
,cheapest
.
- availability_
vs_ strcost You can control the approach that Ocean takes while launching nodes by configuring this value. Possible values:
costOriented
,balanced
,cheapest
.
- availability
Vs StringCost You can control the approach that Ocean takes while launching nodes by configuring this value. Possible values:
costOriented
,balanced
,cheapest
.
OceanFilters
- Architectures List<string>
The filtered instance types will support at least one of the architectures from this list.
- Categories List<string>
The filtered instance types will belong to one of the categories types from this list.
- Disk
Types List<string> The filtered instance types will have one of the disk type from this list.
- Exclude
Families List<string> Types belonging to a family from the ExcludeFamilies will not be available for scaling (asterisk wildcard is also supported). For example, C* will exclude instance types from these families: c5, c4, c4a, etc.
- Exclude
Metal bool In case excludeMetal is set to true, metal types will not be available for scaling.
- Hypervisors List<string>
The filtered instance types will have a hypervisor type from this list.
- Include
Families List<string> Types belonging to a family from the IncludeFamilies will be available for scaling (asterisk wildcard is also supported). For example, C* will include instance types from these families: c5, c4, c4a, etc.
- Is
Ena stringSupported Ena is supported or not.
- Max
Gpu int Maximum total number of GPUs.
- Max
Memory doubleGib Maximum amount of Memory (GiB).
- Max
Network intPerformance Maximum Bandwidth in Gib/s of network performance.
- Max
Vcpu int Maximum number of vcpus available.
- Min
Enis int Minimum number of network interfaces (ENIs).
- Min
Gpu int Minimum total number of GPUs.
- Min
Memory doubleGib Minimum amount of Memory (GiB).
- Min
Network intPerformance Minimum Bandwidth in Gib/s of network performance.
- Min
Vcpu int Minimum number of vcpus available.
- Root
Device List<string>Types The filtered instance types will have a root device types from this list.
- Virtualization
Types List<string> The filtered instance types will support at least one of the virtualization types from this list.
- Architectures []string
The filtered instance types will support at least one of the architectures from this list.
- Categories []string
The filtered instance types will belong to one of the categories types from this list.
- Disk
Types []string The filtered instance types will have one of the disk type from this list.
- Exclude
Families []string Types belonging to a family from the ExcludeFamilies will not be available for scaling (asterisk wildcard is also supported). For example, C* will exclude instance types from these families: c5, c4, c4a, etc.
- Exclude
Metal bool In case excludeMetal is set to true, metal types will not be available for scaling.
- Hypervisors []string
The filtered instance types will have a hypervisor type from this list.
- Include
Families []string Types belonging to a family from the IncludeFamilies will be available for scaling (asterisk wildcard is also supported). For example, C* will include instance types from these families: c5, c4, c4a, etc.
- Is
Ena stringSupported Ena is supported or not.
- Max
Gpu int Maximum total number of GPUs.
- Max
Memory float64Gib Maximum amount of Memory (GiB).
- Max
Network intPerformance Maximum Bandwidth in Gib/s of network performance.
- Max
Vcpu int Maximum number of vcpus available.
- Min
Enis int Minimum number of network interfaces (ENIs).
- Min
Gpu int Minimum total number of GPUs.
- Min
Memory float64Gib Minimum amount of Memory (GiB).
- Min
Network intPerformance Minimum Bandwidth in Gib/s of network performance.
- Min
Vcpu int Minimum number of vcpus available.
- Root
Device []stringTypes The filtered instance types will have a root device types from this list.
- Virtualization
Types []string The filtered instance types will support at least one of the virtualization types from this list.
- architectures List<String>
The filtered instance types will support at least one of the architectures from this list.
- categories List<String>
The filtered instance types will belong to one of the categories types from this list.
- disk
Types List<String> The filtered instance types will have one of the disk type from this list.
- exclude
Families List<String> Types belonging to a family from the ExcludeFamilies will not be available for scaling (asterisk wildcard is also supported). For example, C* will exclude instance types from these families: c5, c4, c4a, etc.
- exclude
Metal Boolean In case excludeMetal is set to true, metal types will not be available for scaling.
- hypervisors List<String>
The filtered instance types will have a hypervisor type from this list.
- include
Families List<String> Types belonging to a family from the IncludeFamilies will be available for scaling (asterisk wildcard is also supported). For example, C* will include instance types from these families: c5, c4, c4a, etc.
- is
Ena StringSupported Ena is supported or not.
- max
Gpu Integer Maximum total number of GPUs.
- max
Memory DoubleGib Maximum amount of Memory (GiB).
- max
Network IntegerPerformance Maximum Bandwidth in Gib/s of network performance.
- max
Vcpu Integer Maximum number of vcpus available.
- min
Enis Integer Minimum number of network interfaces (ENIs).
- min
Gpu Integer Minimum total number of GPUs.
- min
Memory DoubleGib Minimum amount of Memory (GiB).
- min
Network IntegerPerformance Minimum Bandwidth in Gib/s of network performance.
- min
Vcpu Integer Minimum number of vcpus available.
- root
Device List<String>Types The filtered instance types will have a root device types from this list.
- virtualization
Types List<String> The filtered instance types will support at least one of the virtualization types from this list.
- architectures string[]
The filtered instance types will support at least one of the architectures from this list.
- categories string[]
The filtered instance types will belong to one of the categories types from this list.
- disk
Types string[] The filtered instance types will have one of the disk type from this list.
- exclude
Families string[] Types belonging to a family from the ExcludeFamilies will not be available for scaling (asterisk wildcard is also supported). For example, C* will exclude instance types from these families: c5, c4, c4a, etc.
- exclude
Metal boolean In case excludeMetal is set to true, metal types will not be available for scaling.
- hypervisors string[]
The filtered instance types will have a hypervisor type from this list.
- include
Families string[] Types belonging to a family from the IncludeFamilies will be available for scaling (asterisk wildcard is also supported). For example, C* will include instance types from these families: c5, c4, c4a, etc.
- is
Ena stringSupported Ena is supported or not.
- max
Gpu number Maximum total number of GPUs.
- max
Memory numberGib Maximum amount of Memory (GiB).
- max
Network numberPerformance Maximum Bandwidth in Gib/s of network performance.
- max
Vcpu number Maximum number of vcpus available.
- min
Enis number Minimum number of network interfaces (ENIs).
- min
Gpu number Minimum total number of GPUs.
- min
Memory numberGib Minimum amount of Memory (GiB).
- min
Network numberPerformance Minimum Bandwidth in Gib/s of network performance.
- min
Vcpu number Minimum number of vcpus available.
- root
Device string[]Types The filtered instance types will have a root device types from this list.
- virtualization
Types string[] The filtered instance types will support at least one of the virtualization types from this list.
- architectures Sequence[str]
The filtered instance types will support at least one of the architectures from this list.
- categories Sequence[str]
The filtered instance types will belong to one of the categories types from this list.
- disk_
types Sequence[str] The filtered instance types will have one of the disk type from this list.
- exclude_
families Sequence[str] Types belonging to a family from the ExcludeFamilies will not be available for scaling (asterisk wildcard is also supported). For example, C* will exclude instance types from these families: c5, c4, c4a, etc.
- exclude_
metal bool In case excludeMetal is set to true, metal types will not be available for scaling.
- hypervisors Sequence[str]
The filtered instance types will have a hypervisor type from this list.
- include_
families Sequence[str] Types belonging to a family from the IncludeFamilies will be available for scaling (asterisk wildcard is also supported). For example, C* will include instance types from these families: c5, c4, c4a, etc.
- is_
ena_ strsupported Ena is supported or not.
- max_
gpu int Maximum total number of GPUs.
- max_
memory_ floatgib Maximum amount of Memory (GiB).
- max_
network_ intperformance Maximum Bandwidth in Gib/s of network performance.
- max_
vcpu int Maximum number of vcpus available.
- min_
enis int Minimum number of network interfaces (ENIs).
- min_
gpu int Minimum total number of GPUs.
- min_
memory_ floatgib Minimum amount of Memory (GiB).
- min_
network_ intperformance Minimum Bandwidth in Gib/s of network performance.
- min_
vcpu int Minimum number of vcpus available.
- root_
device_ Sequence[str]types The filtered instance types will have a root device types from this list.
- virtualization_
types Sequence[str] The filtered instance types will support at least one of the virtualization types from this list.
- architectures List<String>
The filtered instance types will support at least one of the architectures from this list.
- categories List<String>
The filtered instance types will belong to one of the categories types from this list.
- disk
Types List<String> The filtered instance types will have one of the disk type from this list.
- exclude
Families List<String> Types belonging to a family from the ExcludeFamilies will not be available for scaling (asterisk wildcard is also supported). For example, C* will exclude instance types from these families: c5, c4, c4a, etc.
- exclude
Metal Boolean In case excludeMetal is set to true, metal types will not be available for scaling.
- hypervisors List<String>
The filtered instance types will have a hypervisor type from this list.
- include
Families List<String> Types belonging to a family from the IncludeFamilies will be available for scaling (asterisk wildcard is also supported). For example, C* will include instance types from these families: c5, c4, c4a, etc.
- is
Ena StringSupported Ena is supported or not.
- max
Gpu Number Maximum total number of GPUs.
- max
Memory NumberGib Maximum amount of Memory (GiB).
- max
Network NumberPerformance Maximum Bandwidth in Gib/s of network performance.
- max
Vcpu Number Maximum number of vcpus available.
- min
Enis Number Minimum number of network interfaces (ENIs).
- min
Gpu Number Minimum total number of GPUs.
- min
Memory NumberGib Minimum amount of Memory (GiB).
- min
Network NumberPerformance Minimum Bandwidth in Gib/s of network performance.
- min
Vcpu Number Minimum number of vcpus available.
- root
Device List<String>Types The filtered instance types will have a root device types from this list.
- virtualization
Types List<String> The filtered instance types will support at least one of the virtualization types from this list.
OceanInstanceMetadataOptions
- Http
Tokens string Determines if a signed token is required or not. Valid values:
optional
orrequired
.- Http
Put intResponse Hop Limit An integer from 1 through 64. The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further the instance metadata requests can travel.
- Http
Tokens string Determines if a signed token is required or not. Valid values:
optional
orrequired
.- Http
Put intResponse Hop Limit An integer from 1 through 64. The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further the instance metadata requests can travel.
- http
Tokens String Determines if a signed token is required or not. Valid values:
optional
orrequired
.- http
Put IntegerResponse Hop Limit An integer from 1 through 64. The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further the instance metadata requests can travel.
- http
Tokens string Determines if a signed token is required or not. Valid values:
optional
orrequired
.- http
Put numberResponse Hop Limit An integer from 1 through 64. The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further the instance metadata requests can travel.
- http_
tokens str Determines if a signed token is required or not. Valid values:
optional
orrequired
.- http_
put_ intresponse_ hop_ limit An integer from 1 through 64. The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further the instance metadata requests can travel.
- http
Tokens String Determines if a signed token is required or not. Valid values:
optional
orrequired
.- http
Put NumberResponse Hop Limit An integer from 1 through 64. The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further the instance metadata requests can travel.
OceanLoadBalancer
OceanLogging
- Export
Pulumi.
Spot Inst. Aws. Inputs. Ocean Logging Export Logging Export configuration.
- Export
Ocean
Logging Export Logging Export configuration.
- export
Ocean
Logging Export Logging Export configuration.
- export
Ocean
Logging Export Logging Export configuration.
- export
Ocean
Logging Export Logging Export configuration.
- export Property Map
Logging Export configuration.
OceanLoggingExport
- S3s
List<Pulumi.
Spot Inst. Aws. Inputs. Ocean Logging Export S3> Exports your cluster's logs to the S3 bucket and subdir configured on the S3 data integration given.
- S3s
[]Ocean
Logging Export S3 Exports your cluster's logs to the S3 bucket and subdir configured on the S3 data integration given.
- s3s
List<Ocean
Logging Export S3> Exports your cluster's logs to the S3 bucket and subdir configured on the S3 data integration given.
- s3s
Ocean
Logging Export S3[] Exports your cluster's logs to the S3 bucket and subdir configured on the S3 data integration given.
- s3s
Sequence[Ocean
Logging Export S3] Exports your cluster's logs to the S3 bucket and subdir configured on the S3 data integration given.
- s3s List<Property Map>
Exports your cluster's logs to the S3 bucket and subdir configured on the S3 data integration given.
OceanLoggingExportS3
- Id string
The identifier of The S3 data integration to export the logs to.
- Id string
The identifier of The S3 data integration to export the logs to.
- id String
The identifier of The S3 data integration to export the logs to.
- id string
The identifier of The S3 data integration to export the logs to.
- id str
The identifier of The S3 data integration to export the logs to.
- id String
The identifier of The S3 data integration to export the logs to.
OceanScheduledTask
OceanScheduledTaskShutdownHours
- Time
Windows List<string> - Is
Enabled bool
- Time
Windows []string - Is
Enabled bool
- time
Windows List<String> - is
Enabled Boolean
- time
Windows string[] - is
Enabled boolean
- time_
windows Sequence[str] - is_
enabled bool
- time
Windows List<String> - is
Enabled Boolean
OceanScheduledTaskTask
- Cron
Expression string - Is
Enabled bool - Task
Type string
- Cron
Expression string - Is
Enabled bool - Task
Type string
- cron
Expression String - is
Enabled Boolean - task
Type String
- cron
Expression string - is
Enabled boolean - task
Type string
- cron_
expression str - is_
enabled bool - task_
type str
- cron
Expression String - is
Enabled Boolean - task
Type String
OceanTag
OceanUpdatePolicy
- Should
Roll bool Enables the roll.
- bool
will update instance tags on the fly without rolling the cluster.
- Conditioned
Roll bool Spot will perform a cluster Roll in accordance with a relevant modification of the cluster’s settings. When set to true , only specific changes in the cluster’s configuration will trigger a cluster roll (such as AMI, Key Pair, user data, instance types, load balancers, etc).
- Roll
Config Pulumi.Spot Inst. Aws. Inputs. Ocean Update Policy Roll Config While used, you can control whether the group should perform a deployment after an update to the configuration.
- Should
Roll bool Enables the roll.
- bool
will update instance tags on the fly without rolling the cluster.
- Conditioned
Roll bool Spot will perform a cluster Roll in accordance with a relevant modification of the cluster’s settings. When set to true , only specific changes in the cluster’s configuration will trigger a cluster roll (such as AMI, Key Pair, user data, instance types, load balancers, etc).
- Roll
Config OceanUpdate Policy Roll Config While used, you can control whether the group should perform a deployment after an update to the configuration.
- should
Roll Boolean Enables the roll.
- Boolean
will update instance tags on the fly without rolling the cluster.
- conditioned
Roll Boolean Spot will perform a cluster Roll in accordance with a relevant modification of the cluster’s settings. When set to true , only specific changes in the cluster’s configuration will trigger a cluster roll (such as AMI, Key Pair, user data, instance types, load balancers, etc).
- roll
Config OceanUpdate Policy Roll Config While used, you can control whether the group should perform a deployment after an update to the configuration.
- should
Roll boolean Enables the roll.
- boolean
will update instance tags on the fly without rolling the cluster.
- conditioned
Roll boolean Spot will perform a cluster Roll in accordance with a relevant modification of the cluster’s settings. When set to true , only specific changes in the cluster’s configuration will trigger a cluster roll (such as AMI, Key Pair, user data, instance types, load balancers, etc).
- roll
Config OceanUpdate Policy Roll Config While used, you can control whether the group should perform a deployment after an update to the configuration.
- should_
roll bool Enables the roll.
- bool
will update instance tags on the fly without rolling the cluster.
- conditioned_
roll bool Spot will perform a cluster Roll in accordance with a relevant modification of the cluster’s settings. When set to true , only specific changes in the cluster’s configuration will trigger a cluster roll (such as AMI, Key Pair, user data, instance types, load balancers, etc).
- roll_
config OceanUpdate Policy Roll Config While used, you can control whether the group should perform a deployment after an update to the configuration.
- should
Roll Boolean Enables the roll.
- Boolean
will update instance tags on the fly without rolling the cluster.
- conditioned
Roll Boolean Spot will perform a cluster Roll in accordance with a relevant modification of the cluster’s settings. When set to true , only specific changes in the cluster’s configuration will trigger a cluster roll (such as AMI, Key Pair, user data, instance types, load balancers, etc).
- roll
Config Property Map While used, you can control whether the group should perform a deployment after an update to the configuration.
OceanUpdatePolicyRollConfig
- Batch
Size intPercentage Sets the percentage of the instances to deploy in each batch.
- Batch
Min intHealthy Percentage Default: 50. Indicates the threshold of minimum healthy instances in single batch. If the amount of healthy instances in single batch is under the threshold, the cluster roll will fail. If exists, the parameter value will be in range of 1-100. In case of null as value, the default value in the backend will be 50%. Value of param should represent the number in percentage (%) of the batch.
- Launch
Spec List<string>Ids List of virtual node group identifiers to be rolled.
- Respect
Pdb bool During the roll, if the parameter is set to True we honor PDB during the instance replacement.
- Batch
Size intPercentage Sets the percentage of the instances to deploy in each batch.
- Batch
Min intHealthy Percentage Default: 50. Indicates the threshold of minimum healthy instances in single batch. If the amount of healthy instances in single batch is under the threshold, the cluster roll will fail. If exists, the parameter value will be in range of 1-100. In case of null as value, the default value in the backend will be 50%. Value of param should represent the number in percentage (%) of the batch.
- Launch
Spec []stringIds List of virtual node group identifiers to be rolled.
- Respect
Pdb bool During the roll, if the parameter is set to True we honor PDB during the instance replacement.
- batch
Size IntegerPercentage Sets the percentage of the instances to deploy in each batch.
- batch
Min IntegerHealthy Percentage Default: 50. Indicates the threshold of minimum healthy instances in single batch. If the amount of healthy instances in single batch is under the threshold, the cluster roll will fail. If exists, the parameter value will be in range of 1-100. In case of null as value, the default value in the backend will be 50%. Value of param should represent the number in percentage (%) of the batch.
- launch
Spec List<String>Ids List of virtual node group identifiers to be rolled.
- respect
Pdb Boolean During the roll, if the parameter is set to True we honor PDB during the instance replacement.
- batch
Size numberPercentage Sets the percentage of the instances to deploy in each batch.
- batch
Min numberHealthy Percentage Default: 50. Indicates the threshold of minimum healthy instances in single batch. If the amount of healthy instances in single batch is under the threshold, the cluster roll will fail. If exists, the parameter value will be in range of 1-100. In case of null as value, the default value in the backend will be 50%. Value of param should represent the number in percentage (%) of the batch.
- launch
Spec string[]Ids List of virtual node group identifiers to be rolled.
- respect
Pdb boolean During the roll, if the parameter is set to True we honor PDB during the instance replacement.
- batch_
size_ intpercentage Sets the percentage of the instances to deploy in each batch.
- batch_
min_ inthealthy_ percentage Default: 50. Indicates the threshold of minimum healthy instances in single batch. If the amount of healthy instances in single batch is under the threshold, the cluster roll will fail. If exists, the parameter value will be in range of 1-100. In case of null as value, the default value in the backend will be 50%. Value of param should represent the number in percentage (%) of the batch.
- launch_
spec_ Sequence[str]ids List of virtual node group identifiers to be rolled.
- respect_
pdb bool During the roll, if the parameter is set to True we honor PDB during the instance replacement.
- batch
Size NumberPercentage Sets the percentage of the instances to deploy in each batch.
- batch
Min NumberHealthy Percentage Default: 50. Indicates the threshold of minimum healthy instances in single batch. If the amount of healthy instances in single batch is under the threshold, the cluster roll will fail. If exists, the parameter value will be in range of 1-100. In case of null as value, the default value in the backend will be 50%. Value of param should represent the number in percentage (%) of the batch.
- launch
Spec List<String>Ids List of virtual node group identifiers to be rolled.
- respect
Pdb Boolean During the roll, if the parameter is set to True we honor PDB during the instance replacement.
Import
Clusters can be imported using the Ocean id
, e.g., hcl
$ pulumi import spotinst:aws/ocean:Ocean this o-12345678
Package Details
- Repository
- Spotinst pulumi/pulumi-spotinst
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
spotinst
Terraform Provider.