CfnIntegrationResourcePropertyPropsMixin

class aws_cdk.mixins_preview.aws_glue.mixins.CfnIntegrationResourcePropertyPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::Glue::IntegrationResourceProperty resource type can be used to setup ResourceProperty of the AWS Glue connection (for the SaaS source), DynamoDB Database (for DynamoDB source), or AWS Glue database ARN (for the target).

ResourceProperty is used to define the properties requires to setup the integration, including the role to access the connection or database, KMS keys, event bus for event notifications and VPC connection. To set both source and target properties the same API needs to be invoked twice, once with the AWS Glue connection ARN as ResourceArn with SourceProcessingProperties and next, with the AWS Glue database ARN as ResourceArn with TargetProcessingProperties respectively.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-integrationresourceproperty.html
CloudformationResource:: AWS::Glue::IntegrationResourceProperty
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_glue import mixins as glue_mixins

cfn_integration_resource_property_props_mixin = glue_mixins.CfnIntegrationResourcePropertyPropsMixin(glue_mixins.CfnIntegrationResourcePropertyMixinProps(
    resource_arn="resourceArn",
    source_processing_properties=glue_mixins.CfnIntegrationResourcePropertyPropsMixin.SourceProcessingPropertiesProperty(
        role_arn="roleArn"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    target_processing_properties=glue_mixins.CfnIntegrationResourcePropertyPropsMixin.TargetProcessingPropertiesProperty(
        connection_name="connectionName",
        event_bus_arn="eventBusArn",
        kms_arn="kmsArn",
        role_arn="roleArn"
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Glue::IntegrationResourceProperty.

Parameters:

props (Union[CfnIntegrationResourcePropertyMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['resourceArn', 'sourceProcessingProperties', 'tags', 'targetProcessingProperties']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

SourceProcessingPropertiesProperty

class CfnIntegrationResourcePropertyPropsMixin.SourceProcessingPropertiesProperty(*, role_arn=None)

Bases: object

The structure used to define the resource properties associated with the integration source.

Parameters:: role_arn (Optional[str]) – The IAM role to access the AWS Glue connection.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-integrationresourceproperty-sourceprocessingproperties.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_glue import mixins as glue_mixins

source_processing_properties_property = glue_mixins.CfnIntegrationResourcePropertyPropsMixin.SourceProcessingPropertiesProperty(
    role_arn="roleArn"
)

Attributes

role_arn

The IAM role to access the AWS Glue connection.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-integrationresourceproperty-sourceprocessingproperties.html#cfn-glue-integrationresourceproperty-sourceprocessingproperties-rolearn

TargetProcessingPropertiesProperty

class CfnIntegrationResourcePropertyPropsMixin.TargetProcessingPropertiesProperty(*, connection_name=None, event_bus_arn=None, kms_arn=None, role_arn=None)

Bases: object

The structure used to define the resource properties associated with the integration target.

Parameters:

connection_name (Optional[str]) – The AWS Glue network connection to configure the AWS Glue job running in the customer VPC.
event_bus_arn (Optional[str]) – The ARN of an Eventbridge event bus to receive the integration status notification.
kms_arn (Optional[str]) – The ARN of the KMS key used for encryption.
role_arn (Optional[str]) – The IAM role to access the AWS Glue database.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-integrationresourceproperty-targetprocessingproperties.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_glue import mixins as glue_mixins

target_processing_properties_property = glue_mixins.CfnIntegrationResourcePropertyPropsMixin.TargetProcessingPropertiesProperty(
    connection_name="connectionName",
    event_bus_arn="eventBusArn",
    kms_arn="kmsArn",
    role_arn="roleArn"
)

Attributes

connection_name

The AWS Glue network connection to configure the AWS Glue job running in the customer VPC.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-integrationresourceproperty-targetprocessingproperties.html#cfn-glue-integrationresourceproperty-targetprocessingproperties-connectionname

event_bus_arn

The ARN of an Eventbridge event bus to receive the integration status notification.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-integrationresourceproperty-targetprocessingproperties.html#cfn-glue-integrationresourceproperty-targetprocessingproperties-eventbusarn

kms_arn

The ARN of the KMS key used for encryption.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-integrationresourceproperty-targetprocessingproperties.html#cfn-glue-integrationresourceproperty-targetprocessingproperties-kmsarn

role_arn

The IAM role to access the AWS Glue database.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-integrationresourceproperty-targetprocessingproperties.html#cfn-glue-integrationresourceproperty-targetprocessingproperties-rolearn