Struct aws_sdk_opsworks::operation::create_stack::CreateStackInput
source · #[non_exhaustive]pub struct CreateStackInput {Show 19 fields
pub name: Option<String>,
pub region: Option<String>,
pub vpc_id: Option<String>,
pub attributes: Option<HashMap<StackAttributesKeys, String>>,
pub service_role_arn: Option<String>,
pub default_instance_profile_arn: Option<String>,
pub default_os: Option<String>,
pub hostname_theme: Option<String>,
pub default_availability_zone: Option<String>,
pub default_subnet_id: Option<String>,
pub custom_json: Option<String>,
pub configuration_manager: Option<StackConfigurationManager>,
pub chef_configuration: Option<ChefConfiguration>,
pub use_custom_cookbooks: Option<bool>,
pub use_opsworks_security_groups: Option<bool>,
pub custom_cookbooks_source: Option<Source>,
pub default_ssh_key_name: Option<String>,
pub default_root_device_type: Option<RootDeviceType>,
pub agent_version: Option<String>,
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.name: Option<String>
The stack name.
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: 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: Option<HashMap<StackAttributesKeys, String>>
One or more user-defined key-value pairs to be added to the stack attributes.
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: 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: 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
, 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
-
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
, 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, 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: 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: 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: 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: 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: 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: 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: Option<bool>
Whether the stack uses custom cookbooks.
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: 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: 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: 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: 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.
Implementations§
source§impl CreateStackInput
impl CreateStackInput
sourcepub fn region(&self) -> Option<&str>
pub fn region(&self) -> Option<&str>
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.
sourcepub fn vpc_id(&self) -> Option<&str>
pub fn vpc_id(&self) -> Option<&str>
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.
sourcepub fn attributes(&self) -> Option<&HashMap<StackAttributesKeys, String>>
pub fn attributes(&self) -> Option<&HashMap<StackAttributesKeys, String>>
One or more user-defined key-value pairs to be added to the stack attributes.
sourcepub fn service_role_arn(&self) -> Option<&str>
pub fn service_role_arn(&self) -> Option<&str>
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.
sourcepub fn default_instance_profile_arn(&self) -> Option<&str>
pub fn default_instance_profile_arn(&self) -> Option<&str>
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) -> Option<&str>
pub fn default_os(&self) -> Option<&str>
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
, 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
-
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
, 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, 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.
sourcepub fn hostname_theme(&self) -> Option<&str>
pub fn hostname_theme(&self) -> Option<&str>
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.
sourcepub fn default_availability_zone(&self) -> Option<&str>
pub fn default_availability_zone(&self) -> Option<&str>
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.
sourcepub fn default_subnet_id(&self) -> Option<&str>
pub fn default_subnet_id(&self) -> Option<&str>
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) -> Option<&str>
pub fn custom_json(&self) -> Option<&str>
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.
sourcepub fn configuration_manager(&self) -> Option<&StackConfigurationManager>
pub fn configuration_manager(&self) -> 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.
sourcepub fn chef_configuration(&self) -> Option<&ChefConfiguration>
pub fn chef_configuration(&self) -> 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.
sourcepub fn use_custom_cookbooks(&self) -> Option<bool>
pub fn use_custom_cookbooks(&self) -> Option<bool>
Whether the stack uses custom cookbooks.
sourcepub fn use_opsworks_security_groups(&self) -> Option<bool>
pub fn use_opsworks_security_groups(&self) -> 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.
sourcepub fn custom_cookbooks_source(&self) -> Option<&Source>
pub fn custom_cookbooks_source(&self) -> 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.
sourcepub fn default_ssh_key_name(&self) -> Option<&str>
pub fn default_ssh_key_name(&self) -> Option<&str>
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 default_root_device_type(&self) -> Option<&RootDeviceType>
pub fn default_root_device_type(&self) -> 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.
sourcepub fn agent_version(&self) -> Option<&str>
pub fn agent_version(&self) -> Option<&str>
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.
source§impl CreateStackInput
impl CreateStackInput
sourcepub fn builder() -> CreateStackInputBuilder
pub fn builder() -> CreateStackInputBuilder
Creates a new builder-style object to manufacture CreateStackInput
.
Trait Implementations§
source§impl Clone for CreateStackInput
impl Clone for CreateStackInput
source§fn clone(&self) -> CreateStackInput
fn clone(&self) -> CreateStackInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for CreateStackInput
impl Debug for CreateStackInput
source§impl PartialEq for CreateStackInput
impl PartialEq for CreateStackInput
source§fn eq(&self, other: &CreateStackInput) -> bool
fn eq(&self, other: &CreateStackInput) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for CreateStackInput
Auto Trait Implementations§
impl Freeze for CreateStackInput
impl RefUnwindSafe for CreateStackInput
impl Send for CreateStackInput
impl Sync for CreateStackInput
impl Unpin for CreateStackInput
impl UnwindSafe for CreateStackInput
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more