Documentation
¶
Index ¶
- func CfnDataIntegration_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDataIntegration_IsCfnElement(x interface{}) *bool
- func CfnDataIntegration_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDataIntegration_IsConstruct(x interface{}) *bool
- func CfnEventIntegration_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEventIntegration_IsCfnElement(x interface{}) *bool
- func CfnEventIntegration_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnEventIntegration_IsConstruct(x interface{}) *bool
- func NewCfnDataIntegration_Override(c CfnDataIntegration, scope awscdk.Construct, id *string, ...)
- func NewCfnEventIntegration_Override(c CfnEventIntegration, scope awscdk.Construct, id *string, ...)
- type CfnDataIntegration
- type CfnDataIntegrationProps
- type CfnDataIntegration_ScheduleConfigProperty
- type CfnEventIntegration
- type CfnEventIntegrationProps
- type CfnEventIntegration_EventFilterProperty
- type CfnEventIntegration_EventIntegrationAssociationProperty
- type CfnEventIntegration_MetadataProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnDataIntegration_CFN_RESOURCE_TYPE_NAME ¶
func CfnDataIntegration_CFN_RESOURCE_TYPE_NAME() *string
func CfnDataIntegration_IsCfnElement ¶
func CfnDataIntegration_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.
func CfnDataIntegration_IsCfnResource ¶
func CfnDataIntegration_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnDataIntegration_IsConstruct ¶
func CfnDataIntegration_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnEventIntegration_CFN_RESOURCE_TYPE_NAME ¶
func CfnEventIntegration_CFN_RESOURCE_TYPE_NAME() *string
func CfnEventIntegration_IsCfnElement ¶
func CfnEventIntegration_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.
func CfnEventIntegration_IsCfnResource ¶
func CfnEventIntegration_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnEventIntegration_IsConstruct ¶
func CfnEventIntegration_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func NewCfnDataIntegration_Override ¶
func NewCfnDataIntegration_Override(c CfnDataIntegration, scope awscdk.Construct, id *string, props *CfnDataIntegrationProps)
Create a new `AWS::AppIntegrations::DataIntegration`.
func NewCfnEventIntegration_Override ¶
func NewCfnEventIntegration_Override(c CfnEventIntegration, scope awscdk.Construct, id *string, props *CfnEventIntegrationProps)
Create a new `AWS::AppIntegrations::EventIntegration`.
Types ¶
type CfnDataIntegration ¶
type CfnDataIntegration interface {
awscdk.CfnResource
awscdk.IInspectable
AttrDataIntegrationArn() *string
AttrId() *string
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
Description() *string
SetDescription(val *string)
KmsKey() *string
SetKmsKey(val *string)
LogicalId() *string
Name() *string
SetName(val *string)
Node() awscdk.ConstructNode
Ref() *string
ScheduleConfig() interface{}
SetScheduleConfig(val interface{})
SourceUri() *string
SetSourceUri(val *string)
Stack() awscdk.Stack
Tags() awscdk.TagManager
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OnPrepare()
OnSynthesize(session constructs.ISynthesisSession)
OnValidate() *[]*string
OverrideLogicalId(newLogicalId *string)
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
Synthesize(session awscdk.ISynthesisSession)
ToString() *string
Validate() *[]*string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::AppIntegrations::DataIntegration`.
Creates and persists a DataIntegration resource.
TODO: EXAMPLE
func NewCfnDataIntegration ¶
func NewCfnDataIntegration(scope awscdk.Construct, id *string, props *CfnDataIntegrationProps) CfnDataIntegration
Create a new `AWS::AppIntegrations::DataIntegration`.
type CfnDataIntegrationProps ¶
type CfnDataIntegrationProps struct {
// The KMS key for the DataIntegration.
KmsKey *string `json:"kmsKey" yaml:"kmsKey"`
// The name of the DataIntegration.
Name *string `json:"name" yaml:"name"`
// The name of the data and how often it should be pulled from the source.
ScheduleConfig interface{} `json:"scheduleConfig" yaml:"scheduleConfig"`
// The URI of the data source.
SourceUri *string `json:"sourceUri" yaml:"sourceUri"`
// A description of the DataIntegration.
Description *string `json:"description" yaml:"description"`
// An array of key-value pairs to apply to this resource.
//
// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}
Properties for defining a `CfnDataIntegration`.
TODO: EXAMPLE
type CfnDataIntegration_ScheduleConfigProperty ¶
type CfnDataIntegration_ScheduleConfigProperty struct {
// The start date for objects to import in the first flow run as an Unix/epoch timestamp in milliseconds or in ISO-8601 format.
FirstExecutionFrom *string `json:"firstExecutionFrom" yaml:"firstExecutionFrom"`
// The name of the object to pull from the data source.
Object *string `json:"object" yaml:"object"`
// How often the data should be pulled from data source.
ScheduleExpression *string `json:"scheduleExpression" yaml:"scheduleExpression"`
}
The name of the data and how often it should be pulled from the source.
TODO: EXAMPLE
type CfnEventIntegration ¶
type CfnEventIntegration interface {
awscdk.CfnResource
awscdk.IInspectable
AttrAssociations() awscdk.IResolvable
AttrEventIntegrationArn() *string
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
Description() *string
SetDescription(val *string)
EventBridgeBus() *string
SetEventBridgeBus(val *string)
EventFilter() interface{}
SetEventFilter(val interface{})
LogicalId() *string
Name() *string
SetName(val *string)
Node() awscdk.ConstructNode
Ref() *string
Stack() awscdk.Stack
Tags() awscdk.TagManager
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OnPrepare()
OnSynthesize(session constructs.ISynthesisSession)
OnValidate() *[]*string
OverrideLogicalId(newLogicalId *string)
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
Synthesize(session awscdk.ISynthesisSession)
ToString() *string
Validate() *[]*string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::AppIntegrations::EventIntegration`.
Creates an event integration. You provide a name, description, and a reference to an Amazon EventBridge bus in your account and a partner event source that will push events to that bus. No objects are created in your account, only metadata that is persisted on the EventIntegration control plane.
TODO: EXAMPLE
func NewCfnEventIntegration ¶
func NewCfnEventIntegration(scope awscdk.Construct, id *string, props *CfnEventIntegrationProps) CfnEventIntegration
Create a new `AWS::AppIntegrations::EventIntegration`.
type CfnEventIntegrationProps ¶
type CfnEventIntegrationProps struct {
// The Amazon EventBridge bus for the event integration.
EventBridgeBus *string `json:"eventBridgeBus" yaml:"eventBridgeBus"`
// The event integration filter.
EventFilter interface{} `json:"eventFilter" yaml:"eventFilter"`
// The name of the event integration.
Name *string `json:"name" yaml:"name"`
// The event integration description.
Description *string `json:"description" yaml:"description"`
// An array of key-value pairs to apply to this resource.
//
// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}
Properties for defining a `CfnEventIntegration`.
TODO: EXAMPLE
type CfnEventIntegration_EventFilterProperty ¶
type CfnEventIntegration_EventFilterProperty struct {
// The source of the events.
Source *string `json:"source" yaml:"source"`
}
The event integration filter.
TODO: EXAMPLE
type CfnEventIntegration_EventIntegrationAssociationProperty ¶
type CfnEventIntegration_EventIntegrationAssociationProperty struct {
// The metadata associated with the client.
ClientAssociationMetadata interface{} `json:"clientAssociationMetadata" yaml:"clientAssociationMetadata"`
// The identifier for the client that is associated with the event integration.
ClientId *string `json:"clientId" yaml:"clientId"`
// The name of the EventBridge rule.
EventBridgeRuleName *string `json:"eventBridgeRuleName" yaml:"eventBridgeRuleName"`
// The Amazon Resource Name (ARN) for the event integration association.
EventIntegrationAssociationArn *string `json:"eventIntegrationAssociationArn" yaml:"eventIntegrationAssociationArn"`
// The identifier for the event integration association.
EventIntegrationAssociationId *string `json:"eventIntegrationAssociationId" yaml:"eventIntegrationAssociationId"`
}
The event integration association.
TODO: EXAMPLE
type CfnEventIntegration_MetadataProperty ¶
type CfnEventIntegration_MetadataProperty struct {
// The key name.
Key *string `json:"key" yaml:"key"`
// The value.
Value *string `json:"value" yaml:"value"`
}
The metadata associated with the client.
TODO: EXAMPLE