amazonka-simspaceweaver-2.0: Amazon SimSpace Weaver SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SimSpaceWeaver.Types.Domain

Description

 
Synopsis

Documentation

data Domain Source #

A collection of app instances that run the same executable app code and have the same launch options and commands.

For more information about domains, see Key concepts in the Amazon Web Services SimSpace Weaver User Guide.

See: newDomain smart constructor.

Constructors

Domain' 

Fields

  • lifecycle :: Maybe LifecycleManagementStrategy

    The type of lifecycle management for apps in the domain. This value indicates whether apps in this domain are managed (SimSpace Weaver starts and stops the apps) or unmanaged (you must start and stop the apps).

    Lifecycle types

    • PerWorker – Managed: SimSpace Weaver starts 1 app on each worker
    • BySpatialSubdivision – Managed: SimSpace Weaver starts 1 app for each spatial partition
    • ByRequest – Unmanaged: You use the StartApp API to start the apps and use the StopApp API to stop the apps.

    The lifecycle types will change when the service is released for general availability (GA).

  • name :: Maybe Text

    The name of the domain.

Instances

Instances details
FromJSON Domain Source # 
Instance details

Defined in Amazonka.SimSpaceWeaver.Types.Domain

Generic Domain Source # 
Instance details

Defined in Amazonka.SimSpaceWeaver.Types.Domain

Associated Types

type Rep Domain :: Type -> Type #

Methods

from :: Domain -> Rep Domain x #

to :: Rep Domain x -> Domain #

Read Domain Source # 
Instance details

Defined in Amazonka.SimSpaceWeaver.Types.Domain

Show Domain Source # 
Instance details

Defined in Amazonka.SimSpaceWeaver.Types.Domain

NFData Domain Source # 
Instance details

Defined in Amazonka.SimSpaceWeaver.Types.Domain

Methods

rnf :: Domain -> () #

Eq Domain Source # 
Instance details

Defined in Amazonka.SimSpaceWeaver.Types.Domain

Methods

(==) :: Domain -> Domain -> Bool #

(/=) :: Domain -> Domain -> Bool #

Hashable Domain Source # 
Instance details

Defined in Amazonka.SimSpaceWeaver.Types.Domain

Methods

hashWithSalt :: Int -> Domain -> Int #

hash :: Domain -> Int #

type Rep Domain Source # 
Instance details

Defined in Amazonka.SimSpaceWeaver.Types.Domain

type Rep Domain = D1 ('MetaData "Domain" "Amazonka.SimSpaceWeaver.Types.Domain" "amazonka-simspaceweaver-2.0-C619ppqhgbWKEJKYoFCug9" 'False) (C1 ('MetaCons "Domain'" 'PrefixI 'True) (S1 ('MetaSel ('Just "lifecycle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LifecycleManagementStrategy)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDomain :: Domain Source #

Create a value of Domain with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:lifecycle:Domain', domain_lifecycle - The type of lifecycle management for apps in the domain. This value indicates whether apps in this domain are managed (SimSpace Weaver starts and stops the apps) or unmanaged (you must start and stop the apps).

Lifecycle types

  • PerWorker – Managed: SimSpace Weaver starts 1 app on each worker
  • BySpatialSubdivision – Managed: SimSpace Weaver starts 1 app for each spatial partition
  • ByRequest – Unmanaged: You use the StartApp API to start the apps and use the StopApp API to stop the apps.

The lifecycle types will change when the service is released for general availability (GA).

$sel:name:Domain', domain_name - The name of the domain.

domain_lifecycle :: Lens' Domain (Maybe LifecycleManagementStrategy) Source #

The type of lifecycle management for apps in the domain. This value indicates whether apps in this domain are managed (SimSpace Weaver starts and stops the apps) or unmanaged (you must start and stop the apps).

Lifecycle types

  • PerWorker – Managed: SimSpace Weaver starts 1 app on each worker
  • BySpatialSubdivision – Managed: SimSpace Weaver starts 1 app for each spatial partition
  • ByRequest – Unmanaged: You use the StartApp API to start the apps and use the StopApp API to stop the apps.

The lifecycle types will change when the service is released for general availability (GA).

domain_name :: Lens' Domain (Maybe Text) Source #

The name of the domain.