Server class
Describes a configuration management server.
Constructors
-
Server({bool? associatePublicIpAddress, int? backupRetentionCount, String? cloudFormationStackArn, DateTime? createdAt, String? customDomain, bool? disableAutomatedBackup, String? endpoint, String? engine, List<
EngineAttribute> ? engineAttributes, String? engineModel, String? engineVersion, String? instanceProfileArn, String? instanceType, String? keyPair, MaintenanceStatus? maintenanceStatus, String? preferredBackupWindow, String? preferredMaintenanceWindow, List<String> ? securityGroupIds, String? serverArn, String? serverName, String? serviceRoleArn, ServerStatus? status, String? statusReason, List<String> ? subnetIds}) -
Server.fromJson(Map<
String, dynamic> json) -
factory
Properties
- associatePublicIpAddress → bool?
-
Associate a public IP address with a server that you are launching.
final
- backupRetentionCount → int?
-
The number of automated backups to keep.
final
- cloudFormationStackArn → String?
-
The ARN of the CloudFormation stack that was used to create the server.
final
- createdAt → DateTime?
-
Time stamp of server creation. Example
2016-07-29T13:38:47.520Z
final - customDomain → String?
-
An optional public endpoint of a server, such as
https://aws.my-company.com
. You cannot access the server by using theEndpoint
value if the server has aCustomDomain
specified.final - disableAutomatedBackup → bool?
-
Disables automated backups. The number of stored backups is dependent on the
value of PreferredBackupCount.
final
- endpoint → String?
-
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 theEndpoint
value if the server has aCustomDomain
specified.final - engine → String?
-
The engine type of the server. Valid values in this release include
ChefAutomate
andPuppet
.final -
engineAttributes
→ List<
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().
final
- engineModel → String?
-
The engine model of the server. Valid values in this release include
Monolithic
for Puppet andSingle
for Chef.final - engineVersion → String?
-
The engine version of the server. For a Chef server, the valid value for
EngineVersion is currently
2
. For a Puppet server, the valid value is2017
.final - hashCode → int
-
The hash code for this object.
no setterinherited
- instanceProfileArn → String?
-
The instance profile ARN of the server.
final
- instanceType → String?
-
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.
final
- keyPair → String?
-
The key pair associated with the server.
final
- maintenanceStatus → MaintenanceStatus?
-
The status of the most recent server maintenance run. Shows
SUCCESS
orFAILED
.final - preferredBackupWindow → String?
-
The preferred backup period specified for the server.
final
- preferredMaintenanceWindow → String?
-
The preferred maintenance period specified for the server.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
securityGroupIds
→ List<
String> ? -
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.
final
- serverArn → String?
-
The ARN of the server.
final
- serverName → String?
-
The name of the server.
final
- serviceRoleArn → String?
-
The service role ARN used to create the server.
final
- status → 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.
final
- statusReason → String?
-
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).
final
-
subnetIds
→ List<
String> ? -
The subnet IDs specified in a CreateServer request.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited