Class CfnDataIntegration
Creates and persists a DataIntegration resource.
Inherited Members
Namespace: Amazon.CDK.AWS.AppIntegrations
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDataIntegration : CfnResource, IInspectable, IDataIntegrationRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Syntax (vb)
Public Class CfnDataIntegration Inherits CfnResource Implements IInspectable, IDataIntegrationRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Remarks
CloudformationResource: AWS::AppIntegrations::DataIntegration
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppIntegrations;
var filters;
var objectConfiguration;
var cfnDataIntegration = new CfnDataIntegration(this, "MyCfnDataIntegration", new CfnDataIntegrationProps {
KmsKey = "kmsKey",
Name = "name",
SourceUri = "sourceUri",
// the properties below are optional
Description = "description",
FileConfiguration = new FileConfigurationProperty {
Folders = new [] { "folders" },
// the properties below are optional
Filters = filters
},
ObjectConfiguration = objectConfiguration,
ScheduleConfig = new ScheduleConfigProperty {
ScheduleExpression = "scheduleExpression",
// the properties below are optional
FirstExecutionFrom = "firstExecutionFrom",
Object = "object"
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
| CfnDataIntegration(Construct, string, ICfnDataIntegrationProps) | Create a new |
Properties
| AttrDataIntegrationArn | The Amazon Resource Name (ARN) for the DataIntegration. |
| AttrId | A unique identifier. |
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CfnProperties | Creates and persists a DataIntegration resource. |
| DataIntegrationRef | A reference to a DataIntegration resource. |
| Description | A description of the DataIntegration. |
| FileConfiguration | The configuration for what files should be pulled from the source. |
| KmsKey | The KMS key for the DataIntegration. |
| Name | The name of the DataIntegration. |
| ObjectConfiguration | The configuration for what data should be pulled from the source. |
| ScheduleConfig | The name of the data and how often it should be pulled from the source. |
| SourceUri | The URI of the data source. |
| Tags | Tag Manager which manages the tags for this resource. |
| TagsRaw | An array of key-value pairs to apply to this resource. |
Methods
| ArnForDataIntegration(IDataIntegrationRef) | Creates and persists a DataIntegration resource. |
| FromDataIntegrationArn(Construct, string, string) | Creates a new IDataIntegrationRef from an ARN. |
| FromDataIntegrationId(Construct, string, string) | Creates a new IDataIntegrationRef from a dataIntegrationId. |
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| IsCfnDataIntegration(object) | Checks whether the given object is a CfnDataIntegration. |
| RenderProperties(IDictionary<string, object>) | Creates and persists a DataIntegration resource. |
Constructors
CfnDataIntegration(Construct, string, ICfnDataIntegrationProps)
Create a new AWS::AppIntegrations::DataIntegration.
public CfnDataIntegration(Construct scope, string id, ICfnDataIntegrationProps props)
Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnDataIntegrationProps
Resource properties.
Remarks
CloudformationResource: AWS::AppIntegrations::DataIntegration
ExampleMetadata: fixture=_generated
Properties
AttrDataIntegrationArn
The Amazon Resource Name (ARN) for the DataIntegration.
public virtual string AttrDataIntegrationArn { get; }
Property Value
Remarks
CloudformationAttribute: DataIntegrationArn
AttrId
A unique identifier.
public virtual string AttrId { get; }
Property Value
Remarks
CloudformationAttribute: Id
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
Remarks
CloudformationResource: AWS::AppIntegrations::DataIntegration
ExampleMetadata: fixture=_generated
CfnProperties
Creates and persists a DataIntegration resource.
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
Remarks
CloudformationResource: AWS::AppIntegrations::DataIntegration
ExampleMetadata: fixture=_generated
DataIntegrationRef
A reference to a DataIntegration resource.
public virtual IDataIntegrationReference DataIntegrationRef { get; }
Property Value
Remarks
CloudformationResource: AWS::AppIntegrations::DataIntegration
ExampleMetadata: fixture=_generated
Description
A description of the DataIntegration.
public virtual string? Description { get; set; }
Property Value
Remarks
CloudformationResource: AWS::AppIntegrations::DataIntegration
ExampleMetadata: fixture=_generated
FileConfiguration
The configuration for what files should be pulled from the source.
public virtual object? FileConfiguration { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnDataIntegration.IFileConfigurationProperty
KmsKey
The KMS key for the DataIntegration.
public virtual string KmsKey { get; set; }
Property Value
Remarks
CloudformationResource: AWS::AppIntegrations::DataIntegration
ExampleMetadata: fixture=_generated
Name
The name of the DataIntegration.
public virtual string Name { get; set; }
Property Value
Remarks
CloudformationResource: AWS::AppIntegrations::DataIntegration
ExampleMetadata: fixture=_generated
ObjectConfiguration
The configuration for what data should be pulled from the source.
public virtual object ObjectConfiguration { get; set; }
Property Value
Remarks
CloudformationResource: AWS::AppIntegrations::DataIntegration
ExampleMetadata: fixture=_generated
ScheduleConfig
The name of the data and how often it should be pulled from the source.
public virtual object? ScheduleConfig { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnDataIntegration.IScheduleConfigProperty
SourceUri
The URI of the data source.
public virtual string SourceUri { get; set; }
Property Value
Remarks
CloudformationResource: AWS::AppIntegrations::DataIntegration
ExampleMetadata: fixture=_generated
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
CloudformationResource: AWS::AppIntegrations::DataIntegration
ExampleMetadata: fixture=_generated
TagsRaw
An array of key-value pairs to apply to this resource.
public virtual ICfnTag[]? TagsRaw { get; set; }
Property Value
ICfnTag[]
Remarks
CloudformationResource: AWS::AppIntegrations::DataIntegration
ExampleMetadata: fixture=_generated
Methods
ArnForDataIntegration(IDataIntegrationRef)
Creates and persists a DataIntegration resource.
public static string ArnForDataIntegration(IDataIntegrationRef resource)
Parameters
- resource IDataIntegrationRef
Returns
Remarks
CloudformationResource: AWS::AppIntegrations::DataIntegration
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppIntegrations;
var filters;
var objectConfiguration;
var cfnDataIntegration = new CfnDataIntegration(this, "MyCfnDataIntegration", new CfnDataIntegrationProps {
KmsKey = "kmsKey",
Name = "name",
SourceUri = "sourceUri",
// the properties below are optional
Description = "description",
FileConfiguration = new FileConfigurationProperty {
Folders = new [] { "folders" },
// the properties below are optional
Filters = filters
},
ObjectConfiguration = objectConfiguration,
ScheduleConfig = new ScheduleConfigProperty {
ScheduleExpression = "scheduleExpression",
// the properties below are optional
FirstExecutionFrom = "firstExecutionFrom",
Object = "object"
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
FromDataIntegrationArn(Construct, string, string)
Creates a new IDataIntegrationRef from an ARN.
public static IDataIntegrationRef FromDataIntegrationArn(Construct scope, string id, string arn)
Parameters
Returns
Remarks
CloudformationResource: AWS::AppIntegrations::DataIntegration
ExampleMetadata: fixture=_generated
FromDataIntegrationId(Construct, string, string)
Creates a new IDataIntegrationRef from a dataIntegrationId.
public static IDataIntegrationRef FromDataIntegrationId(Construct scope, string id, string dataIntegrationId)
Parameters
Returns
Remarks
CloudformationResource: AWS::AppIntegrations::DataIntegration
ExampleMetadata: fixture=_generated
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
Remarks
CloudformationResource: AWS::AppIntegrations::DataIntegration
ExampleMetadata: fixture=_generated
IsCfnDataIntegration(object)
Checks whether the given object is a CfnDataIntegration.
public static bool IsCfnDataIntegration(object x)
Parameters
- x object
Returns
Remarks
CloudformationResource: AWS::AppIntegrations::DataIntegration
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
Creates and persists a DataIntegration resource.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
CloudformationResource: AWS::AppIntegrations::DataIntegration
ExampleMetadata: fixture=_generated