Struct aws_sdk_opsworks::client::Client

source · [−]
pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }
Expand description

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.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_opsworks::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
    let shared_config = aws_config::load_from_env().await;
    let config = aws_sdk_opsworks::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_opsworks::Client::from_conf(config);

Implementations

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the AssignInstance operation.

Constructs a fluent builder for the AssignVolume operation.

Constructs a fluent builder for the AssociateElasticIp operation.

Constructs a fluent builder for the AttachElasticLoadBalancer operation.

Constructs a fluent builder for the CloneStack operation.

Constructs a fluent builder for the CreateApp operation.

Constructs a fluent builder for the CreateDeployment operation.

Constructs a fluent builder for the CreateInstance operation.

Constructs a fluent builder for the CreateLayer operation.

Constructs a fluent builder for the CreateStack operation.

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

      The stack name.

    • region(impl 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 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 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 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 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 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 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 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 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 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 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>

Constructs a fluent builder for the CreateUserProfile operation.

Constructs a fluent builder for the DeleteApp operation.

Constructs a fluent builder for the DeleteInstance operation.

Constructs a fluent builder for the DeleteLayer operation.

Constructs a fluent builder for the DeleteStack operation.

Constructs a fluent builder for the DeleteUserProfile operation.

Constructs a fluent builder for the DeregisterEcsCluster operation.

Constructs a fluent builder for the DeregisterElasticIp operation.

Constructs a fluent builder for the DeregisterInstance operation.

Constructs a fluent builder for the DeregisterRdsDbInstance operation.

Constructs a fluent builder for the DeregisterVolume operation.

Constructs a fluent builder for the DescribeAgentVersions operation.

Constructs a fluent builder for the DescribeApps operation.

Constructs a fluent builder for the DescribeCommands operation.

Constructs a fluent builder for the DescribeDeployments operation.

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

Constructs a fluent builder for the DescribeElasticIps operation.

Constructs a fluent builder for the DescribeElasticLoadBalancers operation.

Constructs a fluent builder for the DescribeInstances operation.

Constructs a fluent builder for the DescribeLayers operation.

Constructs a fluent builder for the DescribeLoadBasedAutoScaling operation.

Constructs a fluent builder for the DescribeMyUserProfile operation.

Constructs a fluent builder for the DescribeOperatingSystems operation.

Constructs a fluent builder for the DescribePermissions operation.

Constructs a fluent builder for the DescribeRaidArrays operation.

Constructs a fluent builder for the DescribeRdsDbInstances operation.

Constructs a fluent builder for the DescribeServiceErrors operation.

Constructs a fluent builder for the DescribeStackProvisioningParameters operation.

Constructs a fluent builder for the DescribeStacks operation.

Constructs a fluent builder for the DescribeStackSummary operation.

Constructs a fluent builder for the DescribeTimeBasedAutoScaling operation.

Constructs a fluent builder for the DescribeUserProfiles operation.

Constructs a fluent builder for the DescribeVolumes operation.

Constructs a fluent builder for the DetachElasticLoadBalancer operation.

Constructs a fluent builder for the DisassociateElasticIp operation.

Constructs a fluent builder for the GetHostnameSuggestion operation.

Constructs a fluent builder for the GrantAccess operation.

Constructs a fluent builder for the ListTags operation.

Constructs a fluent builder for the RebootInstance operation.

Constructs a fluent builder for the RegisterEcsCluster operation.

Constructs a fluent builder for the RegisterElasticIp operation.

Constructs a fluent builder for the RegisterInstance operation.

Constructs a fluent builder for the RegisterRdsDbInstance operation.

Constructs a fluent builder for the RegisterVolume operation.

Constructs a fluent builder for the SetLoadBasedAutoScaling operation.

Constructs a fluent builder for the SetPermission operation.

Constructs a fluent builder for the SetTimeBasedAutoScaling operation.

Constructs a fluent builder for the StartInstance operation.

Constructs a fluent builder for the StartStack operation.

Constructs a fluent builder for the StopInstance operation.

Constructs a fluent builder for the StopStack operation.

Constructs a fluent builder for the TagResource operation.

Constructs a fluent builder for the UnassignInstance operation.

Constructs a fluent builder for the UnassignVolume operation.

Constructs a fluent builder for the UntagResource operation.

Constructs a fluent builder for the UpdateApp operation.

Constructs a fluent builder for the UpdateElasticIp operation.

Constructs a fluent builder for the UpdateInstance operation.

  • The fluent builder is configurable:
    • instance_id(impl 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 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 Into<String>) / set_hostname(Option<String>):

      The instance host name.

    • os(impl 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 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 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 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>

Constructs a fluent builder for the UpdateLayer operation.

Constructs a fluent builder for the UpdateMyUserProfile operation.

Constructs a fluent builder for the UpdateRdsDbInstance operation.

Constructs a fluent builder for the UpdateStack operation.

Constructs a fluent builder for the UpdateUserProfile operation.

Constructs a fluent builder for the UpdateVolume operation.

Creates a client with the given service config and connector override.

Creates a new client from a shared config.

Creates a new client from the service Config.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Performs the conversion.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Performs the conversion.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more