Struct aws_sdk_resiliencehub::operation::describe_app_version_template::DescribeAppVersionTemplateOutput
source · #[non_exhaustive]pub struct DescribeAppVersionTemplateOutput {
pub app_arn: String,
pub app_version: String,
pub app_template_body: String,
/* private fields */
}
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.app_arn: String
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.
app_version: String
The version of the application.
app_template_body: String
A JSON string that provides information about your application structure. To learn more about the appTemplateBody
template, see the sample template provided in the Examples section.
The appTemplateBody
JSON string has the following structure:
-
resources
The list of logical resources that must be included in the Resilience Hub application.
Type: Array
Don't add the resources that you want to exclude.
Each
resources
array item includes the following fields:-
logicalResourceId
Logical identifier of the resource.
Type: Object
Each
logicalResourceId
object includes the following fields:-
identifier
Identifier of the resource.
Type: String
-
logicalStackName
The name of the CloudFormation stack this resource belongs to.
Type: String
-
resourceGroupName
The name of the resource group this resource belongs to.
Type: String
-
terraformSourceName
The name of the Terraform S3 state file this resource belongs to.
Type: String
-
eksSourceName
Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in "eks-cluster/namespace" format.
Type: String
-
-
type
The type of resource.
Type: string
-
name
The name of the resource.
Type: String
-
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement
additionalInfo
through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key:
"failover-regions"
Value:
"[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
-
-
appComponents
List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.
Type: Array
Each
appComponents
array item includes the following fields:-
name
Name of the Application Component.
Type: String
-
type
Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.
Type: String
-
resourceNames
The list of included resources that are assigned to the Application Component.
Type: Array of strings
-
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement
additionalInfo
through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key:
"failover-regions"
Value:
"[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
-
-
excludedResources
The list of logical resource identifiers to be excluded from the application.
Type: Array
Don't add the resources that you want to include.
Each
excludedResources
array item includes the following fields:-
logicalResourceIds
Logical identifier of the resource.
Type: Object
You can configure only one of the following fields:
-
logicalStackName
-
resourceGroupName
-
terraformSourceName
-
eksSourceName
Each
logicalResourceIds
object includes the following fields:-
identifier
Identifier of the resource.
Type: String
-
logicalStackName
The name of the CloudFormation stack this resource belongs to.
Type: String
-
resourceGroupName
The name of the resource group this resource belongs to.
Type: String
-
terraformSourceName
The name of the Terraform S3 state file this resource belongs to.
Type: String
-
eksSourceName
Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in "eks-cluster/namespace" format.
Type: String
-
-
-
version
Resilience Hub application version.
-
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement
additionalInfo
through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key:
"failover-regions"
Value:
"[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
Implementations§
source§impl DescribeAppVersionTemplateOutput
impl DescribeAppVersionTemplateOutput
sourcepub fn app_arn(&self) -> &str
pub fn app_arn(&self) -> &str
Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition
:resiliencehub:region
:account
:app/app-id
. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.
sourcepub fn app_version(&self) -> &str
pub fn app_version(&self) -> &str
The version of the application.
sourcepub fn app_template_body(&self) -> &str
pub fn app_template_body(&self) -> &str
A JSON string that provides information about your application structure. To learn more about the appTemplateBody
template, see the sample template provided in the Examples section.
The appTemplateBody
JSON string has the following structure:
-
resources
The list of logical resources that must be included in the Resilience Hub application.
Type: Array
Don't add the resources that you want to exclude.
Each
resources
array item includes the following fields:-
logicalResourceId
Logical identifier of the resource.
Type: Object
Each
logicalResourceId
object includes the following fields:-
identifier
Identifier of the resource.
Type: String
-
logicalStackName
The name of the CloudFormation stack this resource belongs to.
Type: String
-
resourceGroupName
The name of the resource group this resource belongs to.
Type: String
-
terraformSourceName
The name of the Terraform S3 state file this resource belongs to.
Type: String
-
eksSourceName
Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in "eks-cluster/namespace" format.
Type: String
-
-
type
The type of resource.
Type: string
-
name
The name of the resource.
Type: String
-
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement
additionalInfo
through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key:
"failover-regions"
Value:
"[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
-
-
appComponents
List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.
Type: Array
Each
appComponents
array item includes the following fields:-
name
Name of the Application Component.
Type: String
-
type
Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.
Type: String
-
resourceNames
The list of included resources that are assigned to the Application Component.
Type: Array of strings
-
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement
additionalInfo
through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key:
"failover-regions"
Value:
"[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
-
-
excludedResources
The list of logical resource identifiers to be excluded from the application.
Type: Array
Don't add the resources that you want to include.
Each
excludedResources
array item includes the following fields:-
logicalResourceIds
Logical identifier of the resource.
Type: Object
You can configure only one of the following fields:
-
logicalStackName
-
resourceGroupName
-
terraformSourceName
-
eksSourceName
Each
logicalResourceIds
object includes the following fields:-
identifier
Identifier of the resource.
Type: String
-
logicalStackName
The name of the CloudFormation stack this resource belongs to.
Type: String
-
resourceGroupName
The name of the resource group this resource belongs to.
Type: String
-
terraformSourceName
The name of the Terraform S3 state file this resource belongs to.
Type: String
-
eksSourceName
Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.
This parameter accepts values in "eks-cluster/namespace" format.
Type: String
-
-
-
version
Resilience Hub application version.
-
additionalInfo
Additional configuration parameters for an Resilience Hub application. If you want to implement
additionalInfo
through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.
Key:
"failover-regions"
Value:
"[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"
source§impl DescribeAppVersionTemplateOutput
impl DescribeAppVersionTemplateOutput
sourcepub fn builder() -> DescribeAppVersionTemplateOutputBuilder
pub fn builder() -> DescribeAppVersionTemplateOutputBuilder
Creates a new builder-style object to manufacture DescribeAppVersionTemplateOutput
.
Trait Implementations§
source§impl Clone for DescribeAppVersionTemplateOutput
impl Clone for DescribeAppVersionTemplateOutput
source§fn clone(&self) -> DescribeAppVersionTemplateOutput
fn clone(&self) -> DescribeAppVersionTemplateOutput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl PartialEq for DescribeAppVersionTemplateOutput
impl PartialEq for DescribeAppVersionTemplateOutput
source§fn eq(&self, other: &DescribeAppVersionTemplateOutput) -> bool
fn eq(&self, other: &DescribeAppVersionTemplateOutput) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl RequestId for DescribeAppVersionTemplateOutput
impl RequestId for DescribeAppVersionTemplateOutput
source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.impl StructuralPartialEq for DescribeAppVersionTemplateOutput
Auto Trait Implementations§
impl Freeze for DescribeAppVersionTemplateOutput
impl RefUnwindSafe for DescribeAppVersionTemplateOutput
impl Send for DescribeAppVersionTemplateOutput
impl Sync for DescribeAppVersionTemplateOutput
impl Unpin for DescribeAppVersionTemplateOutput
impl UnwindSafe for DescribeAppVersionTemplateOutput
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