Struct aws_sdk_opsworks::Client

pub struct Client { /* private fields */ }

Client for AWS OpsWorks

Client for invoking operations on AWS OpsWorks. Each operation on AWS OpsWorks is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_opsworks::Client::new(&config);

Occasionally, SDKs may have additional service-specific that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_opsworks::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AssignInstance operation has a Client::assign_instance, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.assign_instance()
    .instance_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn assign_instance(&self) -> AssignInstanceFluentBuilder

Constructs a fluent builder for the AssignInstance operation.

• The fluent builder is configurable:
  • instance_id(impl ::std::convert::Into<String>) / set_instance_id(Option<String>):

    The instance ID.

  • layer_ids(Vec<String>) / set_layer_ids(Option<Vec<String>>):

    The layer ID, which must correspond to a custom layer. You cannot assign a registered instance to a built-in layer.

• On success, responds with AssignInstanceOutput
• On failure, responds with SdkError<AssignInstanceError>

impl Client

pub fn assign_volume(&self) -> AssignVolumeFluentBuilder

Constructs a fluent builder for the AssignVolume operation.

• The fluent builder is configurable:
  • volume_id(impl ::std::convert::Into<String>) / set_volume_id(Option<String>):

    The volume ID.

  • instance_id(impl ::std::convert::Into<String>) / set_instance_id(Option<String>):

    The instance ID.

• On success, responds with AssignVolumeOutput
• On failure, responds with SdkError<AssignVolumeError>

impl Client

pub fn associate_elastic_ip(&self) -> AssociateElasticIpFluentBuilder

Constructs a fluent builder for the AssociateElasticIp operation.

• The fluent builder is configurable:
  • elastic_ip(impl ::std::convert::Into<String>) / set_elastic_ip(Option<String>):

    The Elastic IP address.

  • instance_id(impl ::std::convert::Into<String>) / set_instance_id(Option<String>):

    The instance ID.

• On success, responds with AssociateElasticIpOutput
• On failure, responds with SdkError<AssociateElasticIpError>

impl Client

pub fn attach_elastic_load_balancer( &self ) -> AttachElasticLoadBalancerFluentBuilder

Constructs a fluent builder for the AttachElasticLoadBalancer operation.

• The fluent builder is configurable:
  • elastic_load_balancer_name(impl ::std::convert::Into<String>) / set_elastic_load_balancer_name(Option<String>):

    The Elastic Load Balancing instance’s name.

  • layer_id(impl ::std::convert::Into<String>) / set_layer_id(Option<String>):

    The ID of the layer to which the Elastic Load Balancing instance is to be attached.

• On success, responds with AttachElasticLoadBalancerOutput
• On failure, responds with SdkError<AttachElasticLoadBalancerError>

impl Client

pub fn clone_stack(&self) -> CloneStackFluentBuilder

Constructs a fluent builder for the CloneStack operation.

• The fluent builder is configurable:
  • source_stack_id(impl ::std::convert::Into<String>) / set_source_stack_id(Option<String>):

    The source stack ID.

  • name(impl ::std::convert::Into<String>) / set_name(Option<String>):

    The cloned stack name.

  • region(impl ::std::convert::Into<String>) / set_region(Option<String>):

    The cloned stack AWS region, such as “ap-northeast-2”. For more information about AWS regions, see Regions and Endpoints.

  • vpc_id(impl ::std::convert::Into<String>) / set_vpc_id(Option<String>):

    The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All instances are launched into this VPC, and you cannot change the ID later.

    • If your account supports EC2 Classic, the default value is no VPC.

    • If your account does not support EC2 Classic, the default value is the default VPC for the specified region.

    If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.

    If you specify a nondefault VPC ID, note the following:

    • It must belong to a VPC in your account that is in the specified region.

    • You must specify a value for DefaultSubnetId.

    For more information about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about default VPC and EC2 Classic, see Supported Platforms.

  • attributes(HashMap<StackAttributesKeys, String>) / set_attributes(Option<HashMap<StackAttributesKeys, String>>):

    A list of stack attributes and values as key/value pairs to be added to the cloned stack.

  • service_role_arn(impl ::std::convert::Into<String>) / set_service_role_arn(Option<String>):

    The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. If you create a stack by using the AWS OpsWorks Stacks console, it creates the role for you. You can obtain an existing stack’s IAM ARN programmatically by calling DescribePermissions. For more information about IAM ARNs, see Using Identifiers.

    You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the source stack’s service role ARN, if you prefer, but you must do so explicitly.

  • default_instance_profile_arn(impl ::std::convert::Into<String>) / set_default_instance_profile_arn(Option<String>):

    The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack’s EC2 instances. For more information about IAM ARNs, see Using Identifiers.

  • default_os(impl ::std::convert::Into<String>) / set_default_os(Option<String>):

    The stack’s operating system, which must be set to one of the following.

    • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

    • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

    • CentOS Linux 7

    • Red Hat Enterprise Linux 7

    • Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

    • A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information about how to use custom AMIs with OpsWorks, see Using Custom AMIs.

    The default option is the parent stack’s operating system. For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems.

    You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to Windows or Windows to Linux.

  • hostname_theme(impl ::std::convert::Into<String>) / set_hostname_theme(Option<String>):

    The stack’s host name theme, with spaces are replaced by underscores. The theme is used to generate host names for the stack’s instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer’s short name. The other themes are:

    • Baked_Goods

    • Clouds

    • Europe_Cities

    • Fruits

    • Greek_Deities_and_Titans

    • Legendary_creatures_from_Japan

    • Planets_and_Moons

    • Roman_Deities

    • Scottish_Islands

    • US_Cities

    • Wild_Cats

    To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

  • default_availability_zone(impl ::std::convert::Into<String>) / set_default_availability_zone(Option<String>):

    The cloned stack’s default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the VpcId parameter description.

  • default_subnet_id(impl ::std::convert::Into<String>) / set_default_subnet_id(Option<String>):

    The stack’s default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.

  • custom_json(impl ::std::convert::Into<String>) / set_custom_json(Option<String>):

    A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format:

    “{"key1": "value1", "key2": "value2",…}”

    For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes

  • configuration_manager(StackConfigurationManager) / set_configuration_manager(Option<StackConfigurationManager>):

    The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.

  • chef_configuration(ChefConfiguration) / set_chef_configuration(Option<ChefConfiguration>):

    A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

  • use_custom_cookbooks(bool) / set_use_custom_cookbooks(Option<bool>):

    Whether to use custom cookbooks.

  • use_opsworks_security_groups(bool) / set_use_opsworks_security_groups(Option<bool>):

    Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack’s layers.

    AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:

    • True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it but you cannot delete the built-in security group.

    • False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate Amazon Elastic Compute Cloud (Amazon EC2) security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.

    For more information, see Create a New Stack.

  • custom_cookbooks_source(Source) / set_custom_cookbooks_source(Option<Source>):

    Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.

  • default_ssh_key_name(impl ::std::convert::Into<String>) / set_default_ssh_key_name(Option<String>):

    A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.

  • clone_permissions(bool) / set_clone_permissions(Option<bool>):

    Whether to clone the source stack’s permissions.

  • clone_app_ids(Vec<String>) / set_clone_app_ids(Option<Vec<String>>):

    A list of source stack app IDs to be included in the cloned stack.

  • default_root_device_type(RootDeviceType) / set_default_root_device_type(Option<RootDeviceType>):

    The default root device type. This value is used by default for all instances in the cloned stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

  • agent_version(impl ::std::convert::Into<String>) / set_agent_version(Option<String>):

    The default AWS OpsWorks Stacks agent version. You have the following options:

    • Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks automatically installs new agent versions on the stack’s instances as soon as they are available.

    • Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack’s instances.

    The default setting is LATEST. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

    You can also specify an agent version when you create or update an instance, which overrides the stack’s default setting.

• On success, responds with CloneStackOutput with field(s):
  • stack_id(Option<String>):

    The cloned stack ID.

• On failure, responds with SdkError<CloneStackError>

impl Client

pub fn create_app(&self) -> CreateAppFluentBuilder

Constructs a fluent builder for the CreateApp operation.

• The fluent builder is configurable:
  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    The stack ID.

  • shortname(impl ::std::convert::Into<String>) / set_shortname(Option<String>):

    The app’s short name.

  • name(impl ::std::convert::Into<String>) / set_name(Option<String>):

    The app name.

  • description(impl ::std::convert::Into<String>) / set_description(Option<String>):

    A description of the app.

  • data_sources(Vec<DataSource>) / set_data_sources(Option<Vec<DataSource>>):

    The app’s data source.

  • r#type(AppType) / set_type(Option<AppType>):

    The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. AWS OpsWorks Stacks deploys an application to those instances that are members of the corresponding layer. If your app isn’t one of the standard types, or you prefer to implement your own Deploy recipes, specify other.

  • app_source(Source) / set_app_source(Option<Source>):

    A Source object that specifies the app repository.

  • domains(Vec<String>) / set_domains(Option<Vec<String>>):

    The app virtual host settings, with multiple domains separated by commas. For example: ‘www.example.com, example.com’

  • enable_ssl(bool) / set_enable_ssl(Option<bool>):

    Whether to enable SSL for the app.

  • ssl_configuration(SslConfiguration) / set_ssl_configuration(Option<SslConfiguration>):

    An SslConfiguration object with the SSL configuration.

  • attributes(HashMap<AppAttributesKeys, String>) / set_attributes(Option<HashMap<AppAttributesKeys, String>>):

    One or more user-defined key/value pairs to be added to the stack attributes.

  • environment(Vec<EnvironmentVariable>) / set_environment(Option<Vec<EnvironmentVariable>>):

    An array of EnvironmentVariable objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instance. For more information, see Environment Variables.

    There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables’ names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, “Environment: is too large (maximum is 20KB).”

    If you have specified one or more environment variables, you cannot modify the stack’s Chef version.

