amazonka-opsworks-cm-2.0: Amazon OpsWorks CM 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.OpsWorksCM.Types

Description

 
Synopsis

Service Configuration

defaultService :: Service Source #

API version 2016-11-01 of the Amazon OpsWorks CM SDK configuration.

Errors

_InvalidNextTokenException :: AsError a => Fold a ServiceError Source #

This occurs when the provided nextToken is not valid.

_InvalidStateException :: AsError a => Fold a ServiceError Source #

The resource is in a state that does not allow you to perform a specified action.

_LimitExceededException :: AsError a => Fold a ServiceError Source #

The limit of servers or backups has been reached.

_ResourceAlreadyExistsException :: AsError a => Fold a ServiceError Source #

The requested resource cannot be created because it already exists.

_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #

The requested resource does not exist, or access was denied.

_ValidationException :: AsError a => Fold a ServiceError Source #

One or more of the provided request parameters are not valid.

BackupStatus

newtype BackupStatus Source #

Constructors

BackupStatus' 

Instances

Instances details
FromJSON BackupStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupStatus

FromJSONKey BackupStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupStatus

ToJSON BackupStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupStatus

ToJSONKey BackupStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupStatus

ToByteString BackupStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupStatus

ToHeader BackupStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupStatus

ToLog BackupStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupStatus

ToQuery BackupStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupStatus

FromText BackupStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupStatus

ToText BackupStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupStatus

Methods

toText :: BackupStatus -> Text #

FromXML BackupStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupStatus

ToXML BackupStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupStatus

Methods

toXML :: BackupStatus -> XML #

Generic BackupStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupStatus

Associated Types

type Rep BackupStatus :: Type -> Type #

Read BackupStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupStatus

Show BackupStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupStatus

NFData BackupStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupStatus

Methods

rnf :: BackupStatus -> () #

Eq BackupStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupStatus

Ord BackupStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupStatus

Hashable BackupStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupStatus

type Rep BackupStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupStatus

