com.amazonaws.services.resiliencehub.model

Class PutDraftAppVersionTemplateRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.resiliencehub.model.PutDraftAppVersionTemplateRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutDraftAppVersionTemplateRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutDraftAppVersionTemplateRequest()

Method Summary

Modifier and Type	Method and Description
PutDraftAppVersionTemplateRequest	clone()
boolean	equals(Object obj)
String	getAppArn() The Amazon Resource Name (ARN) of the AWS Resilience Hub application.
String	getAppTemplateBody() A JSON string that provides information about your application structure.
int	hashCode()
void	setAppArn(String appArn) The Amazon Resource Name (ARN) of the AWS Resilience Hub application.
void	setAppTemplateBody(String appTemplateBody) A JSON string that provides information about your application structure.
String	toString() Returns a string representation of this object.
PutDraftAppVersionTemplateRequest	withAppArn(String appArn) The Amazon Resource Name (ARN) of the AWS Resilience Hub application.
PutDraftAppVersionTemplateRequest	withAppTemplateBody(String appTemplateBody) A JSON string that provides information about your application structure.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutDraftAppVersionTemplateRequest

public PutDraftAppVersionTemplateRequest()

Method Detail

setAppArn

public void setAppArn(String appArn)

The Amazon Resource Name (ARN) of the AWS 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 AWS General Reference guide.

Parameters:

appArn - The Amazon Resource Name (ARN) of the AWS 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 AWS General Reference guide.

getAppArn

public String getAppArn()

The Amazon Resource Name (ARN) of the AWS 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 AWS General Reference guide.

Returns:

The Amazon Resource Name (ARN) of the AWS 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 AWS General Reference guide.

withAppArn

public PutDraftAppVersionTemplateRequest withAppArn(String appArn)

The Amazon Resource Name (ARN) of the AWS 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 AWS General Reference guide.

Parameters:

appArn - The Amazon Resource Name (ARN) of the AWS 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 AWS General Reference guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAppTemplateBody

public void setAppTemplateBody(String appTemplateBody)

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 needs to 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

    The logical identifier of the resource.

    Type: Object

    Each logicalResourceId object includes the following fields:

    • identifier

      The 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

  • type

    The type of resource.

    Type: string

  • name

    The name of the resource.

    Type: String

  • additionalInfo

    Additional configuration parameters for an AWS Resilience Hub application.

    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

  The list of Application Components that this resource belongs to. If an Application Component is not part of the AWS Resilience Hub application, it will be added.

  Type: Array

  Each appComponents array item includes the following fields:

  • name

    The name of the Application Component.

    Type: String

  • type

    The 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 AWS Resilience Hub application.

    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

    The logical identifier of the resource.

    Type: Object

    You can configure only one of the following fields:

    • logicalStackName

    • resourceGroupName

    • terraformSourceName

    Each logicalResourceIds object includes the following fields:

    • identifier

      The 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

• version

  The AWS Resilience Hub application version.

• additionalInfo

  Additional configuration parameters for an AWS Resilience Hub application.

  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>"}]}]"

Parameters:

appTemplateBody - 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 needs to 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

    The logical identifier of the resource.

    Type: Object

    Each logicalResourceId object includes the following fields:

    • identifier

      The 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

  • type

    The type of resource.

    Type: string

  • name

    The name of the resource.

    Type: String

  • additionalInfo

    Additional configuration parameters for an AWS Resilience Hub application.

    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

  The list of Application Components that this resource belongs to. If an Application Component is not part of the AWS Resilience Hub application, it will be added.

  Type: Array

  Each appComponents array item includes the following fields:

  • name

    The name of the Application Component.

    Type: String

  • type

    The 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 AWS Resilience Hub application.

    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

    The logical identifier of the resource.

    Type: Object

    You can configure only one of the following fields:

    • logicalStackName

    • resourceGroupName

    • terraformSourceName

    Each logicalResourceIds object includes the following fields:

    • identifier

      The 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

• version

  The AWS Resilience Hub application version.

• additionalInfo

  Additional configuration parameters for an AWS Resilience Hub application.

  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>"}]}]"

getAppTemplateBody