• On success, responds with CreateAppOutput with field(s):
  • app_id(Option<String>):

    The app ID.

• On failure, responds with SdkError<CreateAppError>

impl Client

pub fn create_deployment(&self) -> CreateDeploymentFluentBuilder

Constructs a fluent builder for the CreateDeployment operation.

• The fluent builder is configurable:
  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    The stack ID.

  • app_id(impl ::std::convert::Into<String>) / set_app_id(Option<String>):

    The app ID. This parameter is required for app deployments, but not for other deployment commands.

  • instance_ids(Vec<String>) / set_instance_ids(Option<Vec<String>>):

    The instance IDs for the deployment targets.

  • layer_ids(Vec<String>) / set_layer_ids(Option<Vec<String>>):

    The layer IDs for the deployment targets.

  • command(DeploymentCommand) / set_command(Option<DeploymentCommand>):

    A DeploymentCommand object that specifies the deployment command and any associated arguments.

  • comment(impl ::std::convert::Into<String>) / set_comment(Option<String>):

    A user-defined comment.

  • custom_json(impl ::std::convert::Into<String>) / set_custom_json(Option<String>):

    A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding default stack configuration JSON values. The string should be in the following format:

    “{"key1": "value1", "key2": "value2",…}”

    For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes and Overriding Attributes With Custom JSON.

• On success, responds with CreateDeploymentOutput with field(s):
  • deployment_id(Option<String>):

    The deployment ID, which can be used with other requests to identify the deployment.

• On failure, responds with SdkError<CreateDeploymentError>

impl Client

pub fn create_instance(&self) -> CreateInstanceFluentBuilder

Constructs a fluent builder for the CreateInstance operation.

• The fluent builder is configurable:
  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    The stack ID.

  • layer_ids(Vec<String>) / set_layer_ids(Option<Vec<String>>):

    An array that contains the instance’s layer IDs.

  • instance_type(impl ::std::convert::Into<String>) / set_instance_type(Option<String>):

    The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

  • auto_scaling_type(AutoScalingType) / set_auto_scaling_type(Option<AutoScalingType>):

    For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

  • hostname(impl ::std::convert::Into<String>) / set_hostname(Option<String>):

    The instance host name.

  • os(impl ::std::convert::Into<String>) / set_os(Option<String>):

    The instance’s operating system, which must be set to one of the following.

    • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

    • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

    • CentOS Linux 7

    • Red Hat Enterprise Linux 7

    • A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

    • A custom AMI: Custom.

    For more information about the supported operating systems, see AWS OpsWorks Stacks Operating Systems.

    The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the CreateInstance action’s AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom. For more information about supported operating systems, see Operating SystemsFor more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom AMIs.

  • ami_id(impl ::std::convert::Into<String>) / set_ami_id(Option<String>):

    A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs.

    If you specify a custom AMI, you must set Os to Custom.

  • ssh_key_name(impl ::std::convert::Into<String>) / set_ssh_key_name(Option<String>):

    The instance’s Amazon EC2 key-pair name.

  • availability_zone(impl ::std::convert::Into<String>) / set_availability_zone(Option<String>):

    The instance Availability Zone. For more information, see Regions and Endpoints.

  • virtualization_type(impl ::std::convert::Into<String>) / set_virtualization_type(Option<String>):

    The instance’s virtualization type, paravirtual or hvm.

  • subnet_id(impl ::std::convert::Into<String>) / set_subnet_id(Option<String>):

    The ID of the instance’s subnet. If the stack is running in a VPC, you can use this parameter to override the stack’s default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet.

  • architecture(Architecture) / set_architecture(Option<Architecture>):

    The instance architecture. The default option is x86_64. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

  • root_device_type(RootDeviceType) / set_root_device_type(Option<RootDeviceType>):

    The instance root device type. For more information, see Storage for the Root Device.

  • block_device_mappings(Vec<BlockDeviceMapping>) / set_block_device_mappings(Option<Vec<BlockDeviceMapping>>):

    An array of BlockDeviceMapping objects that specify the instance’s block devices. For more information, see Block Device Mapping. Note that block device mappings are not supported for custom AMIs.

  • install_updates_on_boot(bool) / set_install_updates_on_boot(Option<bool>):

    Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

    We strongly recommend using the default value of true to ensure that your instances have the latest security updates.

  • ebs_optimized(bool) / set_ebs_optimized(Option<bool>):

    Whether to create an Amazon EBS-optimized instance.

  • agent_version(impl ::std::convert::Into<String>) / set_agent_version(Option<String>):

    The default AWS OpsWorks Stacks agent version. You have the following options:

    • INHERIT - Use the stack’s default agent version setting.

    • version_number - Use the specified agent version. This value overrides the stack’s default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.

    The default setting is INHERIT. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

  • tenancy(impl ::std::convert::Into<String>) / set_tenancy(Option<String>):

    The instance’s tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated, default, or host. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances.

• On success, responds with CreateInstanceOutput with field(s):
  • instance_id(Option<String>):

    The instance ID.

• On failure, responds with SdkError<CreateInstanceError>

impl Client

pub fn create_layer(&self) -> CreateLayerFluentBuilder

Constructs a fluent builder for the CreateLayer operation.

• The fluent builder is configurable:
  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    The layer stack ID.

  • r#type(LayerType) / set_type(Option<LayerType>):

    The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers. Built-in layers are not available in Chef 12 stacks.

  • name(impl ::std::convert::Into<String>) / set_name(Option<String>):

    The layer name, which is used by the console.

  • shortname(impl ::std::convert::Into<String>) / set_shortname(Option<String>):

    For custom layers only, use this parameter to specify the layer’s short name, which is used internally by AWS OpsWorks Stacks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, ‘-’, ‘_’, and ‘.’.

    The built-in layers’ short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference.

  • attributes(HashMap<LayerAttributesKeys, String>) / set_attributes(Option<HashMap<LayerAttributesKeys, String>>):

    One or more user-defined key-value pairs to be added to the stack attributes.

    To create a cluster layer, set the EcsClusterArn attribute to the cluster’s ARN.

  • cloud_watch_logs_configuration(CloudWatchLogsConfiguration) / set_cloud_watch_logs_configuration(Option<CloudWatchLogsConfiguration>):

    Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream.

  • custom_instance_profile_arn(impl ::std::convert::Into<String>) / set_custom_instance_profile_arn(Option<String>):

    The ARN of an IAM profile to be used for the layer’s EC2 instances. For more information about IAM ARNs, see Using Identifiers.

  • custom_json(impl ::std::convert::Into<String>) / set_custom_json(Option<String>):

    A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer’s instances. For more information, see Using Custom JSON. This feature is supported as of version 1.7.42 of the AWS CLI.

  • custom_security_group_ids(Vec<String>) / set_custom_security_group_ids(Option<Vec<String>>):

    An array containing the layer custom security group IDs.

  • packages(Vec<String>) / set_packages(Option<Vec<String>>):

    An array of Package objects that describes the layer packages.

  • volume_configurations(Vec<VolumeConfiguration>) / set_volume_configurations(Option<Vec<VolumeConfiguration>>):

    A VolumeConfigurations object that describes the layer’s Amazon EBS volumes.

  • enable_auto_healing(bool) / set_enable_auto_healing(Option<bool>):

    Whether to disable auto healing for the layer.

  • auto_assign_elastic_ips(bool) / set_auto_assign_elastic_ips(Option<bool>):

    Whether to automatically assign an Elastic IP address to the layer’s instances. For more information, see How to Edit a Layer.

  • auto_assign_public_ips(bool) / set_auto_assign_public_ips(Option<bool>):

    For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer’s instances. For more information, see How to Edit a Layer.

  • custom_recipes(Recipes) / set_custom_recipes(Option<Recipes>):

    A LayerCustomRecipes object that specifies the layer custom recipes.

  • install_updates_on_boot(bool) / set_install_updates_on_boot(Option<bool>):

    Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

    To ensure that your instances have the latest security updates, we strongly recommend using the default value of true.

  • use_ebs_optimized_instances(bool) / set_use_ebs_optimized_instances(Option<bool>):

    Whether to use Amazon EBS-optimized instances.

  • lifecycle_event_configuration(LifecycleEventConfiguration) / set_lifecycle_event_configuration(Option<LifecycleEventConfiguration>):

    A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.

• On success, responds with CreateLayerOutput with field(s):
  • layer_id(Option<String>):

    The layer ID.

• On failure, responds with SdkError<CreateLayerError>

impl Client

pub fn create_stack(&self) -> CreateStackFluentBuilder

Constructs a fluent builder for the CreateStack operation.

