Package software.amazon.awscdk.services.fis

Class CfnTargetAccountConfiguration

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.fis.CfnTargetAccountConfiguration

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-24T02:42:38.544Z")
@Stability(Stable)
public class CfnTargetAccountConfiguration
extends CfnResource
implements IInspectable

Creates a target account configuration for the experiment template.

A target account configuration is required when accountTargeting of experimentOptions is set to multi-account . For more information, see experiment options in the AWS Fault Injection Service User Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.fis.*;
 CfnTargetAccountConfiguration cfnTargetAccountConfiguration = CfnTargetAccountConfiguration.Builder.create(this, "MyCfnTargetAccountConfiguration")
         .accountId("accountId")
         .experimentTemplateId("experimentTemplateId")
         .roleArn("roleArn")
         // the properties below are optional
         .description("description")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fis-targetaccountconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnTargetAccountConfiguration.Builder	A fluent builder for CfnTargetAccountConfiguration.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnTargetAccountConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTargetAccountConfiguration(software.amazon.jsii.JsiiObjectRef objRef)
	CfnTargetAccountConfiguration(software.constructs.Construct scope, String id, CfnTargetAccountConfigurationProps props)

Method Summary

Modifier and Type	Method	Description
String	getAccountId()	The AWS account ID of the target account.
protected Map<String,Object>	getCfnProperties()
String	getDescription()	The description of the target account.
String	getExperimentTemplateId()	The ID of the experiment template.
String	getRoleArn()	The Amazon Resource Name (ARN) of an IAM role for the target account.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccountId(String value)	The AWS account ID of the target account.
void	setDescription(String value)	The description of the target account.
void	setExperimentTemplateId(String value)	The ID of the experiment template.
void	setRoleArn(String value)	The Amazon Resource Name (ARN) of an IAM role for the target account.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnTargetAccountConfiguration

protected CfnTargetAccountConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

CfnTargetAccountConfiguration

protected CfnTargetAccountConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnTargetAccountConfiguration

@Stability(Stable)
public CfnTargetAccountConfiguration(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnTargetAccountConfigurationProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAccountId

@Stability(Stable)
@NotNull
public String getAccountId()

The AWS account ID of the target account.

setAccountId

@Stability(Stable)
public void setAccountId(@NotNull
 String value)

The AWS account ID of the target account.

getExperimentTemplateId

@Stability(Stable)
@NotNull
public String getExperimentTemplateId()

The ID of the experiment template.

setExperimentTemplateId

@Stability(Stable)
public void setExperimentTemplateId(@NotNull
 String value)

The ID of the experiment template.

getRoleArn

@Stability(Stable)
@NotNull
public String getRoleArn()

The Amazon Resource Name (ARN) of an IAM role for the target account.

setRoleArn

@Stability(Stable)
public void setRoleArn(@NotNull
 String value)

The Amazon Resource Name (ARN) of an IAM role for the target account.

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

The description of the target account.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

The description of the target account.