public String getAppTemplateBody()

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 needs to 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

    The logical identifier of the resource.

    Type: Object

    Each logicalResourceId object includes the following fields:

    • identifier

      The 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

  • type

    The type of resource.

    Type: string

  • name

    The name of the resource.

    Type: String

  • additionalInfo

    Additional configuration parameters for an AWS Resilience Hub application.

    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

  The list of Application Components that this resource belongs to. If an Application Component is not part of the AWS Resilience Hub application, it will be added.

  Type: Array

  Each appComponents array item includes the following fields:

  • name

    The name of the Application Component.

    Type: String

  • type

    The 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 AWS Resilience Hub application.

    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

    The logical identifier of the resource.

    Type: Object

    You can configure only one of the following fields:

    • logicalStackName

    • resourceGroupName

    • terraformSourceName

    Each logicalResourceIds object includes the following fields:

    • identifier

      The 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

• version

  The AWS Resilience Hub application version.

• additionalInfo

  Additional configuration parameters for an AWS Resilience Hub application.

  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>"}]}]"

Returns:

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 needs to 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

    The logical identifier of the resource.

    Type: Object

    Each logicalResourceId object includes the following fields:

    • identifier

      The 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

  • type

    The type of resource.

    Type: string

  • name

    The name of the resource.

    Type: String

  • additionalInfo

    Additional configuration parameters for an AWS Resilience Hub application.

    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

  The list of Application Components that this resource belongs to. If an Application Component is not part of the AWS Resilience Hub application, it will be added.

  Type: Array

  Each appComponents array item includes the following fields:

  • name

    The name of the Application Component.

    Type: String

  • type

    The 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 AWS Resilience Hub application.

    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

    The logical identifier of the resource.

    Type: Object

    You can configure only one of the following fields:

    • logicalStackName

    • resourceGroupName

    • terraformSourceName

    Each logicalResourceIds object includes the following fields:

    • identifier

      The 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

• version

  The AWS Resilience Hub application version.

• additionalInfo

  Additional configuration parameters for an AWS Resilience Hub application.

  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>"}]}]"

withAppTemplateBody

public PutDraftAppVersionTemplateRequest withAppTemplateBody(String appTemplateBody)

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 needs to 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

    The logical identifier of the resource.

    Type: Object

    Each logicalResourceId object includes the following fields:

    • identifier

      The 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

  • type

    The type of resource.

    Type: string

  • name

    The name of the resource.

    Type: String

  • additionalInfo

    Additional configuration parameters for an AWS Resilience Hub application.

    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

  The list of Application Components that this resource belongs to. If an Application Component is not part of the AWS Resilience Hub application, it will be added.

  Type: Array

  Each appComponents array item includes the following fields:

  • name

    The name of the Application Component.

    Type: String

  • type

    The 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 AWS Resilience Hub application.

    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

    The logical identifier of the resource.

    Type: Object

    You can configure only one of the following fields:

    • logicalStackName

    • resourceGroupName

    • terraformSourceName

    Each logicalResourceIds object includes the following fields:

    • identifier

      The 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

• version

  The AWS Resilience Hub application version.

• additionalInfo

  Additional configuration parameters for an AWS Resilience Hub application.

  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>"}]}]"

Parameters:

appTemplateBody - 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 needs to 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

    The logical identifier of the resource.

    Type: Object

    Each logicalResourceId object includes the following fields:

    • identifier

      The 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

  • type

    The type of resource.

    Type: string

  • name

    The name of the resource.

    Type: String

  • additionalInfo

    Additional configuration parameters for an AWS Resilience Hub application.

    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

  The list of Application Components that this resource belongs to. If an Application Component is not part of the AWS Resilience Hub application, it will be added.

  Type: Array

  Each appComponents array item includes the following fields:

  • name

    The name of the Application Component.

    Type: String

  • type

    The 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 AWS Resilience Hub application.

    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

    The logical identifier of the resource.

    Type: Object

    You can configure only one of the following fields:

    • logicalStackName

    • resourceGroupName

    • terraformSourceName

    Each logicalResourceIds object includes the following fields:

    • identifier

      The 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

• version

  The AWS Resilience Hub application version.

• additionalInfo

  Additional configuration parameters for an AWS Resilience Hub application.

  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>"}]}]"

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public PutDraftAppVersionTemplateRequest clone()

Overrides:

clone in class AmazonWebServiceRequest