• The fluent builder is configurable:
  • name(impl ::std::convert::Into<String>) / set_name(Option<String>):

    The stack name.

  • region(impl ::std::convert::Into<String>) / set_region(Option<String>):

    The stack’s AWS region, such as ap-south-1. For more information about Amazon regions, see Regions and Endpoints.

    In the AWS CLI, this API maps to the –stack-region parameter. If the –stack-region parameter and the AWS CLI common parameter –region are set to the same value, the stack uses a regional endpoint. If the –stack-region parameter is not set, but the AWS CLI –region parameter is, this also results in a stack with a regional endpoint. However, if the –region parameter is set to us-east-1, and the –stack-region parameter is set to one of the following, then the stack uses a legacy or classic region: us-west-1, us-west-2, sa-east-1, eu-central-1, eu-west-1, ap-northeast-1, ap-southeast-1, ap-southeast-2. In this case, the actual API endpoint of the stack is in us-east-1. Only the preceding regions are supported as classic regions in the us-east-1 API endpoint. Because it is a best practice to choose the regional endpoint that is closest to where you manage AWS, we recommend that you use regional endpoints for new stacks. The AWS CLI common –region parameter always specifies a regional API endpoint; it cannot be used to specify a classic AWS OpsWorks Stacks region.

  • vpc_id(impl ::std::convert::Into<String>) / set_vpc_id(Option<String>):

    The ID of the VPC that the stack is to be launched into. The VPC must be in the stack’s region. All instances are launched into this VPC. You cannot change the ID later.

    • If your account supports EC2-Classic, the default value is no VPC.

    • If your account does not support EC2-Classic, the default value is the default VPC for the specified region.

    If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.

    If you specify a nondefault VPC ID, note the following:

    • It must belong to a VPC in your account that is in the specified region.

    • You must specify a value for DefaultSubnetId.

    For more information about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about default VPC and EC2-Classic, see Supported Platforms.

  • attributes(HashMap<StackAttributesKeys, String>) / set_attributes(Option<HashMap<StackAttributesKeys, String>>):

    One or more user-defined key-value pairs to be added to the stack attributes.

  • service_role_arn(impl ::std::convert::Into<String>) / set_service_role_arn(Option<String>):

    The stack’s AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers.

  • default_instance_profile_arn(impl ::std::convert::Into<String>) / set_default_instance_profile_arn(Option<String>):

    The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack’s EC2 instances. For more information about IAM ARNs, see Using Identifiers.

  • default_os(impl ::std::convert::Into<String>) / set_default_os(Option<String>):

    The stack’s default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following.

    • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

    • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

    • CentOS Linux 7

    • Red Hat Enterprise Linux 7

    • A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

    • A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information, see Using Custom AMIs.

    The default option is the current Amazon Linux version. For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems.

  • hostname_theme(impl ::std::convert::Into<String>) / set_hostname_theme(Option<String>):

    The stack’s host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack’s instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer’s short name. The other themes are:

    • Baked_Goods

    • Clouds

    • Europe_Cities

    • Fruits

    • Greek_Deities_and_Titans

    • Legendary_creatures_from_Japan

    • Planets_and_Moons

    • Roman_Deities

    • Scottish_Islands

    • US_Cities

    • Wild_Cats

    To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

  • default_availability_zone(impl ::std::convert::Into<String>) / set_default_availability_zone(Option<String>):

    The stack’s default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the VpcId parameter description.

  • default_subnet_id(impl ::std::convert::Into<String>) / set_default_subnet_id(Option<String>):

    The stack’s default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.

  • custom_json(impl ::std::convert::Into<String>) / set_custom_json(Option<String>):

    A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format:

    “{"key1": "value1", "key2": "value2",…}”

    For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

  • configuration_manager(StackConfigurationManager) / set_configuration_manager(Option<StackConfigurationManager>):

    The configuration manager. When you create a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.

  • chef_configuration(ChefConfiguration) / set_chef_configuration(Option<ChefConfiguration>):

    A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

  • use_custom_cookbooks(bool) / set_use_custom_cookbooks(Option<bool>):

    Whether the stack uses custom cookbooks.

  • use_opsworks_security_groups(bool) / set_use_opsworks_security_groups(Option<bool>):

    Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack’s layers.

    AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:

    • True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.

    • False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.

    For more information, see Create a New Stack.

  • custom_cookbooks_source(Source) / set_custom_cookbooks_source(Option<Source>):

    Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.

  • default_ssh_key_name(impl ::std::convert::Into<String>) / set_default_ssh_key_name(Option<String>):

    A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.

  • default_root_device_type(RootDeviceType) / set_default_root_device_type(Option<RootDeviceType>):

    The default root device type. This value is the default for all instances in the stack, but you can override it when you create an instance. The default option is instance-store. For more information, see Storage for the Root Device.

  • agent_version(impl ::std::convert::Into<String>) / set_agent_version(Option<String>):

    The default AWS OpsWorks Stacks agent version. You have the following options:

    • Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks automatically installs new agent versions on the stack’s instances as soon as they are available.

    • Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack’s instances.

    The default setting is the most recent release of the agent. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

    You can also specify an agent version when you create or update an instance, which overrides the stack’s default setting.

• On success, responds with CreateStackOutput with field(s):
  • stack_id(Option<String>):

    The stack ID, which is an opaque string that you use to identify the stack when performing actions such as DescribeStacks.

• On failure, responds with SdkError<CreateStackError>

impl Client

pub fn create_user_profile(&self) -> CreateUserProfileFluentBuilder

Constructs a fluent builder for the CreateUserProfile operation.

• The fluent builder is configurable:
  • iam_user_arn(impl ::std::convert::Into<String>) / set_iam_user_arn(Option<String>):

    The user’s IAM ARN; this can also be a federated user’s ARN.

  • ssh_username(impl ::std::convert::Into<String>) / set_ssh_username(Option<String>):

    The user’s SSH user name. The allowable characters are [a-z], [A-Z], [0-9], ‘-’, and ‘_’. If the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM user name.

  • ssh_public_key(impl ::std::convert::Into<String>) / set_ssh_public_key(Option<String>):

    The user’s public SSH key.

  • allow_self_management(bool) / set_allow_self_management(Option<bool>):

    Whether users can specify their own SSH public key through the My Settings page. For more information, see Setting an IAM User’s Public SSH Key.

• On success, responds with CreateUserProfileOutput with field(s):
  • iam_user_arn(Option<String>):

    The user’s IAM ARN.

• On failure, responds with SdkError<CreateUserProfileError>

impl Client

pub fn delete_app(&self) -> DeleteAppFluentBuilder

Constructs a fluent builder for the DeleteApp operation.

• The fluent builder is configurable:
  • app_id(impl ::std::convert::Into<String>) / set_app_id(Option<String>):

    The app ID.

• On success, responds with DeleteAppOutput
• On failure, responds with SdkError<DeleteAppError>

impl Client

pub fn delete_instance(&self) -> DeleteInstanceFluentBuilder

Constructs a fluent builder for the DeleteInstance operation.

• The fluent builder is configurable:
  • instance_id(impl ::std::convert::Into<String>) / set_instance_id(Option<String>):

    The instance ID.

  • delete_elastic_ip(bool) / set_delete_elastic_ip(Option<bool>):

    Whether to delete the instance Elastic IP address.

  • delete_volumes(bool) / set_delete_volumes(Option<bool>):

    Whether to delete the instance’s Amazon EBS volumes.

• On success, responds with DeleteInstanceOutput
• On failure, responds with SdkError<DeleteInstanceError>

impl Client

pub fn delete_layer(&self) -> DeleteLayerFluentBuilder

Constructs a fluent builder for the DeleteLayer operation.

• The fluent builder is configurable:
  • layer_id(impl ::std::convert::Into<String>) / set_layer_id(Option<String>):

    The layer ID.

• On success, responds with DeleteLayerOutput
• On failure, responds with SdkError<DeleteLayerError>

impl Client

pub fn delete_stack(&self) -> DeleteStackFluentBuilder

Constructs a fluent builder for the DeleteStack operation.

• The fluent builder is configurable:
  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    The stack ID.

• On success, responds with DeleteStackOutput
• On failure, responds with SdkError<DeleteStackError>

impl Client

pub fn delete_user_profile(&self) -> DeleteUserProfileFluentBuilder

Constructs a fluent builder for the DeleteUserProfile operation.

• The fluent builder is configurable:
  • iam_user_arn(impl ::std::convert::Into<String>) / set_iam_user_arn(Option<String>):

    The user’s IAM ARN. This can also be a federated user’s ARN.

• On success, responds with DeleteUserProfileOutput
• On failure, responds with SdkError<DeleteUserProfileError>

impl Client

pub fn deregister_ecs_cluster(&self) -> DeregisterEcsClusterFluentBuilder

Constructs a fluent builder for the DeregisterEcsCluster operation.

• The fluent builder is configurable:
  • ecs_cluster_arn(impl ::std::convert::Into<String>) / set_ecs_cluster_arn(Option<String>):

    The cluster’s Amazon Resource Number (ARN).

• On success, responds with DeregisterEcsClusterOutput
• On failure, responds with SdkError<DeregisterEcsClusterError>

impl Client

pub fn deregister_elastic_ip(&self) -> DeregisterElasticIpFluentBuilder

Constructs a fluent builder for the DeregisterElasticIp operation.

• The fluent builder is configurable:
  • elastic_ip(impl ::std::convert::Into<String>) / set_elastic_ip(Option<String>):

    The Elastic IP address.

• On success, responds with DeregisterElasticIpOutput
• On failure, responds with SdkError<DeregisterElasticIpError>

impl Client

pub fn deregister_instance(&self) -> DeregisterInstanceFluentBuilder

Constructs a fluent builder for the DeregisterInstance operation.

• The fluent builder is configurable:
  • instance_id(impl ::std::convert::Into<String>) / set_instance_id(Option<String>):

    The instance ID.

• On success, responds with DeregisterInstanceOutput
• On failure, responds with SdkError<DeregisterInstanceError>

impl Client

pub fn deregister_rds_db_instance(&self) -> DeregisterRdsDbInstanceFluentBuilder

Constructs a fluent builder for the DeregisterRdsDbInstance operation.

• The fluent builder is configurable:
  • rds_db_instance_arn(impl ::std::convert::Into<String>) / set_rds_db_instance_arn(Option<String>):

    The Amazon RDS instance’s ARN.

• On success, responds with DeregisterRdsDbInstanceOutput
• On failure, responds with SdkError<DeregisterRdsDbInstanceError>

impl Client

pub fn deregister_volume(&self) -> DeregisterVolumeFluentBuilder

Constructs a fluent builder for the DeregisterVolume operation.

• The fluent builder is configurable:
  • volume_id(impl ::std::convert::Into<String>) / set_volume_id(Option<String>):

    The AWS OpsWorks Stacks volume ID, which is the GUID that AWS OpsWorks Stacks assigned to the instance when you registered the volume with the stack, not the Amazon EC2 volume ID.

• On success, responds with DeregisterVolumeOutput
• On failure, responds with SdkError<DeregisterVolumeError>

impl Client

pub fn describe_agent_versions(&self) -> DescribeAgentVersionsFluentBuilder

Constructs a fluent builder for the DescribeAgentVersions operation.

• The fluent builder is configurable:
  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    The stack ID.

  • configuration_manager(StackConfigurationManager) / set_configuration_manager(Option<StackConfigurationManager>):

    The configuration manager.

• On success, responds with DescribeAgentVersionsOutput with field(s):
  • agent_versions(Option<Vec<AgentVersion>>):

    The agent versions for the specified stack or configuration manager. Note that this value is the complete version number, not the abbreviated number used by the console.

• On failure, responds with SdkError<DescribeAgentVersionsError>

impl Client

pub fn describe_apps(&self) -> DescribeAppsFluentBuilder

Constructs a fluent builder for the DescribeApps operation.

• The fluent builder is configurable:
  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the specified stack.

  • app_ids(Vec<String>) / set_app_ids(Option<Vec<String>>):

    An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the specified apps. Otherwise, it returns a description of every app.

• On success, responds with DescribeAppsOutput with field(s):
  • apps(Option<Vec<App>>):

    An array of App objects that describe the specified apps.

• On failure, responds with SdkError<DescribeAppsError>

impl Client

pub fn describe_commands(&self) -> DescribeCommandsFluentBuilder

Constructs a fluent builder for the DescribeCommands operation.

• The fluent builder is configurable:
  • deployment_id(impl ::std::convert::Into<String>) / set_deployment_id(Option<String>):

    The deployment ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified deployment.

  • instance_id(impl ::std::convert::Into<String>) / set_instance_id(Option<String>):

    The instance ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified instance.

  • command_ids(Vec<String>) / set_command_ids(Option<Vec<String>>):

    An array of command IDs. If you include this parameter, DescribeCommands returns a description of the specified commands. Otherwise, it returns a description of every command.

• On success, responds with DescribeCommandsOutput with field(s):
  • commands(Option<Vec<Command>>):

    An array of Command objects that describe each of the specified commands.

• On failure, responds with SdkError<DescribeCommandsError>

impl Client

pub fn describe_deployments(&self) -> DescribeDeploymentsFluentBuilder

Constructs a fluent builder for the DescribeDeployments operation.

• The fluent builder is configurable:
  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    The stack ID. If you include this parameter, the command returns a description of the commands associated with the specified stack.

  • app_id(impl ::std::convert::Into<String>) / set_app_id(Option<String>):

    The app ID. If you include this parameter, the command returns a description of the commands associated with the specified app.

  • deployment_ids(Vec<String>) / set_deployment_ids(Option<Vec<String>>):

    An array of deployment IDs to be described. If you include this parameter, the command returns a description of the specified deployments. Otherwise, it returns a description of every deployment.

• On success, responds with DescribeDeploymentsOutput with field(s):
  • deployments(Option<Vec<Deployment>>):

    An array of Deployment objects that describe the deployments.

• On failure, responds with SdkError<DescribeDeploymentsError>

impl Client

pub fn describe_ecs_clusters(&self) -> DescribeEcsClustersFluentBuilder

Constructs a fluent builder for the DescribeEcsClusters operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • ecs_cluster_arns(Vec<String>) / set_ecs_cluster_arns(Option<Vec<String>>):

    A list of ARNs, one for each cluster to be described.

  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    A stack ID. DescribeEcsClusters returns a description of the cluster that is registered with the stack.

  • next_token(impl ::std::convert::Into<String>) / set_next_token(Option<String>):

    If the previous paginated request did not return all of the remaining results, the response object’sNextToken parameter value is set to a token. To retrieve the next set of results, call DescribeEcsClusters again and assign that token to the request object’s NextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

  • max_results(i32) / set_max_results(Option<i32>):

    To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

• On success, responds with DescribeEcsClustersOutput with field(s):
  • ecs_clusters(Option<Vec<EcsCluster>>):

    A list of EcsCluster objects containing the cluster descriptions.

  • next_token(Option<String>):

    If a paginated request does not return all of the remaining results, this parameter is set to a token that you can assign to the request object’s NextToken parameter to retrieve the next set of results. If the previous paginated request returned all of the remaining results, this parameter is set to null.

• On failure, responds with SdkError<DescribeEcsClustersError>

impl Client

pub fn describe_elastic_ips(&self) -> DescribeElasticIpsFluentBuilder

Constructs a fluent builder for the DescribeElasticIps operation.

• The fluent builder is configurable:
  • instance_id(impl ::std::convert::Into<String>) / set_instance_id(Option<String>):

    The instance ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses associated with the specified instance.

  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    A stack ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses that are registered with the specified stack.

  • ips(Vec<String>) / set_ips(Option<Vec<String>>):

    An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address.

• On success, responds with DescribeElasticIpsOutput with field(s):
  • elastic_ips(Option<Vec<ElasticIp>>):

    An ElasticIps object that describes the specified Elastic IP addresses.

• On failure, responds with SdkError<DescribeElasticIpsError>

impl Client

pub fn describe_elastic_load_balancers( &self ) -> DescribeElasticLoadBalancersFluentBuilder

Constructs a fluent builder for the DescribeElasticLoadBalancers operation.

• The fluent builder is configurable:
  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    A stack ID. The action describes the stack’s Elastic Load Balancing instances.

  • layer_ids(Vec<String>) / set_layer_ids(Option<Vec<String>>):

    A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers.

• On success, responds with DescribeElasticLoadBalancersOutput with field(s):
  • elastic_load_balancers(Option<Vec<ElasticLoadBalancer>>):

    A list of ElasticLoadBalancer objects that describe the specified Elastic Load Balancing instances.

• On failure, responds with SdkError<DescribeElasticLoadBalancersError>

impl Client

pub fn describe_instances(&self) -> DescribeInstancesFluentBuilder

Constructs a fluent builder for the DescribeInstances operation.

• The fluent builder is configurable:
  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified stack.

  • layer_id(impl ::std::convert::Into<String>) / set_layer_id(Option<String>):

    A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified layer.

  • instance_ids(Vec<String>) / set_instance_ids(Option<Vec<String>>):

    An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a description of the specified instances. Otherwise, it returns a description of every instance.

• On success, responds with DescribeInstancesOutput with field(s):
  • instances(Option<Vec<Instance>>):

    An array of Instance objects that describe the instances.

• On failure, responds with SdkError<DescribeInstancesError>

impl Client

pub fn describe_layers(&self) -> DescribeLayersFluentBuilder

Constructs a fluent builder for the DescribeLayers operation.

• The fluent builder is configurable:
  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    The stack ID.

  • layer_ids(Vec<String>) / set_layer_ids(Option<Vec<String>>):

    An array of layer IDs that specify the layers to be described. If you omit this parameter, DescribeLayers returns a description of every layer in the specified stack.

• On success, responds with DescribeLayersOutput with field(s):
  • layers(Option<Vec<Layer>>):

    An array of Layer objects that describe the layers.

• On failure, responds with SdkError<DescribeLayersError>

impl Client

pub fn describe_load_based_auto_scaling( &self ) -> DescribeLoadBasedAutoScalingFluentBuilder

Constructs a fluent builder for the DescribeLoadBasedAutoScaling operation.

• The fluent builder is configurable:
  • layer_ids(Vec<String>) / set_layer_ids(Option<Vec<String>>):

    An array of layer IDs.

