Struct aws_sdk_opsworkscm::types::Server

#[non_exhaustive]
pub struct Server {

    pub associate_public_ip_address: Option<bool>,
    pub backup_retention_count: Option<i32>,
    pub server_name: Option<String>,
    pub created_at: Option<DateTime>,
    pub cloud_formation_stack_arn: Option<String>,
    pub custom_domain: Option<String>,
    pub disable_automated_backup: Option<bool>,
    pub endpoint: Option<String>,
    pub engine: Option<String>,
    pub engine_model: Option<String>,
    pub engine_attributes: Option<Vec<EngineAttribute>>,
    pub engine_version: Option<String>,
    pub instance_profile_arn: Option<String>,
    pub instance_type: Option<String>,
    pub key_pair: Option<String>,
    pub maintenance_status: Option<MaintenanceStatus>,
    pub preferred_maintenance_window: Option<String>,
    pub preferred_backup_window: Option<String>,
    pub security_group_ids: Option<Vec<String>>,
    pub service_role_arn: Option<String>,
    pub status: Option<ServerStatus>,
    pub status_reason: Option<String>,
    pub subnet_ids: Option<Vec<String>>,
    pub server_arn: Option<String>,
}

Describes a configuration management server.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

associate_public_ip_address: Option<bool>

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

backup_retention_count: Option<i32>

The number of automated backups to keep.

server_name: Option<String>

The name of the server.

created_at: Option<DateTime>

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

cloud_formation_stack_arn: Option<String>

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

custom_domain: Option<String>

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.

disable_automated_backup: Option<bool>

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

endpoint: Option<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 the Endpoint value if the server has a CustomDomain specified.

engine: Option<String>

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

engine_model: Option<String>

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

engine_attributes: Option<Vec<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.

engine_version: Option<String>

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.

instance_profile_arn: Option<String>

The instance profile ARN of the server.

instance_type: Option<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.

key_pair: Option<String>

The key pair associated with the server.

maintenance_status: Option<MaintenanceStatus>

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

preferred_maintenance_window: Option<String>

The preferred maintenance period specified for the server.

preferred_backup_window: Option<String>

The preferred backup period specified for the server.

security_group_ids: Option<Vec<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.

service_role_arn: Option<String>

The service role ARN used to create the server.

status: Option<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.

status_reason: Option<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).

subnet_ids: Option<Vec<String>>

The subnet IDs specified in a CreateServer request.

server_arn: Option<String>

The ARN of the server.

Implementations

impl Server

pub fn associate_public_ip_address(&self) -> Option<bool>

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

pub fn backup_retention_count(&self) -> Option<i32>

The number of automated backups to keep.

pub fn server_name(&self) -> Option<&str>

The name of the server.

pub fn created_at(&self) -> Option<&DateTime>

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

pub fn cloud_formation_stack_arn(&self) -> Option<&str>

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

pub fn custom_domain(&self) -> Option<&str>

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.

pub fn disable_automated_backup(&self) -> Option<bool>

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

pub fn endpoint(&self) -> Option<&str>

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.

pub fn engine(&self) -> Option<&str>

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

pub fn engine_model(&self) -> Option<&str>

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

pub fn engine_attributes(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .engine_attributes.is_none().

pub fn engine_version(&self) -> Option<&str>

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.

pub fn instance_profile_arn(&self) -> Option<&str>

The instance profile ARN of the server.

pub fn instance_type(&self) -> Option<&str>

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.

pub fn key_pair(&self) -> Option<&str>

The key pair associated with the server.

pub fn maintenance_status(&self) -> Option<&MaintenanceStatus>

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

pub fn preferred_maintenance_window(&self) -> Option<&str>

The preferred maintenance period specified for the server.

pub fn preferred_backup_window(&self) -> Option<&str>

The preferred backup period specified for the server.

pub fn security_group_ids(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .security_group_ids.is_none().

pub fn service_role_arn(&self) -> Option<&str>

The service role ARN used to create the server.

pub fn status(&self) -> Option<&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.

pub fn status_reason(&self) -> Option<&str>

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).

pub fn subnet_ids(&self) -> &[String]

The subnet IDs specified in a CreateServer request.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .subnet_ids.is_none().

pub fn server_arn(&self) -> Option<&str>

The ARN of the server.

impl Server

pub fn builder() -> ServerBuilder

Creates a new builder-style object to manufacture Server.

Trait Implementations

impl Clone for Server

fn clone(&self) -> Server

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Server

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Server

fn eq(&self, other: &Server) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Server