Class CfnConnection

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

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnConnection
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.CodeStarConnections
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnConnection : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnConnection
    Inherits CfnResource
    Implements IInspectable, ITaggable
Remarks

Note: A connection created through AWS 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(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnConnection(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnConnection(Construct, String, ICfnConnectionProps)

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
ConnectionName

The name of the connection.
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

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnConnection(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnConnection(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnConnection(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnConnection(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnConnection(Construct, String, ICfnConnectionProps)

public CfnConnection(Construct scope, string id, ICfnConnectionProps props)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

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

props ICfnConnectionProps

Resource properties.

Properties

AttrConnectionArn

The Amazon Resource Name (ARN) of the connection.

public virtual string AttrConnectionArn { get; }
Property Value

System.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

System.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

System.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

System.String

CfnProperties

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

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

ConnectionName

The name of the connection.

public virtual string ConnectionName { get; set; }
Property Value

System.String

HostArn

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

public virtual string HostArn { get; set; }
Property Value

System.String

ProviderType

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

public virtual string ProviderType { get; set; }
Property Value

System.String

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

TagsRaw

Specifies the tags applied to the resource.

public virtual ICfnTag[] TagsRaw { get; set; }
Property Value

ICfnTag[]

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>

Overrides

Implements