• On success, responds with DescribeLoadBasedAutoScalingOutput with field(s):
  • load_based_auto_scaling_configurations(Option<Vec<LoadBasedAutoScalingConfiguration>>):

    An array of LoadBasedAutoScalingConfiguration objects that describe each layer’s configuration.

• On failure, responds with SdkError<DescribeLoadBasedAutoScalingError>

impl Client

pub fn describe_my_user_profile(&self) -> DescribeMyUserProfileFluentBuilder

Constructs a fluent builder for the DescribeMyUserProfile operation.

• The fluent builder takes no input, just send it.
• On success, responds with DescribeMyUserProfileOutput with field(s):
  • user_profile(Option<SelfUserProfile>):

    A UserProfile object that describes the user’s SSH information.

• On failure, responds with SdkError<DescribeMyUserProfileError>

impl Client

pub fn describe_operating_systems( &self ) -> DescribeOperatingSystemsFluentBuilder

Constructs a fluent builder for the DescribeOperatingSystems operation.

• The fluent builder takes no input, just send it.
• On success, responds with DescribeOperatingSystemsOutput with field(s):
  • operating_systems(Option<Vec<OperatingSystem>>):

    Contains information in response to a DescribeOperatingSystems request.

• On failure, responds with SdkError<DescribeOperatingSystemsError>

impl Client

pub fn describe_permissions(&self) -> DescribePermissionsFluentBuilder

Constructs a fluent builder for the DescribePermissions operation.

• The fluent builder is configurable:
  • iam_user_arn(impl ::std::convert::Into<String>) / set_iam_user_arn(Option<String>):

    The user’s IAM ARN. This can also be a federated user’s ARN. For more information about IAM ARNs, see Using Identifiers.

  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    The stack ID.

• On success, responds with DescribePermissionsOutput with field(s):
  • permissions(Option<Vec<Permission>>):

    An array of Permission objects that describe the stack permissions.

    • If the request object contains only a stack ID, the array contains a Permission object with permissions for each of the stack IAM ARNs.

    • If the request object contains only an IAM ARN, the array contains a Permission object with permissions for each of the user’s stack IDs.

    • If the request contains a stack ID and an IAM ARN, the array contains a single Permission object with permissions for the specified stack and IAM ARN.

• On failure, responds with SdkError<DescribePermissionsError>

impl Client

pub fn describe_raid_arrays(&self) -> DescribeRaidArraysFluentBuilder

Constructs a fluent builder for the DescribeRaidArrays operation.

• The fluent builder is configurable:
  • instance_id(impl ::std::convert::Into<String>) / set_instance_id(Option<String>):

    The instance ID. If you use this parameter, DescribeRaidArrays returns descriptions of the RAID arrays associated with the specified instance.

  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    The stack ID.

  • raid_array_ids(Vec<String>) / set_raid_array_ids(Option<Vec<String>>):

    An array of RAID array IDs. If you use this parameter, DescribeRaidArrays returns descriptions of the specified arrays. Otherwise, it returns a description of every array.

• On success, responds with DescribeRaidArraysOutput with field(s):
  • raid_arrays(Option<Vec<RaidArray>>):

    A RaidArrays object that describes the specified RAID arrays.

• On failure, responds with SdkError<DescribeRaidArraysError>

impl Client

pub fn describe_rds_db_instances(&self) -> DescribeRdsDbInstancesFluentBuilder

Constructs a fluent builder for the DescribeRdsDbInstances operation.

• The fluent builder is configurable:
  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    The ID of the stack with which the instances are registered. The operation returns descriptions of all registered Amazon RDS instances.

  • rds_db_instance_arns(Vec<String>) / set_rds_db_instance_arns(Option<Vec<String>>):

    An array containing the ARNs of the instances to be described.

• On success, responds with DescribeRdsDbInstancesOutput with field(s):
  • rds_db_instances(Option<Vec<RdsDbInstance>>):

    An a array of RdsDbInstance objects that describe the instances.

• On failure, responds with SdkError<DescribeRdsDbInstancesError>

impl Client

pub fn describe_service_errors(&self) -> DescribeServiceErrorsFluentBuilder

Constructs a fluent builder for the DescribeServiceErrors operation.

• The fluent builder is configurable:
  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    The stack ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified stack.

  • instance_id(impl ::std::convert::Into<String>) / set_instance_id(Option<String>):

    The instance ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified instance.

  • service_error_ids(Vec<String>) / set_service_error_ids(Option<Vec<String>>):

    An array of service error IDs. If you use this parameter, DescribeServiceErrors returns descriptions of the specified errors. Otherwise, it returns a description of every error.

• On success, responds with DescribeServiceErrorsOutput with field(s):
  • service_errors(Option<Vec<ServiceError>>):

    An array of ServiceError objects that describe the specified service errors.

• On failure, responds with SdkError<DescribeServiceErrorsError>

impl Client

pub fn describe_stack_provisioning_parameters( &self ) -> DescribeStackProvisioningParametersFluentBuilder

Constructs a fluent builder for the DescribeStackProvisioningParameters operation.

• The fluent builder is configurable:
  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    The stack ID.

• On success, responds with DescribeStackProvisioningParametersOutput with field(s):
  • agent_installer_url(Option<String>):

    The AWS OpsWorks Stacks agent installer’s URL.

  • parameters(Option<HashMap<String, String>>):

    An embedded object that contains the provisioning parameters.

• On failure, responds with SdkError<DescribeStackProvisioningParametersError>

impl Client

pub fn describe_stack_summary(&self) -> DescribeStackSummaryFluentBuilder

Constructs a fluent builder for the DescribeStackSummary operation.

• The fluent builder is configurable:
  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    The stack ID.

• On success, responds with DescribeStackSummaryOutput with field(s):
  • stack_summary(Option<StackSummary>):

    A StackSummary object that contains the results.

• On failure, responds with SdkError<DescribeStackSummaryError>

impl Client

pub fn describe_stacks(&self) -> DescribeStacksFluentBuilder

Constructs a fluent builder for the DescribeStacks operation.

• The fluent builder is configurable:
  • stack_ids(Vec<String>) / set_stack_ids(Option<Vec<String>>):

    An array of stack IDs that specify the stacks to be described. If you omit this parameter, DescribeStacks returns a description of every stack.

• On success, responds with DescribeStacksOutput with field(s):
  • stacks(Option<Vec<Stack>>):

    An array of Stack objects that describe the stacks.

• On failure, responds with SdkError<DescribeStacksError>

impl Client

pub fn describe_time_based_auto_scaling( &self ) -> DescribeTimeBasedAutoScalingFluentBuilder

Constructs a fluent builder for the DescribeTimeBasedAutoScaling operation.

• The fluent builder is configurable:
  • instance_ids(Vec<String>) / set_instance_ids(Option<Vec<String>>):

    An array of instance IDs.

• On success, responds with DescribeTimeBasedAutoScalingOutput with field(s):
  • time_based_auto_scaling_configurations(Option<Vec<TimeBasedAutoScalingConfiguration>>):

    An array of TimeBasedAutoScalingConfiguration objects that describe the configuration for the specified instances.

• On failure, responds with SdkError<DescribeTimeBasedAutoScalingError>

impl Client

pub fn describe_user_profiles(&self) -> DescribeUserProfilesFluentBuilder

Constructs a fluent builder for the DescribeUserProfiles operation.

• The fluent builder is configurable:
  • iam_user_arns(Vec<String>) / set_iam_user_arns(Option<Vec<String>>):

    An array of IAM or federated user ARNs that identify the users to be described.

• On success, responds with DescribeUserProfilesOutput with field(s):
  • user_profiles(Option<Vec<UserProfile>>):

    A Users object that describes the specified users.

• On failure, responds with SdkError<DescribeUserProfilesError>

impl Client

pub fn describe_volumes(&self) -> DescribeVolumesFluentBuilder

Constructs a fluent builder for the DescribeVolumes operation.

• The fluent builder is configurable:
  • instance_id(impl ::std::convert::Into<String>) / set_instance_id(Option<String>):

    The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified instance.

  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    A stack ID. The action describes the stack’s registered Amazon EBS volumes.

  • raid_array_id(impl ::std::convert::Into<String>) / set_raid_array_id(Option<String>):

    The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified RAID array.

  • volume_ids(Vec<String>) / set_volume_ids(Option<Vec<String>>):

    Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the specified volumes. Otherwise, it returns a description of every volume.

• On success, responds with DescribeVolumesOutput with field(s):
  • volumes(Option<Vec<Volume>>):

    An array of volume IDs.

• On failure, responds with SdkError<DescribeVolumesError>

impl Client

pub fn detach_elastic_load_balancer( &self ) -> DetachElasticLoadBalancerFluentBuilder

Constructs a fluent builder for the DetachElasticLoadBalancer operation.

• The fluent builder is configurable:
  • elastic_load_balancer_name(impl ::std::convert::Into<String>) / set_elastic_load_balancer_name(Option<String>):

    The Elastic Load Balancing instance’s name.

  • layer_id(impl ::std::convert::Into<String>) / set_layer_id(Option<String>):

    The ID of the layer that the Elastic Load Balancing instance is attached to.

• On success, responds with DetachElasticLoadBalancerOutput
• On failure, responds with SdkError<DetachElasticLoadBalancerError>

impl Client

pub fn disassociate_elastic_ip(&self) -> DisassociateElasticIpFluentBuilder

