Skip to content

Latest commit

 

History

History
922 lines (687 loc) · 25.3 KB

stateful_node.md

File metadata and controls

922 lines (687 loc) · 25.3 KB

spotinst_sdk2.models.stateful_node

PersistenceMode

PersistenceMode(cls,
                value,
                names=None,
                *,
                module,
                qualname,
                type,
                start)

An enumeration.

on_launch

reattach

Persistence

Persistence(
  self,
  data_disks_persistence_mode:
    PersistenceMode = 'd3043820717d74d9a17694c176d39733',
  os_disk_persistence_mode:
    PersistenceMode = 'd3043820717d74d9a17694c176d39733',
  should_persist_data_disks: bool = 'd3043820717d74d9a17694c176d39733',
  should_persist_network: bool = 'd3043820717d74d9a17694c176d39733',
  should_persist_os_disk: bool = 'd3043820717d74d9a17694c176d39733')

Arguments

  • data_disks_persistence_mode: PersistenceMode
  • os_disk_persistence_mode: PersistenceMode
  • should_persist_data_disks: bool
  • should_persist_network: bool
  • should_persist_os_disk: bool

HealthCheckTypes

HealthCheckTypes(cls,
                 value,
                 names=None,
                 *,
                 module,
                 qualname,
                 type,
                 start)

An enumeration.

application_gateway

vm_state

Health

Health(
  self,
  health_check_types:
    typing.List[spotinst_sdk2.models.stateful_node.HealthCheckTypes] = 'd3043820717d74d9a17694c176d39733',
  auto_healing: bool = 'd3043820717d74d9a17694c176d39733',
  grace_period: int = 'd3043820717d74d9a17694c176d39733',
  unhealthy_duration: int = 'd3043820717d74d9a17694c176d39733')

Arguments

  • health_check_types: List[HealthCheckTypes]
  • auto_healing: bool
  • grace_period: int
  • unhealthy_duration: int

SchedulingTaskType

SchedulingTaskType(cls,
                   value,
                   names=None,
                   *,
                   module,
                   qualname,
                   type,
                   start)

An enumeration.

pause

recycle

resume

SchedulingTask

SchedulingTask(
  self,
  is_enabled: bool = 'd3043820717d74d9a17694c176d39733',
  cron_expression: str = 'd3043820717d74d9a17694c176d39733',
  type: SchedulingTaskType = 'd3043820717d74d9a17694c176d39733')

Arguments

  • is_enabled: bool
  • cron_expression: str
  • type: SchedulingTaskType

Scheduling

Scheduling(
    self,
    tasks:
    typing.List[spotinst_sdk2.models.stateful_node.SchedulingTask] = 'd3043820717d74d9a17694c176d39733'
)

Arguments

  • tasks: List[SchedulingTask]

PerformAt

PerformAt(cls, value, names=None, *, module, qualname, type, start)

An enumeration.

always

never

time_window

RevertToSpot

RevertToSpot(self,
             perform_at: PerformAt = 'd3043820717d74d9a17694c176d39733')

Arguments

  • perform_at: PerformAt

SignalType

SignalType(cls, value, names=None, *, module, qualname, type, start)

An enumeration.

vm_ready

vm_ready_to_shutdown

Signal

Signal(self,
       timeout: int = 'd3043820717d74d9a17694c176d39733',
       type: SignalType = 'd3043820717d74d9a17694c176d39733')

Arguments

  • timeout: int
  • type: SignalType

CapacityReservationGroups

CapacityReservationGroups(
  self,
  name: str = 'd3043820717d74d9a17694c176d39733',
  resource_group_name: str = 'd3043820717d74d9a17694c176d39733',
  should_prioritize: bool = 'd3043820717d74d9a17694c176d39733')

Arguments

  • name: str
  • resource_group_name: str
  • should_prioritize: bool

UtilizationStrategy

UtilizationStrategy(cls,
                    value,
                    names=None,
                    *,
                    module,
                    qualname,
                    type,
                    start)

An enumeration.

utilize_over_od

utilize_over_spot

CapacityReservation

CapacityReservation(
    self,
    capacity_reservation_groups:
    typing.List[spotinst_sdk2.models.stateful_node.CapacityReservationGroups] = 'd3043820717d74d9a17694c176d39733',
    should_utilize: bool = 'd3043820717d74d9a17694c176d39733',
    utilization_strategy:
    UtilizationStrategy = 'd3043820717d74d9a17694c176d39733')

