Connection L2 construct
Define an EventBridge Connection.
Example
ts
const connection = new events.Connection(this, 'Connection', {
authorization: events.Authorization.apiKey('x-api-key', SecretValue.secretsManager('ApiSecretName')),
description: 'Connection with API Key x-api-key',
});
const destination = new events.ApiDestination(this, 'Destination', {
connection,
endpoint: 'https://example.com',
description: 'Calling example.com with API key x-api-key',
});
const rule = new events.Rule(this, 'Rule', {
schedule: events.Schedule.rate(Duration.minutes(1)),
targets: [new targets.ApiDestination(destination)],
});
python
connection = events.Connection(self, "Connection",
authorization=events.Authorization.api_key("x-api-key", SecretValue.secrets_manager("ApiSecretName")),
description="Connection with API Key x-api-key"
)
destination = events.ApiDestination(self, "Destination",
connection=connection,
endpoint="https://example.com",
description="Calling example.com with API key x-api-key"
)
rule = events.Rule(self, "Rule",
schedule=events.Schedule.rate(Duration.minutes(1)),
targets=[targets.ApiDestination(destination)]
)
java
Connection connection = Connection.Builder.create(this, "Connection")
.authorization(Authorization.apiKey("x-api-key", SecretValue.secretsManager("ApiSecretName")))
.description("Connection with API Key x-api-key")
.build();
ApiDestination destination = ApiDestination.Builder.create(this, "Destination")
.connection(connection)
.endpoint("https://example.com")
.description("Calling example.com with API key x-api-key")
.build();
Rule rule = Rule.Builder.create(this, "Rule")
.schedule(Schedule.rate(Duration.minutes(1)))
.targets(List.of(new ApiDestination(destination)))
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
var connection = new Connection(this, "Connection", new ConnectionProps {
Authorization = Authorization.ApiKey("x-api-key", SecretValue.SecretsManager("ApiSecretName")),
Description = "Connection with API Key x-api-key"
});
var destination = new ApiDestination(this, "Destination", new ApiDestinationProps {
Connection = connection,
Endpoint = "https://example.com",
Description = "Calling example.com with API key x-api-key"
});
var rule = new Rule(this, "Rule", new RuleProps {
Schedule = Schedule.Rate(Duration.Minutes(1)),
Targets = new [] { new ApiDestination(destination) }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
connection := events.NewConnection(this, jsii.String("Connection"), &ConnectionProps{
Authorization: events.Authorization_ApiKey(jsii.String("x-api-key"), awscdk.SecretValue_SecretsManager(jsii.String("ApiSecretName"))),
Description: jsii.String("Connection with API Key x-api-key"),
})
destination := events.NewApiDestination(this, jsii.String("Destination"), &ApiDestinationProps{
Connection: Connection,
Endpoint: jsii.String("https://example.com"),
Description: jsii.String("Calling example.com with API key x-api-key"),
})
rule := events.NewRule(this, jsii.String("Rule"), &RuleProps{
Schedule: events.Schedule_Rate(awscdk.Duration_Minutes(jsii.Number(1))),
Targets: []IRuleTarget{
targets.NewApiDestination(destination),
},
})
Initializer
ts
new Connection(scope: Construct, id: string, props: ConnectionProps)
python
Connection(scope: Construct, id: str, props: ConnectionProps)
java
new Connection(Construct scope, String id, ConnectionProps props)
csharp
new Connection(Construct scope, string id, ConnectionProps props)
go
NewConnection(Scope Construct, Id *string, Props ConnectionProps)
Construct Props
authorizationAuthorizationauthorizationAuthorizationauthorizationAuthorizationAuthorizationAuthorizationAuthorizationAuthorizationrequired#The authorization type for the connection.
bodyParameters{ [key: string]: HttpParameter }body_parameterstyping.Mapping[str, HttpParameter]bodyParametersMap<String, HttpParameter>BodyParametersIDictionary<string, HttpParameter>BodyParameters*map[string]HttpParameter= No additional parameters#Additional string parameters to add to the invocation bodies.
connectionNamestringconnection_namestrconnectionNameStringConnectionNamestringConnectionName*string= A name is automatically generate…#The name of the connection.
default
Default: A name is automatically generated
The name of the connection.
headerParameters{ [key: string]: HttpParameter }header_parameterstyping.Mapping[str, HttpParameter]headerParametersMap<String, HttpParameter>HeaderParametersIDictionary<string, HttpParameter>HeaderParameters*map[string]HttpParameter= No additional parameters#Additional string parameters to add to the invocation headers.
queryStringParameters{ [key: string]: HttpParameter }query_string_parameterstyping.Mapping[str, HttpParameter]queryStringParametersMap<String, HttpParameter>QueryStringParametersIDictionary<string, HttpParameter>QueryStringParameters*map[string]HttpParameter= No additional parameters#Additional string parameters to add to the invocation query strings.
Properties
connectionArnstringconnection_arnstrconnectionArnStringConnectionArnstringConnectionArn*stringrequired#The ARN of the connection created.
connectionNamestringconnection_namestrconnectionNameStringConnectionNamestringConnectionName*stringrequired#The Name for the connection.
connectionRefConnectionReferenceconnection_refConnectionReferenceconnectionRefConnectionReferenceConnectionRefConnectionReferenceConnectionRefConnectionReferencerequired#A reference to a Connection resource.
connectionSecretArnstringconnection_secret_arnstrconnectionSecretArnStringConnectionSecretArnstringConnectionSecretArn*stringrequired#The ARN for the secret created for the connection.
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#The environment this resource belongs to.
notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#Uniquely identifies this class.
Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#Override the cross-stack reference strength for this resource.
notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#Apply the given removal policy to this resource.
notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
fromConnectionAttributes(scope: Construct, id: string, attrs: ConnectionAttributes): IConnection@staticmethod def from_connection_attributes(scope: Construct, id: str, attrs: ConnectionAttributes) -> IConnectionpublic static IConnection fromConnectionAttributes(Construct scope, String id, ConnectionAttributes attrs)public static IConnection FromConnectionAttributes(Construct scope, string id, ConnectionAttributes attrs)func FromConnectionAttributes(Scope Construct, Id *string, Attrs ConnectionAttributes) IConnectionstatic#Import an existing connection resource.
3 parameters
Parameters
scopescopescopescopeScope— Parent construct.ididididId— Construct ID.attrsattrsattrsattrsAttrs— Imported connection properties.
fromEventBusArn(scope: Construct, id: string, connectionArn: string, connectionSecretArn: string): IConnection@staticmethod def from_event_bus_arn(scope: Construct, id: str, connection_arn: str, connection_secret_arn: str) -> IConnectionpublic static IConnection fromEventBusArn(Construct scope, String id, String connectionArn, String connectionSecretArn)public static IConnection FromEventBusArn(Construct scope, string id, string connectionArn, string connectionSecretArn)func FromEventBusArn(Scope Construct, Id *string, ConnectionArn *string, ConnectionSecretArn *string) IConnectionstatic#Import an existing connection resource.
3 parameters
Parameters
scopescopescopescopeScope— Parent construct.ididididId— Construct ID.connectionArnconnection_arnconnectionArnconnectionArnConnectionArn— ARN of imported connection.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#Checks if `x` is a construct.
notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#Returns true if the construct was created by CDK, and false otherwise.
isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#Check whether the given construct is a Resource.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#Returns a string representation of this construct.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.