type Rep BackupStatus = D1 ('MetaData "BackupStatus" "Amazonka.OpsWorksCM.Types.BackupStatus" "amazonka-opsworks-cm-2.0-4eRKS676FdFBzYMnhnI9o" 'True) (C1 ('MetaCons "BackupStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromBackupStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

BackupType

newtype BackupType Source #

Constructors

BackupType' 

Fields

Bundled Patterns

pattern BackupType_AUTOMATED :: BackupType 
pattern BackupType_MANUAL :: BackupType 

Instances

Instances details
FromJSON BackupType Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupType

FromJSONKey BackupType Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupType

ToJSON BackupType Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupType

ToJSONKey BackupType Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupType

ToByteString BackupType Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupType

ToHeader BackupType Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupType

ToLog BackupType Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupType

ToQuery BackupType Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupType

FromText BackupType Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupType

ToText BackupType Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupType

Methods

toText :: BackupType -> Text #

FromXML BackupType Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupType

ToXML BackupType Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupType

Methods

toXML :: BackupType -> XML #

Generic BackupType Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupType

Associated Types

type Rep BackupType :: Type -> Type #

Read BackupType Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupType

Show BackupType Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupType

NFData BackupType Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupType

Methods

rnf :: BackupType -> () #

Eq BackupType Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupType

Ord BackupType Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupType

Hashable BackupType Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupType

type Rep BackupType Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.BackupType

type Rep BackupType = D1 ('MetaData "BackupType" "Amazonka.OpsWorksCM.Types.BackupType" "amazonka-opsworks-cm-2.0-4eRKS676FdFBzYMnhnI9o" 'True) (C1 ('MetaCons "BackupType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromBackupType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

MaintenanceStatus

newtype MaintenanceStatus Source #

Instances

Instances details
FromJSON MaintenanceStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.MaintenanceStatus

FromJSONKey MaintenanceStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.MaintenanceStatus

ToJSON MaintenanceStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.MaintenanceStatus

ToJSONKey MaintenanceStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.MaintenanceStatus

ToByteString MaintenanceStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.MaintenanceStatus

ToHeader MaintenanceStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.MaintenanceStatus

ToLog MaintenanceStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.MaintenanceStatus

ToQuery MaintenanceStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.MaintenanceStatus

FromText MaintenanceStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.MaintenanceStatus

ToText MaintenanceStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.MaintenanceStatus

FromXML MaintenanceStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.MaintenanceStatus

ToXML MaintenanceStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.MaintenanceStatus

Generic MaintenanceStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.MaintenanceStatus

Associated Types

type Rep MaintenanceStatus :: Type -> Type #

Read MaintenanceStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.MaintenanceStatus

Show MaintenanceStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.MaintenanceStatus

NFData MaintenanceStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.MaintenanceStatus

Methods

rnf :: MaintenanceStatus -> () #

Eq MaintenanceStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.MaintenanceStatus

Ord MaintenanceStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.MaintenanceStatus

Hashable MaintenanceStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.MaintenanceStatus

type Rep MaintenanceStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.MaintenanceStatus

type Rep MaintenanceStatus = D1 ('MetaData "MaintenanceStatus" "Amazonka.OpsWorksCM.Types.MaintenanceStatus" "amazonka-opsworks-cm-2.0-4eRKS676FdFBzYMnhnI9o" 'True) (C1 ('MetaCons "MaintenanceStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromMaintenanceStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

NodeAssociationStatus

newtype NodeAssociationStatus Source #

The status of the association or disassociation request.

Possible values:

  • SUCCESS: The association or disassociation succeeded.
  • FAILED: The association or disassociation failed.
  • IN_PROGRESS: The association or disassociation is still in progress.

Instances

Instances details
FromJSON NodeAssociationStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.NodeAssociationStatus

FromJSONKey NodeAssociationStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.NodeAssociationStatus

ToJSON NodeAssociationStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.NodeAssociationStatus

ToJSONKey NodeAssociationStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.NodeAssociationStatus

ToByteString NodeAssociationStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.NodeAssociationStatus

ToHeader NodeAssociationStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.NodeAssociationStatus

ToLog NodeAssociationStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.NodeAssociationStatus

ToQuery NodeAssociationStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.NodeAssociationStatus

FromText NodeAssociationStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.NodeAssociationStatus

ToText NodeAssociationStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.NodeAssociationStatus

FromXML NodeAssociationStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.NodeAssociationStatus

ToXML NodeAssociationStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.NodeAssociationStatus

Generic NodeAssociationStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.NodeAssociationStatus

Associated Types

type Rep NodeAssociationStatus :: Type -> Type #

Read NodeAssociationStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.NodeAssociationStatus

Show NodeAssociationStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.NodeAssociationStatus

NFData NodeAssociationStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.NodeAssociationStatus

Methods

rnf :: NodeAssociationStatus -> () #

Eq NodeAssociationStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.NodeAssociationStatus

Ord NodeAssociationStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.NodeAssociationStatus

Hashable NodeAssociationStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.NodeAssociationStatus

type Rep NodeAssociationStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.NodeAssociationStatus

type Rep NodeAssociationStatus = D1 ('MetaData "NodeAssociationStatus" "Amazonka.OpsWorksCM.Types.NodeAssociationStatus" "amazonka-opsworks-cm-2.0-4eRKS676FdFBzYMnhnI9o" 'True) (C1 ('MetaCons "NodeAssociationStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromNodeAssociationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ServerStatus

newtype ServerStatus Source #

Constructors

ServerStatus' 

Instances

Instances details
FromJSON ServerStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.ServerStatus

FromJSONKey ServerStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.ServerStatus

ToJSON ServerStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.ServerStatus

ToJSONKey ServerStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.ServerStatus

ToByteString ServerStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.ServerStatus

ToHeader ServerStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.ServerStatus

ToLog ServerStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.ServerStatus

ToQuery ServerStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.ServerStatus

FromText ServerStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.ServerStatus

ToText ServerStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.ServerStatus

Methods

toText :: ServerStatus -> Text #

FromXML ServerStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.ServerStatus

ToXML ServerStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.ServerStatus

Methods

toXML :: ServerStatus -> XML #

Generic ServerStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.ServerStatus

Associated Types

type Rep ServerStatus :: Type -> Type #

Read ServerStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.ServerStatus

Show ServerStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.ServerStatus

NFData ServerStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.ServerStatus

Methods

rnf :: ServerStatus -> () #

Eq ServerStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.ServerStatus

Ord ServerStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.ServerStatus

Hashable ServerStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.ServerStatus

type Rep ServerStatus Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.ServerStatus

type Rep ServerStatus = D1 ('MetaData "ServerStatus" "Amazonka.OpsWorksCM.Types.ServerStatus" "amazonka-opsworks-cm-2.0-4eRKS676FdFBzYMnhnI9o" 'True) (C1 ('MetaCons "ServerStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromServerStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

AccountAttribute

data AccountAttribute Source #

Stores account attributes.

See: newAccountAttribute smart constructor.

Constructors

AccountAttribute' 

Fields

  • maximum :: Maybe Int

    The maximum allowed value.

  • name :: Maybe Text

    The attribute name. The following are supported attribute names.

    • ServerLimit: The number of current servers/maximum number of servers allowed. By default, you can have a maximum of 10 servers.
    • ManualBackupLimit: The number of current manual backups/maximum number of backups allowed. By default, you can have a maximum of 50 manual backups saved.
  • used :: Maybe Int

    The current usage, such as the current number of servers that are associated with the account.

Instances

Instances details
FromJSON AccountAttribute Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.AccountAttribute

Generic AccountAttribute Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.AccountAttribute

Associated Types

type Rep AccountAttribute :: Type -> Type #

Read AccountAttribute Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.AccountAttribute

Show AccountAttribute Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.AccountAttribute

NFData AccountAttribute Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.AccountAttribute

Methods

rnf :: AccountAttribute -> () #

Eq AccountAttribute Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.AccountAttribute

Hashable AccountAttribute Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.AccountAttribute

type Rep AccountAttribute Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.AccountAttribute

type Rep AccountAttribute = D1 ('MetaData "AccountAttribute" "Amazonka.OpsWorksCM.Types.AccountAttribute" "amazonka-opsworks-cm-2.0-4eRKS676FdFBzYMnhnI9o" 'False) (C1 ('MetaCons "AccountAttribute'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maximum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "used") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))

newAccountAttribute :: AccountAttribute Source #

Create a value of AccountAttribute 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:maximum:AccountAttribute', accountAttribute_maximum - The maximum allowed value.

$sel:name:AccountAttribute', accountAttribute_name - The attribute name. The following are supported attribute names.

  • ServerLimit: The number of current servers/maximum number of servers allowed. By default, you can have a maximum of 10 servers.
  • ManualBackupLimit: The number of current manual backups/maximum number of backups allowed. By default, you can have a maximum of 50 manual backups saved.

$sel:used:AccountAttribute', accountAttribute_used - The current usage, such as the current number of servers that are associated with the account.

accountAttribute_name :: Lens' AccountAttribute (Maybe Text) Source #

The attribute name. The following are supported attribute names.

  • ServerLimit: The number of current servers/maximum number of servers allowed. By default, you can have a maximum of 10 servers.
  • ManualBackupLimit: The number of current manual backups/maximum number of backups allowed. By default, you can have a maximum of 50 manual backups saved.

accountAttribute_used :: Lens' AccountAttribute (Maybe Int) Source #

The current usage, such as the current number of servers that are associated with the account.

Backup

data Backup Source #

Describes a single backup.

See: newBackup smart constructor.

Constructors

Backup' 

Fields

Instances

Instances details
FromJSON Backup Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.Backup

Generic Backup Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.Backup

Associated Types

type Rep Backup :: Type -> Type #

Methods

from :: Backup -> Rep Backup x #

to :: Rep Backup x -> Backup #

Read Backup Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.Backup

Show Backup Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.Backup

NFData Backup Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.Backup

Methods

rnf :: Backup -> () #

Eq Backup Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.Backup

Methods

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

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

Hashable Backup Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.Backup

Methods

hashWithSalt :: Int -> Backup -> Int #

hash :: Backup -> Int #

type Rep Backup Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.Backup

type Rep Backup = D1 ('MetaData "Backup" "Amazonka.OpsWorksCM.Types.Backup" "amazonka-opsworks-cm-2.0-4eRKS676FdFBzYMnhnI9o" 'False) (C1 ('MetaCons "Backup'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "backupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "backupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "backupType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BackupType)))) :*: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "engineModel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "instanceProfileArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "instanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "keyPair") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "preferredBackupWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "s3DataSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "s3DataUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "s3LogUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "serverName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "serviceRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BackupStatus)) :*: S1 ('MetaSel ('Just "statusDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "toolsVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "userArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))

newBackup :: Backup Source #

Create a value of Backup 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:backupArn:Backup', backup_backupArn - The ARN of the backup.

$sel:backupId:Backup', backup_backupId - The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS

$sel:backupType:Backup', backup_backupType - The backup type. Valid values are automated or manual.

$sel:createdAt:Backup', backup_createdAt - The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z

$sel:description:Backup', backup_description - A user-provided description for a manual backup. This field is empty for automated backups.

$sel:engine:Backup', backup_engine - The engine type that is obtained from the server when the backup is created.

$sel:engineModel:Backup', backup_engineModel - The engine model that is obtained from the server when the backup is created.

$sel:engineVersion:Backup', backup_engineVersion - The engine version that is obtained from the server when the backup is created.

$sel:instanceProfileArn:Backup', backup_instanceProfileArn - The EC2 instance profile ARN that is obtained from the server when the backup is created. Because this value is stored, you are not required to provide the InstanceProfileArn again if you restore a backup.

$sel:instanceType:Backup', backup_instanceType - The instance type that is obtained from the server when the backup is created.

$sel:keyPair:Backup', backup_keyPair - The key pair that is obtained from the server when the backup is created.

$sel:preferredBackupWindow:Backup', backup_preferredBackupWindow - The preferred backup period that is obtained from the server when the backup is created.

$sel:preferredMaintenanceWindow:Backup', backup_preferredMaintenanceWindow - The preferred maintenance period that is obtained from the server when the backup is created.

$sel:s3DataSize:Backup', backup_s3DataSize - This field is deprecated and is no longer used.

$sel:s3DataUrl:Backup', backup_s3DataUrl - This field is deprecated and is no longer used.

$sel:s3LogUrl:Backup', backup_s3LogUrl - The Amazon S3 URL of the backup's log file.

$sel:securityGroupIds:Backup', backup_securityGroupIds - The security group IDs that are obtained from the server when the backup is created.

$sel:serverName:Backup', backup_serverName - The name of the server from which the backup was made.

$sel:serviceRoleArn:Backup', backup_serviceRoleArn - The service role ARN that is obtained from the server when the backup is created.

$sel:status:Backup', backup_status - The status of a backup while in progress.

$sel:statusDescription:Backup', backup_statusDescription - An informational message about backup status.

$sel:subnetIds:Backup', backup_subnetIds - The subnet IDs that are obtained from the server when the backup is created.

$sel:toolsVersion:Backup', backup_toolsVersion - The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.

$sel:userArn:Backup', backup_userArn - The IAM user ARN of the requester for manual backups. This field is empty for automated backups.

backup_backupArn :: Lens' Backup (Maybe Text) Source #

The ARN of the backup.

backup_backupId :: Lens' Backup (Maybe Text) Source #

The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS

backup_backupType :: Lens' Backup (Maybe BackupType) Source #

The backup type. Valid values are automated or manual.

backup_createdAt :: Lens' Backup (Maybe UTCTime) Source #

The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z

backup_description :: Lens' Backup (Maybe Text) Source #

A user-provided description for a manual backup. This field is empty for automated backups.

backup_engine :: Lens' Backup (Maybe Text) Source #

The engine type that is obtained from the server when the backup is created.

backup_engineModel :: Lens' Backup (Maybe Text) Source #

The engine model that is obtained from the server when the backup is created.

backup_engineVersion :: Lens' Backup (Maybe Text) Source #

The engine version that is obtained from the server when the backup is created.

backup_instanceProfileArn :: Lens' Backup (Maybe Text) Source #

The EC2 instance profile ARN that is obtained from the server when the backup is created. Because this value is stored, you are not required to provide the InstanceProfileArn again if you restore a backup.

backup_instanceType :: Lens' Backup (Maybe Text) Source #

The instance type that is obtained from the server when the backup is created.

backup_keyPair :: Lens' Backup (Maybe Text) Source #

The key pair that is obtained from the server when the backup is created.

backup_preferredBackupWindow :: Lens' Backup (Maybe Text) Source #

The preferred backup period that is obtained from the server when the backup is created.

backup_preferredMaintenanceWindow :: Lens' Backup (Maybe Text) Source #

The preferred maintenance period that is obtained from the server when the backup is created.

backup_s3DataSize :: Lens' Backup (Maybe Int) Source #

This field is deprecated and is no longer used.

backup_s3DataUrl :: Lens' Backup (Maybe Text) Source #

This field is deprecated and is no longer used.

backup_s3LogUrl :: Lens' Backup (Maybe Text) Source #

The Amazon S3 URL of the backup's log file.

backup_securityGroupIds :: Lens' Backup (Maybe [Text]) Source #

The security group IDs that are obtained from the server when the backup is created.

backup_serverName :: Lens' Backup (Maybe Text) Source #

The name of the server from which the backup was made.

backup_serviceRoleArn :: Lens' Backup (Maybe Text) Source #

The service role ARN that is obtained from the server when the backup is created.

backup_status :: Lens' Backup (Maybe BackupStatus) Source #

The status of a backup while in progress.

backup_statusDescription :: Lens' Backup (Maybe Text) Source #

An informational message about backup status.

backup_subnetIds :: Lens' Backup (Maybe [Text]) Source #

The subnet IDs that are obtained from the server when the backup is created.

backup_toolsVersion :: Lens' Backup (Maybe Text) Source #

The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.

backup_userArn :: Lens' Backup (Maybe Text) Source #

The IAM user ARN of the requester for manual backups. This field is empty for automated backups.

EngineAttribute

data EngineAttribute Source #

A name and value pair that is specific to the engine of the server.

See: newEngineAttribute smart constructor.

Constructors

EngineAttribute' 

Fields

Instances

Instances details
FromJSON EngineAttribute Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.EngineAttribute

ToJSON EngineAttribute Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.EngineAttribute

Generic EngineAttribute Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.EngineAttribute

Associated Types

type Rep EngineAttribute :: Type -> Type #

Show EngineAttribute Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.EngineAttribute

NFData EngineAttribute Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.EngineAttribute

Methods

rnf :: EngineAttribute -> () #

Eq EngineAttribute Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.EngineAttribute

Hashable EngineAttribute Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.EngineAttribute

type Rep EngineAttribute Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.EngineAttribute

type Rep EngineAttribute = D1 ('MetaData "EngineAttribute" "Amazonka.OpsWorksCM.Types.EngineAttribute" "amazonka-opsworks-cm-2.0-4eRKS676FdFBzYMnhnI9o" 'False) (C1 ('MetaCons "EngineAttribute'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))))

newEngineAttribute :: EngineAttribute Source #

Create a value of EngineAttribute 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:name:EngineAttribute', engineAttribute_name - The name of the engine attribute.

$sel:value:EngineAttribute', engineAttribute_value - The value of the engine attribute.

engineAttribute_name :: Lens' EngineAttribute (Maybe Text) Source #

The name of the engine attribute.

engineAttribute_value :: Lens' EngineAttribute (Maybe Text) Source #

The value of the engine attribute.

Server

data Server Source #

Describes a configuration management server.

See: newServer smart constructor.

Constructors

Server' 

Fields

  • associatePublicIpAddress :: Maybe Bool

    Associate a public IP address with a server that you are launching.

  • backupRetentionCount :: Maybe Int

    The number of automated backups to keep.

  • cloudFormationStackArn :: Maybe Text

    The ARN of the CloudFormation stack that was used to create the server.

  • createdAt :: Maybe POSIX

    Time stamp of server creation. Example 2016-07-29T13:38:47.520Z

  • customDomain :: Maybe Text

    An optional public endpoint of a server, such as https://aws.my-company.com. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.

  • disableAutomatedBackup :: Maybe Bool

    Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.

  • endpoint :: Maybe Text

    A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.

  • engine :: Maybe Text

    The engine type of the server. Valid values in this release include ChefAutomate and Puppet.

  • engineAttributes :: Maybe [EngineAttribute]

    The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks CM; they are returned only as part of the result of createServer().

    Attributes returned in a createServer response for Chef

    • CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA private key that is generated by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API.
    • CHEF_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. From this directory, you can run Knife commands.

    Attributes returned in a createServer response for Puppet

    • PUPPET_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents.
    • PUPPET_ADMIN_PASSWORD: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.
  • engineModel :: Maybe Text

    The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.

  • engineVersion :: Maybe Text

    The engine version of the server. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, specify either 2019 or 2017.

  • instanceProfileArn :: Maybe Text

    The instance profile ARN of the server.

  • instanceType :: Maybe Text

    The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console.

  • keyPair :: Maybe Text

    The key pair associated with the server.

  • maintenanceStatus :: Maybe MaintenanceStatus

    The status of the most recent server maintenance run. Shows SUCCESS or FAILED.

  • preferredBackupWindow :: Maybe Text

    The preferred backup period specified for the server.

  • preferredMaintenanceWindow :: Maybe Text

    The preferred maintenance period specified for the server.

  • securityGroupIds :: Maybe [Text]

    The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console.

  • serverArn :: Maybe Text

    The ARN of the server.

  • serverName :: Maybe Text

    The name of the server.

  • serviceRoleArn :: Maybe Text

    The service role ARN used to create the server.

  • status :: Maybe ServerStatus

    The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as the server's health state.

  • statusReason :: Maybe Text

    Depending on the server status, this field has either a human-readable message (such as a create or backup error), or an escaped block of JSON (used for health check results).

  • subnetIds :: Maybe [Text]

    The subnet IDs specified in a CreateServer request.

Instances

Instances details
FromJSON Server Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.Server

Generic Server Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.Server

Associated Types

type Rep Server :: Type -> Type #

Methods

from :: Server -> Rep Server x #

to :: Rep Server x -> Server #

Show Server Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.Server

NFData Server Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.Server

Methods

rnf :: Server -> () #

Eq Server Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.Server

Methods

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

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

Hashable Server Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.Server

Methods

hashWithSalt :: Int -> Server -> Int #

hash :: Server -> Int #

type Rep Server Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.Server

type Rep Server = D1 ('MetaData "Server" "Amazonka.OpsWorksCM.Types.Server" "amazonka-opsworks-cm-2.0-4eRKS676FdFBzYMnhnI9o" 'False) (C1 ('MetaCons "Server'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "associatePublicIpAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "backupRetentionCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "cloudFormationStackArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "customDomain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "disableAutomatedBackup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "endpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "engineAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EngineAttribute])))) :*: (S1 ('MetaSel ('Just "engineModel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "instanceProfileArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "instanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "keyPair") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maintenanceStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MaintenanceStatus)))) :*: (S1 ('MetaSel ('Just "preferredBackupWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :*: ((S1 ('MetaSel ('Just "serverArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "serverName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "serviceRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServerStatus)) :*: (S1 ('MetaSel ('Just "statusReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))))

newServer :: Server Source #

Create a value of Server 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:associatePublicIpAddress:Server', server_associatePublicIpAddress - Associate a public IP address with a server that you are launching.

$sel:backupRetentionCount:Server', server_backupRetentionCount - The number of automated backups to keep.

$sel:cloudFormationStackArn:Server', server_cloudFormationStackArn - The ARN of the CloudFormation stack that was used to create the server.

$sel:createdAt:Server', server_createdAt - Time stamp of server creation. Example 2016-07-29T13:38:47.520Z

$sel:customDomain:Server', server_customDomain - An optional public endpoint of a server, such as https://aws.my-company.com. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.

$sel:disableAutomatedBackup:Server', server_disableAutomatedBackup - Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.

$sel:endpoint:Server', server_endpoint - A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.

$sel:engine:Server', server_engine - The engine type of the server. Valid values in this release include ChefAutomate and Puppet.

$sel:engineAttributes:Server', server_engineAttributes - The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks CM; they are returned only as part of the result of createServer().

Attributes returned in a createServer response for Chef

  • CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA private key that is generated by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API.
  • CHEF_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. From this directory, you can run Knife commands.

Attributes returned in a createServer response for Puppet

  • PUPPET_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents.
  • PUPPET_ADMIN_PASSWORD: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.

$sel:engineModel:Server', server_engineModel - The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.

$sel:engineVersion:Server', server_engineVersion - The engine version of the server. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, specify either 2019 or 2017.

$sel:instanceProfileArn:Server', server_instanceProfileArn - The instance profile ARN of the server.

$sel:instanceType:Server', server_instanceType - The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console.

$sel:keyPair:Server', server_keyPair - The key pair associated with the server.

$sel:maintenanceStatus:Server', server_maintenanceStatus - The status of the most recent server maintenance run. Shows SUCCESS or FAILED.

$sel:preferredBackupWindow:Server', server_preferredBackupWindow - The preferred backup period specified for the server.

$sel:preferredMaintenanceWindow:Server', server_preferredMaintenanceWindow - The preferred maintenance period specified for the server.

$sel:securityGroupIds:Server', server_securityGroupIds - The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console.

$sel:serverArn:Server', server_serverArn - The ARN of the server.

$sel:serverName:Server', server_serverName - The name of the server.

$sel:serviceRoleArn:Server', server_serviceRoleArn - The service role ARN used to create the server.

$sel:status:Server', server_status - The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as the server's health state.

$sel:statusReason:Server', server_statusReason - Depending on the server status, this field has either a human-readable message (such as a create or backup error), or an escaped block of JSON (used for health check results).

$sel:subnetIds:Server', server_subnetIds - The subnet IDs specified in a CreateServer request.

server_associatePublicIpAddress :: Lens' Server (Maybe Bool) Source #

Associate a public IP address with a server that you are launching.

server_backupRetentionCount :: Lens' Server (Maybe Int) Source #

The number of automated backups to keep.

server_cloudFormationStackArn :: Lens' Server (Maybe Text) Source #

The ARN of the CloudFormation stack that was used to create the server.

server_createdAt :: Lens' Server (Maybe UTCTime) Source #

Time stamp of server creation. Example 2016-07-29T13:38:47.520Z

server_customDomain :: Lens' Server (Maybe Text) Source #

An optional public endpoint of a server, such as https://aws.my-company.com. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.

server_disableAutomatedBackup :: Lens' Server (Maybe Bool) Source #

Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.

server_endpoint :: Lens' Server (Maybe Text) Source #

A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.

server_engine :: Lens' Server (Maybe Text) Source #

The engine type of the server. Valid values in this release include ChefAutomate and Puppet.

server_engineAttributes :: Lens' Server (Maybe [EngineAttribute]) Source #

The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks CM; they are returned only as part of the result of createServer().

Attributes returned in a createServer response for Chef

  • CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA private key that is generated by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API.
  • CHEF_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. From this directory, you can run Knife commands.

Attributes returned in a createServer response for Puppet

  • PUPPET_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents.
  • PUPPET_ADMIN_PASSWORD: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.

server_engineModel :: Lens' Server (Maybe Text) Source #

The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.

server_engineVersion :: Lens' Server (Maybe Text) Source #

The engine version of the server. For a Chef server, the valid value for EngineVersion is currently 2. For a Puppet server, specify either 2019 or 2017.

server_instanceProfileArn :: Lens' Server (Maybe Text) Source #

The instance profile ARN of the server.

server_instanceType :: Lens' Server (Maybe Text) Source #

The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console.

server_keyPair :: Lens' Server (Maybe Text) Source #

The key pair associated with the server.

server_maintenanceStatus :: Lens' Server (Maybe MaintenanceStatus) Source #

The status of the most recent server maintenance run. Shows SUCCESS or FAILED.

server_preferredBackupWindow :: Lens' Server (Maybe Text) Source #

The preferred backup period specified for the server.

server_preferredMaintenanceWindow :: Lens' Server (Maybe Text) Source #

The preferred maintenance period specified for the server.

server_securityGroupIds :: Lens' Server (Maybe [Text]) Source #

The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console.

server_serverArn :: Lens' Server (Maybe Text) Source #

The ARN of the server.

server_serverName :: Lens' Server (Maybe Text) Source #

The name of the server.

server_serviceRoleArn :: Lens' Server (Maybe Text) Source #

The service role ARN used to create the server.

server_status :: Lens' Server (Maybe ServerStatus) Source #

The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as the server's health state.

server_statusReason :: Lens' Server (Maybe Text) Source #

Depending on the server status, this field has either a human-readable message (such as a create or backup error), or an escaped block of JSON (used for health check results).

server_subnetIds :: Lens' Server (Maybe [Text]) Source #

The subnet IDs specified in a CreateServer request.

ServerEvent

data ServerEvent Source #

An event that is related to the server, such as the start of maintenance or backup.

See: newServerEvent smart constructor.

Constructors

ServerEvent' 

Fields

Instances

Instances details
FromJSON ServerEvent Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.ServerEvent

Generic ServerEvent Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.ServerEvent

Associated Types

type Rep ServerEvent :: Type -> Type #

Read ServerEvent Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.ServerEvent

Show ServerEvent Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.ServerEvent

NFData ServerEvent Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.ServerEvent

Methods

rnf :: ServerEvent -> () #

Eq ServerEvent Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.ServerEvent

Hashable ServerEvent Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.ServerEvent

type Rep ServerEvent Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.ServerEvent

type Rep ServerEvent = D1 ('MetaData "ServerEvent" "Amazonka.OpsWorksCM.Types.ServerEvent" "amazonka-opsworks-cm-2.0-4eRKS676FdFBzYMnhnI9o" 'False) (C1 ('MetaCons "ServerEvent'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "logUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "serverName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newServerEvent :: ServerEvent Source #

Create a value of ServerEvent 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:createdAt:ServerEvent', serverEvent_createdAt - The time when the event occurred.

$sel:logUrl:ServerEvent', serverEvent_logUrl - The Amazon S3 URL of the event's log file.

$sel:message:ServerEvent', serverEvent_message - A human-readable informational or status message.

$sel:serverName:ServerEvent', serverEvent_serverName - The name of the server on or for which the event occurred.

serverEvent_createdAt :: Lens' ServerEvent (Maybe UTCTime) Source #

The time when the event occurred.

serverEvent_logUrl :: Lens' ServerEvent (Maybe Text) Source #

The Amazon S3 URL of the event's log file.

serverEvent_message :: Lens' ServerEvent (Maybe Text) Source #

A human-readable informational or status message.

serverEvent_serverName :: Lens' ServerEvent (Maybe Text) Source #

The name of the server on or for which the event occurred.

Tag

data Tag Source #

A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server. Leading and trailing white spaces are trimmed from both the key and value. A maximum of 50 user-applied tags is allowed for tag-supported AWS OpsWorks-CM resources.

See: newTag smart constructor.

Constructors

Tag' 

Fields

  • key :: Text

    A tag key, such as Stage or Name. A tag key cannot be empty. The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

  • value :: Text

    An optional tag value, such as Production or test-owcm-server. The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

Instances

Instances details
FromJSON Tag Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.Tag

ToJSON Tag Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.Tag

Generic Tag Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.Tag

Associated Types

type Rep Tag :: Type -> Type #

Methods

from :: Tag -> Rep Tag x #

to :: Rep Tag x -> Tag #

Read Tag Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.Tag

Show Tag Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.Tag

Methods

showsPrec :: Int -> Tag -> ShowS #

show :: Tag -> String #

showList :: [Tag] -> ShowS #

NFData Tag Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.Tag

Methods

rnf :: Tag -> () #

Eq Tag Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.Tag

Methods

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

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

Hashable Tag Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.Tag

Methods

hashWithSalt :: Int -> Tag -> Int #

hash :: Tag -> Int #

type Rep Tag Source # 
Instance details

Defined in Amazonka.OpsWorksCM.Types.Tag

type Rep Tag = D1 ('MetaData "Tag" "Amazonka.OpsWorksCM.Types.Tag" "amazonka-opsworks-cm-2.0-4eRKS676FdFBzYMnhnI9o" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newTag Source #

Create a value of Tag 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:key:Tag', tag_key - A tag key, such as Stage or Name. A tag key cannot be empty. The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

$sel:value:Tag', tag_value - An optional tag value, such as Production or test-owcm-server. The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

tag_key :: Lens' Tag Text Source #

A tag key, such as Stage or Name. A tag key cannot be empty. The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

tag_value :: Lens' Tag Text Source #

An optional tag value, such as Production or test-owcm-server. The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /