software.amazon.awscdk.services.appflow

Class CfnConnector

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.appflow.CfnConnector

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.312Z")
public class CfnConnector
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppFlow::Connector`.

Creates a new connector profile associated with your AWS account . There is a soft quota of 100 connector profiles per AWS account . If you need more connector profiles than this quota allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support channel. In each connector profile that you create, you can provide the credentials and properties for only one connector.

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.appflow.*;
 CfnConnector cfnConnector = CfnConnector.Builder.create(this, "MyCfnConnector")
         .connectorProvisioningConfig(ConnectorProvisioningConfigProperty.builder()
                 .lambda(LambdaConnectorProvisioningConfigProperty.builder()
                         .lambdaArn("lambdaArn")
                         .build())
                 .build())
         .connectorProvisioningType("connectorProvisioningType")
         // the properties below are optional
         .connectorLabel("connectorLabel")
         .description("description")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnConnector.Builder A fluent builder for CfnConnector.
static interface	CfnConnector.ConnectorProvisioningConfigProperty Contains information about the configuration of the connector being registered.
static interface	CfnConnector.LambdaConnectorProvisioningConfigProperty Contains information about the configuration of the lambda which is being registered as the connector.

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnConnector(Construct scope, java.lang.String id, CfnConnectorProps props) Create a new `AWS::AppFlow::Connector`.
protected	CfnConnector(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConnector(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrConnectorArn()
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getConnectorLabel() The label used for registering the connector.
java.lang.Object	getConnectorProvisioningConfig() The configuration required for registering the connector.
java.lang.String	getConnectorProvisioningType() The provisioning type used to register the connector.
java.lang.String	getDescription() A description about the connector runtime setting.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setConnectorLabel(java.lang.String value) The label used for registering the connector.
void	setConnectorProvisioningConfig(CfnConnector.ConnectorProvisioningConfigProperty value) The configuration required for registering the connector.
void	setConnectorProvisioningConfig(IResolvable value) The configuration required for registering the connector.
void	setConnectorProvisioningType(java.lang.String value) The provisioning type used to register the connector.
void	setDescription(java.lang.String value) A description about the connector runtime setting.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnConnector

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

CfnConnector

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

CfnConnector

public CfnConnector(Construct scope,
                    java.lang.String id,
                    CfnConnectorProps props)

Create a new `AWS::AppFlow::Connector`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrConnectorArn

public java.lang.String getAttrConnectorArn()

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getConnectorProvisioningConfig

public java.lang.Object getConnectorProvisioningConfig()

The configuration required for registering the connector.

setConnectorProvisioningConfig

public void setConnectorProvisioningConfig(CfnConnector.ConnectorProvisioningConfigProperty value)

The configuration required for registering the connector.

setConnectorProvisioningConfig

public void setConnectorProvisioningConfig(IResolvable value)

The configuration required for registering the connector.

getConnectorProvisioningType

public java.lang.String getConnectorProvisioningType()

The provisioning type used to register the connector.

setConnectorProvisioningType

public void setConnectorProvisioningType(java.lang.String value)

The provisioning type used to register the connector.

getConnectorLabel

public java.lang.String getConnectorLabel()

The label used for registering the connector.

setConnectorLabel

public void setConnectorLabel(java.lang.String value)

The label used for registering the connector.

getDescription

public java.lang.String getDescription()

A description about the connector runtime setting.

setDescription

public void setDescription(java.lang.String value)

A description about the connector runtime setting.