Struct aws_sdk_opsworks::model::DeploymentCommand
source · [−]#[non_exhaustive]pub struct DeploymentCommand {
pub name: Option<DeploymentCommandName>,
pub args: Option<HashMap<String, Vec<String>>>,
}
Expand description
Used to specify a stack or deployment command.
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<DeploymentCommandName>
Specifies the operation. You can specify only one command.
For stacks, the following commands are available:
-
execute_recipes
: Execute one or more recipes. To specify the recipes, set anArgs
parameter namedrecipes
to the list of recipes to be executed. For example, to executephpapp::appsetup
, setArgs
to{"recipes":["phpapp::appsetup"]}
. -
install_dependencies
: Install the stack's dependencies. -
update_custom_cookbooks
: Update the stack's custom cookbooks. -
update_dependencies
: Update the stack's dependencies.
The update_dependencies and install_dependencies commands are supported only for Linux instances. You can run the commands successfully on Windows instances, but they do nothing.
For apps, the following commands are available:
-
deploy
: Deploy an app. Ruby on Rails apps have an optionalArgs
parameter namedmigrate
. SetArgs
to {"migrate":["true"]} to migrate the database. The default setting is {"migrate":["false"]}. -
rollback
Roll the app back to the previous version. When you update an app, AWS OpsWorks Stacks stores the previous version, up to a maximum of five versions. You can use this command to roll an app back as many as four versions. -
start
: Start the app's web or application server. -
stop
: Stop the app's web or application server. -
restart
: Restart the app's web or application server. -
undeploy
: Undeploy the app.
args: Option<HashMap<String, Vec<String>>>
The arguments of those commands that take arguments. It should be set to a JSON object with the following format:
{"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1", "value2", ...], ...}
The update_dependencies
command takes two arguments:
-
upgrade_os_to
- Specifies the desired Amazon Linux version for instances whose OS you want to upgrade, such asAmazon Linux 2016.09
. You must also set theallow_reboot
argument to true. -
allow_reboot
- Specifies whether to allow AWS OpsWorks Stacks to reboot the instances if necessary, after installing the updates. This argument can be set to eithertrue
orfalse
. The default value isfalse
.
For example, to upgrade an instance to Amazon Linux 2016.09, set Args
to the following.
{ "upgrade_os_to":["Amazon Linux 2016.09"], "allow_reboot":["true"] }
Implementations
sourceimpl DeploymentCommand
impl DeploymentCommand
sourcepub fn name(&self) -> Option<&DeploymentCommandName>
pub fn name(&self) -> Option<&DeploymentCommandName>
Specifies the operation. You can specify only one command.
For stacks, the following commands are available:
-
execute_recipes
: Execute one or more recipes. To specify the recipes, set anArgs
parameter namedrecipes
to the list of recipes to be executed. For example, to executephpapp::appsetup
, setArgs
to{"recipes":["phpapp::appsetup"]}
. -
install_dependencies
: Install the stack's dependencies. -
update_custom_cookbooks
: Update the stack's custom cookbooks. -
update_dependencies
: Update the stack's dependencies.
The update_dependencies and install_dependencies commands are supported only for Linux instances. You can run the commands successfully on Windows instances, but they do nothing.
For apps, the following commands are available:
-
deploy
: Deploy an app. Ruby on Rails apps have an optionalArgs
parameter namedmigrate
. SetArgs
to {"migrate":["true"]} to migrate the database. The default setting is {"migrate":["false"]}. -
rollback
Roll the app back to the previous version. When you update an app, AWS OpsWorks Stacks stores the previous version, up to a maximum of five versions. You can use this command to roll an app back as many as four versions. -
start
: Start the app's web or application server. -
stop
: Stop the app's web or application server. -
restart
: Restart the app's web or application server. -
undeploy
: Undeploy the app.
sourcepub fn args(&self) -> Option<&HashMap<String, Vec<String>>>
pub fn args(&self) -> Option<&HashMap<String, Vec<String>>>
The arguments of those commands that take arguments. It should be set to a JSON object with the following format:
{"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1", "value2", ...], ...}
The update_dependencies
command takes two arguments:
-
upgrade_os_to
- Specifies the desired Amazon Linux version for instances whose OS you want to upgrade, such asAmazon Linux 2016.09
. You must also set theallow_reboot
argument to true. -
allow_reboot
- Specifies whether to allow AWS OpsWorks Stacks to reboot the instances if necessary, after installing the updates. This argument can be set to eithertrue
orfalse
. The default value isfalse
.
For example, to upgrade an instance to Amazon Linux 2016.09, set Args
to the following.
{ "upgrade_os_to":["Amazon Linux 2016.09"], "allow_reboot":["true"] }
sourceimpl DeploymentCommand
impl DeploymentCommand
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture DeploymentCommand
Trait Implementations
sourceimpl Clone for DeploymentCommand
impl Clone for DeploymentCommand
sourcefn clone(&self) -> DeploymentCommand
fn clone(&self) -> DeploymentCommand
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for DeploymentCommand
impl Debug for DeploymentCommand
sourceimpl PartialEq<DeploymentCommand> for DeploymentCommand
impl PartialEq<DeploymentCommand> for DeploymentCommand
sourcefn eq(&self, other: &DeploymentCommand) -> bool
fn eq(&self, other: &DeploymentCommand) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &DeploymentCommand) -> bool
fn ne(&self, other: &DeploymentCommand) -> bool
This method tests for !=
.
impl StructuralPartialEq for DeploymentCommand
Auto Trait Implementations
impl RefUnwindSafe for DeploymentCommand
impl Send for DeploymentCommand
impl Sync for DeploymentCommand
impl Unpin for DeploymentCommand
impl UnwindSafe for DeploymentCommand
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