Package software.amazon.awscdk.services.glue

Class CfnConnection

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.glue.CfnConnection

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-15T21:09:19.943Z")
@Stability(Stable)
public class CfnConnection
extends CfnResource
implements IInspectable

The AWS::Glue::Connection resource specifies an AWS Glue connection to a data source.

For more information, see Adding a Connection to Your Data Store and Connection Structure in the AWS Glue Developer Guide .

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.glue.*;
 Object connectionProperties;
 CfnConnection cfnConnection = CfnConnection.Builder.create(this, "MyCfnConnection")
         .catalogId("catalogId")
         .connectionInput(ConnectionInputProperty.builder()
                 .connectionType("connectionType")
                 // the properties below are optional
                 .connectionProperties(connectionProperties)
                 .description("description")
                 .matchCriteria(List.of("matchCriteria"))
                 .name("name")
                 .physicalConnectionRequirements(PhysicalConnectionRequirementsProperty.builder()
                         .availabilityZone("availabilityZone")
                         .securityGroupIdList(List.of("securityGroupIdList"))
                         .subnetId("subnetId")
                         .build())
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnConnection.Builder	A fluent builder for CfnConnection.
static interface	CfnConnection.ConnectionInputProperty	A structure that is used to specify a connection to create or update.
static interface	CfnConnection.PhysicalConnectionRequirementsProperty	The OAuth client app in GetConnection response.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnConnection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConnection(software.amazon.jsii.JsiiObjectRef objRef)
	CfnConnection(software.constructs.Construct scope, String id, CfnConnectionProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrId()
String	getCatalogId()	The ID of the data catalog to create the catalog object in.
protected Map<String,Object>	getCfnProperties()
Object	getConnectionInput()	The connection that you want to create.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCatalogId(String value)	The ID of the data catalog to create the catalog object in.
void	setConnectionInput(IResolvable value)	The connection that you want to create.
void	setConnectionInput(CfnConnection.ConnectionInputProperty value)	The connection that you want to create.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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 Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnConnection

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

CfnConnection

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

CfnConnection

@Stability(Stable)
public CfnConnection(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnConnectionProps props)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

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

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getCatalogId

@Stability(Stable)
@NotNull
public String getCatalogId()

The ID of the data catalog to create the catalog object in.

setCatalogId

@Stability(Stable)
public void setCatalogId(@NotNull
 String value)

The ID of the data catalog to create the catalog object in.

getConnectionInput

@Stability(Stable)
@NotNull
public Object getConnectionInput()

The connection that you want to create.

setConnectionInput

@Stability(Stable)
public void setConnectionInput(@NotNull
 IResolvable value)

The connection that you want to create.

setConnectionInput

@Stability(Stable)
public void setConnectionInput(@NotNull
 CfnConnection.ConnectionInputProperty value)

The connection that you want to create.