Constructs a fluent builder for the DisassociateElasticIp operation.

• The fluent builder is configurable:
  • elastic_ip(impl ::std::convert::Into<String>) / set_elastic_ip(Option<String>):

    The Elastic IP address.

• On success, responds with DisassociateElasticIpOutput
• On failure, responds with SdkError<DisassociateElasticIpError>

impl Client

pub fn get_hostname_suggestion(&self) -> GetHostnameSuggestionFluentBuilder

Constructs a fluent builder for the GetHostnameSuggestion operation.

• The fluent builder is configurable:
  • layer_id(impl ::std::convert::Into<String>) / set_layer_id(Option<String>):

    The layer ID.

• On success, responds with GetHostnameSuggestionOutput with field(s):
  • layer_id(Option<String>):

    The layer ID.

  • hostname(Option<String>):

    The generated host name.

• On failure, responds with SdkError<GetHostnameSuggestionError>

impl Client

pub fn grant_access(&self) -> GrantAccessFluentBuilder

Constructs a fluent builder for the GrantAccess operation.

• The fluent builder is configurable:
  • instance_id(impl ::std::convert::Into<String>) / set_instance_id(Option<String>):

    The instance’s AWS OpsWorks Stacks ID.

  • valid_for_in_minutes(i32) / set_valid_for_in_minutes(Option<i32>):

    The length of time (in minutes) that the grant is valid. When the grant expires at the end of this period, the user will no longer be able to use the credentials to log in. If the user is logged in at the time, he or she automatically will be logged out.

• On success, responds with GrantAccessOutput with field(s):
  • temporary_credential(Option<TemporaryCredential>):

    A TemporaryCredential object that contains the data needed to log in to the instance by RDP clients, such as the Microsoft Remote Desktop Connection.

• On failure, responds with SdkError<GrantAccessError>

impl Client

pub fn list_tags(&self) -> ListTagsFluentBuilder

Constructs a fluent builder for the ListTags operation.

• The fluent builder is configurable:
  • resource_arn(impl ::std::convert::Into<String>) / set_resource_arn(Option<String>):

    The stack or layer’s Amazon Resource Number (ARN).

  • max_results(i32) / set_max_results(i32):

    Do not use. A validation exception occurs if you add a MaxResults parameter to a ListTagsRequest call.

  • next_token(impl ::std::convert::Into<String>) / set_next_token(Option<String>):

    Do not use. A validation exception occurs if you add a NextToken parameter to a ListTagsRequest call.

• On success, responds with ListTagsOutput with field(s):
  • tags(Option<HashMap<String, String>>):

    A set of key-value pairs that contain tag keys and tag values that are attached to a stack or layer.

  • next_token(Option<String>):

    If a paginated request does not return all of the remaining results, this parameter is set to a token that you can assign to the request object’s NextToken parameter to get the next set of results. If the previous paginated request returned all of the remaining results, this parameter is set to null.

• On failure, responds with SdkError<ListTagsError>

impl Client

pub fn reboot_instance(&self) -> RebootInstanceFluentBuilder

Constructs a fluent builder for the RebootInstance operation.

• The fluent builder is configurable:
  • instance_id(impl ::std::convert::Into<String>) / set_instance_id(Option<String>):

    The instance ID.

• On success, responds with RebootInstanceOutput
• On failure, responds with SdkError<RebootInstanceError>

impl Client

pub fn register_ecs_cluster(&self) -> RegisterEcsClusterFluentBuilder

Constructs a fluent builder for the RegisterEcsCluster operation.

• The fluent builder is configurable:
  • ecs_cluster_arn(impl ::std::convert::Into<String>) / set_ecs_cluster_arn(Option<String>):

    The cluster’s ARN.

  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    The stack ID.

• On success, responds with RegisterEcsClusterOutput with field(s):
  • ecs_cluster_arn(Option<String>):

    The cluster’s ARN.

• On failure, responds with SdkError<RegisterEcsClusterError>

impl Client

pub fn register_elastic_ip(&self) -> RegisterElasticIpFluentBuilder

Constructs a fluent builder for the RegisterElasticIp operation.

• The fluent builder is configurable:
  • elastic_ip(impl ::std::convert::Into<String>) / set_elastic_ip(Option<String>):

    The Elastic IP address.

  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    The stack ID.

• On success, responds with RegisterElasticIpOutput with field(s):
  • elastic_ip(Option<String>):

    The Elastic IP address.

• On failure, responds with SdkError<RegisterElasticIpError>

impl Client

pub fn register_instance(&self) -> RegisterInstanceFluentBuilder

Constructs a fluent builder for the RegisterInstance operation.

• The fluent builder is configurable:
  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    The ID of the stack that the instance is to be registered with.

  • hostname(impl ::std::convert::Into<String>) / set_hostname(Option<String>):

    The instance’s hostname.

  • public_ip(impl ::std::convert::Into<String>) / set_public_ip(Option<String>):

    The instance’s public IP address.

  • private_ip(impl ::std::convert::Into<String>) / set_private_ip(Option<String>):

    The instance’s private IP address.

  • rsa_public_key(impl ::std::convert::Into<String>) / set_rsa_public_key(Option<String>):

    The instances public RSA key. This key is used to encrypt communication between the instance and the service.

  • rsa_public_key_fingerprint(impl ::std::convert::Into<String>) / set_rsa_public_key_fingerprint(Option<String>):

    The instances public RSA key fingerprint.

  • instance_identity(InstanceIdentity) / set_instance_identity(Option<InstanceIdentity>):

    An InstanceIdentity object that contains the instance’s identity.

• On success, responds with RegisterInstanceOutput with field(s):
  • instance_id(Option<String>):

    The registered instance’s AWS OpsWorks Stacks ID.

• On failure, responds with SdkError<RegisterInstanceError>

impl Client

pub fn register_rds_db_instance(&self) -> RegisterRdsDbInstanceFluentBuilder

Constructs a fluent builder for the RegisterRdsDbInstance operation.

• The fluent builder is configurable:
  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    The stack ID.

  • rds_db_instance_arn(impl ::std::convert::Into<String>) / set_rds_db_instance_arn(Option<String>):

    The Amazon RDS instance’s ARN.

  • db_user(impl ::std::convert::Into<String>) / set_db_user(Option<String>):

    The database’s master user name.

  • db_password(impl ::std::convert::Into<String>) / set_db_password(Option<String>):

    The database password.

• On success, responds with RegisterRdsDbInstanceOutput
• On failure, responds with SdkError<RegisterRdsDbInstanceError>

impl Client

pub fn register_volume(&self) -> RegisterVolumeFluentBuilder

Constructs a fluent builder for the RegisterVolume operation.

• The fluent builder is configurable:
  • ec2_volume_id(impl ::std::convert::Into<String>) / set_ec2_volume_id(Option<String>):

    The Amazon EBS volume ID.

  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    The stack ID.

• On success, responds with RegisterVolumeOutput with field(s):
  • volume_id(Option<String>):

    The volume ID.

• On failure, responds with SdkError<RegisterVolumeError>

impl Client

pub fn set_load_based_auto_scaling( &self ) -> SetLoadBasedAutoScalingFluentBuilder

Constructs a fluent builder for the SetLoadBasedAutoScaling operation.

• The fluent builder is configurable:
  • layer_id(impl ::std::convert::Into<String>) / set_layer_id(Option<String>):

    The layer ID.

  • enable(bool) / set_enable(Option<bool>):

    Enables load-based auto scaling for the layer.

  • up_scaling(AutoScalingThresholds) / set_up_scaling(Option<AutoScalingThresholds>):

    An AutoScalingThresholds object with the upscaling threshold configuration. If the load exceeds these thresholds for a specified amount of time, AWS OpsWorks Stacks starts a specified number of instances.

  • down_scaling(AutoScalingThresholds) / set_down_scaling(Option<AutoScalingThresholds>):

    An AutoScalingThresholds object with the downscaling threshold configuration. If the load falls below these thresholds for a specified amount of time, AWS OpsWorks Stacks stops a specified number of instances.

• On success, responds with SetLoadBasedAutoScalingOutput
• On failure, responds with SdkError<SetLoadBasedAutoScalingError>

impl Client

pub fn set_permission(&self) -> SetPermissionFluentBuilder

Constructs a fluent builder for the SetPermission operation.

• The fluent builder is configurable:
  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    The stack ID.

  • iam_user_arn(impl ::std::convert::Into<String>) / set_iam_user_arn(Option<String>):

    The user’s IAM ARN. This can also be a federated user’s ARN.

  • allow_ssh(bool) / set_allow_ssh(Option<bool>):

    The user is allowed to use SSH to communicate with the instance.

  • allow_sudo(bool) / set_allow_sudo(Option<bool>):

    The user is allowed to use sudo to elevate privileges.

  • level(impl ::std::convert::Into<String>) / set_level(Option<String>):

    The user’s permission level, which must be set to one of the following strings. You cannot set your own permissions level.

    • deny

    • show

    • deploy

    • manage

    • iam_only

    For more information about the permissions associated with these levels, see Managing User Permissions.

• On success, responds with SetPermissionOutput
• On failure, responds with SdkError<SetPermissionError>

impl Client

pub fn set_time_based_auto_scaling( &self ) -> SetTimeBasedAutoScalingFluentBuilder

