Package software.amazon.awscdk.services.codeconnections

Interface CfnConnectionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConnectionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.109.0 (build c221850)",
           date="2025-03-14T03:24:55.240Z")
@Stability(Stable)
public interface CfnConnectionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnConnection.

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.codeconnections.*;
 CfnConnectionProps cfnConnectionProps = CfnConnectionProps.builder()
         .connectionName("connectionName")
         // the properties below are optional
         .hostArn("hostArn")
         .providerType("providerType")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeconnections-connection.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnConnectionProps.Builder	A builder for CfnConnectionProps
static final class	CfnConnectionProps.Jsii$Proxy	An implementation for CfnConnectionProps

Method Summary

Modifier and Type	Method	Description
static CfnConnectionProps.Builder	builder()
String	getConnectionName()	The name of the connection.
default String	getHostArn()	The Amazon Resource Name (ARN) of the host associated with the connection.
default String	getProviderType()	The name of the external provider where your third-party code repository is configured.
default List<CfnTag>	getTags()	Specifies the tags applied to a connection.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConnectionName

@Stability(Stable)
@NotNull
String getConnectionName()

The name of the connection.

Connection names must be unique in an AWS account .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeconnections-connection.html#cfn-codeconnections-connection-connectionname

getHostArn

@Stability(Stable)
@Nullable
default String getHostArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeconnections-connection.html#cfn-codeconnections-connection-hostarn

getProviderType

@Stability(Stable)
@Nullable
default String getProviderType()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeconnections-connection.html#cfn-codeconnections-connection-providertype

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Specifies the tags applied to a connection.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeconnections-connection.html#cfn-codeconnections-connection-tags

builder

@Stability(Stable)
static CfnConnectionProps.Builder builder()

Returns:

a CfnConnectionProps.Builder of CfnConnectionProps