Arguments

  • capacity_reservation_groups: List[CapacityReservationGroups]
  • should_utilize: bool
  • utilization_strategy: UtilizationStrategy

PreferredLifeCycle

PreferredLifeCycle(cls,
                   value,
                   names=None,
                   *,
                   module,
                   qualname,
                   type,
                   start)

An enumeration.

od

spot

Strategy

Strategy(
    self,
    availability_vs_cost: int = 'd3043820717d74d9a17694c176d39733',
    capacity_reservation:
    CapacityReservation = 'd3043820717d74d9a17694c176d39733',
    draining_timeout: int = 'd3043820717d74d9a17694c176d39733',
    fallback_to_od: bool = 'd3043820717d74d9a17694c176d39733',
    od_windows: typing.List[str] = 'd3043820717d74d9a17694c176d39733',
    optimization_windows: typing.List[str] = 'd3043820717d74d9a17694c176d39733',
    preferred_lifecycle:
    PreferredLifeCycle = 'd3043820717d74d9a17694c176d39733',
    revert_to_spot: RevertToSpot = 'd3043820717d74d9a17694c176d39733',
    signals:
    typing.List[spotinst_sdk2.models.stateful_node.Signal] = 'd3043820717d74d9a17694c176d39733'
)

Arguments

  • availability_vs_cost: int
  • capacity_reservation: CapacityReservation
  • draining_timeout: int
  • fallback_to_od: bool
  • od_windows: List[str]
  • optimization_windows: List[str]
  • preferred_lifecycle: PreferredLifeCycle
  • revert_to_spot: RevertToSpot
  • signals: List[Signal]

StorageType

StorageType(cls, value, names=None, *, module, qualname, type, start)

An enumeration.

managed

unmanaged

BootDiagnostics

BootDiagnostics(self,
                is_enabled: bool = 'd3043820717d74d9a17694c176d39733',
                storage_uri: str = 'd3043820717d74d9a17694c176d39733',
                type: StorageType = 'd3043820717d74d9a17694c176d39733')

Arguments

  • is_enabled: bool storage_uri = str
  • type: StorageType

DataDiskType

DataDiskType(cls, value, names=None, *, module, qualname, type, start)

An enumeration.

premium_lrs

standard_lrs

standard_ssd_lrs

ultra_ssd_lrs

CachingType

CachingType(cls, value, names=None, *, module, qualname, type, start)

An enumeration.

none

read_only

read_write

DataDisk

DataDisk(self,
         lun: int = 'd3043820717d74d9a17694c176d39733',
         size_g_b: int = 'd3043820717d74d9a17694c176d39733',
         type: DataDiskType = 'd3043820717d74d9a17694c176d39733',
         caching: CachingType = 'd3043820717d74d9a17694c176d39733')

Arguments

  • lun: int size_g_b = int
  • type: DataDiskType
  • __caching __: CachingType

Extension

Extension(
  self,
  api_version: str = 'd3043820717d74d9a17694c176d39733',
  minor_version_auto_upgrade: bool = 'd3043820717d74d9a17694c176d39733',
  name: str = 'd3043820717d74d9a17694c176d39733',
  protected_settings='d3043820717d74d9a17694c176d39733',
  public_settings='d3043820717d74d9a17694c176d39733',
  publisher: str = 'd3043820717d74d9a17694c176d39733',
  type: str = 'd3043820717d74d9a17694c176d39733')

Arguments

  • api_version: str
  • minor_version_auto_upgrade: bool
  • name: str
  • protected_settings: ProtectedSettings
  • public_settings: PublicSettings
  • publisher: str
  • type: str

Marketplace

Marketplace(self,
            publisher: str = 'd3043820717d74d9a17694c176d39733',
            offer: str = 'd3043820717d74d9a17694c176d39733',
            sku: str = 'd3043820717d74d9a17694c176d39733',
            version: str = 'd3043820717d74d9a17694c176d39733')

Arguments

  • publisher: str
  • offer: str
  • sku: str
  • version: str

Custom

Custom(self,
       resource_group_name: str = 'd3043820717d74d9a17694c176d39733',
       name: str = 'd3043820717d74d9a17694c176d39733')

Arguments

  • resource_group_name: str
  • name: str

Gallery

