Class CfnConnection

The AWS::CodeStarConnections::Connection resource can be used to connect external source providers with services like AWS CodePipeline .

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnConnection

Implements

IInspectable

IConnectionRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.CodeStarConnections

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnConnection : CfnResource, IInspectable, IConnectionRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnConnection Inherits CfnResource Implements IInspectable, IConnectionRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

Note: A connection created through CloudFormation is in PENDING status by default. You can make its status AVAILABLE by updating the connection in the console.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html

CloudformationResource: AWS::CodeStarConnections::Connection

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.CodeStarConnections;

             var cfnConnection = new CfnConnection(this, "MyCfnConnection", new CfnConnectionProps {
                 ConnectionName = "connectionName",

                 // the properties below are optional
                 HostArn = "hostArn",
                 ProviderType = "providerType",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnConnection(Construct, string, ICfnConnectionProps)

Create a new AWS::CodeStarConnections::Connection.

Properties

AttrConnectionArn	The Amazon Resource Name (ARN) of the connection.
AttrConnectionStatus	The current status of the connection.
AttrOwnerAccountId	The AWS account ID of the owner of the connection.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The AWS::CodeStarConnections::Connection resource can be used to connect external source providers with services like AWS CodePipeline .
ConnectionName	The name of the connection.
ConnectionRef	A reference to a Connection resource.
HostArn	The Amazon Resource Name (ARN) of the host associated with the connection.
ProviderType	The name of the external provider where your third-party code repository is configured.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	Specifies the tags applied to the resource.

Methods

ArnForConnection(IConnectionRef)	The AWS::CodeStarConnections::Connection resource can be used to connect external source providers with services like AWS CodePipeline .
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnConnection(object)	Checks whether the given object is a CfnConnection.
RenderProperties(IDictionary<string, object>)	The AWS::CodeStarConnections::Connection resource can be used to connect external source providers with services like AWS CodePipeline .

Constructors

CfnConnection(Construct, string, ICfnConnectionProps)

Create a new AWS::CodeStarConnections::Connection.

public CfnConnection(Construct scope, string id, ICfnConnectionProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnConnectionProps

Resource properties.

Remarks

Note: A connection created through CloudFormation is in PENDING status by default. You can make its status AVAILABLE by updating the connection in the console.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html

CloudformationResource: AWS::CodeStarConnections::Connection

ExampleMetadata: fixture=_generated

Properties

AttrConnectionArn

The Amazon Resource Name (ARN) of the connection.

public virtual string AttrConnectionArn { get; }

Property Value

string

Remarks

The ARN is used as the connection reference when the connection is shared between AWS services. For example: arn:aws:codestar-connections:us-west-2:123456789012:connection/39e4c34d-e13a-4e94-a886-ea67651bf042 .

CloudformationAttribute: ConnectionArn

AttrConnectionStatus

The current status of the connection.

public virtual string AttrConnectionStatus { get; }

Property Value

string

Remarks

For example: PENDING , AVAILABLE , or ERROR .

CloudformationAttribute: ConnectionStatus

AttrOwnerAccountId

The AWS account ID of the owner of the connection.

public virtual string AttrOwnerAccountId { get; }

Property Value

string

Remarks

For Bitbucket, this is the account ID of the owner of the Bitbucket repository. For example: 123456789012 .

CloudformationAttribute: OwnerAccountId

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

Note: A connection created through CloudFormation is in PENDING status by default. You can make its status AVAILABLE by updating the connection in the console.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html

CloudformationResource: AWS::CodeStarConnections::Connection

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::CodeStarConnections::Connection resource can be used to connect external source providers with services like AWS CodePipeline .

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

Note: A connection created through CloudFormation is in PENDING status by default. You can make its status AVAILABLE by updating the connection in the console.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html

CloudformationResource: AWS::CodeStarConnections::Connection

ExampleMetadata: fixture=_generated

ConnectionName

The name of the connection.

public virtual string ConnectionName { get; set; }

Property Value

string

Remarks

Note: A connection created through CloudFormation is in PENDING status by default. You can make its status AVAILABLE by updating the connection in the console.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html

CloudformationResource: AWS::CodeStarConnections::Connection

ExampleMetadata: fixture=_generated

ConnectionRef

A reference to a Connection resource.

public virtual IConnectionReference ConnectionRef { get; }

Property Value

IConnectionReference

Remarks

Note: A connection created through CloudFormation is in PENDING status by default. You can make its status AVAILABLE by updating the connection in the console.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html

CloudformationResource: AWS::CodeStarConnections::Connection

ExampleMetadata: fixture=_generated

HostArn

The Amazon Resource Name (ARN) of the host associated with the connection.

public virtual string? HostArn { get; set; }

Property Value

string

Remarks

Note: A connection created through CloudFormation is in PENDING status by default. You can make its status AVAILABLE by updating the connection in the console.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html

CloudformationResource: AWS::CodeStarConnections::Connection

ExampleMetadata: fixture=_generated

ProviderType

The name of the external provider where your third-party code repository is configured.

public virtual string? ProviderType { get; set; }

Property Value

string

Remarks

Note: A connection created through CloudFormation is in PENDING status by default. You can make its status AVAILABLE by updating the connection in the console.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html

CloudformationResource: AWS::CodeStarConnections::Connection

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

Note: A connection created through CloudFormation is in PENDING status by default. You can make its status AVAILABLE by updating the connection in the console.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html

CloudformationResource: AWS::CodeStarConnections::Connection

ExampleMetadata: fixture=_generated

TagsRaw

Specifies the tags applied to the resource.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

Note: A connection created through CloudFormation is in PENDING status by default. You can make its status AVAILABLE by updating the connection in the console.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html

CloudformationResource: AWS::CodeStarConnections::Connection

ExampleMetadata: fixture=_generated

Methods

ArnForConnection(IConnectionRef)

The AWS::CodeStarConnections::Connection resource can be used to connect external source providers with services like AWS CodePipeline .

public static string ArnForConnection(IConnectionRef resource)

Parameters

resource IConnectionRef

Returns

string

Remarks

Note: A connection created through CloudFormation is in PENDING status by default. You can make its status AVAILABLE by updating the connection in the console.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html

CloudformationResource: AWS::CodeStarConnections::Connection

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.CodeStarConnections;

             var cfnConnection = new CfnConnection(this, "MyCfnConnection", new CfnConnectionProps {
                 ConnectionName = "connectionName",

                 // the properties below are optional
                 HostArn = "hostArn",
                 ProviderType = "providerType",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

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.

Remarks

Note: A connection created through CloudFormation is in PENDING status by default. You can make its status AVAILABLE by updating the connection in the console.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html

CloudformationResource: AWS::CodeStarConnections::Connection

ExampleMetadata: fixture=_generated

IsCfnConnection(object)

Checks whether the given object is a CfnConnection.

public static bool IsCfnConnection(object x)

Parameters

x object

Returns

bool

Remarks

Note: A connection created through CloudFormation is in PENDING status by default. You can make its status AVAILABLE by updating the connection in the console.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html

CloudformationResource: AWS::CodeStarConnections::Connection

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::CodeStarConnections::Connection resource can be used to connect external source providers with services like AWS CodePipeline .

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

Note: A connection created through CloudFormation is in PENDING status by default. You can make its status AVAILABLE by updating the connection in the console.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html

CloudformationResource: AWS::CodeStarConnections::Connection

ExampleMetadata: fixture=_generated

Implements

IInspectable

IConnectionRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable