Struct aws_sdk_opsworkscm::types::builders::ServerBuilder

#[non_exhaustive]
pub struct ServerBuilder { /* private fields */ }

A builder for Server.

Implementations

impl ServerBuilder

pub fn associate_public_ip_address(self, input: bool) -> Self

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

pub fn set_associate_public_ip_address(self, input: Option<bool>) -> Self

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

pub fn get_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, input: i32) -> Self

The number of automated backups to keep.

pub fn set_backup_retention_count(self, input: Option<i32>) -> Self

The number of automated backups to keep.

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

The number of automated backups to keep.

pub fn server_name(self, input: impl Into<String>) -> Self

The name of the server.

pub fn set_server_name(self, input: Option<String>) -> Self

The name of the server.

pub fn get_server_name(&self) -> &Option<String>

The name of the server.

pub fn created_at(self, input: DateTime) -> Self

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

pub fn set_created_at(self, input: Option<DateTime>) -> Self

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

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

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

pub fn cloud_formation_stack_arn(self, input: impl Into<String>) -> Self

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

pub fn set_cloud_formation_stack_arn(self, input: Option<String>) -> Self

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

pub fn get_cloud_formation_stack_arn(&self) -> &Option<String>

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

pub fn custom_domain(self, input: impl Into<String>) -> Self

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 set_custom_domain(self, input: Option<String>) -> Self

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 get_custom_domain(&self) -> &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.

pub fn disable_automated_backup(self, input: bool) -> Self

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

pub fn set_disable_automated_backup(self, input: Option<bool>) -> Self

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

pub fn get_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, input: impl Into<String>) -> Self

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 set_endpoint(self, input: Option<String>) -> Self

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 get_endpoint(&self) -> &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.

pub fn engine(self, input: impl Into<String>) -> Self

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

pub fn set_engine(self, input: Option<String>) -> Self

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

pub fn get_engine(&self) -> &Option<String>

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

pub fn engine_model(self, input: impl Into<String>) -> Self

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

pub fn set_engine_model(self, input: Option<String>) -> Self

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

pub fn get_engine_model(&self) -> &Option<String>

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

pub fn engine_attributes(self, input: EngineAttribute) -> Self

Appends an item to engine_attributes.

To override the contents of this collection use set_engine_attributes.

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.

pub fn set_engine_attributes(self, input: Option<Vec<EngineAttribute>>) -> Self

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.

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

pub fn engine_version(self, input: impl Into<String>) -> Self

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 set_engine_version(self, input: Option<String>) -> Self

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 get_engine_version(&self) -> &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.

pub fn instance_profile_arn(self, input: impl Into<String>) -> Self

The instance profile ARN of the server.

pub fn set_instance_profile_arn(self, input: Option<String>) -> Self

The instance profile ARN of the server.

pub fn get_instance_profile_arn(&self) -> &Option<String>

The instance profile ARN of the server.

pub fn instance_type(self, input: impl Into<String>) -> Self

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 set_instance_type(self, input: Option<String>) -> Self

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 get_instance_type(&self) -> &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.

pub fn key_pair(self, input: impl Into<String>) -> Self

The key pair associated with the server.

pub fn set_key_pair(self, input: Option<String>) -> Self

The key pair associated with the server.

pub fn get_key_pair(&self) -> &Option<String>

The key pair associated with the server.

pub fn maintenance_status(self, input: MaintenanceStatus) -> Self

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

pub fn set_maintenance_status(self, input: Option<MaintenanceStatus>) -> Self

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

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

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

pub fn preferred_maintenance_window(self, input: impl Into<String>) -> Self

The preferred maintenance period specified for the server.

pub fn set_preferred_maintenance_window(self, input: Option<String>) -> Self

The preferred maintenance period specified for the server.

pub fn get_preferred_maintenance_window(&self) -> &Option<String>

The preferred maintenance period specified for the server.

pub fn preferred_backup_window(self, input: impl Into<String>) -> Self

The preferred backup period specified for the server.

pub fn set_preferred_backup_window(self, input: Option<String>) -> Self

The preferred backup period specified for the server.

pub fn get_preferred_backup_window(&self) -> &Option<String>

The preferred backup period specified for the server.

pub fn security_group_ids(self, input: impl Into<String>) -> Self

Appends an item to security_group_ids.

To override the contents of this collection use set_security_group_ids.

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.

pub fn set_security_group_ids(self, input: Option<Vec<String>>) -> Self

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.

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

pub fn service_role_arn(self, input: impl Into<String>) -> Self

The service role ARN used to create the server.

pub fn set_service_role_arn(self, input: Option<String>) -> Self

The service role ARN used to create the server.

pub fn get_service_role_arn(&self) -> &Option<String>

The service role ARN used to create the server.

pub fn status(self, input: ServerStatus) -> Self

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 set_status(self, input: Option<ServerStatus>) -> Self

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 get_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, input: impl Into<String>) -> Self

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 set_status_reason(self, input: Option<String>) -> Self

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 get_status_reason(&self) -> &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).

pub fn subnet_ids(self, input: impl Into<String>) -> Self

Appends an item to subnet_ids.

To override the contents of this collection use set_subnet_ids.

The subnet IDs specified in a CreateServer request.

pub fn set_subnet_ids(self, input: Option<Vec<String>>) -> Self

The subnet IDs specified in a CreateServer request.

pub fn get_subnet_ids(&self) -> &Option<Vec<String>>

The subnet IDs specified in a CreateServer request.

pub fn server_arn(self, input: impl Into<String>) -> Self

The ARN of the server.

pub fn set_server_arn(self, input: Option<String>) -> Self

The ARN of the server.

pub fn get_server_arn(&self) -> &Option<String>

The ARN of the server.

pub fn build(self) -> Server

Consumes the builder and constructs a Server.

Trait Implementations

impl Clone for ServerBuilder

fn clone(&self) -> ServerBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ServerBuilder

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

Formats the value using the given formatter.

impl Default for ServerBuilder

fn default() -> ServerBuilder

Returns the “default value” for a type.

impl PartialEq for ServerBuilder

fn eq(&self, other: &ServerBuilder) -> 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 ServerBuilder