Class CfnEnvironmentAccountConnection
A CloudFormation AWS::Proton::EnvironmentAccountConnection
.
Inheritance
Inherited Members
Namespace: Amazon.CDK.AWS.Proton
Assembly: Amazon.CDK.AWS.Proton.dll
Syntax (csharp)
public class CfnEnvironmentAccountConnection : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnEnvironmentAccountConnection
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Detailed data of an AWS Proton environment account connection resource.
CloudformationResource: AWS::Proton::EnvironmentAccountConnection
ExampleMetadata: fixture=_generated
Examples
// 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 cfnEnvironmentAccountConnection = new CfnEnvironmentAccountConnection(this, "MyCfnEnvironmentAccountConnection", new CfnEnvironmentAccountConnectionProps {
CodebuildRoleArn = "codebuildRoleArn",
ComponentRoleArn = "componentRoleArn",
EnvironmentAccountId = "environmentAccountId",
EnvironmentName = "environmentName",
ManagementAccountId = "managementAccountId",
RoleArn = "roleArn",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnEnvironmentAccountConnection(Construct, String, ICfnEnvironmentAccountConnectionProps) | Create a new |
CfnEnvironmentAccountConnection(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnEnvironmentAccountConnection(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | Returns the environment account connection ARN. |
AttrId | Returns the environment account connection ID. |
AttrStatus | Returns the environment account connection status. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
CodebuildRoleArn | The Amazon Resource Name (ARN) of an IAM service role in the environment account. |
ComponentRoleArn | The Amazon Resource Name (ARN) of the IAM service role that AWS Proton uses when provisioning directly defined components in the associated environment account. |
EnvironmentAccountId | The environment account that's connected to the environment account connection. |
EnvironmentName | The name of the environment that's associated with the environment account connection. |
ManagementAccountId | The ID of the management account that's connected to the environment account connection. |
RoleArn | The IAM service role that's associated with the environment account connection. |
Tags | An optional list of metadata items that you can associate with the AWS Proton environment account connection. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnEnvironmentAccountConnection(Construct, String, ICfnEnvironmentAccountConnectionProps)
Create a new AWS::Proton::EnvironmentAccountConnection
.
public CfnEnvironmentAccountConnection(Construct scope, string id, ICfnEnvironmentAccountConnectionProps props = null)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnEnvironmentAccountConnectionProps
- resource properties.
CfnEnvironmentAccountConnection(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnEnvironmentAccountConnection(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnEnvironmentAccountConnection(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnEnvironmentAccountConnection(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
Returns the environment account connection ARN.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrId
Returns the environment account connection ID.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
AttrStatus
Returns the environment account connection status.
public virtual string AttrStatus { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Status
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
CodebuildRoleArn
The Amazon Resource Name (ARN) of an IAM service role in the environment account.
public virtual string CodebuildRoleArn { get; set; }
Property Value
System.String
Remarks
AWS Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.
ComponentRoleArn
The Amazon Resource Name (ARN) of the IAM service role that AWS Proton uses when provisioning directly defined components in the associated environment account.
public virtual string ComponentRoleArn { get; set; }
Property Value
System.String
Remarks
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 .
EnvironmentAccountId
The environment account that's connected to the environment account connection.
public virtual string EnvironmentAccountId { get; set; }
Property Value
System.String
Remarks
EnvironmentName
The name of the environment that's associated with the environment account connection.
public virtual string EnvironmentName { get; set; }
Property Value
System.String
Remarks
ManagementAccountId
The ID of the management account that's connected to the environment account connection.
public virtual string ManagementAccountId { get; set; }
Property Value
System.String
Remarks
RoleArn
The IAM service role that's associated with the environment account connection.
public virtual string RoleArn { get; set; }
Property Value
System.String
Remarks
Tags
An optional list of metadata items that you can associate with the AWS Proton environment account connection.
public virtual TagManager Tags { get; }
Property Value
Remarks
A tag is a key-value pair.
For more information, see AWS Proton resources and tagging in the AWS Proton User Guide .
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>