Gallery(self,
        gallery_name: str = 'd3043820717d74d9a17694c176d39733',
        image_name: str = 'd3043820717d74d9a17694c176d39733',
        resource_group_name: str = 'd3043820717d74d9a17694c176d39733',
        spot_account_id: str = 'd3043820717d74d9a17694c176d39733',
        version_name: str = 'd3043820717d74d9a17694c176d39733')

Arguments

  • gallery_name: str
  • image_name: str
  • resource_group_name: str
  • spot_account_id: str
  • version_name: str

Image

Image(self,
      marketplace: Marketplace = 'd3043820717d74d9a17694c176d39733',
      custom: Custom = 'd3043820717d74d9a17694c176d39733',
      gallery: Gallery = 'd3043820717d74d9a17694c176d39733')

Arguments

  • marketplace: Marketplace
  • custom: Custom
  • gallery: Gallery

LoadBalancerType

LoadBalancerType(cls,
                 value,
                 names=None,
                 *,
                 module,
                 qualname,
                 type,
                 start)

An enumeration.

application_gateway

load_balancer

LoadBalancer

LoadBalancer(
  self,
  backend_pool_names:
    typing.List[str] = 'd3043820717d74d9a17694c176d39733',
  load_balancer_sku: str = 'd3043820717d74d9a17694c176d39733',
  name: str = 'd3043820717d74d9a17694c176d39733',
  resource_group_name: str = 'd3043820717d74d9a17694c176d39733',
  type: LoadBalancerType = 'd3043820717d74d9a17694c176d39733')

Arguments

  • backend_pool_names: List[str]
  • load_balancer_sku: str
  • name: str
  • resource_group_name: str
  • type: LoadBalancerType

LoadBalancerConfig

LoadBalancerConfig(
    self,
    load_balancers:
    typing.List[spotinst_sdk2.models.stateful_node.LoadBalancer] = 'd3043820717d74d9a17694c176d39733'
)

Arguments

  • load_balancers: List[LoadBalancer]

Login

Login(self,
      ssh_public_key: str = 'd3043820717d74d9a17694c176d39733',
      user_name: str = 'd3043820717d74d9a17694c176d39733',
      password: str = 'd3043820717d74d9a17694c176d39733')

Arguments

  • ssh_public_key: str
  • user_name: str
  • password: str

ManagedServiceIdentity

ManagedServiceIdentity(
  self,
  resource_group_name: str = 'd3043820717d74d9a17694c176d39733',
  name: str = 'd3043820717d74d9a17694c176d39733')

Arguments

  • resource_group_name: str
  • name: str

PrivateIpAddressVersion

PrivateIpAddressVersion(cls,
                        value,
                        names=None,
                        *,
                        module,
                        qualname,
                        type,
                        start)

An enumeration.

ipv4

ipv6

AdditionalIpConfiguration

AdditionalIpConfiguration(
    self,
    name: str = 'd3043820717d74d9a17694c176d39733',
    private_ip_address_version:
    PrivateIpAddressVersion = 'd3043820717d74d9a17694c176d39733')

Arguments

  • name: str
  • private_ip_address_version: PrivateIpAddressVersion

ApplicationSecurityGroup

ApplicationSecurityGroup(
  self,
  name: str = 'd3043820717d74d9a17694c176d39733',
  resource_group_name: str = 'd3043820717d74d9a17694c176d39733')

Arguments

  • name: str
  • resource_group_name: str

NetworkSecurityGroup

NetworkSecurityGroup(
  self,
  name: str = 'd3043820717d74d9a17694c176d39733',
  resource_group_name: str = 'd3043820717d74d9a17694c176d39733')

Arguments

  • name: str
  • resource_group_name: str

PublicIp

PublicIp(self,
         name: str = 'd3043820717d74d9a17694c176d39733',
         resource_group_name: str = 'd3043820717d74d9a17694c176d39733')

Arguments

  • name: str
  • resource_group_name: str

PublicIpSku

PublicIpSku(cls, value, names=None, *, module, qualname, type, start)

An enumeration.

basic

standard

NetworkInterface

