Package software.amazon.awscdk.services.proton

Class CfnEnvironmentAccountConnection

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.proton.CfnEnvironmentAccountConnection

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-05T03:43:47.059Z")
@Stability(Stable)
public class CfnEnvironmentAccountConnection
extends CfnResource
implements IInspectable, ITaggable

Detailed data of an AWS Proton environment account connection resource.

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.proton.*;
 CfnEnvironmentAccountConnection cfnEnvironmentAccountConnection = CfnEnvironmentAccountConnection.Builder.create(this, "MyCfnEnvironmentAccountConnection")
         .codebuildRoleArn("codebuildRoleArn")
         .componentRoleArn("componentRoleArn")
         .environmentAccountId("environmentAccountId")
         .environmentName("environmentName")
         .managementAccountId("managementAccountId")
         .roleArn("roleArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-proton-environmentaccountconnection.html

Nested Class Summary

Nested Classes

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

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

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

ITaggable.Jsii$Default, ITaggable.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	CfnEnvironmentAccountConnection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEnvironmentAccountConnection(software.amazon.jsii.JsiiObjectRef objRef)
	CfnEnvironmentAccountConnection(software.constructs.Construct scope, String id)
	CfnEnvironmentAccountConnection(software.constructs.Construct scope, String id, CfnEnvironmentAccountConnectionProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	Returns the environment account connection ARN.
String	getAttrId()	Returns the environment account connection ID.
String	getAttrStatus()	Returns the environment account connection status.
protected Map<String,Object>	getCfnProperties()
String	getCodebuildRoleArn()	The Amazon Resource Name (ARN) of an IAM service role in the environment account.
String	getComponentRoleArn()	The Amazon Resource Name (ARN) of the IAM service role that AWS Proton uses when provisioning directly defined components in the associated environment account.
String	getEnvironmentAccountId()	The environment account that's connected to the environment account connection.
String	getEnvironmentName()	The name of the environment that's associated with the environment account connection.
String	getManagementAccountId()	The ID of the management account that's connected to the environment account connection.
String	getRoleArn()	The IAM service role that's associated with the environment account connection.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	An optional list of metadata items that you can associate with the AWS Proton environment account connection.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCodebuildRoleArn(String value)	The Amazon Resource Name (ARN) of an IAM service role in the environment account.
void	setComponentRoleArn(String value)	The Amazon Resource Name (ARN) of the IAM service role that AWS Proton uses when provisioning directly defined components in the associated environment account.
void	setEnvironmentAccountId(String value)	The environment account that's connected to the environment account connection.
void	setEnvironmentName(String value)	The name of the environment that's associated with the environment account connection.
void	setManagementAccountId(String value)	The ID of the management account that's connected to the environment account connection.
void	setRoleArn(String value)	The IAM service role that's associated with the environment account connection.
void	setTagsRaw(List<CfnTag> value)	An optional list of metadata items that you can associate with the AWS Proton environment account connection.

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

CfnEnvironmentAccountConnection

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

CfnEnvironmentAccountConnection

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

CfnEnvironmentAccountConnection

@Stability(Stable)
public CfnEnvironmentAccountConnection(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnEnvironmentAccountConnectionProps 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.

CfnEnvironmentAccountConnection

@Stability(Stable)
public CfnEnvironmentAccountConnection(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

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.

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.

getAttrArn

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

Returns the environment account connection ARN.

getAttrId

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

Returns the environment account connection ID.

getAttrStatus

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

Returns the environment account connection status.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getCodebuildRoleArn

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

The Amazon Resource Name (ARN) of an IAM service role in the environment account.

setCodebuildRoleArn

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

The Amazon Resource Name (ARN) of an IAM service role in the environment account.

getComponentRoleArn

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

The Amazon Resource Name (ARN) of the IAM service role that AWS Proton uses when provisioning directly defined components in the associated environment account.

setComponentRoleArn

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

The Amazon Resource Name (ARN) of the IAM service role that AWS Proton uses when provisioning directly defined components in the associated environment account.

getEnvironmentAccountId

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

The environment account that's connected to the environment account connection.

setEnvironmentAccountId

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

The environment account that's connected to the environment account connection.

getEnvironmentName

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

The name of the environment that's associated with the environment account connection.

setEnvironmentName

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

The name of the environment that's associated with the environment account connection.

getManagementAccountId

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

The ID of the management account that's connected to the environment account connection.

setManagementAccountId

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

The ID of the management account that's connected to the environment account connection.

getRoleArn

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

The IAM service role that's associated with the environment account connection.

setRoleArn

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

The IAM service role that's associated with the environment account connection.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

An optional list of metadata items that you can associate with the AWS Proton environment account connection.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

An optional list of metadata items that you can associate with the AWS Proton environment account connection.