Constructs a fluent builder for the SetTimeBasedAutoScaling operation.

• The fluent builder is configurable:
  • instance_id(impl ::std::convert::Into<String>) / set_instance_id(Option<String>):

    The instance ID.

  • auto_scaling_schedule(WeeklyAutoScalingSchedule) / set_auto_scaling_schedule(Option<WeeklyAutoScalingSchedule>):

    An AutoScalingSchedule with the instance schedule.

• On success, responds with SetTimeBasedAutoScalingOutput
• On failure, responds with SdkError<SetTimeBasedAutoScalingError>

impl Client

pub fn start_instance(&self) -> StartInstanceFluentBuilder

Constructs a fluent builder for the StartInstance operation.

• The fluent builder is configurable:
  • instance_id(impl ::std::convert::Into<String>) / set_instance_id(Option<String>):

    The instance ID.

• On success, responds with StartInstanceOutput
• On failure, responds with SdkError<StartInstanceError>

impl Client

pub fn start_stack(&self) -> StartStackFluentBuilder

Constructs a fluent builder for the StartStack operation.

• The fluent builder is configurable:
  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    The stack ID.

• On success, responds with StartStackOutput
• On failure, responds with SdkError<StartStackError>

impl Client

pub fn stop_instance(&self) -> StopInstanceFluentBuilder

Constructs a fluent builder for the StopInstance operation.

• The fluent builder is configurable:
  • instance_id(impl ::std::convert::Into<String>) / set_instance_id(Option<String>):

    The instance ID.

  • force(bool) / set_force(Option<bool>):

    Specifies whether to force an instance to stop. If the instance’s root device type is ebs, or EBS-backed, adding the Force parameter to the StopInstances API call disassociates the AWS OpsWorks Stacks instance from EC2, and forces deletion of only the OpsWorks Stacks instance. You must also delete the formerly-associated instance in EC2 after troubleshooting and replacing the AWS OpsWorks Stacks instance with a new one.

• On success, responds with StopInstanceOutput
• On failure, responds with SdkError<StopInstanceError>

impl Client

pub fn stop_stack(&self) -> StopStackFluentBuilder

Constructs a fluent builder for the StopStack operation.

• The fluent builder is configurable:
  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    The stack ID.

• On success, responds with StopStackOutput
• On failure, responds with SdkError<StopStackError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl ::std::convert::Into<String>) / set_resource_arn(Option<String>):

    The stack or layer’s Amazon Resource Number (ARN).

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    A map that contains tag keys and tag values that are attached to a stack or layer.

    • The 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: + - = . _ : /

    • The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

    • Leading and trailing white spaces are trimmed from both the key and value.

    • A maximum of 40 tags is allowed for any resource.

• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn unassign_instance(&self) -> UnassignInstanceFluentBuilder

Constructs a fluent builder for the UnassignInstance operation.

• The fluent builder is configurable:
  • instance_id(impl ::std::convert::Into<String>) / set_instance_id(Option<String>):

    The instance ID.

• On success, responds with UnassignInstanceOutput
• On failure, responds with SdkError<UnassignInstanceError>

impl Client

pub fn unassign_volume(&self) -> UnassignVolumeFluentBuilder

Constructs a fluent builder for the UnassignVolume operation.

• The fluent builder is configurable:
  • volume_id(impl ::std::convert::Into<String>) / set_volume_id(Option<String>):

    The volume ID.

• On success, responds with UnassignVolumeOutput
• On failure, responds with SdkError<UnassignVolumeError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl ::std::convert::Into<String>) / set_resource_arn(Option<String>):

    The stack or layer’s Amazon Resource Number (ARN).

  • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

    A list of the keys of tags to be removed from a stack or layer.

• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_app(&self) -> UpdateAppFluentBuilder

Constructs a fluent builder for the UpdateApp operation.

• The fluent builder is configurable:
  • app_id(impl ::std::convert::Into<String>) / set_app_id(Option<String>):

    The app ID.

  • name(impl ::std::convert::Into<String>) / set_name(Option<String>):

    The app name.

  • description(impl ::std::convert::Into<String>) / set_description(Option<String>):

    A description of the app.

  • data_sources(Vec<DataSource>) / set_data_sources(Option<Vec<DataSource>>):

    The app’s data sources.

  • r#type(AppType) / set_type(Option<AppType>):

    The app type.

  • app_source(Source) / set_app_source(Option<Source>):

    A Source object that specifies the app repository.

  • domains(Vec<String>) / set_domains(Option<Vec<String>>):

    The app’s virtual host settings, with multiple domains separated by commas. For example: ‘www.example.com, example.com’

  • enable_ssl(bool) / set_enable_ssl(Option<bool>):

    Whether SSL is enabled for the app.

  • ssl_configuration(SslConfiguration) / set_ssl_configuration(Option<SslConfiguration>):

    An SslConfiguration object with the SSL configuration.

  • attributes(HashMap<AppAttributesKeys, String>) / set_attributes(Option<HashMap<AppAttributesKeys, String>>):

    One or more user-defined key/value pairs to be added to the stack attributes.

  • environment(Vec<EnvironmentVariable>) / set_environment(Option<Vec<EnvironmentVariable>>):

    An array of EnvironmentVariable objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances.For more information, see Environment Variables.

    There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables’ names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, “Environment: is too large (maximum is 20 KB).”

    If you have specified one or more environment variables, you cannot modify the stack’s Chef version.

• On success, responds with UpdateAppOutput
• On failure, responds with SdkError<UpdateAppError>

impl Client

pub fn update_elastic_ip(&self) -> UpdateElasticIpFluentBuilder

Constructs a fluent builder for the UpdateElasticIp operation.

• The fluent builder is configurable:
  • elastic_ip(impl ::std::convert::Into<String>) / set_elastic_ip(Option<String>):

    The IP address for which you want to update the name.

  • name(impl ::std::convert::Into<String>) / set_name(Option<String>):

    The new name.

• On success, responds with UpdateElasticIpOutput
• On failure, responds with SdkError<UpdateElasticIpError>

impl Client

pub fn update_instance(&self) -> UpdateInstanceFluentBuilder

Constructs a fluent builder for the UpdateInstance operation.

• The fluent builder is configurable:
  • instance_id(impl ::std::convert::Into<String>) / set_instance_id(Option<String>):

    The instance ID.

  • layer_ids(Vec<String>) / set_layer_ids(Option<Vec<String>>):

    The instance’s layer IDs.

  • instance_type(impl ::std::convert::Into<String>) / set_instance_type(Option<String>):

    The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

  • auto_scaling_type(AutoScalingType) / set_auto_scaling_type(Option<AutoScalingType>):

    For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

  • hostname(impl ::std::convert::Into<String>) / set_hostname(Option<String>):

    The instance host name.

  • os(impl ::std::convert::Into<String>) / set_os(Option<String>):

    The instance’s operating system, which must be set to one of the following. You cannot update an instance that is using a custom AMI.

    • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

    • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

    • CentOS Linux 7

    • Red Hat Enterprise Linux 7

    • A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

    For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems.

    The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the AmiId parameter to specify the custom AMI that you want to use. For more information about supported operating systems, see Operating Systems. For more information about how to use custom AMIs with OpsWorks, see Using Custom AMIs.

    You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux.

  • ami_id(impl ::std::convert::Into<String>) / set_ami_id(Option<String>):

    The ID of the AMI that was used to create the instance. The value of this parameter must be the same AMI ID that the instance is already using. You cannot apply a new AMI to an instance by running UpdateInstance. UpdateInstance does not work on instances that are using custom AMIs.

  • ssh_key_name(impl ::std::convert::Into<String>) / set_ssh_key_name(Option<String>):

    The instance’s Amazon EC2 key name.

  • architecture(Architecture) / set_architecture(Option<Architecture>):

    The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

  • install_updates_on_boot(bool) / set_install_updates_on_boot(Option<bool>):

    Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

    We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

  • ebs_optimized(bool) / set_ebs_optimized(Option<bool>):

    This property cannot be updated.

  • agent_version(impl ::std::convert::Into<String>) / set_agent_version(Option<String>):

    The default AWS OpsWorks Stacks agent version. You have the following options:

    • INHERIT - Use the stack’s default agent version setting.

    • version_number - Use the specified agent version. This value overrides the stack’s default setting. To update the agent version, you must edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.

    The default setting is INHERIT. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions.

    AgentVersion cannot be set to Chef 12.2.

• On success, responds with UpdateInstanceOutput
• On failure, responds with SdkError<UpdateInstanceError>

impl Client

pub fn update_layer(&self) -> UpdateLayerFluentBuilder

Constructs a fluent builder for the UpdateLayer operation.

