software.amazon.awscdk.services.codestarconnections

Class CfnConnection

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.codestarconnections.CfnConnection

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-05-19T23:08:44.801Z")
 @Stability(value=Stable)
public class CfnConnection
extends CfnResource
implements IInspectable

A CloudFormation `AWS::CodeStarConnections::Connection`.

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

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.

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.codestarconnections.*;
 CfnConnection cfnConnection = CfnConnection.Builder.create(this, "MyCfnConnection")
         .connectionName("connectionName")
         // the properties below are optional
         .hostArn("hostArn")
         .providerType("providerType")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnConnection(Construct scope, String id, CfnConnectionProps props) Create a new `AWS::CodeStarConnections::Connection`.
protected	CfnConnection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConnection(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrConnectionArn() The Amazon Resource Name (ARN) of the connection.
String	getAttrConnectionStatus() The current status of the connection.
String	getAttrOwnerAccountId() The AWS account ID of the owner of the connection.
protected Map<String,Object>	getCfnProperties()
String	getConnectionName() The name of the connection.
String	getHostArn() The Amazon Resource Name (ARN) of the host associated with the connection.
String	getProviderType() The name of the external provider where your third-party code repository is configured.
TagManager	getTags() Specifies the tags applied to the resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setConnectionName(String value) The name of the connection.
void	setHostArn(String value) The Amazon Resource Name (ARN) of the host associated with the connection.
void	setProviderType(String value) The name of the external provider where your third-party code repository is configured.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnConnection

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

CfnConnection

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

CfnConnection

@Stability(value=Stable)
public CfnConnection(@NotNull
                                              Construct scope,
                                              @NotNull
                                              String id,
                                              @NotNull
                                              CfnConnectionProps props)

Create a new `AWS::CodeStarConnections::Connection`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrConnectionArn

@Stability(value=Stable)
 @NotNull
public String getAttrConnectionArn()

The Amazon Resource Name (ARN) of the connection.

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 .

getAttrConnectionStatus

@Stability(value=Stable)
 @NotNull
public String getAttrConnectionStatus()

The current status of the connection.

For example: PENDING , AVAILABLE , or ERROR .

getAttrOwnerAccountId

@Stability(value=Stable)
 @NotNull
public String getAttrOwnerAccountId()

The AWS account ID of the owner of the connection.

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

Specifies the tags applied to the resource.

getConnectionName

@Stability(value=Stable)
 @NotNull
public String getConnectionName()

The name of the connection.

Connection names must be unique in an AWS user account.

setConnectionName

@Stability(value=Stable)
public void setConnectionName(@NotNull
                                                       String value)

The name of the connection.

Connection names must be unique in an AWS user account.

getHostArn

@Stability(value=Stable)
 @Nullable
public String getHostArn()

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

setHostArn

@Stability(value=Stable)
public void setHostArn(@Nullable
                                                String value)

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

getProviderType

@Stability(value=Stable)
 @Nullable
public String getProviderType()

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

setProviderType

@Stability(value=Stable)
public void setProviderType(@Nullable
                                                     String value)

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