software.amazon.awscdk.services.appintegrations

Class CfnDataIntegration

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.appintegrations.CfnDataIntegration

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.362Z")
 @Stability(value=Stable)
public class CfnDataIntegration
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppIntegrations::DataIntegration`.

Creates and persists a DataIntegration resource.

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.appintegrations.*;
 CfnDataIntegration cfnDataIntegration = CfnDataIntegration.Builder.create(this, "MyCfnDataIntegration")
         .kmsKey("kmsKey")
         .name("name")
         .scheduleConfig(ScheduleConfigProperty.builder()
                 .firstExecutionFrom("firstExecutionFrom")
                 .object("object")
                 .scheduleExpression("scheduleExpression")
                 .build())
         .sourceUri("sourceUri")
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDataIntegration.Builder A fluent builder for CfnDataIntegration.
static interface	CfnDataIntegration.ScheduleConfigProperty The name of the data and how often it should be pulled from the source.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDataIntegration(software.constructs.Construct scope, String id, CfnDataIntegrationProps props) Create a new `AWS::AppIntegrations::DataIntegration`.
protected	CfnDataIntegration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDataIntegration(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrDataIntegrationArn() The Amazon Resource Name (ARN) for the DataIntegration.
String	getAttrId() A unique identifier.
protected Map<String,Object>	getCfnProperties()
String	getDescription() A description of the DataIntegration.
String	getKmsKey() The KMS key for the DataIntegration.
String	getName() The name of the DataIntegration.
Object	getScheduleConfig() The name of the data and how often it should be pulled from the source.
String	getSourceUri() The URI of the data source.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) A description of the DataIntegration.
void	setKmsKey(String value) The KMS key for the DataIntegration.
void	setName(String value) The name of the DataIntegration.
void	setScheduleConfig(CfnDataIntegration.ScheduleConfigProperty value) The name of the data and how often it should be pulled from the source.
void	setScheduleConfig(IResolvable value) The name of the data and how often it should be pulled from the source.
void	setSourceUri(String value) The URI of the data source.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDataIntegration

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

CfnDataIntegration

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

CfnDataIntegration

@Stability(value=Stable)
public CfnDataIntegration(@NotNull
                                                   software.constructs.Construct scope,
                                                   @NotNull
                                                   String id,
                                                   @NotNull
                                                   CfnDataIntegrationProps props)

Create a new `AWS::AppIntegrations::DataIntegration`.

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

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

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrDataIntegrationArn

@Stability(value=Stable)
 @NotNull
public String getAttrDataIntegrationArn()

The Amazon Resource Name (ARN) for the DataIntegration.

getAttrId

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

A unique identifier.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

For more information, see Tag .

getKmsKey

@Stability(value=Stable)
 @NotNull
public String getKmsKey()

The KMS key for the DataIntegration.

setKmsKey

@Stability(value=Stable)
public void setKmsKey(@NotNull
                                               String value)

The KMS key for the DataIntegration.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the DataIntegration.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the DataIntegration.

getScheduleConfig

@Stability(value=Stable)
 @NotNull
public Object getScheduleConfig()

The name of the data and how often it should be pulled from the source.

setScheduleConfig

@Stability(value=Stable)
public void setScheduleConfig(@NotNull
                                                       CfnDataIntegration.ScheduleConfigProperty value)

The name of the data and how often it should be pulled from the source.

setScheduleConfig

@Stability(value=Stable)
public void setScheduleConfig(@NotNull
                                                       IResolvable value)

The name of the data and how often it should be pulled from the source.

getSourceUri

@Stability(value=Stable)
 @NotNull
public String getSourceUri()

The URI of the data source.

setSourceUri

@Stability(value=Stable)
public void setSourceUri(@NotNull
                                                  String value)

The URI of the data source.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A description of the DataIntegration.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description of the DataIntegration.