• The fluent builder is configurable:
  • layer_id(impl ::std::convert::Into<String>) / set_layer_id(Option<String>):

    The layer ID.

  • name(impl ::std::convert::Into<String>) / set_name(Option<String>):

    The layer name, which is used by the console.

  • shortname(impl ::std::convert::Into<String>) / set_shortname(Option<String>):

    For custom layers only, use this parameter to specify the layer’s short name, which is used internally by AWS OpsWorks Stacks and by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\A[a-z0-9-_.]+\Z/.

    The built-in layers’ short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference

  • attributes(HashMap<LayerAttributesKeys, String>) / set_attributes(Option<HashMap<LayerAttributesKeys, String>>):

    One or more user-defined key/value pairs to be added to the stack attributes.

  • cloud_watch_logs_configuration(CloudWatchLogsConfiguration) / set_cloud_watch_logs_configuration(Option<CloudWatchLogsConfiguration>):

    Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream.

  • custom_instance_profile_arn(impl ::std::convert::Into<String>) / set_custom_instance_profile_arn(Option<String>):

    The ARN of an IAM profile to be used for all of the layer’s EC2 instances. For more information about IAM ARNs, see Using Identifiers.

  • custom_json(impl ::std::convert::Into<String>) / set_custom_json(Option<String>):

    A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer’s instances. For more information, see Using Custom JSON.

  • custom_security_group_ids(Vec<String>) / set_custom_security_group_ids(Option<Vec<String>>):

    An array containing the layer’s custom security group IDs.

  • packages(Vec<String>) / set_packages(Option<Vec<String>>):

    An array of Package objects that describe the layer’s packages.

  • volume_configurations(Vec<VolumeConfiguration>) / set_volume_configurations(Option<Vec<VolumeConfiguration>>):

    A VolumeConfigurations object that describes the layer’s Amazon EBS volumes.

  • enable_auto_healing(bool) / set_enable_auto_healing(Option<bool>):

    Whether to disable auto healing for the layer.

  • auto_assign_elastic_ips(bool) / set_auto_assign_elastic_ips(Option<bool>):

    Whether to automatically assign an Elastic IP address to the layer’s instances. For more information, see How to Edit a Layer.

  • auto_assign_public_ips(bool) / set_auto_assign_public_ips(Option<bool>):

    For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer’s instances. For more information, see How to Edit a Layer.

  • custom_recipes(Recipes) / set_custom_recipes(Option<Recipes>):

    A LayerCustomRecipes object that specifies the layer’s custom recipes.

  • install_updates_on_boot(bool) / set_install_updates_on_boot(Option<bool>):

    Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

    We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

  • use_ebs_optimized_instances(bool) / set_use_ebs_optimized_instances(Option<bool>):

    Whether to use Amazon EBS-optimized instances.

  • lifecycle_event_configuration(LifecycleEventConfiguration) / set_lifecycle_event_configuration(Option<LifecycleEventConfiguration>):

• On success, responds with UpdateLayerOutput
• On failure, responds with SdkError<UpdateLayerError>

impl Client

pub fn update_my_user_profile(&self) -> UpdateMyUserProfileFluentBuilder

Constructs a fluent builder for the UpdateMyUserProfile operation.

• The fluent builder is configurable:
  • ssh_public_key(impl ::std::convert::Into<String>) / set_ssh_public_key(Option<String>):

    The user’s SSH public key.

• On success, responds with UpdateMyUserProfileOutput
• On failure, responds with SdkError<UpdateMyUserProfileError>

impl Client

pub fn update_rds_db_instance(&self) -> UpdateRdsDbInstanceFluentBuilder

Constructs a fluent builder for the UpdateRdsDbInstance operation.

• The fluent builder is configurable:
  • rds_db_instance_arn(impl ::std::convert::Into<String>) / set_rds_db_instance_arn(Option<String>):

    The Amazon RDS instance’s ARN.

  • db_user(impl ::std::convert::Into<String>) / set_db_user(Option<String>):

    The master user name.

  • db_password(impl ::std::convert::Into<String>) / set_db_password(Option<String>):

    The database password.

• On success, responds with UpdateRdsDbInstanceOutput
• On failure, responds with SdkError<UpdateRdsDbInstanceError>

impl Client

pub fn update_stack(&self) -> UpdateStackFluentBuilder

Constructs a fluent builder for the UpdateStack operation.

• The fluent builder is configurable:
  • stack_id(impl ::std::convert::Into<String>) / set_stack_id(Option<String>):

    The stack ID.

  • name(impl ::std::convert::Into<String>) / set_name(Option<String>):

    The stack’s new name.

  • attributes(HashMap<StackAttributesKeys, String>) / set_attributes(Option<HashMap<StackAttributesKeys, String>>):

    One or more user-defined key-value pairs to be added to the stack attributes.

  • service_role_arn(impl ::std::convert::Into<String>) / set_service_role_arn(Option<String>):

    Do not use this parameter. You cannot update a stack’s service role.

  • default_instance_profile_arn(impl ::std::convert::Into<String>) / set_default_instance_profile_arn(Option<String>):

    The ARN of an IAM profile that is the default profile for all of the stack’s EC2 instances. For more information about IAM ARNs, see Using Identifiers.

  • default_os(impl ::std::convert::Into<String>) / set_default_os(Option<String>):

    The stack’s operating system, which must be set to one of the following:

    • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

    • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

    • CentOS Linux 7

    • Red Hat Enterprise Linux 7

    • A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

    • A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information about how to use custom AMIs with OpsWorks, see Using Custom AMIs.

    The default option is the stack’s current operating system. For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems.

  • hostname_theme(impl ::std::convert::Into<String>) / set_hostname_theme(Option<String>):

    The stack’s new host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack’s instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer’s short name. The other themes are:

    • Baked_Goods

    • Clouds

    • Europe_Cities

    • Fruits

    • Greek_Deities_and_Titans

    • Legendary_creatures_from_Japan

    • Planets_and_Moons

    • Roman_Deities

    • Scottish_Islands

    • US_Cities

    • Wild_Cats

    To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

  • default_availability_zone(impl ::std::convert::Into<String>) / set_default_availability_zone(Option<String>):

    The stack’s default Availability Zone, which must be in the stack’s region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see CreateStack.

  • default_subnet_id(impl ::std::convert::Into<String>) / set_default_subnet_id(Option<String>):

    The stack’s default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.

  • custom_json(impl ::std::convert::Into<String>) / set_custom_json(Option<String>):

    A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration JSON values or to pass data to recipes. The string should be in the following format:

    “{"key1": "value1", "key2": "value2",…}”

    For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

  • configuration_manager(StackConfigurationManager) / set_configuration_manager(Option<StackConfigurationManager>):

    The configuration manager. When you update a stack, we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.

  • chef_configuration(ChefConfiguration) / set_chef_configuration(Option<ChefConfiguration>):

    A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

  • use_custom_cookbooks(bool) / set_use_custom_cookbooks(Option<bool>):

    Whether the stack uses custom cookbooks.

  • custom_cookbooks_source(Source) / set_custom_cookbooks_source(Option<Source>):

    Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.

  • default_ssh_key_name(impl ::std::convert::Into<String>) / set_default_ssh_key_name(Option<String>):

    A default Amazon EC2 key-pair name. The default value is none. If you specify a key-pair name, AWS OpsWorks Stacks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.

  • default_root_device_type(RootDeviceType) / set_default_root_device_type(Option<RootDeviceType>):

    The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

  • use_opsworks_security_groups(bool) / set_use_opsworks_security_groups(Option<bool>):

    Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack’s layers.

    AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. UseOpsworksSecurityGroups allows you to provide your own custom security groups instead of using the built-in groups. UseOpsworksSecurityGroups has the following settings:

    • True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.

    • False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on. Custom security groups are required only for those layers that need custom settings.

    For more information, see Create a New Stack.

  • agent_version(impl ::std::convert::Into<String>) / set_agent_version(Option<String>):

    The default AWS OpsWorks Stacks agent version. You have the following options:

    • Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks automatically installs new agent versions on the stack’s instances as soon as they are available.

    • Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack’s instances.

    The default setting is LATEST. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

    You can also specify an agent version when you create or update an instance, which overrides the stack’s default setting.

• On success, responds with UpdateStackOutput
• On failure, responds with SdkError<UpdateStackError>

impl Client

pub fn update_user_profile(&self) -> UpdateUserProfileFluentBuilder

Constructs a fluent builder for the UpdateUserProfile operation.

• The fluent builder is configurable:
  • iam_user_arn(impl ::std::convert::Into<String>) / set_iam_user_arn(Option<String>):

    The user IAM ARN. This can also be a federated user’s ARN.

  • ssh_username(impl ::std::convert::Into<String>) / set_ssh_username(Option<String>):

    The user’s SSH user name. The allowable characters are [a-z], [A-Z], [0-9], ‘-’, and ‘_’. If the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM user name.

  • ssh_public_key(impl ::std::convert::Into<String>) / set_ssh_public_key(Option<String>):

    The user’s new SSH public key.

  • allow_self_management(bool) / set_allow_self_management(Option<bool>):

    Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.

• On success, responds with UpdateUserProfileOutput
• On failure, responds with SdkError<UpdateUserProfileError>

impl Client

pub fn update_volume(&self) -> UpdateVolumeFluentBuilder

Constructs a fluent builder for the UpdateVolume operation.

• The fluent builder is configurable:
  • volume_id(impl ::std::convert::Into<String>) / set_volume_id(Option<String>):

    The volume ID.

  • name(impl ::std::convert::Into<String>) / set_name(Option<String>):

    The new name.

  • mount_point(impl ::std::convert::Into<String>) / set_mount_point(Option<String>):

    The new mount point.

• On success, responds with UpdateVolumeOutput
• On failure, responds with SdkError<UpdateVolumeError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

• This method will panic if the conf is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.