NetworkInterface(
  self,
  additional_ip_configurations:
    typing.List[spotinst_sdk2.models.stateful_node.AdditionalIpConfiguration] = 'd3043820717d74d9a17694c176d39733',
  application_security_groups:
    typing.List[spotinst_sdk2.models.stateful_node.ApplicationSecurityGroup] = 'd3043820717d74d9a17694c176d39733',
  assign_public_ip: bool = 'd3043820717d74d9a17694c176d39733',
  enable_ip_forwarding: bool = 'd3043820717d74d9a17694c176d39733',
  is_primary: bool = 'd3043820717d74d9a17694c176d39733',
  network_security_group:
    NetworkSecurityGroup = 'd3043820717d74d9a17694c176d39733',
  private_ip_addresses:
    typing.List[str] = 'd3043820717d74d9a17694c176d39733',
  public_ips:
    typing.List[spotinst_sdk2.models.stateful_node.PublicIp] = 'd3043820717d74d9a17694c176d39733',
  public_ip_sku: PublicIpSku = 'd3043820717d74d9a17694c176d39733',
  subnet_name: str = 'd3043820717d74d9a17694c176d39733')

Arguments

  • additional_ip_configurations: List[AdditionalIpConfiguration]
  • application_security_groups: List[ApplicationSecurityGroup]
  • assign_public_ip: bool
  • enable_ip_forwarding: bool
  • is_primary: bool
  • network_security_group: NetworkSecurityGroup
  • private_ip_addresses: List[str]
  • public_ips: List[PublicIp]
  • public_ip_sku: str
  • subnet_name: str

Network

Network(
  self,
  network_interfaces:
    typing.List[spotinst_sdk2.models.stateful_node.NetworkInterface] = 'd3043820717d74d9a17694c176d39733',
  virtual_network_name: str = 'd3043820717d74d9a17694c176d39733',
  resource_group_name: str = 'd3043820717d74d9a17694c176d39733')

Arguments

  • network_interfaces: List[NetworkInterface]
  • resource_group_name: str
  • virtual_network_name: str

OsDisk

OsDisk(self,
       size_g_b: int = 'd3043820717d74d9a17694c176d39733',
       type: DataDiskType = 'd3043820717d74d9a17694c176d39733',
       caching: CachingType = 'd3043820717d74d9a17694c176d39733')

Arguments

  • size_g_b: int
  • type: DataDiskType
  • __caching __: CachingType

SourceVault

SourceVault(
  self,
  name: str = 'd3043820717d74d9a17694c176d39733',
  resource_group_name: str = 'd3043820717d74d9a17694c176d39733')

Arguments

  • name: str
  • resource_group_name: str

VaultCertificate

VaultCertificate(
  self,
  certificate_store: str = 'd3043820717d74d9a17694c176d39733',
  certificate_url: str = 'd3043820717d74d9a17694c176d39733')

Arguments

  • certificate_store: str
  • certificate_url: str

Secret

Secret(
    self,
    source_vault: SourceVault = 'd3043820717d74d9a17694c176d39733',
    vault_certificates:
    typing.List[spotinst_sdk2.models.stateful_node.VaultCertificate] = 'd3043820717d74d9a17694c176d39733'
)

Arguments

  • source_vault: SourceVault
  • vault_certificates: List[VaultCertificate]

Tag

Tag(self,
    tag_key: str = 'd3043820717d74d9a17694c176d39733',
    tag_value: str = 'd3043820717d74d9a17694c176d39733')

Arguments

  • tag_key: str
  • tag_value: str

VmSizes

VmSizes(
  self,
  od_sizes: typing.List[str] = 'd3043820717d74d9a17694c176d39733',
  preferred_spot_sizes:
    typing.List[str] = 'd3043820717d74d9a17694c176d39733',
  spot_sizes: typing.List[str] = 'd3043820717d74d9a17694c176d39733')

Arguments

  • od_sizes: List[str]
  • preferred_spot_sizes: List[str]
  • spot_sizes: List[str]

ProximityPlacementGroups

ProximityPlacementGroups(
  self,
  name: str = 'd3043820717d74d9a17694c176d39733',
  resource_group_name: str = 'd3043820717d74d9a17694c176d39733')

Arguments

  • name: str
  • resource_group_name: str

SecurityType

SecurityType(cls, value, names=None, *, module, qualname, type, start)

An enumeration.

standard

trusted_launch

Security

Security(
  self,
  secure_boot_enabled: bool = 'd3043820717d74d9a17694c176d39733',
  security_type: SecurityType = 'd3043820717d74d9a17694c176d39733',
  v_tpm_enabled: bool = 'd3043820717d74d9a17694c176d39733')

