CfnEnvironmentAccountConnectionProps Struct
Properties for defining a CfnEnvironmentAccountConnection.
| Source | |
|---|---|
| Type last changed |
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_proton as proton } from 'aws-cdk-lib';
const cfnEnvironmentAccountConnectionProps: proton.CfnEnvironmentAccountConnectionProps = {
codebuildRoleArn: 'codebuildRoleArn',
componentRoleArn: 'componentRoleArn',
environmentAccountId: 'environmentAccountId',
environmentName: 'environmentName',
managementAccountId: 'managementAccountId',
roleArn: 'roleArn',
tags: [{
key: 'key',
value: 'value',
}],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_proton as proton
cfn_environment_account_connection_props = proton.CfnEnvironmentAccountConnectionProps(
codebuild_role_arn="codebuildRoleArn",
component_role_arn="componentRoleArn",
environment_account_id="environmentAccountId",
environment_name="environmentName",
management_account_id="managementAccountId",
role_arn="roleArn",
tags=[CfnTag(
key="key",
value="value"
)]
)
java
// 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.*;
CfnEnvironmentAccountConnectionProps cfnEnvironmentAccountConnectionProps = CfnEnvironmentAccountConnectionProps.builder()
.codebuildRoleArn("codebuildRoleArn")
.componentRoleArn("componentRoleArn")
.environmentAccountId("environmentAccountId")
.environmentName("environmentName")
.managementAccountId("managementAccountId")
.roleArn("roleArn")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Proton;
var cfnEnvironmentAccountConnectionProps = new CfnEnvironmentAccountConnectionProps {
CodebuildRoleArn = "codebuildRoleArn",
ComponentRoleArn = "componentRoleArn",
EnvironmentAccountId = "environmentAccountId",
EnvironmentName = "environmentName",
ManagementAccountId = "managementAccountId",
RoleArn = "roleArn",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnEnvironmentAccountConnectionProps := &CfnEnvironmentAccountConnectionProps{
CodebuildRoleArn: jsii.String("codebuildRoleArn"),
ComponentRoleArn: jsii.String("componentRoleArn"),
EnvironmentAccountId: jsii.String("environmentAccountId"),
EnvironmentName: jsii.String("environmentName"),
ManagementAccountId: jsii.String("managementAccountId"),
RoleArn: jsii.String("roleArn"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
Properties
codebuildRoleArnoptionalstringcodebuild_role_arnoptionalstrcodebuildRoleArnoptionalStringCodebuildRoleArnoptionalstringCodebuildRoleArnoptional*string #The Amazon Resource Name (ARN) of an IAM service role in the environment account.
AWS Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.
componentRoleArnoptionalstringcomponent_role_arnoptionalstrcomponentRoleArnoptionalStringComponentRoleArnoptionalstringComponentRoleArnoptional*string #The Amazon Resource Name (ARN) of the IAM service role that AWS Proton uses when provisioning directly defined components in the associated environment account.
notes
It determines the scope of infrastructure that a component can provision in the account.
The environment account connection must have a componentRoleArn to allow directly defined components to be associated with any environments running in the account.
For more information about components, see AWS Proton components in the AWS Proton User Guide .
environmentAccountIdoptionalstringenvironment_account_idoptionalstrenvironmentAccountIdoptionalStringEnvironmentAccountIdoptionalstringEnvironmentAccountIdoptional*string #The environment account that's connected to the environment account connection.
environmentNameoptionalstringenvironment_nameoptionalstrenvironmentNameoptionalStringEnvironmentNameoptionalstringEnvironmentNameoptional*string #The name of the environment that's associated with the environment account connection.
managementAccountIdoptionalstringmanagement_account_idoptionalstrmanagementAccountIdoptionalStringManagementAccountIdoptionalstringManagementAccountIdoptional*string #The ID of the management account that's connected to the environment account connection.
roleArnoptionalstringrole_arnoptionalstrroleArnoptionalStringRoleArnoptionalstringRoleArnoptional*string #The IAM service role that's associated with the environment account connection.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #An optional list of metadata items that you can associate with the AWS Proton environment account connection.
A tag is a key-value pair.
For more information, see AWS Proton resources and tagging in the AWS Proton User Guide .