Class: AWSCDK::Events::CfnConnection

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSEvents::IConnectionRef
Defined in:
events/cfn_connection.rb

Overview

Creates a connection.

A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.

For more information, see Connections for endpoint targets in the Amazon EventBridge User Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnConnection

Create a new AWS::Events::Connection.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::Events::CfnConnectionProps, nil) (defaults to: nil) —

    Resource properties.



21
22
23
24
25
26
27
 
# File 'events/cfn_connection.rb', line 21

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::Events::CfnConnectionProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZXZlbnRzLkNmbkNvbm5lY3Rpb25Qcm9wcyJ9")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_connection(resource) ⇒ String

Parameters:

Returns:

  • (String) 


83
84
85
86
 
# File 'events/cfn_connection.rb', line 83

def self.arn_for_connection(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19ldmVudHMuSUNvbm5lY3Rpb25SZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_events.CfnConnection", "arnForConnection", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


216
217
218
 
# File 'events/cfn_connection.rb', line 216

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_events.CfnConnection", "CFN_RESOURCE_TYPE_NAME")
end

.from_connection_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSEvents::IConnectionRef

Creates a new IConnectionRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



94
95
96
97
98
99
 
# File 'events/cfn_connection.rb', line 94

def self.from_connection_arn(scope, id, arn)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_events.CfnConnection", "fromConnectionArn", [scope, id, arn])
end

.from_connection_name(scope, id, connection_name) ⇒ AWSCDK::Interfaces::AWSEvents::IConnectionRef

Creates a new IConnectionRef from a connectionName.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • connection_name (String)

Returns:



107
108
109
110
111
112
 
# File 'events/cfn_connection.rb', line 107

def self.from_connection_name(scope, id, connection_name)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(connection_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "connectionName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_events.CfnConnection", "fromConnectionName", [scope, id, connection_name])
end

.is_cfn_connection(x) ⇒ Boolean

Checks whether the given object is a CfnConnection.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


118
119
120
121
 
# File 'events/cfn_connection.rb', line 118

def self.is_cfn_connection(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_events.CfnConnection", "isCfnConnection", [x])
end

.jsii_overridable_methods ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'events/cfn_connection.rb', line 29

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_arn_for_policy => { kind: :property, name: "attrArnForPolicy", is_optional: false },
    :attr_auth_parameters_connectivity_parameters_resource_parameters_resource_association_arn => { kind: :property, name: "attrAuthParametersConnectivityParametersResourceParametersResourceAssociationArn", is_optional: false },
    :attr_invocation_connectivity_parameters_resource_parameters_resource_association_arn => { kind: :property, name: "attrInvocationConnectivityParametersResourceParametersResourceAssociationArn", is_optional: false },
    :attr_secret_arn => { kind: :property, name: "attrSecretArn", is_optional: false },
    :connection_ref => { kind: :property, name: "connectionRef", is_optional: false },
    :authorization_type => { kind: :property, name: "authorizationType", is_optional: true },
    :auth_parameters => { kind: :property, name: "authParameters", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :invocation_connectivity_parameters => { kind: :property, name: "invocationConnectivityParameters", is_optional: true },
    :kms_key_identifier => { kind: :property, name: "kmsKeyIdentifier", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



382
383
384
385
 
# File 'events/cfn_connection.rb', line 382

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



394
395
396
397
 
# File 'events/cfn_connection.rb', line 394

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



404
405
406
407
 
# File 'events/cfn_connection.rb', line 404

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



415
416
417
418
419
 
# File 'events/cfn_connection.rb', line 415

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


472
473
474
475
476
 
# File 'events/cfn_connection.rb', line 472

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



482
483
484
485
 
# File 'events/cfn_connection.rb', line 482

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



494
495
496
497
498
 
# File 'events/cfn_connection.rb', line 494

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



507
508
509
510
 
# File 'events/cfn_connection.rb', line 507

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



529
530
531
532
533
534
 
# File 'events/cfn_connection.rb', line 529

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

The ARN of the connection that was created by the request.

Returns:

  • (String) 


223
224
225
 
# File 'events/cfn_connection.rb', line 223

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_arn_for_policy ⇒ String

Returns the Amazon Resource Name (ARN) of a connection in resource format, so it can be used in the Resource element of IAM permission policy statements.

For more information, see Resource types defined by Amazon EventBridge in the Service Authorization Reference .

For example, the following resource defines an IAM policy that grants permission to update a specific connection.

Resources: ExamplePolicy: Type: AWS::IAM::Policy Properties: PolicyName: ExamplePolicy PolicyDocument: Version: '2012-10-17 ' Statement: - Effect: Allow Action: - events:UpdateConnection Resource: - !GetAtt myConnection.ArnForPolicy

Returns:

  • (String) 


236
237
238
 
# File 'events/cfn_connection.rb', line 236

def attr_arn_for_policy()
  jsii_get_property("attrArnForPolicy")
end

#attr_auth_parameters_connectivity_parameters_resource_parameters_resource_association_arn ⇒ String

For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.

The value of this property is set by EventBridge . Any value you specify in your template is ignored.

Returns:

  • (String) 


245
246
247
 
# File 'events/cfn_connection.rb', line 245

def attr_auth_parameters_connectivity_parameters_resource_parameters_resource_association_arn()
  jsii_get_property("attrAuthParametersConnectivityParametersResourceParametersResourceAssociationArn")
end

#attr_invocation_connectivity_parameters_resource_parameters_resource_association_arn ⇒ String

For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.

The value of this property is set by EventBridge . Any value you specify in your template is ignored.

Returns:

  • (String) 


254
255
256
 
# File 'events/cfn_connection.rb', line 254

def attr_invocation_connectivity_parameters_resource_parameters_resource_association_arn()
  jsii_get_property("attrInvocationConnectivityParametersResourceParametersResourceAssociationArn")
end

#attr_secret_arn ⇒ String

The ARN for the secret created for the connection.

Returns:

  • (String) 


261
262
263
 
# File 'events/cfn_connection.rb', line 261

def attr_secret_arn()
  jsii_get_property("attrSecretArn")
end

#auth_parameters ⇒ AWSCDK::IResolvable, ...

The authorization parameters to use to authorize with the endpoint.

Returns:



287
288
289
 
# File 'events/cfn_connection.rb', line 287

def auth_parameters()
  jsii_get_property("authParameters")
end

#auth_parameters=(value) ⇒ Object 



291
292
293
294
295
 
# File 'events/cfn_connection.rb', line 291

def auth_parameters=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Events::CfnConnection::AuthParametersProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ldmVudHMuQ2ZuQ29ubmVjdGlvbi5BdXRoUGFyYW1ldGVyc1Byb3BlcnR5In1dfX0=")), "authParameters") unless value.nil?
  jsii_set_property("authParameters", value)
end

#authorization_type ⇒ String?

The type of authorization to use for the connection.

Returns:

  • (String, nil) 


275
276
277
 
# File 'events/cfn_connection.rb', line 275

def authorization_type()
  jsii_get_property("authorizationType")
end

#authorization_type=(value) ⇒ Object 



279
280
281
282
 
# File 'events/cfn_connection.rb', line 279

def authorization_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authorizationType") unless value.nil?
  jsii_set_property("authorizationType", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



169
170
171
 
# File 'events/cfn_connection.rb', line 169

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


174
175
176
 
# File 'events/cfn_connection.rb', line 174

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


538
539
540
541
 
# File 'events/cfn_connection.rb', line 538

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


179
180
181
 
# File 'events/cfn_connection.rb', line 179

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


186
187
188
 
# File 'events/cfn_connection.rb', line 186

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#connection_ref ⇒ AWSCDK::Interfaces::AWSEvents::ConnectionReference

A reference to a Connection resource.

Returns:



268
269
270
 
# File 'events/cfn_connection.rb', line 268

def connection_ref()
  jsii_get_property("connectionRef")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


131
132
133
 
# File 'events/cfn_connection.rb', line 131

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

A description for the connection to create.

Returns:

  • (String, nil) 


300
301
302
 
# File 'events/cfn_connection.rb', line 300

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



304
305
306
307
 
# File 'events/cfn_connection.rb', line 304

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil?
  jsii_set_property("description", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



191
192
193
 
# File 'events/cfn_connection.rb', line 191

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



551
552
553
554
555
 
# File 'events/cfn_connection.rb', line 551

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



562
563
564
565
 
# File 'events/cfn_connection.rb', line 562

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



632
633
634
635
 
# File 'events/cfn_connection.rb', line 632

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#invocation_connectivity_parameters ⇒ AWSCDK::IResolvable, ...

For connections to private APIs, the parameters to use for invoking the API.

Returns:



312
313
314
 
# File 'events/cfn_connection.rb', line 312

def invocation_connectivity_parameters()
  jsii_get_property("invocationConnectivityParameters")
end

#invocation_connectivity_parameters=(value) ⇒ Object 



316
317
318
319
320
 
# File 'events/cfn_connection.rb', line 316

def invocation_connectivity_parameters=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Events::CfnConnection::InvocationConnectivityParametersProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19ldmVudHMuQ2ZuQ29ubmVjdGlvbi5JbnZvY2F0aW9uQ29ubmVjdGl2aXR5UGFyYW1ldGVyc1Byb3BlcnR5In1dfX0=")), "invocationConnectivityParameters") unless value.nil?
  jsii_set_property("invocationConnectivityParameters", value)
end

#kms_key_identifier ⇒ String?

The identifier of the AWS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection.

Returns:

  • (String, nil) 


325
326
327
 
# File 'events/cfn_connection.rb', line 325

def kms_key_identifier()
  jsii_get_property("kmsKeyIdentifier")
end

#kms_key_identifier=(value) ⇒ Object 



329
330
331
332
 
# File 'events/cfn_connection.rb', line 329

def kms_key_identifier=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyIdentifier") unless value.nil?
  jsii_set_property("kmsKeyIdentifier", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


143
144
145
 
# File 'events/cfn_connection.rb', line 143

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String?

The name for the connection to create.

Returns:

  • (String, nil) 


337
338
339
 
# File 'events/cfn_connection.rb', line 337

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



341
342
343
344
 
# File 'events/cfn_connection.rb', line 341

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless value.nil?
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


126
127
128
 
# File 'events/cfn_connection.rb', line 126

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



573
574
575
 
# File 'events/cfn_connection.rb', line 573

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



580
581
582
 
# File 'events/cfn_connection.rb', line 580

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



373
374
375
376
 
# File 'events/cfn_connection.rb', line 373

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


162
163
164
 
# File 'events/cfn_connection.rb', line 162

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



591
592
593
594
 
# File 'events/cfn_connection.rb', line 591

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


598
599
600
601
 
# File 'events/cfn_connection.rb', line 598

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



608
609
610
611
612
 
# File 'events/cfn_connection.rb', line 608

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



617
618
619
 
# File 'events/cfn_connection.rb', line 617

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



152
153
154
 
# File 'events/cfn_connection.rb', line 152

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



349
350
351
 
# File 'events/cfn_connection.rb', line 349

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


199
200
201
 
# File 'events/cfn_connection.rb', line 199

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


209
210
211
 
# File 'events/cfn_connection.rb', line 209

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


623
624
625
626
 
# File 'events/cfn_connection.rb', line 623

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::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.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


362
363
364
365
366
367
 
# File 'events/cfn_connection.rb', line 362

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end