Package software.amazon.awscdk.services.interconnect

Interface CfnConnectionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConnectionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-02T21:55:12.483Z")
@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.interconnect.*;
 CfnConnectionProps cfnConnectionProps = CfnConnectionProps.builder()
         .attachPoint(AttachPointProperty.builder()
                 .arn("arn")
                 .directConnectGateway("directConnectGateway")
                 .build())
         // the properties below are optional
         .activationKey("activationKey")
         .bandwidth("bandwidth")
         .description("description")
         .environmentId("environmentId")
         .remoteOwnerAccount("remoteOwnerAccount")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-interconnect-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()
default String	getActivationKey()	The activation key for accepting a connection proposal from a partner CSP.
Object	getAttachPoint()	The logical attachment point in your AWS network where the managed connection will be connected.
default String	getBandwidth()	The bandwidth of the connection (e.g., 50Mbps, 1Gbps).
default String	getDescription()	A description of the connection.
default String	getEnvironmentId()	The ID of the environment for the connection.
default String	getRemoteOwnerAccount()	The account ID of the remote owner.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAttachPoint

@Stability(Stable)
@NotNull
Object getAttachPoint()

The logical attachment point in your AWS network where the managed connection will be connected.

Returns union: either IResolvable or CfnConnection.AttachPointProperty

See Also:

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

getActivationKey

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

The activation key for accepting a connection proposal from a partner CSP.

Mutually exclusive with EnvironmentId.

See Also:

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

getBandwidth

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

The bandwidth of the connection (e.g., 50Mbps, 1Gbps). Required when creating a connection through AWS.

See Also:

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

getDescription

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

A description of the connection.

See Also:

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

getEnvironmentId

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

The ID of the environment for the connection.

Required when creating a connection through AWS. Mutually exclusive with ActivationKey.

See Also:

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

getRemoteOwnerAccount

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

The account ID of the remote owner.

Required when creating a connection through AWS.

See Also:

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

getTags

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

An array of key-value pairs to apply to this resource.

See Also:

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

builder

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

Returns:

a CfnConnectionProps.Builder of CfnConnectionProps