Arguments

  • secure_boot_enabled: bool
  • security_type: SecurityType
  • v_tpm_enabled: bool

LaunchSpecification

LaunchSpecification(
  self,
  boot_diagnostics: BootDiagnostics = 'd3043820717d74d9a17694c176d39733',
  custom_data: str = 'd3043820717d74d9a17694c176d39733',
  data_disks:
    typing.List[spotinst_sdk2.models.stateful_node.DataDisk] = 'd3043820717d74d9a17694c176d39733',
  extensions:
    typing.List[spotinst_sdk2.models.stateful_node.Extension] = 'd3043820717d74d9a17694c176d39733',
  image: Image = 'd3043820717d74d9a17694c176d39733',
  license_type: str = 'd3043820717d74d9a17694c176d39733',
  load_balancers_config:
    LoadBalancerConfig = 'd3043820717d74d9a17694c176d39733',
  login: Login = 'd3043820717d74d9a17694c176d39733',
  managed_service_identities:
    typing.List[spotinst_sdk2.models.stateful_node.ManagedServiceIdentity] = 'd3043820717d74d9a17694c176d39733',
  network: Network = 'd3043820717d74d9a17694c176d39733',
  os_disk: OsDisk = 'd3043820717d74d9a17694c176d39733',
  proximity_placement_groups:
    typing.List[spotinst_sdk2.models.stateful_node.ProximityPlacementGroups] = 'd3043820717d74d9a17694c176d39733',
  secrets:
    typing.List[spotinst_sdk2.models.stateful_node.Secret] = 'd3043820717d74d9a17694c176d39733',
  security: Security = 'd3043820717d74d9a17694c176d39733',
  shutdown_script: str = 'd3043820717d74d9a17694c176d39733',
  tags:
    typing.List[spotinst_sdk2.models.stateful_node.Tag] = 'd3043820717d74d9a17694c176d39733',
  user_data: str = 'd3043820717d74d9a17694c176d39733',
  vm_name: str = 'd3043820717d74d9a17694c176d39733',
  vm_name_prefix: str = 'd3043820717d74d9a17694c176d39733')

Arguments

  • boot_diagnostics: BootDiagnostics
  • custom_data: str
  • data_disks: List[DataDisk]
  • extensions: List[Extension]
  • image: Image
  • license_type: str
  • load_balancers_config: LoadBalancerConfig
  • login: Login
  • managed_service_identities: List[ManagedServiceIdentity]
  • network: Network
  • os_disk: OsDisk
  • proximity_placement_groups: List[ProximityPlacementGroups]
  • secrets: List[Secret]
  • security: Security
  • shutdown_script: str
  • tags: List[Tag]
  • user_data: str
  • vm_name: str
  • vm_name_prefix: str

OsType

OsType(cls, value, names=None, *, module, qualname, type, start)

An enumeration.

linux

windows

Compute

Compute(self,
        launch_specification:
        LaunchSpecification = 'd3043820717d74d9a17694c176d39733',
        os: OsType = 'd3043820717d74d9a17694c176d39733',
        preferred_zone: str = 'd3043820717d74d9a17694c176d39733',
        vm_sizes: VmSizes = 'd3043820717d74d9a17694c176d39733',
        zones: typing.List[str] = 'd3043820717d74d9a17694c176d39733')

Arguments

  • launch_specification: LaunchSpecification
  • os: OsType
  • preferred_zone: str
  • vm_sizes: VmSizes
  • zones: List[str]

StatefulNode

StatefulNode(
  self,
  compute: Compute = 'd3043820717d74d9a17694c176d39733',
  description: str = 'd3043820717d74d9a17694c176d39733',
  health: Health = 'd3043820717d74d9a17694c176d39733',
  name: str = 'd3043820717d74d9a17694c176d39733',
  persistence: Persistence = 'd3043820717d74d9a17694c176d39733',
  region: str = 'd3043820717d74d9a17694c176d39733',
  resource_group_name: str = 'd3043820717d74d9a17694c176d39733',
  scheduling: Scheduling = 'd3043820717d74d9a17694c176d39733',
  strategy: Strategy = 'd3043820717d74d9a17694c176d39733')

Arguments

  • compute: Compute
  • description: str
  • health: Health
  • name: str
  • persistence: Persistence
  • region: str
  • resource_group_name: str
  • scheduling: Scheduling
  • strategy: Strategy