spotinst.aws.Ocean
Explore with Pulumi AI
Example Usage
Create Ocean Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Ocean(name: string, args: OceanArgs, opts?: CustomResourceOptions);
@overload
def Ocean(resource_name: str,
args: OceanArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Ocean(resource_name: str,
opts: Optional[ResourceOptions] = None,
image_id: Optional[str] = None,
subnet_ids: Optional[Sequence[str]] = None,
security_groups: Optional[Sequence[str]] = None,
draining_timeout: Optional[int] = None,
utilize_reserved_instances: Optional[bool] = None,
block_device_mappings: Optional[Sequence[OceanBlockDeviceMappingArgs]] = None,
cluster_orientations: Optional[Sequence[OceanClusterOrientationArgs]] = None,
controller_id: Optional[str] = None,
desired_capacity: Optional[int] = None,
detach_load_balancers: Optional[Sequence[OceanDetachLoadBalancerArgs]] = None,
associate_ipv6_address: Optional[bool] = None,
logging: Optional[OceanLoggingArgs] = None,
fallback_to_ondemand: Optional[bool] = None,
filters: Optional[OceanFiltersArgs] = None,
grace_period: Optional[int] = None,
health_check_unhealthy_duration_before_replacement: Optional[int] = None,
iam_instance_profile: Optional[str] = None,
autoscaler: Optional[OceanAutoscalerArgs] = None,
instance_metadata_options: Optional[OceanInstanceMetadataOptionsArgs] = None,
key_name: Optional[str] = None,
load_balancers: Optional[Sequence[OceanLoadBalancerArgs]] = None,
ebs_optimized: Optional[bool] = None,
blacklists: Optional[Sequence[str]] = None,
root_volume_size: Optional[int] = None,
monitoring: Optional[bool] = None,
name: Optional[str] = None,
region: Optional[str] = None,
resource_tag_specifications: Optional[Sequence[OceanResourceTagSpecificationArgs]] = None,
min_size: Optional[int] = None,
scheduled_tasks: Optional[Sequence[OceanScheduledTaskArgs]] = None,
attach_load_balancers: Optional[Sequence[OceanAttachLoadBalancerArgs]] = None,
spot_percentage: Optional[int] = None,
spread_nodes_by: Optional[str] = None,
associate_public_ip_address: Optional[bool] = 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,
max_size: Optional[int] = None,
whitelists: Optional[Sequence[str]] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var oceanResource = new SpotInst.Aws.Ocean("oceanResource", new()
{
ImageId = "string",
SubnetIds = new[]
{
"string",
},
SecurityGroups = new[]
{
"string",
},
DrainingTimeout = 0,
UtilizeReservedInstances = false,
BlockDeviceMappings = new[]
{
new SpotInst.Aws.Inputs.OceanBlockDeviceMappingArgs
{
DeviceName = "string",
Ebs = new SpotInst.Aws.Inputs.OceanBlockDeviceMappingEbsArgs
{
DeleteOnTermination = false,
DynamicIops = new SpotInst.Aws.Inputs.OceanBlockDeviceMappingEbsDynamicIopsArgs
{
BaseSize = 0,
Resource = "string",
SizePerResourceUnit = 0,
},
DynamicVolumeSize = new SpotInst.Aws.Inputs.OceanBlockDeviceMappingEbsDynamicVolumeSizeArgs
{
BaseSize = 0,
Resource = "string",
SizePerResourceUnit = 0,
},
Encrypted = false,
Iops = 0,
KmsKeyId = "string",
SnapshotId = "string",
Throughput = 0,
VolumeSize = 0,
VolumeType = "string",
},
},
},
ClusterOrientations = new[]
{
new SpotInst.Aws.Inputs.OceanClusterOrientationArgs
{
AvailabilityVsCost = "string",
},
},
ControllerId = "string",
DesiredCapacity = 0,
DetachLoadBalancers = new[]
{
new SpotInst.Aws.Inputs.OceanDetachLoadBalancerArgs
{
Type = "string",
Arn = "string",
Name = "string",
},
},
AssociateIpv6Address = false,
Logging = new SpotInst.Aws.Inputs.OceanLoggingArgs
{
Export = new SpotInst.Aws.Inputs.OceanLoggingExportArgs
{
S3s = new[]
{
new SpotInst.Aws.Inputs.OceanLoggingExportS3Args
{
Id = "string",
},
},
},
},
FallbackToOndemand = false,
Filters = new SpotInst.Aws.Inputs.OceanFiltersArgs
{
Architectures = new[]
{
"string",
},
Categories = new[]
{
"string",
},
DiskTypes = new[]
{
"string",
},
ExcludeFamilies = new[]
{
"string",
},
ExcludeMetal = false,
Hypervisors = new[]
{
"string",
},
IncludeFamilies = new[]
{
"string",
},
IsEnaSupported = "string",
MaxGpu = 0,
MaxMemoryGib = 0,
MaxNetworkPerformance = 0,
MaxVcpu = 0,
MinEnis = 0,
MinGpu = 0,
MinMemoryGib = 0,
MinNetworkPerformance = 0,
MinVcpu = 0,
RootDeviceTypes = new[]
{
"string",
},
VirtualizationTypes = new[]
{
"string",
},
},
GracePeriod = 0,
HealthCheckUnhealthyDurationBeforeReplacement = 0,
IamInstanceProfile = "string",
Autoscaler = new SpotInst.Aws.Inputs.OceanAutoscalerArgs
{
AutoHeadroomPercentage = 0,
AutoscaleCooldown = 0,
AutoscaleDown = new SpotInst.Aws.Inputs.OceanAutoscalerAutoscaleDownArgs
{
EvaluationPeriods = 0,
IsAggressiveScaleDownEnabled = false,
MaxScaleDownPercentage = 0,
},
AutoscaleHeadroom = new SpotInst.Aws.Inputs.OceanAutoscalerAutoscaleHeadroomArgs
{
CpuPerUnit = 0,
GpuPerUnit = 0,
MemoryPerUnit = 0,
NumOfUnits = 0,
},
AutoscaleIsAutoConfig = false,
AutoscaleIsEnabled = false,
EnableAutomaticAndManualHeadroom = false,
ExtendedResourceDefinitions = new[]
{
"string",
},
ResourceLimits = new SpotInst.Aws.Inputs.OceanAutoscalerResourceLimitsArgs
{
MaxMemoryGib = 0,
MaxVcpu = 0,
},
},
InstanceMetadataOptions = new SpotInst.Aws.Inputs.OceanInstanceMetadataOptionsArgs
{
HttpTokens = "string",
HttpPutResponseHopLimit = 0,
},
KeyName = "string",
LoadBalancers = new[]
{
new SpotInst.Aws.Inputs.OceanLoadBalancerArgs
{
Arn = "string",
Name = "string",
Type = "string",
},
},
EbsOptimized = false,
Blacklists = new[]
{
"string",
},
RootVolumeSize = 0,
Monitoring = false,
Name = "string",
Region = "string",
ResourceTagSpecifications = new[]
{
new SpotInst.Aws.Inputs.OceanResourceTagSpecificationArgs
{
ShouldTagVolumes = false,
},
},
MinSize = 0,
ScheduledTasks = new[]
{
new SpotInst.Aws.Inputs.OceanScheduledTaskArgs
{
ShutdownHours = new SpotInst.Aws.Inputs.OceanScheduledTaskShutdownHoursArgs
{
TimeWindows = new[]
{
"string",
},
IsEnabled = false,
},
Tasks = new[]
{
new SpotInst.Aws.Inputs.OceanScheduledTaskTaskArgs
{
CronExpression = "string",
IsEnabled = false,
TaskType = "string",
Parameters = new SpotInst.Aws.Inputs.OceanScheduledTaskTaskParametersArgs
{
AmiAutoUpdate = new SpotInst.Aws.Inputs.OceanScheduledTaskTaskParametersAmiAutoUpdateArgs
{
AmiAutoUpdateClusterRoll = new SpotInst.Aws.Inputs.OceanScheduledTaskTaskParametersAmiAutoUpdateAmiAutoUpdateClusterRollArgs
{
BatchMinHealthyPercentage = 0,
BatchSizePercentage = 0,
Comment = "string",
RespectPdb = false,
},
ApplyRoll = false,
MinorVersion = false,
Patch = false,
},
ParametersClusterRoll = new SpotInst.Aws.Inputs.OceanScheduledTaskTaskParametersParametersClusterRollArgs
{
BatchMinHealthyPercentage = 0,
BatchSizePercentage = 0,
Comment = "string",
RespectPdb = false,
},
},
},
},
},
},
AttachLoadBalancers = new[]
{
new SpotInst.Aws.Inputs.OceanAttachLoadBalancerArgs
{
Type = "string",
Arn = "string",
Name = "string",
},
},
SpotPercentage = 0,
SpreadNodesBy = "string",
AssociatePublicIpAddress = false,
Tags = new[]
{
new SpotInst.Aws.Inputs.OceanTagArgs
{
Key = "string",
Value = "string",
},
},
UpdatePolicy = new SpotInst.Aws.Inputs.OceanUpdatePolicyArgs
{
ShouldRoll = false,
AutoApplyTags = false,
ConditionedRoll = false,
ConditionedRollParams = new[]
{
"string",
},
RollConfig = new SpotInst.Aws.Inputs.OceanUpdatePolicyRollConfigArgs
{
BatchSizePercentage = 0,
BatchMinHealthyPercentage = 0,
LaunchSpecIds = new[]
{
"string",
},
RespectPdb = false,
},
},
UseAsTemplateOnly = false,
UserData = "string",
UtilizeCommitments = false,
MaxSize = 0,
Whitelists = new[]
{
"string",
},
});
example, err := aws.NewOcean(ctx, "oceanResource", &aws.OceanArgs{
ImageId: pulumi.String("string"),
SubnetIds: pulumi.StringArray{
pulumi.String("string"),
},
SecurityGroups: pulumi.StringArray{
pulumi.String("string"),
},
DrainingTimeout: pulumi.Int(0),
UtilizeReservedInstances: pulumi.Bool(false),
BlockDeviceMappings: aws.OceanBlockDeviceMappingArray{
&aws.OceanBlockDeviceMappingArgs{
DeviceName: pulumi.String("string"),
Ebs: &aws.OceanBlockDeviceMappingEbsArgs{
DeleteOnTermination: pulumi.Bool(false),
DynamicIops: &aws.OceanBlockDeviceMappingEbsDynamicIopsArgs{
BaseSize: pulumi.Int(0),
Resource: pulumi.String("string"),
SizePerResourceUnit: pulumi.Int(0),
},
DynamicVolumeSize: &aws.OceanBlockDeviceMappingEbsDynamicVolumeSizeArgs{
BaseSize: pulumi.Int(0),
Resource: pulumi.String("string"),
SizePerResourceUnit: pulumi.Int(0),
},
Encrypted: pulumi.Bool(false),
Iops: pulumi.Int(0),
KmsKeyId: pulumi.String("string"),
SnapshotId: pulumi.String("string"),
Throughput: pulumi.Int(0),
VolumeSize: pulumi.Int(0),
VolumeType: pulumi.String("string"),
},
},
},
ClusterOrientations: aws.OceanClusterOrientationArray{
&aws.OceanClusterOrientationArgs{
AvailabilityVsCost: pulumi.String("string"),
},
},
ControllerId: pulumi.String("string"),
DesiredCapacity: pulumi.Int(0),
DetachLoadBalancers: aws.OceanDetachLoadBalancerArray{
&aws.OceanDetachLoadBalancerArgs{
Type: pulumi.String("string"),
Arn: pulumi.String("string"),
Name: pulumi.String("string"),
},
},
AssociateIpv6Address: pulumi.Bool(false),
Logging: &aws.OceanLoggingArgs{
Export: &aws.OceanLoggingExportArgs{
S3s: aws.OceanLoggingExportS3Array{
&aws.OceanLoggingExportS3Args{
Id: pulumi.String("string"),
},
},
},
},
FallbackToOndemand: pulumi.Bool(false),
Filters: &aws.OceanFiltersArgs{
Architectures: pulumi.StringArray{
pulumi.String("string"),
},
Categories: pulumi.StringArray{
pulumi.String("string"),
},
DiskTypes: pulumi.StringArray{
pulumi.String("string"),
},
ExcludeFamilies: pulumi.StringArray{
pulumi.String("string"),
},
ExcludeMetal: pulumi.Bool(false),
Hypervisors: pulumi.StringArray{
pulumi.String("string"),
},
IncludeFamilies: pulumi.StringArray{
pulumi.String("string"),
},
IsEnaSupported: pulumi.String("string"),
MaxGpu: pulumi.Int(0),
MaxMemoryGib: pulumi.Float64(0),
MaxNetworkPerformance: pulumi.Int(0),
MaxVcpu: pulumi.Int(0),
MinEnis: pulumi.Int(0),
MinGpu: pulumi.Int(0),
MinMemoryGib: pulumi.Float64(0),
MinNetworkPerformance: pulumi.Int(0),
MinVcpu: pulumi.Int(0),
RootDeviceTypes: pulumi.StringArray{
pulumi.String("string"),
},
VirtualizationTypes: pulumi.StringArray{
pulumi.String("string"),
},
},
GracePeriod: pulumi.Int(0),
HealthCheckUnhealthyDurationBeforeReplacement: pulumi.Int(0),
IamInstanceProfile: pulumi.String("string"),
Autoscaler: &aws.OceanAutoscalerArgs{
AutoHeadroomPercentage: pulumi.Int(0),
AutoscaleCooldown: pulumi.Int(0),
AutoscaleDown: &aws.OceanAutoscalerAutoscaleDownArgs{
EvaluationPeriods: pulumi.Int(0),
IsAggressiveScaleDownEnabled: pulumi.Bool(false),
MaxScaleDownPercentage: pulumi.Float64(0),
},
AutoscaleHeadroom: &aws.OceanAutoscalerAutoscaleHeadroomArgs{
CpuPerUnit: pulumi.Int(0),
GpuPerUnit: pulumi.Int(0),
MemoryPerUnit: pulumi.Int(0),
NumOfUnits: pulumi.Int(0),
},
AutoscaleIsAutoConfig: pulumi.Bool(false),
AutoscaleIsEnabled: pulumi.Bool(false),
EnableAutomaticAndManualHeadroom: pulumi.Bool(false),
ExtendedResourceDefinitions: pulumi.StringArray{
pulumi.String("string"),
},
ResourceLimits: &aws.OceanAutoscalerResourceLimitsArgs{
MaxMemoryGib: pulumi.Int(0),
MaxVcpu: pulumi.Int(0),
},
},
InstanceMetadataOptions: &aws.OceanInstanceMetadataOptionsArgs{
HttpTokens: pulumi.String("string"),
HttpPutResponseHopLimit: pulumi.Int(0),
},
KeyName: pulumi.String("string"),
LoadBalancers: aws.OceanLoadBalancerArray{
&aws.OceanLoadBalancerArgs{
Arn: pulumi.String("string"),
Name: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
EbsOptimized: pulumi.Bool(false),
Blacklists: pulumi.StringArray{
pulumi.String("string"),
},
RootVolumeSize: pulumi.Int(0),
Monitoring: pulumi.Bool(false),
Name: pulumi.String("string"),
Region: pulumi.String("string"),
ResourceTagSpecifications: aws.OceanResourceTagSpecificationArray{
&aws.OceanResourceTagSpecificationArgs{
ShouldTagVolumes: pulumi.Bool(false),
},
},
MinSize: pulumi.Int(0),
ScheduledTasks: aws.OceanScheduledTaskArray{
&aws.OceanScheduledTaskArgs{
ShutdownHours: &aws.OceanScheduledTaskShutdownHoursArgs{
TimeWindows: pulumi.StringArray{
pulumi.String("string"),
},
IsEnabled: pulumi.Bool(false),
},
Tasks: aws.OceanScheduledTaskTaskArray{
&aws.OceanScheduledTaskTaskArgs{
CronExpression: pulumi.String("string"),
IsEnabled: pulumi.Bool(false),
TaskType: pulumi.String("string"),
Parameters: &aws.OceanScheduledTaskTaskParametersArgs{
AmiAutoUpdate: &aws.OceanScheduledTaskTaskParametersAmiAutoUpdateArgs{
AmiAutoUpdateClusterRoll: &aws.OceanScheduledTaskTaskParametersAmiAutoUpdateAmiAutoUpdateClusterRollArgs{
BatchMinHealthyPercentage: pulumi.Int(0),
BatchSizePercentage: pulumi.Int(0),
Comment: pulumi.String("string"),
RespectPdb: pulumi.Bool(false),
},
ApplyRoll: pulumi.Bool(false),
MinorVersion: pulumi.Bool(false),
Patch: pulumi.Bool(false),
},
ParametersClusterRoll: &aws.OceanScheduledTaskTaskParametersParametersClusterRollArgs{
BatchMinHealthyPercentage: pulumi.Int(0),
BatchSizePercentage: pulumi.Int(0),
Comment: pulumi.String("string"),
RespectPdb: pulumi.Bool(false),
},
},
},
},
},
},
AttachLoadBalancers: aws.OceanAttachLoadBalancerArray{
&aws.OceanAttachLoadBalancerArgs{
Type: pulumi.String("string"),
Arn: pulumi.String("string"),
Name: pulumi.String("string"),
},
},
SpotPercentage: pulumi.Int(0),
SpreadNodesBy: pulumi.String("string"),
AssociatePublicIpAddress: pulumi.Bool(false),
Tags: aws.OceanTagArray{
&aws.OceanTagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
UpdatePolicy: &aws.OceanUpdatePolicyArgs{
ShouldRoll: pulumi.Bool(false),
AutoApplyTags: pulumi.Bool(false),
ConditionedRoll: pulumi.Bool(false),
ConditionedRollParams: pulumi.StringArray{
pulumi.String("string"),
},
RollConfig: &aws.OceanUpdatePolicyRollConfigArgs{
BatchSizePercentage: pulumi.Int(0),
BatchMinHealthyPercentage: pulumi.Int(0),
LaunchSpecIds: pulumi.StringArray{
pulumi.String("string"),
},
RespectPdb: pulumi.Bool(false),
},
},
UseAsTemplateOnly: pulumi.Bool(false),
UserData: pulumi.String("string"),
UtilizeCommitments: pulumi.Bool(false),
MaxSize: pulumi.Int(0),
Whitelists: pulumi.StringArray{
pulumi.String("string"),
},
})
var oceanResource = new Ocean("oceanResource", OceanArgs.builder()
.imageId("string")
.subnetIds("string")
.securityGroups("string")
.drainingTimeout(0)
.utilizeReservedInstances(false)
.blockDeviceMappings(OceanBlockDeviceMappingArgs.builder()
.deviceName("string")
.ebs(OceanBlockDeviceMappingEbsArgs.builder()
.deleteOnTermination(false)
.dynamicIops(OceanBlockDeviceMappingEbsDynamicIopsArgs.builder()
.baseSize(0)
.resource("string")
.sizePerResourceUnit(0)
.build())
.dynamicVolumeSize(OceanBlockDeviceMappingEbsDynamicVolumeSizeArgs.builder()
.baseSize(0)
.resource("string")
.sizePerResourceUnit(0)
.build())
.encrypted(false)
.iops(0)
.kmsKeyId("string")
.snapshotId("string")
.throughput(0)
.volumeSize(0)
.volumeType("string")
.build())
.build())
.clusterOrientations(OceanClusterOrientationArgs.builder()
.availabilityVsCost("string")
.build())
.controllerId("string")
.desiredCapacity(0)
.detachLoadBalancers(OceanDetachLoadBalancerArgs.builder()
.type("string")
.arn("string")
.name("string")
.build())
.associateIpv6Address(false)
.logging(OceanLoggingArgs.builder()
.export(OceanLoggingExportArgs.builder()
.s3s(OceanLoggingExportS3Args.builder()
.id("string")
.build())
.build())
.build())
.fallbackToOndemand(false)
.filters(OceanFiltersArgs.builder()
.architectures("string")
.categories("string")
.diskTypes("string")
.excludeFamilies("string")
.excludeMetal(false)
.hypervisors("string")
.includeFamilies("string")
.isEnaSupported("string")
.maxGpu(0)
.maxMemoryGib(0)
.maxNetworkPerformance(0)
.maxVcpu(0)
.minEnis(0)
.minGpu(0)
.minMemoryGib(0)
.minNetworkPerformance(0)
.minVcpu(0)
.rootDeviceTypes("string")
.virtualizationTypes("string")
.build())
.gracePeriod(0)
.healthCheckUnhealthyDurationBeforeReplacement(0)
.iamInstanceProfile("string")
.autoscaler(OceanAutoscalerArgs.builder()
.autoHeadroomPercentage(0)
.autoscaleCooldown(0)
.autoscaleDown(OceanAutoscalerAutoscaleDownArgs.builder()
.evaluationPeriods(0)
.isAggressiveScaleDownEnabled(false)
.maxScaleDownPercentage(0)
.build())
.autoscaleHeadroom(OceanAutoscalerAutoscaleHeadroomArgs.builder()
.cpuPerUnit(0)
.gpuPerUnit(0)
.memoryPerUnit(0)
.numOfUnits(0)
.build())
.autoscaleIsAutoConfig(false)
.autoscaleIsEnabled(false)
.enableAutomaticAndManualHeadroom(false)
.extendedResourceDefinitions("string")
.resourceLimits(OceanAutoscalerResourceLimitsArgs.builder()
.maxMemoryGib(0)
.maxVcpu(0)
.build())
.build())
.instanceMetadataOptions(OceanInstanceMetadataOptionsArgs.builder()
.httpTokens("string")
.httpPutResponseHopLimit(0)
.build())
.keyName("string")
.loadBalancers(OceanLoadBalancerArgs.builder()
.arn("string")
.name("string")
.type("string")
.build())
.ebsOptimized(false)
.blacklists("string")
.rootVolumeSize(0)
.monitoring(false)
.name("string")
.region("string")
.resourceTagSpecifications(OceanResourceTagSpecificationArgs.builder()
.shouldTagVolumes(false)
.build())
.minSize(0)
.scheduledTasks(OceanScheduledTaskArgs.builder()
.shutdownHours(OceanScheduledTaskShutdownHoursArgs.builder()
.timeWindows("string")
.isEnabled(false)
.build())
.tasks(OceanScheduledTaskTaskArgs.builder()
.cronExpression("string")
.isEnabled(false)
.taskType("string")
.parameters(OceanScheduledTaskTaskParametersArgs.builder()
.amiAutoUpdate(OceanScheduledTaskTaskParametersAmiAutoUpdateArgs.builder()
.amiAutoUpdateClusterRoll(OceanScheduledTaskTaskParametersAmiAutoUpdateAmiAutoUpdateClusterRollArgs.builder()
.batchMinHealthyPercentage(0)
.batchSizePercentage(0)
.comment("string")
.respectPdb(false)
.build())
.applyRoll(false)
.minorVersion(false)
.patch(false)
.build())
.parametersClusterRoll(OceanScheduledTaskTaskParametersParametersClusterRollArgs.builder()
.batchMinHealthyPercentage(0)
.batchSizePercentage(0)
.comment("string")
.respectPdb(false)
.build())
.build())
.build())
.build())
.attachLoadBalancers(OceanAttachLoadBalancerArgs.builder()
.type("string")
.arn("string")
.name("string")
.build())
.spotPercentage(0)
.spreadNodesBy("string")
.associatePublicIpAddress(false)
.tags(OceanTagArgs.builder()
.key("string")
.value("string")
.build())
.updatePolicy(OceanUpdatePolicyArgs.builder()
.shouldRoll(false)
.autoApplyTags(false)
.conditionedRoll(false)
.conditionedRollParams("string")
.rollConfig(OceanUpdatePolicyRollConfigArgs.builder()
.batchSizePercentage(0)
.batchMinHealthyPercentage(0)
.launchSpecIds("string")
.respectPdb(false)
.build())
.build())
.useAsTemplateOnly(false)
.userData("string")
.utilizeCommitments(false)
.maxSize(0)
.whitelists("string")
.build());
ocean_resource = spotinst.aws.Ocean("oceanResource",
image_id="string",
subnet_ids=["string"],
security_groups=["string"],
draining_timeout=0,
utilize_reserved_instances=False,
block_device_mappings=[spotinst.aws.OceanBlockDeviceMappingArgs(
device_name="string",
ebs=spotinst.aws.OceanBlockDeviceMappingEbsArgs(
delete_on_termination=False,
dynamic_iops=spotinst.aws.OceanBlockDeviceMappingEbsDynamicIopsArgs(
base_size=0,
resource="string",
size_per_resource_unit=0,
),
dynamic_volume_size=spotinst.aws.OceanBlockDeviceMappingEbsDynamicVolumeSizeArgs(
base_size=0,
resource="string",
size_per_resource_unit=0,
),
encrypted=False,
iops=0,
kms_key_id="string",
snapshot_id="string",
throughput=0,
volume_size=0,
volume_type="string",
),
)],
cluster_orientations=[spotinst.aws.OceanClusterOrientationArgs(
availability_vs_cost="string",
)],
controller_id="string",
desired_capacity=0,
detach_load_balancers=[spotinst.aws.OceanDetachLoadBalancerArgs(
type="string",
arn="string",
name="string",
)],
associate_ipv6_address=False,
logging=spotinst.aws.OceanLoggingArgs(
export=spotinst.aws.OceanLoggingExportArgs(
s3s=[spotinst.aws.OceanLoggingExportS3Args(
id="string",
)],
),
),
fallback_to_ondemand=False,
filters=spotinst.aws.OceanFiltersArgs(
architectures=["string"],
categories=["string"],
disk_types=["string"],
exclude_families=["string"],
exclude_metal=False,
hypervisors=["string"],
include_families=["string"],
is_ena_supported="string",
max_gpu=0,
max_memory_gib=0,
max_network_performance=0,
max_vcpu=0,
min_enis=0,
min_gpu=0,
min_memory_gib=0,
min_network_performance=0,
min_vcpu=0,
root_device_types=["string"],
virtualization_types=["string"],
),
grace_period=0,
health_check_unhealthy_duration_before_replacement=0,
iam_instance_profile="string",
autoscaler=spotinst.aws.OceanAutoscalerArgs(
auto_headroom_percentage=0,
autoscale_cooldown=0,
autoscale_down=spotinst.aws.OceanAutoscalerAutoscaleDownArgs(
evaluation_periods=0,
is_aggressive_scale_down_enabled=False,
max_scale_down_percentage=0,
),
autoscale_headroom=spotinst.aws.OceanAutoscalerAutoscaleHeadroomArgs(
cpu_per_unit=0,
gpu_per_unit=0,
memory_per_unit=0,
num_of_units=0,
),
autoscale_is_auto_config=False,
autoscale_is_enabled=False,
enable_automatic_and_manual_headroom=False,
extended_resource_definitions=["string"],
resource_limits=spotinst.aws.OceanAutoscalerResourceLimitsArgs(
max_memory_gib=0,
max_vcpu=0,
),
),
instance_metadata_options=spotinst.aws.OceanInstanceMetadataOptionsArgs(
http_tokens="string",
http_put_response_hop_limit=0,
),
key_name="string",
load_balancers=[spotinst.aws.OceanLoadBalancerArgs(
arn="string",
name="string",
type="string",
)],
ebs_optimized=False,
blacklists=["string"],
root_volume_size=0,
monitoring=False,
name="string",
region="string",
resource_tag_specifications=[spotinst.aws.OceanResourceTagSpecificationArgs(
should_tag_volumes=False,
)],
min_size=0,
scheduled_tasks=[spotinst.aws.OceanScheduledTaskArgs(
shutdown_hours=spotinst.aws.OceanScheduledTaskShutdownHoursArgs(
time_windows=["string"],
is_enabled=False,
),
tasks=[spotinst.aws.OceanScheduledTaskTaskArgs(
cron_expression="string",
is_enabled=False,
task_type="string",
parameters=spotinst.aws.OceanScheduledTaskTaskParametersArgs(
ami_auto_update=spotinst.aws.OceanScheduledTaskTaskParametersAmiAutoUpdateArgs(
ami_auto_update_cluster_roll=spotinst.aws.OceanScheduledTaskTaskParametersAmiAutoUpdateAmiAutoUpdateClusterRollArgs(
batch_min_healthy_percentage=0,
batch_size_percentage=0,
comment="string",
respect_pdb=False,
),
apply_roll=False,
minor_version=False,
patch=False,
),
parameters_cluster_roll=spotinst.aws.OceanScheduledTaskTaskParametersParametersClusterRollArgs(
batch_min_healthy_percentage=0,
batch_size_percentage=0,
comment="string",
respect_pdb=False,
),
),
)],
)],
attach_load_balancers=[spotinst.aws.OceanAttachLoadBalancerArgs(
type="string",
arn="string",
name="string",
)],
spot_percentage=0,
spread_nodes_by="string",
associate_public_ip_address=False,
tags=[spotinst.aws.OceanTagArgs(
key="string",
value="string",
)],
update_policy=spotinst.aws.OceanUpdatePolicyArgs(
should_roll=False,
auto_apply_tags=False,
conditioned_roll=False,
conditioned_roll_params=["string"],
roll_config=spotinst.aws.OceanUpdatePolicyRollConfigArgs(
batch_size_percentage=0,
batch_min_healthy_percentage=0,
launch_spec_ids=["string"],
respect_pdb=False,
),
),
use_as_template_only=False,
user_data="string",
utilize_commitments=False,
max_size=0,
whitelists=["string"])
const oceanResource = new spotinst.aws.Ocean("oceanResource", {
imageId: "string",
subnetIds: ["string"],
securityGroups: ["string"],
drainingTimeout: 0,
utilizeReservedInstances: false,
blockDeviceMappings: [{
deviceName: "string",
ebs: {
deleteOnTermination: false,
dynamicIops: {
baseSize: 0,
resource: "string",
sizePerResourceUnit: 0,
},
dynamicVolumeSize: {
baseSize: 0,
resource: "string",
sizePerResourceUnit: 0,
},
encrypted: false,
iops: 0,
kmsKeyId: "string",
snapshotId: "string",
throughput: 0,
volumeSize: 0,
volumeType: "string",
},
}],
clusterOrientations: [{
availabilityVsCost: "string",
}],
controllerId: "string",
desiredCapacity: 0,
detachLoadBalancers: [{
type: "string",
arn: "string",
name: "string",
}],
associateIpv6Address: false,
logging: {
"export": {
s3s: [{
id: "string",
}],
},
},
fallbackToOndemand: false,
filters: {
architectures: ["string"],
categories: ["string"],
diskTypes: ["string"],
excludeFamilies: ["string"],
excludeMetal: false,
hypervisors: ["string"],
includeFamilies: ["string"],
isEnaSupported: "string",
maxGpu: 0,
maxMemoryGib: 0,
maxNetworkPerformance: 0,
maxVcpu: 0,
minEnis: 0,
minGpu: 0,
minMemoryGib: 0,
minNetworkPerformance: 0,
minVcpu: 0,
rootDeviceTypes: ["string"],
virtualizationTypes: ["string"],
},
gracePeriod: 0,
healthCheckUnhealthyDurationBeforeReplacement: 0,
iamInstanceProfile: "string",
autoscaler: {
autoHeadroomPercentage: 0,
autoscaleCooldown: 0,
autoscaleDown: {
evaluationPeriods: 0,
isAggressiveScaleDownEnabled: false,
maxScaleDownPercentage: 0,
},
autoscaleHeadroom: {
cpuPerUnit: 0,
gpuPerUnit: 0,
memoryPerUnit: 0,
numOfUnits: 0,
},
autoscaleIsAutoConfig: false,
autoscaleIsEnabled: false,
enableAutomaticAndManualHeadroom: false,
extendedResourceDefinitions: ["string"],
resourceLimits: {
maxMemoryGib: 0,
maxVcpu: 0,
},
},
instanceMetadataOptions: {
httpTokens: "string",
httpPutResponseHopLimit: 0,
},
keyName: "string",
loadBalancers: [{
arn: "string",
name: "string",
type: "string",
}],
ebsOptimized: false,
blacklists: ["string"],
rootVolumeSize: 0,
monitoring: false,
name: "string",
region: "string",
resourceTagSpecifications: [{
shouldTagVolumes: false,
}],
minSize: 0,
scheduledTasks: [{
shutdownHours: {
timeWindows: ["string"],
isEnabled: false,
},
tasks: [{
cronExpression: "string",
isEnabled: false,
taskType: "string",
parameters: {
amiAutoUpdate: {
amiAutoUpdateClusterRoll: {
batchMinHealthyPercentage: 0,
batchSizePercentage: 0,
comment: "string",
respectPdb: false,
},
applyRoll: false,
minorVersion: false,
patch: false,
},
parametersClusterRoll: {
batchMinHealthyPercentage: 0,
batchSizePercentage: 0,
comment: "string",
respectPdb: false,
},
},
}],
}],
attachLoadBalancers: [{
type: "string",
arn: "string",
name: "string",
}],
spotPercentage: 0,
spreadNodesBy: "string",
associatePublicIpAddress: false,
tags: [{
key: "string",
value: "string",
}],
updatePolicy: {
shouldRoll: false,
autoApplyTags: false,
conditionedRoll: false,
conditionedRollParams: ["string"],
rollConfig: {
batchSizePercentage: 0,
batchMinHealthyPercentage: 0,
launchSpecIds: ["string"],
respectPdb: false,
},
},
useAsTemplateOnly: false,
userData: "string",
utilizeCommitments: false,
maxSize: 0,
whitelists: ["string"],
});
type: spotinst:aws:Ocean
properties:
associateIpv6Address: false
associatePublicIpAddress: false
attachLoadBalancers:
- arn: string
name: string
type: string
autoscaler:
autoHeadroomPercentage: 0
autoscaleCooldown: 0
autoscaleDown:
evaluationPeriods: 0
isAggressiveScaleDownEnabled: false
maxScaleDownPercentage: 0
autoscaleHeadroom:
cpuPerUnit: 0
gpuPerUnit: 0
memoryPerUnit: 0
numOfUnits: 0
autoscaleIsAutoConfig: false
autoscaleIsEnabled: false
enableAutomaticAndManualHeadroom: false
extendedResourceDefinitions:
- string
resourceLimits:
maxMemoryGib: 0
maxVcpu: 0
blacklists:
- string
blockDeviceMappings:
- deviceName: string
ebs:
deleteOnTermination: false
dynamicIops:
baseSize: 0
resource: string
sizePerResourceUnit: 0
dynamicVolumeSize:
baseSize: 0
resource: string
sizePerResourceUnit: 0
encrypted: false
iops: 0
kmsKeyId: string
snapshotId: string
throughput: 0
volumeSize: 0
volumeType: string
clusterOrientations:
- availabilityVsCost: string
controllerId: string
desiredCapacity: 0
detachLoadBalancers:
- arn: string
name: string
type: string
drainingTimeout: 0
ebsOptimized: false
fallbackToOndemand: false
filters:
architectures:
- string
categories:
- string
diskTypes:
- string
excludeFamilies:
- string
excludeMetal: false
hypervisors:
- string
includeFamilies:
- string
isEnaSupported: string
maxGpu: 0
maxMemoryGib: 0
maxNetworkPerformance: 0
maxVcpu: 0
minEnis: 0
minGpu: 0
minMemoryGib: 0
minNetworkPerformance: 0
minVcpu: 0
rootDeviceTypes:
- string
virtualizationTypes:
- string
gracePeriod: 0
healthCheckUnhealthyDurationBeforeReplacement: 0
iamInstanceProfile: string
imageId: string
instanceMetadataOptions:
httpPutResponseHopLimit: 0
httpTokens: string
keyName: string
loadBalancers:
- arn: string
name: string
type: string
logging:
export:
s3s:
- id: string
maxSize: 0
minSize: 0
monitoring: false
name: string
region: string
resourceTagSpecifications:
- shouldTagVolumes: false
rootVolumeSize: 0
scheduledTasks:
- shutdownHours:
isEnabled: false
timeWindows:
- string
tasks:
- cronExpression: string
isEnabled: false
parameters:
amiAutoUpdate:
amiAutoUpdateClusterRoll:
batchMinHealthyPercentage: 0
batchSizePercentage: 0
comment: string
respectPdb: false
applyRoll: false
minorVersion: false
patch: false
parametersClusterRoll:
batchMinHealthyPercentage: 0
batchSizePercentage: 0
comment: string
respectPdb: false
taskType: string
securityGroups:
- string
spotPercentage: 0
spreadNodesBy: string
subnetIds:
- string
tags:
- key: string
value: string
updatePolicy:
autoApplyTags: false
conditionedRoll: false
conditionedRollParams:
- string
rollConfig:
batchMinHealthyPercentage: 0
batchSizePercentage: 0
launchSpecIds:
- string
respectPdb: false
shouldRoll: false
useAsTemplateOnly: false
userData: string
utilizeCommitments: false
utilizeReservedInstances: false
whitelists:
- string
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:
- Image
Id string - ID of the image used to launch the instances.
- 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.
instanceTypes
- (Optional) The type of instances that may or may not be a part of the Ocean cluster.
- Associate
Ipv6Address bool - Configure IPv6 address allocation.
- Associate
Public boolIp Address - Configure public IP address allocation.
- Attach
Load List<Pulumi.Balancers Spot Inst. Aws. Inputs. Ocean Attach Load Balancer> - Attach load balancers to the cluster.
- Autoscaler
Pulumi.
Spot Inst. Aws. Inputs. Ocean Autoscaler - Describes the Ocean Kubernetes Auto Scaler.
- Blacklists List<string>
- Block
Device List<Pulumi.Mappings Spot Inst. Aws. Inputs. Ocean Block Device Mapping> - Object. Array list of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
- Cluster
Orientations List<Pulumi.Spot Inst. Aws. Inputs. Ocean Cluster Orientation> - 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.
- Detach
Load List<Pulumi.Balancers Spot Inst. Aws. Inputs. Ocean Detach Load Balancer> - Detach load balancers from 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 - Grace
Period int - The amount of time, in seconds, after the instance has launched to start checking its health.
- Health
Check intUnhealthy Duration Before Replacement - The amount of time, in seconds, an existing instance should remain active after becoming unhealthy. After the set time out the instance will be replaced. The minimum value allowed is 60, and it must be a multiple of 60.
- Iam
Instance stringProfile - The instance profile iam role.
- Instance
Metadata Pulumi.Options Spot Inst. Aws. Inputs. Ocean Instance Metadata Options - 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> - Array of load balancer objects to add to ocean cluster
- Logging
Pulumi.
Spot Inst. Aws. Inputs. Ocean Logging - 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
- The cluster name.
- Region string
- The region the cluster will run in.
- List<Pulumi.
Spot Inst. Aws. Inputs. Ocean Resource Tag Specification> - Specify which resources should be tagged with Virtual Node Group tags or Ocean tags. If tags are set on the VNG, the resources will be tagged with the VNG tags; otherwise, they will be tagged with the Ocean tags.
- 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> - Set scheduling object.
- Spot
Percentage int - The desired percentage of Spot instances out of all running instances. Only available when the field is not set in any VNG directly (launchSpec.strategy.spotPercentage).
- Spread
Nodes stringBy - Ocean will spread the nodes across markets by this value. Possible values:
vcpu
orcount
. - List<Pulumi.
Spot Inst. Aws. Inputs. Ocean Tag> - Optionally adds tags to instances launched in an Ocean cluster.
- Update
Policy Pulumi.Spot Inst. Aws. Inputs. Ocean Update Policy - 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>
- Image
Id string - ID of the image used to launch the instances.
- 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.
instanceTypes
- (Optional) The type of instances that may or may not be a part of the Ocean cluster.
- Associate
Ipv6Address bool - Configure IPv6 address allocation.
- Associate
Public boolIp Address - Configure public IP address allocation.
- Attach
Load []OceanBalancers Attach Load Balancer Args - Attach load balancers to the cluster.
- Autoscaler
Ocean
Autoscaler Args - Describes the Ocean Kubernetes Auto Scaler.
- Blacklists []string
- Block
Device []OceanMappings Block Device Mapping Args - Object. Array list of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
- 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.
- Detach
Load []OceanBalancers Detach Load Balancer Args - Detach load balancers from 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 - Grace
Period int - The amount of time, in seconds, after the instance has launched to start checking its health.
- Health
Check intUnhealthy Duration Before Replacement - The amount of time, in seconds, an existing instance should remain active after becoming unhealthy. After the set time out the instance will be replaced. The minimum value allowed is 60, and it must be a multiple of 60.
- Iam
Instance stringProfile - The instance profile iam role.
- 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
- The cluster name.
- Region string
- The region the cluster will run in.
- []Ocean
Resource Tag Specification Args - Specify which resources should be tagged with Virtual Node Group tags or Ocean tags. If tags are set on the VNG, the resources will be tagged with the VNG tags; otherwise, they will be tagged with the Ocean tags.
- Root
Volume intSize - The size (in Gb) to allocate for the root volume. Minimum
20
. - Scheduled
Tasks []OceanScheduled Task Args - Set scheduling object.
- Spot
Percentage int - The desired percentage of Spot instances out of all running instances. Only available when the field is not set in any VNG directly (launchSpec.strategy.spotPercentage).
- Spread
Nodes stringBy - Ocean will spread the nodes across markets by this value. Possible values:
vcpu
orcount
. - []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
- image
Id String - ID of the image used to launch the instances.
- 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.
instanceTypes
- (Optional) The type of instances that may or may not be a part of the Ocean cluster.
- associate
Ipv6Address Boolean - Configure IPv6 address allocation.
- associate
Public BooleanIp Address - Configure public IP address allocation.
- attach
Load List<OceanBalancers Attach Load Balancer> - Attach load balancers to the cluster.
- autoscaler
Ocean
Autoscaler - Describes the Ocean Kubernetes Auto Scaler.
- blacklists List<String>
- block
Device List<OceanMappings Block Device Mapping> - Object. Array list of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
- cluster
Orientations List<OceanCluster Orientation> - 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.
- detach
Load List<OceanBalancers Detach Load Balancer> - Detach load balancers from 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 - grace
Period Integer - The amount of time, in seconds, after the instance has launched to start checking its health.
- health
Check IntegerUnhealthy Duration Before Replacement - The amount of time, in seconds, an existing instance should remain active after becoming unhealthy. After the set time out the instance will be replaced. The minimum value allowed is 60, and it must be a multiple of 60.
- iam
Instance StringProfile - The instance profile iam role.
- instance
Metadata OceanOptions Instance Metadata Options - Ocean instance metadata options object for IMDSv2.
- key
Name String - The key pair to attach the instances.
- load
Balancers List<OceanLoad Balancer> - Array of load balancer objects to add to ocean cluster
- logging
Ocean
Logging - 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
- The cluster name.
- region String
- The region the cluster will run in.
- List<Ocean
Resource Tag Specification> - Specify which resources should be tagged with Virtual Node Group tags or Ocean tags. If tags are set on the VNG, the resources will be tagged with the VNG tags; otherwise, they will be tagged with the Ocean tags.
- root
Volume IntegerSize - The size (in Gb) to allocate for the root volume. Minimum
20
. - scheduled
Tasks List<OceanScheduled Task> - Set scheduling object.
- spot
Percentage Integer - The desired percentage of Spot instances out of all running instances. Only available when the field is not set in any VNG directly (launchSpec.strategy.spotPercentage).
- spread
Nodes StringBy - Ocean will spread the nodes across markets by this value. Possible values:
vcpu
orcount
. - List<Ocean
Tag> - Optionally adds tags to instances launched in an Ocean cluster.
- update
Policy OceanUpdate Policy - 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>
- image
Id string - ID of the image used to launch the instances.
- 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.
instanceTypes
- (Optional) The type of instances that may or may not be a part of the Ocean cluster.
- associate
Ipv6Address boolean - Configure IPv6 address allocation.
- associate
Public booleanIp Address - Configure public IP address allocation.
- attach
Load OceanBalancers Attach Load Balancer[] - Attach load balancers to the cluster.
- autoscaler
Ocean
Autoscaler - Describes the Ocean Kubernetes Auto Scaler.
- blacklists string[]
- block
Device OceanMappings Block Device Mapping[] - Object. Array list of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
- cluster
Orientations OceanCluster Orientation[] - 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.
- detach
Load OceanBalancers Detach Load Balancer[] - Detach load balancers from 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 - grace
Period number - The amount of time, in seconds, after the instance has launched to start checking its health.
- health
Check numberUnhealthy Duration Before Replacement - The amount of time, in seconds, an existing instance should remain active after becoming unhealthy. After the set time out the instance will be replaced. The minimum value allowed is 60, and it must be a multiple of 60.
- iam
Instance stringProfile - The instance profile iam role.
- instance
Metadata OceanOptions Instance Metadata Options - Ocean instance metadata options object for IMDSv2.
- key
Name string - The key pair to attach the instances.
- load
Balancers OceanLoad Balancer[] - Array of load balancer objects to add to ocean cluster
- logging
Ocean
Logging - 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
- The cluster name.
- region string
- The region the cluster will run in.
- Ocean
Resource Tag Specification[] - Specify which resources should be tagged with Virtual Node Group tags or Ocean tags. If tags are set on the VNG, the resources will be tagged with the VNG tags; otherwise, they will be tagged with the Ocean tags.
- root
Volume numberSize - The size (in Gb) to allocate for the root volume. Minimum
20
. - scheduled
Tasks OceanScheduled Task[] - Set scheduling object.
- spot
Percentage number - The desired percentage of Spot instances out of all running instances. Only available when the field is not set in any VNG directly (launchSpec.strategy.spotPercentage).
- spread
Nodes stringBy - Ocean will spread the nodes across markets by this value. Possible values:
vcpu
orcount
. - Ocean
Tag[] - Optionally adds tags to instances launched in an Ocean cluster.
- update
Policy OceanUpdate Policy - 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[]
- image_
id str - ID of the image used to launch the instances.
- 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.
instanceTypes
- (Optional) The type of instances that may or may not be a part of the Ocean cluster.
- associate_
ipv6_ booladdress - Configure IPv6 address allocation.
- associate_
public_ boolip_ address - Configure public IP address allocation.
- attach_
load_ Sequence[Oceanbalancers Attach Load Balancer Args] - Attach load balancers to the cluster.
- autoscaler
Ocean
Autoscaler Args - Describes the Ocean Kubernetes Auto Scaler.
- blacklists Sequence[str]
- block_
device_ Sequence[Oceanmappings Block Device Mapping Args] - Object. Array list of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
- 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.
- detach_
load_ Sequence[Oceanbalancers Detach Load Balancer Args] - Detach load balancers from 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 - grace_
period int - The amount of time, in seconds, after the instance has launched to start checking its health.
- health_
check_ intunhealthy_ duration_ before_ replacement - The amount of time, in seconds, an existing instance should remain active after becoming unhealthy. After the set time out the instance will be replaced. The minimum value allowed is 60, and it must be a multiple of 60.
- iam_
instance_ strprofile - The instance profile iam role.
- 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
- The cluster name.
- region str
- The region the cluster will run in.
- resource_
tag_ Sequence[Oceanspecifications Resource Tag Specification Args] - Specify which resources should be tagged with Virtual Node Group tags or Ocean tags. If tags are set on the VNG, the resources will be tagged with the VNG tags; otherwise, they will be tagged with the Ocean tags.
- root_
volume_ intsize - The size (in Gb) to allocate for the root volume. Minimum
20
. - scheduled_
tasks Sequence[OceanScheduled Task Args] - Set scheduling object.
- spot_
percentage int - The desired percentage of Spot instances out of all running instances. Only available when the field is not set in any VNG directly (launchSpec.strategy.spotPercentage).
- spread_
nodes_ strby - Ocean will spread the nodes across markets by this value. Possible values:
vcpu
orcount
. - 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]
- image
Id String - ID of the image used to launch the instances.
- 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.
instanceTypes
- (Optional) The type of instances that may or may not be a part of the Ocean cluster.
- associate
Ipv6Address Boolean - Configure IPv6 address allocation.
- associate
Public BooleanIp Address - Configure public IP address allocation.
- attach
Load List<Property Map>Balancers - Attach load balancers to the cluster.
- autoscaler Property Map
- Describes the Ocean Kubernetes Auto Scaler.
- blacklists List<String>
- block
Device List<Property Map>Mappings - Object. Array list of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
- 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.
- detach
Load List<Property Map>Balancers - Detach load balancers from 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
- grace
Period Number - The amount of time, in seconds, after the instance has launched to start checking its health.
- health
Check NumberUnhealthy Duration Before Replacement - The amount of time, in seconds, an existing instance should remain active after becoming unhealthy. After the set time out the instance will be replaced. The minimum value allowed is 60, and it must be a multiple of 60.
- iam
Instance StringProfile - The instance profile iam role.
- 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
- The cluster name.
- region String
- The region the cluster will run in.
- List<Property Map>
- Specify which resources should be tagged with Virtual Node Group tags or Ocean tags. If tags are set on the VNG, the resources will be tagged with the VNG tags; otherwise, they will be tagged with the Ocean tags.
- root
Volume NumberSize - The size (in Gb) to allocate for the root volume. Minimum
20
. - scheduled
Tasks List<Property Map> - Set scheduling object.
- spot
Percentage Number - The desired percentage of Spot instances out of all running instances. Only available when the field is not set in any VNG directly (launchSpec.strategy.spotPercentage).
- spread
Nodes StringBy - Ocean will spread the nodes across markets by this value. Possible values:
vcpu
orcount
. - 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>
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_ipv6_address: Optional[bool] = None,
associate_public_ip_address: Optional[bool] = None,
attach_load_balancers: Optional[Sequence[OceanAttachLoadBalancerArgs]] = None,
autoscaler: Optional[OceanAutoscalerArgs] = None,
blacklists: Optional[Sequence[str]] = None,
block_device_mappings: Optional[Sequence[OceanBlockDeviceMappingArgs]] = None,
cluster_orientations: Optional[Sequence[OceanClusterOrientationArgs]] = None,
controller_id: Optional[str] = None,
desired_capacity: Optional[int] = None,
detach_load_balancers: Optional[Sequence[OceanDetachLoadBalancerArgs]] = 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,
health_check_unhealthy_duration_before_replacement: 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,
resource_tag_specifications: Optional[Sequence[OceanResourceTagSpecificationArgs]] = None,
root_volume_size: Optional[int] = None,
scheduled_tasks: Optional[Sequence[OceanScheduledTaskArgs]] = None,
security_groups: Optional[Sequence[str]] = None,
spot_percentage: Optional[int] = None,
spread_nodes_by: Optional[str] = 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
Ipv6Address bool - Configure IPv6 address allocation.
- Associate
Public boolIp Address - Configure public IP address allocation.
- Attach
Load List<Pulumi.Balancers Spot Inst. Aws. Inputs. Ocean Attach Load Balancer> - Attach load balancers to the cluster.
- Autoscaler
Pulumi.
Spot Inst. Aws. Inputs. Ocean Autoscaler - Describes the Ocean Kubernetes Auto Scaler.
- Blacklists List<string>
- Block
Device List<Pulumi.Mappings Spot Inst. Aws. Inputs. Ocean Block Device Mapping> - Object. Array list of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
- Cluster
Orientations List<Pulumi.Spot Inst. Aws. Inputs. Ocean Cluster Orientation> - 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.
- Detach
Load List<Pulumi.Balancers Spot Inst. Aws. Inputs. Ocean Detach Load Balancer> - Detach load balancers from 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 - Grace
Period int - The amount of time, in seconds, after the instance has launched to start checking its health.
- Health
Check intUnhealthy Duration Before Replacement - The amount of time, in seconds, an existing instance should remain active after becoming unhealthy. After the set time out the instance will be replaced. The minimum value allowed is 60, and it must be a multiple of 60.
- 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 - 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> - Array of load balancer objects to add to ocean cluster
- Logging
Pulumi.
Spot Inst. Aws. Inputs. Ocean Logging - 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
- The cluster name.
- Region string
- The region the cluster will run in.
- List<Pulumi.
Spot Inst. Aws. Inputs. Ocean Resource Tag Specification> - Specify which resources should be tagged with Virtual Node Group tags or Ocean tags. If tags are set on the VNG, the resources will be tagged with the VNG tags; otherwise, they will be tagged with the Ocean tags.
- 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> - Set scheduling object.
- Security
Groups List<string> - One or more security group ids.
- Spot
Percentage int - The desired percentage of Spot instances out of all running instances. Only available when the field is not set in any VNG directly (launchSpec.strategy.spotPercentage).
- Spread
Nodes stringBy - Ocean will spread the nodes across markets by this value. Possible values:
vcpu
orcount
. - 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.
instanceTypes
- (Optional) The type of instances that may or may not be a part of the Ocean cluster.
- List<Pulumi.
Spot Inst. Aws. Inputs. Ocean Tag> - Optionally adds tags to instances launched in an Ocean cluster.
- Update
Policy Pulumi.Spot Inst. Aws. Inputs. Ocean Update Policy - 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>
- Associate
Ipv6Address bool - Configure IPv6 address allocation.
- Associate
Public boolIp Address - Configure public IP address allocation.
- Attach
Load []OceanBalancers Attach Load Balancer Args - Attach load balancers to the cluster.
- Autoscaler
Ocean
Autoscaler Args - Describes the Ocean Kubernetes Auto Scaler.
- Blacklists []string
- Block
Device []OceanMappings Block Device Mapping Args - Object. Array list of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
- 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.
- Detach
Load []OceanBalancers Detach Load Balancer Args - Detach load balancers from 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 - Grace
Period int - The amount of time, in seconds, after the instance has launched to start checking its health.
- Health
Check intUnhealthy Duration Before Replacement - The amount of time, in seconds, an existing instance should remain active after becoming unhealthy. After the set time out the instance will be replaced. The minimum value allowed is 60, and it must be a multiple of 60.
- 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
- The cluster name.
- Region string
- The region the cluster will run in.
- []Ocean
Resource Tag Specification Args - Specify which resources should be tagged with Virtual Node Group tags or Ocean tags. If tags are set on the VNG, the resources will be tagged with the VNG tags; otherwise, they will be tagged with the Ocean tags.
- Root
Volume intSize - The size (in Gb) to allocate for the root volume. Minimum
20
. - Scheduled
Tasks []OceanScheduled Task Args - Set scheduling object.
- Security
Groups []string - One or more security group ids.
- Spot
Percentage int - The desired percentage of Spot instances out of all running instances. Only available when the field is not set in any VNG directly (launchSpec.strategy.spotPercentage).
- Spread
Nodes stringBy - Ocean will spread the nodes across markets by this value. Possible values:
vcpu
orcount
. - Subnet
Ids []string - A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public IP.
instanceTypes
- (Optional) The type of instances that may or may not be a part of the Ocean cluster.
- []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
- associate
Ipv6Address Boolean - Configure IPv6 address allocation.
- associate
Public BooleanIp Address - Configure public IP address allocation.
- attach
Load List<OceanBalancers Attach Load Balancer> - Attach load balancers to the cluster.
- autoscaler
Ocean
Autoscaler - Describes the Ocean Kubernetes Auto Scaler.
- blacklists List<String>
- block
Device List<OceanMappings Block Device Mapping> - Object. Array list of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
- cluster
Orientations List<OceanCluster Orientation> - 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.
- detach
Load List<OceanBalancers Detach Load Balancer> - Detach load balancers from 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 - grace
Period Integer - The amount of time, in seconds, after the instance has launched to start checking its health.
- health
Check IntegerUnhealthy Duration Before Replacement - The amount of time, in seconds, an existing instance should remain active after becoming unhealthy. After the set time out the instance will be replaced. The minimum value allowed is 60, and it must be a multiple of 60.
- 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 - Ocean instance metadata options object for IMDSv2.
- key
Name String - The key pair to attach the instances.
- load
Balancers List<OceanLoad Balancer> - Array of load balancer objects to add to ocean cluster
- logging
Ocean
Logging - 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
- The cluster name.
- region String
- The region the cluster will run in.
- List<Ocean
Resource Tag Specification> - Specify which resources should be tagged with Virtual Node Group tags or Ocean tags. If tags are set on the VNG, the resources will be tagged with the VNG tags; otherwise, they will be tagged with the Ocean tags.
- root
Volume IntegerSize - The size (in Gb) to allocate for the root volume. Minimum
20
. - scheduled
Tasks List<OceanScheduled Task> - Set scheduling object.
- security
Groups List<String> - One or more security group ids.
- spot
Percentage Integer - The desired percentage of Spot instances out of all running instances. Only available when the field is not set in any VNG directly (launchSpec.strategy.spotPercentage).
- spread
Nodes StringBy - Ocean will spread the nodes across markets by this value. Possible values:
vcpu
orcount
. - 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.
instanceTypes
- (Optional) The type of instances that may or may not be a part of the Ocean cluster.
- List<Ocean
Tag> - Optionally adds tags to instances launched in an Ocean cluster.
- update
Policy OceanUpdate Policy - 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>
- associate
Ipv6Address boolean - Configure IPv6 address allocation.
- associate
Public booleanIp Address - Configure public IP address allocation.
- attach
Load OceanBalancers Attach Load Balancer[] - Attach load balancers to the cluster.
- autoscaler
Ocean
Autoscaler - Describes the Ocean Kubernetes Auto Scaler.
- blacklists string[]
- block
Device OceanMappings Block Device Mapping[] - Object. Array list of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
- cluster
Orientations OceanCluster Orientation[] - 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.
- detach
Load OceanBalancers Detach Load Balancer[] - Detach load balancers from 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 - grace
Period number - The amount of time, in seconds, after the instance has launched to start checking its health.
- health
Check numberUnhealthy Duration Before Replacement - The amount of time, in seconds, an existing instance should remain active after becoming unhealthy. After the set time out the instance will be replaced. The minimum value allowed is 60, and it must be a multiple of 60.
- 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 - Ocean instance metadata options object for IMDSv2.
- key
Name string - The key pair to attach the instances.
- load
Balancers OceanLoad Balancer[] - Array of load balancer objects to add to ocean cluster
- logging
Ocean
Logging - 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
- The cluster name.
- region string
- The region the cluster will run in.
- Ocean
Resource Tag Specification[] - Specify which resources should be tagged with Virtual Node Group tags or Ocean tags. If tags are set on the VNG, the resources will be tagged with the VNG tags; otherwise, they will be tagged with the Ocean tags.
- root
Volume numberSize - The size (in Gb) to allocate for the root volume. Minimum
20
. - scheduled
Tasks OceanScheduled Task[] - Set scheduling object.
- security
Groups string[] - One or more security group ids.
- spot
Percentage number - The desired percentage of Spot instances out of all running instances. Only available when the field is not set in any VNG directly (launchSpec.strategy.spotPercentage).
- spread
Nodes stringBy - Ocean will spread the nodes across markets by this value. Possible values:
vcpu
orcount
. - subnet
Ids string[] - A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public IP.
instanceTypes
- (Optional) The type of instances that may or may not be a part of the Ocean cluster.
- Ocean
Tag[] - Optionally adds tags to instances launched in an Ocean cluster.
- update
Policy OceanUpdate Policy - 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[]
- associate_
ipv6_ booladdress - Configure IPv6 address allocation.
- associate_
public_ boolip_ address - Configure public IP address allocation.
- attach_
load_ Sequence[Oceanbalancers Attach Load Balancer Args] - Attach load balancers to the cluster.
- autoscaler
Ocean
Autoscaler Args - Describes the Ocean Kubernetes Auto Scaler.
- blacklists Sequence[str]
- block_
device_ Sequence[Oceanmappings Block Device Mapping Args] - Object. Array list of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
- 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.
- detach_
load_ Sequence[Oceanbalancers Detach Load Balancer Args] - Detach load balancers from 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 - grace_
period int - The amount of time, in seconds, after the instance has launched to start checking its health.
- health_
check_ intunhealthy_ duration_ before_ replacement - The amount of time, in seconds, an existing instance should remain active after becoming unhealthy. After the set time out the instance will be replaced. The minimum value allowed is 60, and it must be a multiple of 60.
- 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
- The cluster name.
- region str
- The region the cluster will run in.
- resource_
tag_ Sequence[Oceanspecifications Resource Tag Specification Args] - Specify which resources should be tagged with Virtual Node Group tags or Ocean tags. If tags are set on the VNG, the resources will be tagged with the VNG tags; otherwise, they will be tagged with the Ocean tags.
- root_
volume_ intsize - The size (in Gb) to allocate for the root volume. Minimum
20
. - scheduled_
tasks Sequence[OceanScheduled Task Args] - Set scheduling object.
- security_
groups Sequence[str] - One or more security group ids.
- spot_
percentage int - The desired percentage of Spot instances out of all running instances. Only available when the field is not set in any VNG directly (launchSpec.strategy.spotPercentage).
- spread_
nodes_ strby - Ocean will spread the nodes across markets by this value. Possible values:
vcpu
orcount
. - 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.
instanceTypes
- (Optional) The type of instances that may or may not be a part of the Ocean cluster.
- 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]
- associate
Ipv6Address Boolean - Configure IPv6 address allocation.
- associate
Public BooleanIp Address - Configure public IP address allocation.
- attach
Load List<Property Map>Balancers - Attach load balancers to the cluster.
- autoscaler Property Map
- Describes the Ocean Kubernetes Auto Scaler.
- blacklists List<String>
- block
Device List<Property Map>Mappings - Object. Array list of block devices that are exposed to the instance, specify either virtual devices and EBS volumes.
- 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.
- detach
Load List<Property Map>Balancers - Detach load balancers from 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
- grace
Period Number - The amount of time, in seconds, after the instance has launched to start checking its health.
- health
Check NumberUnhealthy Duration Before Replacement - The amount of time, in seconds, an existing instance should remain active after becoming unhealthy. After the set time out the instance will be replaced. The minimum value allowed is 60, and it must be a multiple of 60.
- 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
- The cluster name.
- region String
- The region the cluster will run in.
- List<Property Map>
- Specify which resources should be tagged with Virtual Node Group tags or Ocean tags. If tags are set on the VNG, the resources will be tagged with the VNG tags; otherwise, they will be tagged with the Ocean tags.
- root
Volume NumberSize - The size (in Gb) to allocate for the root volume. Minimum
20
. - scheduled
Tasks List<Property Map> - Set scheduling object.
- security
Groups List<String> - One or more security group ids.
- spot
Percentage Number - The desired percentage of Spot instances out of all running instances. Only available when the field is not set in any VNG directly (launchSpec.strategy.spotPercentage).
- spread
Nodes StringBy - Ocean will spread the nodes across markets by this value. Possible values:
vcpu
orcount
. - 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.
instanceTypes
- (Optional) The type of instances that may or may not be a part of the Ocean cluster.
- 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>
Supporting Types
OceanAttachLoadBalancer, OceanAttachLoadBalancerArgs
OceanAutoscaler, OceanAutoscalerArgs
- 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, OceanAutoscalerAutoscaleDownArgs
- Evaluation
Periods int - Is
Aggressive boolScale Down Enabled - When set to 'true', the Aggressive Scale Down feature is enabled.
- Max
Scale doubleDown Percentage - Would represent the maximum % to scale-down. Number between 1-100.
- Evaluation
Periods int - Is
Aggressive boolScale Down Enabled - When set to 'true', the Aggressive Scale Down feature is enabled.
- Max
Scale float64Down Percentage - Would represent the maximum % to scale-down. Number between 1-100.
- evaluation
Periods Integer - is
Aggressive BooleanScale Down Enabled - When set to 'true', the Aggressive Scale Down feature is enabled.
- max
Scale DoubleDown Percentage - Would represent the maximum % to scale-down. Number between 1-100.
- evaluation
Periods number - is
Aggressive booleanScale Down Enabled - When set to 'true', the Aggressive Scale Down feature is enabled.
- max
Scale numberDown Percentage - Would represent the maximum % to scale-down. Number between 1-100.
- evaluation_
periods int - is_
aggressive_ boolscale_ down_ enabled - When set to 'true', the Aggressive Scale Down feature is enabled.
- max_
scale_ floatdown_ percentage - Would represent the maximum % to scale-down. Number between 1-100.
- evaluation
Periods Number - is
Aggressive BooleanScale Down Enabled - When set to 'true', the Aggressive Scale Down feature is enabled.
- max
Scale NumberDown Percentage - Would represent the maximum % to scale-down. Number between 1-100.
OceanAutoscalerAutoscaleHeadroom, OceanAutoscalerAutoscaleHeadroomArgs
- 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, OceanAutoscalerResourceLimitsArgs
- Max
Memory intGib - The maximum memory in GiB units that can be allocated to the cluster.
- Max
Vcpu int - The maximum cpu in vCPU units that can be allocated to the cluster.
- Max
Memory intGib - The maximum memory in GiB units that can be allocated to the cluster.
- Max
Vcpu int - The maximum cpu in vCPU units that can be allocated to the cluster.
- max
Memory IntegerGib - The maximum memory in GiB units that can be allocated to the cluster.
- max
Vcpu Integer - The maximum cpu in vCPU units that can be allocated to the cluster.
- max
Memory numberGib - The maximum memory in GiB units that can be allocated to the cluster.
- max
Vcpu number - The maximum cpu in vCPU units that can be allocated to the cluster.
- max_
memory_ intgib - The maximum memory in GiB units that can be allocated to the cluster.
- max_
vcpu int - The maximum cpu in vCPU units that can be allocated to the cluster.
- max
Memory NumberGib - The maximum memory in GiB units that can be allocated to the cluster.
- max
Vcpu Number - The maximum cpu in vCPU units that can be allocated to the cluster.
OceanBlockDeviceMapping, OceanBlockDeviceMappingArgs
- Device
Name string - String. Set device name. (Example:
/dev/xvda
). - Ebs
Pulumi.
Spot Inst. Aws. Inputs. Ocean Block Device Mapping Ebs - Object. Set Elastic Block Store properties .
- Device
Name string - String. Set device name. (Example:
/dev/xvda
). - Ebs
Ocean
Block Device Mapping Ebs - Object. Set Elastic Block Store properties .
- device
Name String - String. Set device name. (Example:
/dev/xvda
). - ebs
Ocean
Block Device Mapping Ebs - Object. Set Elastic Block Store properties .
- device
Name string - String. Set device name. (Example:
/dev/xvda
). - ebs
Ocean
Block Device Mapping Ebs - Object. Set Elastic Block Store properties .
- device_
name str - String. Set device name. (Example:
/dev/xvda
). - ebs
Ocean
Block Device Mapping Ebs - Object. Set Elastic Block Store properties .
- device
Name String - String. Set device name. (Example:
/dev/xvda
). - ebs Property Map
- Object. Set Elastic Block Store properties .
OceanBlockDeviceMappingEbs, OceanBlockDeviceMappingEbsArgs
- Delete
On boolTermination - Boolean. Flag to delete the EBS on instance termination.
- Dynamic
Iops Pulumi.Spot Inst. Aws. Inputs. Ocean Block Device Mapping Ebs Dynamic Iops - Set dynamic IOPS properties. When using this object, you cannot use the
iops
attribute. You must use one or the other. - Dynamic
Volume Pulumi.Size Spot Inst. Aws. Inputs. Ocean Block Device Mapping Ebs Dynamic Volume Size - Object. Set dynamic volume size properties. When using this object, you cannot use volumeSize. You must use one or the other.
- Encrypted bool
- Boolean. Enables EBS encryption on the volume.
- Iops int
- Must be greater than or equal to 0.
- Kms
Key stringId - String. Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
- Snapshot
Id string - (Optional) String. The Snapshot ID to mount by.
- Throughput int
- The amount of data transferred to or from a storage device per second, you can use this param just in a case that
volume_type
=gp3
. - Volume
Size int - Int. The size, in GB of the volume.
- Volume
Type string - String. The type of the volume. (Example:
gp2
).
- Delete
On boolTermination - Boolean. Flag to delete the EBS on instance termination.
- Dynamic
Iops OceanBlock Device Mapping Ebs Dynamic Iops - Set dynamic IOPS properties. When using this object, you cannot use the
iops
attribute. You must use one or the other. - Dynamic
Volume OceanSize Block Device Mapping Ebs Dynamic Volume Size - Object. Set dynamic volume size properties. When using this object, you cannot use volumeSize. You must use one or the other.
- Encrypted bool
- Boolean. Enables EBS encryption on the volume.
- Iops int
- Must be greater than or equal to 0.
- Kms
Key stringId - String. Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
- Snapshot
Id string - (Optional) String. The Snapshot ID to mount by.
- Throughput int
- The amount of data transferred to or from a storage device per second, you can use this param just in a case that
volume_type
=gp3
. - Volume
Size int - Int. The size, in GB of the volume.
- Volume
Type string - String. The type of the volume. (Example:
gp2
).
- delete
On BooleanTermination - Boolean. Flag to delete the EBS on instance termination.
- dynamic
Iops OceanBlock Device Mapping Ebs Dynamic Iops - Set dynamic IOPS properties. When using this object, you cannot use the
iops
attribute. You must use one or the other. - dynamic
Volume OceanSize Block Device Mapping Ebs Dynamic Volume Size - Object. Set dynamic volume size properties. When using this object, you cannot use volumeSize. You must use one or the other.
- encrypted Boolean
- Boolean. Enables EBS encryption on the volume.
- iops Integer
- Must be greater than or equal to 0.
- kms
Key StringId - String. Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
- snapshot
Id String - (Optional) String. The Snapshot ID to mount by.
- throughput Integer
- The amount of data transferred to or from a storage device per second, you can use this param just in a case that
volume_type
=gp3
. - volume
Size Integer - Int. The size, in GB of the volume.
- volume
Type String - String. The type of the volume. (Example:
gp2
).
- delete
On booleanTermination - Boolean. Flag to delete the EBS on instance termination.
- dynamic
Iops OceanBlock Device Mapping Ebs Dynamic Iops - Set dynamic IOPS properties. When using this object, you cannot use the
iops
attribute. You must use one or the other. - dynamic
Volume OceanSize Block Device Mapping Ebs Dynamic Volume Size - Object. Set dynamic volume size properties. When using this object, you cannot use volumeSize. You must use one or the other.
- encrypted boolean
- Boolean. Enables EBS encryption on the volume.
- iops number
- Must be greater than or equal to 0.
- kms
Key stringId - String. Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
- snapshot
Id string - (Optional) String. The Snapshot ID to mount by.
- throughput number
- The amount of data transferred to or from a storage device per second, you can use this param just in a case that
volume_type
=gp3
. - volume
Size number - Int. The size, in GB of the volume.
- volume
Type string - String. The type of the volume. (Example:
gp2
).
- delete_
on_ booltermination - Boolean. Flag to delete the EBS on instance termination.
- dynamic_
iops OceanBlock Device Mapping Ebs Dynamic Iops - Set dynamic IOPS properties. When using this object, you cannot use the
iops
attribute. You must use one or the other. - dynamic_
volume_ Oceansize Block Device Mapping Ebs Dynamic Volume Size - Object. Set dynamic volume size properties. When using this object, you cannot use volumeSize. You must use one or the other.
- encrypted bool
- Boolean. Enables EBS encryption on the volume.
- iops int
- Must be greater than or equal to 0.
- kms_
key_ strid - String. Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
- snapshot_
id str - (Optional) String. The Snapshot ID to mount by.
- throughput int
- The amount of data transferred to or from a storage device per second, you can use this param just in a case that
volume_type
=gp3
. - volume_
size int - Int. The size, in GB of the volume.
- volume_
type str - String. The type of the volume. (Example:
gp2
).
- delete
On BooleanTermination - Boolean. Flag to delete the EBS on instance termination.
- dynamic
Iops Property Map - Set dynamic IOPS properties. When using this object, you cannot use the
iops
attribute. You must use one or the other. - dynamic
Volume Property MapSize - Object. Set dynamic volume size properties. When using this object, you cannot use volumeSize. You must use one or the other.
- encrypted Boolean
- Boolean. Enables EBS encryption on the volume.
- iops Number
- Must be greater than or equal to 0.
- kms
Key StringId - String. Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
- snapshot
Id String - (Optional) String. The Snapshot ID to mount by.
- throughput Number
- The amount of data transferred to or from a storage device per second, you can use this param just in a case that
volume_type
=gp3
. - volume
Size Number - Int. The size, in GB of the volume.
- volume
Type String - String. The type of the volume. (Example:
gp2
).
OceanBlockDeviceMappingEbsDynamicIops, OceanBlockDeviceMappingEbsDynamicIopsArgs
- Base
Size int - Initial size for IOPS.
- Resource string
- Size
Per intResource Unit - Additional size per resource unit (in IOPS). (Example:
baseSize=50
,sizePerResourceUnit=20
, and an instance with 2 CPU is launched; its IOPS size will be: 90).
- Base
Size int - Initial size for IOPS.
- Resource string
- Size
Per intResource Unit - Additional size per resource unit (in IOPS). (Example:
baseSize=50
,sizePerResourceUnit=20
, and an instance with 2 CPU is launched; its IOPS size will be: 90).
- base
Size Integer - Initial size for IOPS.
- resource String
- size
Per IntegerResource Unit - Additional size per resource unit (in IOPS). (Example:
baseSize=50
,sizePerResourceUnit=20
, and an instance with 2 CPU is launched; its IOPS size will be: 90).
- base
Size number - Initial size for IOPS.
- resource string
- size
Per numberResource Unit - Additional size per resource unit (in IOPS). (Example:
baseSize=50
,sizePerResourceUnit=20
, and an instance with 2 CPU is launched; its IOPS size will be: 90).
- base_
size int - Initial size for IOPS.
- resource str
- size_
per_ intresource_ unit - Additional size per resource unit (in IOPS). (Example:
baseSize=50
,sizePerResourceUnit=20
, and an instance with 2 CPU is launched; its IOPS size will be: 90).
- base
Size Number - Initial size for IOPS.
- resource String
- size
Per NumberResource Unit - Additional size per resource unit (in IOPS). (Example:
baseSize=50
,sizePerResourceUnit=20
, and an instance with 2 CPU is launched; its IOPS size will be: 90).
OceanBlockDeviceMappingEbsDynamicVolumeSize, OceanBlockDeviceMappingEbsDynamicVolumeSizeArgs
- Base
Size int - Int. Initial size for volume. (Example: 50)
- Resource string
- String. Resource type to increase volume size dynamically by. (Valid values:
CPU
) - Size
Per intResource Unit - Int. Additional size (in GB) per resource unit. (Example:
baseSize=50
,sizePerResourceUnit=20
, and instance with 2 CPU is launched; its total disk size will be: 90GB).
- Base
Size int - Int. Initial size for volume. (Example: 50)
- Resource string
- String. Resource type to increase volume size dynamically by. (Valid values:
CPU
) - Size
Per intResource Unit - Int. Additional size (in GB) per resource unit. (Example:
baseSize=50
,sizePerResourceUnit=20
, and instance with 2 CPU is launched; its total disk size will be: 90GB).
- base
Size Integer - Int. Initial size for volume. (Example: 50)
- resource String
- String. Resource type to increase volume size dynamically by. (Valid values:
CPU
) - size
Per IntegerResource Unit - Int. Additional size (in GB) per resource unit. (Example:
baseSize=50
,sizePerResourceUnit=20
, and instance with 2 CPU is launched; its total disk size will be: 90GB).
- base
Size number - Int. Initial size for volume. (Example: 50)
- resource string
- String. Resource type to increase volume size dynamically by. (Valid values:
CPU
) - size
Per numberResource Unit - Int. Additional size (in GB) per resource unit. (Example:
baseSize=50
,sizePerResourceUnit=20
, and instance with 2 CPU is launched; its total disk size will be: 90GB).
- base_
size int - Int. Initial size for volume. (Example: 50)
- resource str
- String. Resource type to increase volume size dynamically by. (Valid values:
CPU
) - size_
per_ intresource_ unit - Int. Additional size (in GB) per resource unit. (Example:
baseSize=50
,sizePerResourceUnit=20
, and instance with 2 CPU is launched; its total disk size will be: 90GB).
- base
Size Number - Int. Initial size for volume. (Example: 50)
- resource String
- String. Resource type to increase volume size dynamically by. (Valid values:
CPU
) - size
Per NumberResource Unit - Int. Additional size (in GB) per resource unit. (Example:
baseSize=50
,sizePerResourceUnit=20
, and instance with 2 CPU is launched; its total disk size will be: 90GB).
OceanClusterOrientation, OceanClusterOrientationArgs
- 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
.
OceanDetachLoadBalancer, OceanDetachLoadBalancerArgs
OceanFilters, OceanFiltersArgs
- 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 - Max
Network intPerformance - Maximum Bandwidth in Gib/s of network performance.
- Max
Vcpu int - 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 - Max
Network intPerformance - Maximum Bandwidth in Gib/s of network performance.
- Max
Vcpu int - 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 - max
Network IntegerPerformance - Maximum Bandwidth in Gib/s of network performance.
- max
Vcpu Integer - 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 - max
Network numberPerformance - Maximum Bandwidth in Gib/s of network performance.
- max
Vcpu number - 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 - max_
network_ intperformance - Maximum Bandwidth in Gib/s of network performance.
- max_
vcpu int - 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 - max
Network NumberPerformance - Maximum Bandwidth in Gib/s of network performance.
- max
Vcpu Number - 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, OceanInstanceMetadataOptionsArgs
- 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, OceanLoadBalancerArgs
OceanLogging, OceanLoggingArgs
- 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, OceanLoggingExportArgs
- 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, OceanLoggingExportS3Args
- 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.
OceanResourceTagSpecification, OceanResourceTagSpecificationArgs
- Should
Tag boolVolumes - Specify if Volume resources will be tagged with Virtual Node Group tags or Ocean tags.
- Should
Tag boolVolumes - Specify if Volume resources will be tagged with Virtual Node Group tags or Ocean tags.
- should
Tag BooleanVolumes - Specify if Volume resources will be tagged with Virtual Node Group tags or Ocean tags.
- should
Tag booleanVolumes - Specify if Volume resources will be tagged with Virtual Node Group tags or Ocean tags.
- should_
tag_ boolvolumes - Specify if Volume resources will be tagged with Virtual Node Group tags or Ocean tags.
- should
Tag BooleanVolumes - Specify if Volume resources will be tagged with Virtual Node Group tags or Ocean tags.
OceanScheduledTask, OceanScheduledTaskArgs
- Shutdown
Hours Pulumi.Spot Inst. Aws. Inputs. Ocean Scheduled Task Shutdown Hours - Set shutdown hours for cluster object.
- Tasks
List<Pulumi.
Spot Inst. Aws. Inputs. Ocean Scheduled Task Task> - The scheduling tasks for the cluster.
- Shutdown
Hours OceanScheduled Task Shutdown Hours - Set shutdown hours for cluster object.
- Tasks
[]Ocean
Scheduled Task Task - The scheduling tasks for the cluster.
- shutdown
Hours OceanScheduled Task Shutdown Hours - Set shutdown hours for cluster object.
- tasks
List<Ocean
Scheduled Task Task> - The scheduling tasks for the cluster.
- shutdown
Hours OceanScheduled Task Shutdown Hours - Set shutdown hours for cluster object.
- tasks
Ocean
Scheduled Task Task[] - The scheduling tasks for the cluster.
- shutdown_
hours OceanScheduled Task Shutdown Hours - Set shutdown hours for cluster object.
- tasks
Sequence[Ocean
Scheduled Task Task] - The scheduling tasks for the cluster.
- shutdown
Hours Property Map - Set shutdown hours for cluster object.
- tasks List<Property Map>
- The scheduling tasks for the cluster.
OceanScheduledTaskShutdownHours, OceanScheduledTaskShutdownHoursArgs
- Time
Windows List<string> - Set time windows for shutdown hours. Specify a list of
timeWindows
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
). - Is
Enabled bool - Toggle the shutdown hours task. (Example:
true
).
- Time
Windows []string - Set time windows for shutdown hours. Specify a list of
timeWindows
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
). - Is
Enabled bool - Toggle the shutdown hours task. (Example:
true
).
- time
Windows List<String> - Set time windows for shutdown hours. Specify a list of
timeWindows
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
). - is
Enabled Boolean - Toggle the shutdown hours task. (Example:
true
).
- time
Windows string[] - Set time windows for shutdown hours. Specify a list of
timeWindows
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
). - is
Enabled boolean - Toggle the shutdown hours task. (Example:
true
).
- time_
windows Sequence[str] - Set time windows for shutdown hours. Specify a list of
timeWindows
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
). - is_
enabled bool - Toggle the shutdown hours task. (Example:
true
).
- time
Windows List<String> - Set time windows for shutdown hours. Specify a list of
timeWindows
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
). - is
Enabled Boolean - Toggle the shutdown hours task. (Example:
true
).
OceanScheduledTaskTask, OceanScheduledTaskTaskArgs
- Cron
Expression string - A valid cron expression. The cron is running in UTC time zone and is in Unix cron format Cron Expression Validator Script. Only one of
frequency
orcronExpression
should be used at a time. Required forcluster.scheduling.tasks
object. (Example:0 1 * * *
). - Is
Enabled bool - Describes whether the task is enabled. When true the task should run when false it should not run. Required for
cluster.scheduling.tasks
object. - Task
Type string - Valid values:
clusterRoll
amiAutoUpdate
. Required forcluster.scheduling.tasks
- Parameters
Pulumi.
Spot Inst. Aws. Inputs. Ocean Scheduled Task Task Parameters - This filed will be compatible to the
task_type
field. Iftask_type
is defined asclusterRoll
, user cluster roll object in parameters.
- Cron
Expression string - A valid cron expression. The cron is running in UTC time zone and is in Unix cron format Cron Expression Validator Script. Only one of
frequency
orcronExpression
should be used at a time. Required forcluster.scheduling.tasks
object. (Example:0 1 * * *
). - Is
Enabled bool - Describes whether the task is enabled. When true the task should run when false it should not run. Required for
cluster.scheduling.tasks
object. - Task
Type string - Valid values:
clusterRoll
amiAutoUpdate
. Required forcluster.scheduling.tasks
- Parameters
Ocean
Scheduled Task Task Parameters - This filed will be compatible to the
task_type
field. Iftask_type
is defined asclusterRoll
, user cluster roll object in parameters.
- cron
Expression String - A valid cron expression. The cron is running in UTC time zone and is in Unix cron format Cron Expression Validator Script. Only one of
frequency
orcronExpression
should be used at a time. Required forcluster.scheduling.tasks
object. (Example:0 1 * * *
). - is
Enabled Boolean - Describes whether the task is enabled. When true the task should run when false it should not run. Required for
cluster.scheduling.tasks
object. - task
Type String - Valid values:
clusterRoll
amiAutoUpdate
. Required forcluster.scheduling.tasks
- parameters
Ocean
Scheduled Task Task Parameters - This filed will be compatible to the
task_type
field. Iftask_type
is defined asclusterRoll
, user cluster roll object in parameters.
- cron
Expression string - A valid cron expression. The cron is running in UTC time zone and is in Unix cron format Cron Expression Validator Script. Only one of
frequency
orcronExpression
should be used at a time. Required forcluster.scheduling.tasks
object. (Example:0 1 * * *
). - is
Enabled boolean - Describes whether the task is enabled. When true the task should run when false it should not run. Required for
cluster.scheduling.tasks
object. - task
Type string - Valid values:
clusterRoll
amiAutoUpdate
. Required forcluster.scheduling.tasks
- parameters
Ocean
Scheduled Task Task Parameters - This filed will be compatible to the
task_type
field. Iftask_type
is defined asclusterRoll
, user cluster roll object in parameters.
- cron_
expression str - A valid cron expression. The cron is running in UTC time zone and is in Unix cron format Cron Expression Validator Script. Only one of
frequency
orcronExpression
should be used at a time. Required forcluster.scheduling.tasks
object. (Example:0 1 * * *
). - is_
enabled bool - Describes whether the task is enabled. When true the task should run when false it should not run. Required for
cluster.scheduling.tasks
object. - task_
type str - Valid values:
clusterRoll
amiAutoUpdate
. Required forcluster.scheduling.tasks
- parameters
Ocean
Scheduled Task Task Parameters - This filed will be compatible to the
task_type
field. Iftask_type
is defined asclusterRoll
, user cluster roll object in parameters.
- cron
Expression String - A valid cron expression. The cron is running in UTC time zone and is in Unix cron format Cron Expression Validator Script. Only one of
frequency
orcronExpression
should be used at a time. Required forcluster.scheduling.tasks
object. (Example:0 1 * * *
). - is
Enabled Boolean - Describes whether the task is enabled. When true the task should run when false it should not run. Required for
cluster.scheduling.tasks
object. - task
Type String - Valid values:
clusterRoll
amiAutoUpdate
. Required forcluster.scheduling.tasks
- parameters Property Map
- This filed will be compatible to the
task_type
field. Iftask_type
is defined asclusterRoll
, user cluster roll object in parameters.
OceanScheduledTaskTaskParameters, OceanScheduledTaskTaskParametersArgs
- Ami
Auto Pulumi.Update Spot Inst. Aws. Inputs. Ocean Scheduled Task Task Parameters Ami Auto Update - Set amiAutoUpdate object
- Parameters
Cluster Pulumi.Roll Spot Inst. Aws. Inputs. Ocean Scheduled Task Task Parameters Parameters Cluster Roll - Set clusterRoll object
- Ami
Auto OceanUpdate Scheduled Task Task Parameters Ami Auto Update - Set amiAutoUpdate object
- Parameters
Cluster OceanRoll Scheduled Task Task Parameters Parameters Cluster Roll - Set clusterRoll object
- ami
Auto OceanUpdate Scheduled Task Task Parameters Ami Auto Update - Set amiAutoUpdate object
- parameters
Cluster OceanRoll Scheduled Task Task Parameters Parameters Cluster Roll - Set clusterRoll object
- ami
Auto OceanUpdate Scheduled Task Task Parameters Ami Auto Update - Set amiAutoUpdate object
- parameters
Cluster OceanRoll Scheduled Task Task Parameters Parameters Cluster Roll - Set clusterRoll object
- ami_
auto_ Oceanupdate Scheduled Task Task Parameters Ami Auto Update - Set amiAutoUpdate object
- parameters_
cluster_ Oceanroll Scheduled Task Task Parameters Parameters Cluster Roll - Set clusterRoll object
- ami
Auto Property MapUpdate - Set amiAutoUpdate object
- parameters
Cluster Property MapRoll - Set clusterRoll object
OceanScheduledTaskTaskParametersAmiAutoUpdate, OceanScheduledTaskTaskParametersAmiAutoUpdateArgs
- Ami
Auto Pulumi.Update Cluster Roll Spot Inst. Aws. Inputs. Ocean Scheduled Task Task Parameters Ami Auto Update Ami Auto Update Cluster Roll - Set clusterRoll object
- Apply
Roll bool - When the AMI is updated according to the configuration set, a cluster roll can be triggered
- Minor
Version bool - When set to 'true', the auto-update process will update the VNGs’ AMI with the AMI to match the Kubernetes control plane version. either "patch" or "minor_version" must be true.
- Patch bool
- When set to 'true', the auto-update process will update the VNGs’ images with the latest security patches. either "patch" or "minorVersion" must be true.
- Ami
Auto OceanUpdate Cluster Roll Scheduled Task Task Parameters Ami Auto Update Ami Auto Update Cluster Roll - Set clusterRoll object
- Apply
Roll bool - When the AMI is updated according to the configuration set, a cluster roll can be triggered
- Minor
Version bool - When set to 'true', the auto-update process will update the VNGs’ AMI with the AMI to match the Kubernetes control plane version. either "patch" or "minor_version" must be true.
- Patch bool
- When set to 'true', the auto-update process will update the VNGs’ images with the latest security patches. either "patch" or "minorVersion" must be true.
- ami
Auto OceanUpdate Cluster Roll Scheduled Task Task Parameters Ami Auto Update Ami Auto Update Cluster Roll - Set clusterRoll object
- apply
Roll Boolean - When the AMI is updated according to the configuration set, a cluster roll can be triggered
- minor
Version Boolean - When set to 'true', the auto-update process will update the VNGs’ AMI with the AMI to match the Kubernetes control plane version. either "patch" or "minor_version" must be true.
- patch Boolean
- When set to 'true', the auto-update process will update the VNGs’ images with the latest security patches. either "patch" or "minorVersion" must be true.
- ami
Auto OceanUpdate Cluster Roll Scheduled Task Task Parameters Ami Auto Update Ami Auto Update Cluster Roll - Set clusterRoll object
- apply
Roll boolean - When the AMI is updated according to the configuration set, a cluster roll can be triggered
- minor
Version boolean - When set to 'true', the auto-update process will update the VNGs’ AMI with the AMI to match the Kubernetes control plane version. either "patch" or "minor_version" must be true.
- patch boolean
- When set to 'true', the auto-update process will update the VNGs’ images with the latest security patches. either "patch" or "minorVersion" must be true.
- ami_
auto_ Oceanupdate_ cluster_ roll Scheduled Task Task Parameters Ami Auto Update Ami Auto Update Cluster Roll - Set clusterRoll object
- apply_
roll bool - When the AMI is updated according to the configuration set, a cluster roll can be triggered
- minor_
version bool - When set to 'true', the auto-update process will update the VNGs’ AMI with the AMI to match the Kubernetes control plane version. either "patch" or "minor_version" must be true.
- patch bool
- When set to 'true', the auto-update process will update the VNGs’ images with the latest security patches. either "patch" or "minorVersion" must be true.
- ami
Auto Property MapUpdate Cluster Roll - Set clusterRoll object
- apply
Roll Boolean - When the AMI is updated according to the configuration set, a cluster roll can be triggered
- minor
Version Boolean - When set to 'true', the auto-update process will update the VNGs’ AMI with the AMI to match the Kubernetes control plane version. either "patch" or "minor_version" must be true.
- patch Boolean
- When set to 'true', the auto-update process will update the VNGs’ images with the latest security patches. either "patch" or "minorVersion" must be true.
OceanScheduledTaskTaskParametersAmiAutoUpdateAmiAutoUpdateClusterRoll, OceanScheduledTaskTaskParametersAmiAutoUpdateAmiAutoUpdateClusterRollArgs
- Batch
Min intHealthy Percentage - 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.
- Batch
Size intPercentage - Value as a percent to set the size of a batch in a roll. Valid values are 0-100.
- Comment string
- Add a
comment
description for the roll. Thecomment
is limited to 256 chars - Respect
Pdb bool - During the roll, if the parameter is set to true we honor PDB during the instance replacement.
- Batch
Min intHealthy Percentage - 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.
- Batch
Size intPercentage - Value as a percent to set the size of a batch in a roll. Valid values are 0-100.
- Comment string
- Add a
comment
description for the roll. Thecomment
is limited to 256 chars - Respect
Pdb bool - During the roll, if the parameter is set to true we honor PDB during the instance replacement.
- batch
Min IntegerHealthy Percentage - 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.
- batch
Size IntegerPercentage - Value as a percent to set the size of a batch in a roll. Valid values are 0-100.
- comment String
- Add a
comment
description for the roll. Thecomment
is limited to 256 chars - respect
Pdb Boolean - During the roll, if the parameter is set to true we honor PDB during the instance replacement.
- batch
Min numberHealthy Percentage - 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.
- batch
Size numberPercentage - Value as a percent to set the size of a batch in a roll. Valid values are 0-100.
- comment string
- Add a
comment
description for the roll. Thecomment
is limited to 256 chars - respect
Pdb boolean - During the roll, if the parameter is set to true we honor PDB during the instance replacement.
- batch_
min_ inthealthy_ percentage - 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.
- batch_
size_ intpercentage - Value as a percent to set the size of a batch in a roll. Valid values are 0-100.
- comment str
- Add a
comment
description for the roll. Thecomment
is limited to 256 chars - respect_
pdb bool - During the roll, if the parameter is set to true we honor PDB during the instance replacement.
- batch
Min NumberHealthy Percentage - 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.
- batch
Size NumberPercentage - Value as a percent to set the size of a batch in a roll. Valid values are 0-100.
- comment String
- Add a
comment
description for the roll. Thecomment
is limited to 256 chars - respect
Pdb Boolean - During the roll, if the parameter is set to true we honor PDB during the instance replacement.
OceanScheduledTaskTaskParametersParametersClusterRoll, OceanScheduledTaskTaskParametersParametersClusterRollArgs
- Batch
Min intHealthy Percentage - 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.
- Batch
Size intPercentage - Value as a percent to set the size of a batch in a roll. Valid values are 0-100.
- Comment string
- Add a
comment
description for the roll. Thecomment
is limited to 256 chars - Respect
Pdb bool - During the roll, if the parameter is set to true we honor PDB during the instance replacement.
- Batch
Min intHealthy Percentage - 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.
- Batch
Size intPercentage - Value as a percent to set the size of a batch in a roll. Valid values are 0-100.
- Comment string
- Add a
comment
description for the roll. Thecomment
is limited to 256 chars - Respect
Pdb bool - During the roll, if the parameter is set to true we honor PDB during the instance replacement.
- batch
Min IntegerHealthy Percentage - 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.
- batch
Size IntegerPercentage - Value as a percent to set the size of a batch in a roll. Valid values are 0-100.
- comment String
- Add a
comment
description for the roll. Thecomment
is limited to 256 chars - respect
Pdb Boolean - During the roll, if the parameter is set to true we honor PDB during the instance replacement.
- batch
Min numberHealthy Percentage - 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.
- batch
Size numberPercentage - Value as a percent to set the size of a batch in a roll. Valid values are 0-100.
- comment string
- Add a
comment
description for the roll. Thecomment
is limited to 256 chars - respect
Pdb boolean - During the roll, if the parameter is set to true we honor PDB during the instance replacement.
- batch_
min_ inthealthy_ percentage - 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.
- batch_
size_ intpercentage - Value as a percent to set the size of a batch in a roll. Valid values are 0-100.
- comment str
- Add a
comment
description for the roll. Thecomment
is limited to 256 chars - respect_
pdb bool - During the roll, if the parameter is set to true we honor PDB during the instance replacement.
- batch
Min NumberHealthy Percentage - 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.
- batch
Size NumberPercentage - Value as a percent to set the size of a batch in a roll. Valid values are 0-100.
- comment String
- Add a
comment
description for the roll. Thecomment
is limited to 256 chars - respect
Pdb Boolean - During the roll, if the parameter is set to true we honor PDB during the instance replacement.
OceanTag, OceanTagArgs
OceanUpdatePolicy, OceanUpdatePolicyArgs
- 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).
- Conditioned
Roll List<string>Params - A custom list of attributes will trigger the cluster roll operation (overrides the predefined list of parameters). Valid only when the
conditioned_roll
parameter is set to true. (Valid values:"subnet_ids"
,"whitelist"
,"blacklist"
,"user_data"
,"image_id"
,"security_groups"
,"key_name"
,"iam_instance_profile"
,"associate_public_ip_address"
,"load_balancers"
,"instance_metadata_options"
,"ebs_optimized"
,"root_volume_size"
) - 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).
- Conditioned
Roll []stringParams - A custom list of attributes will trigger the cluster roll operation (overrides the predefined list of parameters). Valid only when the
conditioned_roll
parameter is set to true. (Valid values:"subnet_ids"
,"whitelist"
,"blacklist"
,"user_data"
,"image_id"
,"security_groups"
,"key_name"
,"iam_instance_profile"
,"associate_public_ip_address"
,"load_balancers"
,"instance_metadata_options"
,"ebs_optimized"
,"root_volume_size"
) - 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).
- conditioned
Roll List<String>Params - A custom list of attributes will trigger the cluster roll operation (overrides the predefined list of parameters). Valid only when the
conditioned_roll
parameter is set to true. (Valid values:"subnet_ids"
,"whitelist"
,"blacklist"
,"user_data"
,"image_id"
,"security_groups"
,"key_name"
,"iam_instance_profile"
,"associate_public_ip_address"
,"load_balancers"
,"instance_metadata_options"
,"ebs_optimized"
,"root_volume_size"
) - 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).
- conditioned
Roll string[]Params - A custom list of attributes will trigger the cluster roll operation (overrides the predefined list of parameters). Valid only when the
conditioned_roll
parameter is set to true. (Valid values:"subnet_ids"
,"whitelist"
,"blacklist"
,"user_data"
,"image_id"
,"security_groups"
,"key_name"
,"iam_instance_profile"
,"associate_public_ip_address"
,"load_balancers"
,"instance_metadata_options"
,"ebs_optimized"
,"root_volume_size"
) - 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).
- conditioned_
roll_ Sequence[str]params - A custom list of attributes will trigger the cluster roll operation (overrides the predefined list of parameters). Valid only when the
conditioned_roll
parameter is set to true. (Valid values:"subnet_ids"
,"whitelist"
,"blacklist"
,"user_data"
,"image_id"
,"security_groups"
,"key_name"
,"iam_instance_profile"
,"associate_public_ip_address"
,"load_balancers"
,"instance_metadata_options"
,"ebs_optimized"
,"root_volume_size"
) - 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).
- conditioned
Roll List<String>Params - A custom list of attributes will trigger the cluster roll operation (overrides the predefined list of parameters). Valid only when the
conditioned_roll
parameter is set to true. (Valid values:"subnet_ids"
,"whitelist"
,"blacklist"
,"user_data"
,"image_id"
,"security_groups"
,"key_name"
,"iam_instance_profile"
,"associate_public_ip_address"
,"load_balancers"
,"instance_metadata_options"
,"ebs_optimized"
,"root_volume_size"
) - roll
Config Property Map - While used, you can control whether the group should perform a deployment after an update to the configuration.
OceanUpdatePolicyRollConfig, OceanUpdatePolicyRollConfigArgs
- 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
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Spotinst pulumi/pulumi-spotinst
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
spotinst
Terraform Provider.