Struct aws_sdk_opsworks::input::clone_stack_input::Builder
source · [−]#[non_exhaustive]pub struct Builder { /* private fields */ }
Expand description
A builder for CloneStackInput
Implementations
sourceimpl Builder
impl Builder
sourcepub fn source_stack_id(self, input: impl Into<String>) -> Self
pub fn source_stack_id(self, input: impl Into<String>) -> Self
The source stack ID.
sourcepub fn set_source_stack_id(self, input: Option<String>) -> Self
pub fn set_source_stack_id(self, input: Option<String>) -> Self
The source stack ID.
sourcepub fn region(self, input: impl Into<String>) -> Self
pub fn region(self, input: impl Into<String>) -> Self
The cloned stack AWS region, such as "ap-northeast-2". For more information about AWS regions, see Regions and Endpoints.
sourcepub fn set_region(self, input: Option<String>) -> Self
pub fn set_region(self, input: Option<String>) -> Self
The cloned stack AWS region, such as "ap-northeast-2". For more information about AWS regions, see Regions and Endpoints.
sourcepub fn vpc_id(self, input: impl Into<String>) -> Self
pub fn vpc_id(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_vpc_id(self, input: Option<String>) -> Self
pub fn set_vpc_id(self, input: Option<String>) -> Self
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.
sourcepub fn attributes(self, k: StackAttributesKeys, v: impl Into<String>) -> Self
pub fn attributes(self, k: StackAttributesKeys, v: impl Into<String>) -> Self
Adds a key-value pair to attributes
.
To override the contents of this collection use set_attributes
.
A list of stack attributes and values as key/value pairs to be added to the cloned stack.
sourcepub fn set_attributes(
self,
input: Option<HashMap<StackAttributesKeys, String>>
) -> Self
pub fn set_attributes(
self,
input: Option<HashMap<StackAttributesKeys, String>>
) -> Self
A list of stack attributes and values as key/value pairs to be added to the cloned stack.
sourcepub fn service_role_arn(self, input: impl Into<String>) -> Self
pub fn service_role_arn(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_service_role_arn(self, input: Option<String>) -> Self
pub fn set_service_role_arn(self, input: Option<String>) -> Self
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.
sourcepub fn default_instance_profile_arn(self, input: impl Into<String>) -> Self
pub fn default_instance_profile_arn(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_default_instance_profile_arn(self, input: Option<String>) -> Self
pub fn set_default_instance_profile_arn(self, input: Option<String>) -> Self
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.
sourcepub fn default_os(self, input: impl Into<String>) -> Self
pub fn default_os(self, input: impl Into<String>) -> Self
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
, orAmazon Linux 2015.03
. -
A supported Ubuntu operating system, such as
Ubuntu 16.04 LTS
,Ubuntu 14.04 LTS
, orUbuntu 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
, orMicrosoft 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.
sourcepub fn set_default_os(self, input: Option<String>) -> Self
pub fn set_default_os(self, input: Option<String>) -> Self
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
, orAmazon Linux 2015.03
. -
A supported Ubuntu operating system, such as
Ubuntu 16.04 LTS
,Ubuntu 14.04 LTS
, orUbuntu 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
, orMicrosoft 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.
sourcepub fn hostname_theme(self, input: impl Into<String>) -> Self
pub fn hostname_theme(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_hostname_theme(self, input: Option<String>) -> Self
pub fn set_hostname_theme(self, input: Option<String>) -> Self
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.
sourcepub fn default_availability_zone(self, input: impl Into<String>) -> Self
pub fn default_availability_zone(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_default_availability_zone(self, input: Option<String>) -> Self
pub fn set_default_availability_zone(self, input: Option<String>) -> Self
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.
sourcepub fn default_subnet_id(self, input: impl Into<String>) -> Self
pub fn default_subnet_id(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_default_subnet_id(self, input: Option<String>) -> Self
pub fn set_default_subnet_id(self, input: Option<String>) -> Self
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.
sourcepub fn custom_json(self, input: impl Into<String>) -> Self
pub fn custom_json(self, input: impl Into<String>) -> Self
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
sourcepub fn set_custom_json(self, input: Option<String>) -> Self
pub fn set_custom_json(self, input: Option<String>) -> Self
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
sourcepub fn configuration_manager(self, input: StackConfigurationManager) -> Self
pub fn configuration_manager(self, input: StackConfigurationManager) -> Self
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.
sourcepub fn set_configuration_manager(
self,
input: Option<StackConfigurationManager>
) -> Self
pub fn set_configuration_manager(
self,
input: Option<StackConfigurationManager>
) -> Self
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.
sourcepub fn chef_configuration(self, input: ChefConfiguration) -> Self
pub fn chef_configuration(self, input: ChefConfiguration) -> Self
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.
sourcepub fn set_chef_configuration(self, input: Option<ChefConfiguration>) -> Self
pub fn set_chef_configuration(self, input: Option<ChefConfiguration>) -> Self
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.
sourcepub fn use_custom_cookbooks(self, input: bool) -> Self
pub fn use_custom_cookbooks(self, input: bool) -> Self
Whether to use custom cookbooks.
sourcepub fn set_use_custom_cookbooks(self, input: Option<bool>) -> Self
pub fn set_use_custom_cookbooks(self, input: Option<bool>) -> Self
Whether to use custom cookbooks.
sourcepub fn use_opsworks_security_groups(self, input: bool) -> Self
pub fn use_opsworks_security_groups(self, input: bool) -> Self
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.
sourcepub fn set_use_opsworks_security_groups(self, input: Option<bool>) -> Self
pub fn set_use_opsworks_security_groups(self, input: Option<bool>) -> Self
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.
sourcepub fn custom_cookbooks_source(self, input: Source) -> Self
pub fn custom_cookbooks_source(self, input: Source) -> Self
Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.
sourcepub fn set_custom_cookbooks_source(self, input: Option<Source>) -> Self
pub fn set_custom_cookbooks_source(self, input: Option<Source>) -> Self
Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.
sourcepub fn default_ssh_key_name(self, input: impl Into<String>) -> Self
pub fn default_ssh_key_name(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_default_ssh_key_name(self, input: Option<String>) -> Self
pub fn set_default_ssh_key_name(self, input: Option<String>) -> Self
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.
sourcepub fn clone_permissions(self, input: bool) -> Self
pub fn clone_permissions(self, input: bool) -> Self
Whether to clone the source stack's permissions.
sourcepub fn set_clone_permissions(self, input: Option<bool>) -> Self
pub fn set_clone_permissions(self, input: Option<bool>) -> Self
Whether to clone the source stack's permissions.
sourcepub fn clone_app_ids(self, input: impl Into<String>) -> Self
pub fn clone_app_ids(self, input: impl Into<String>) -> Self
Appends an item to clone_app_ids
.
To override the contents of this collection use set_clone_app_ids
.
A list of source stack app IDs to be included in the cloned stack.
sourcepub fn set_clone_app_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_clone_app_ids(self, input: Option<Vec<String>>) -> Self
A list of source stack app IDs to be included in the cloned stack.
sourcepub fn default_root_device_type(self, input: RootDeviceType) -> Self
pub fn default_root_device_type(self, input: RootDeviceType) -> Self
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.
sourcepub fn set_default_root_device_type(self, input: Option<RootDeviceType>) -> Self
pub fn set_default_root_device_type(self, input: Option<RootDeviceType>) -> Self
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.
sourcepub fn agent_version(self, input: impl Into<String>) -> Self
pub fn agent_version(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_agent_version(self, input: Option<String>) -> Self
pub fn set_agent_version(self, input: Option<String>) -> Self
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.
sourcepub fn build(self) -> Result<CloneStackInput, BuildError>
pub fn build(self) -> Result<CloneStackInput, BuildError>
Consumes the builder and constructs a CloneStackInput
Trait Implementations
impl StructuralPartialEq for Builder
Auto Trait Implementations
impl RefUnwindSafe for Builder
impl Send for Builder
impl Sync for Builder
impl Unpin for Builder
impl UnwindSafe for Builder
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more