CfnCustomPluginPropsMixin

class aws_cdk.mixins_preview.aws_kafkaconnect.mixins.CfnCustomPluginPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a custom plugin using the specified properties.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-customplugin.html
CloudformationResource:: AWS::KafkaConnect::CustomPlugin
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_kafkaconnect import mixins as kafkaconnect_mixins

cfn_custom_plugin_props_mixin = kafkaconnect_mixins.CfnCustomPluginPropsMixin(kafkaconnect_mixins.CfnCustomPluginMixinProps(
    content_type="contentType",
    description="description",
    location=kafkaconnect_mixins.CfnCustomPluginPropsMixin.CustomPluginLocationProperty(
        s3_location=kafkaconnect_mixins.CfnCustomPluginPropsMixin.S3LocationProperty(
            bucket_arn="bucketArn",
            file_key="fileKey",
            object_version="objectVersion"
        )
    ),
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::KafkaConnect::CustomPlugin.

Parameters:

props (Union[CfnCustomPluginMixinProps, 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 = ['contentType', 'description', 'location', 'name', 'tags']

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

CustomPluginFileDescriptionProperty

class CfnCustomPluginPropsMixin.CustomPluginFileDescriptionProperty(*, file_md5=None, file_size=None)

Bases: object

Details about a custom plugin file.

Parameters:

file_md5 (Optional[str]) – The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file.
file_size (Union[int, float, None]) – The size in bytes of the custom plugin file. You can use it to validate the file.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-customplugin-custompluginfiledescription.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_kafkaconnect import mixins as kafkaconnect_mixins

custom_plugin_file_description_property = kafkaconnect_mixins.CfnCustomPluginPropsMixin.CustomPluginFileDescriptionProperty(
    file_md5="fileMd5",
    file_size=123
)

Attributes

file_md5

The hex-encoded MD5 checksum of the custom plugin file.

You can use it to validate the file.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-customplugin-custompluginfiledescription.html#cfn-kafkaconnect-customplugin-custompluginfiledescription-filemd5

file_size

The size in bytes of the custom plugin file.

You can use it to validate the file.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-customplugin-custompluginfiledescription.html#cfn-kafkaconnect-customplugin-custompluginfiledescription-filesize

CustomPluginLocationProperty

class CfnCustomPluginPropsMixin.CustomPluginLocationProperty(*, s3_location=None)

Bases: object

Information about the location of a custom plugin.

Parameters:: s3_location (Union[IResolvable, S3LocationProperty, Dict[str, Any], None]) – The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-customplugin-custompluginlocation.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_kafkaconnect import mixins as kafkaconnect_mixins

custom_plugin_location_property = kafkaconnect_mixins.CfnCustomPluginPropsMixin.CustomPluginLocationProperty(
    s3_location=kafkaconnect_mixins.CfnCustomPluginPropsMixin.S3LocationProperty(
        bucket_arn="bucketArn",
        file_key="fileKey",
        object_version="objectVersion"
    )
)

Attributes

s3_location

The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-customplugin-custompluginlocation.html#cfn-kafkaconnect-customplugin-custompluginlocation-s3location

S3LocationProperty

class CfnCustomPluginPropsMixin.S3LocationProperty(*, bucket_arn=None, file_key=None, object_version=None)

Bases: object

The location of an object in Amazon S3.

Parameters:

bucket_arn (Optional[str]) – The Amazon Resource Name (ARN) of an S3 bucket.
file_key (Optional[str]) – The file key for an object in an S3 bucket.
object_version (Optional[str]) – The version of an object in an S3 bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-customplugin-s3location.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_kafkaconnect import mixins as kafkaconnect_mixins

s3_location_property = kafkaconnect_mixins.CfnCustomPluginPropsMixin.S3LocationProperty(
    bucket_arn="bucketArn",
    file_key="fileKey",
    object_version="objectVersion"
)

Attributes

bucket_arn

The Amazon Resource Name (ARN) of an S3 bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-customplugin-s3location.html#cfn-kafkaconnect-customplugin-s3location-bucketarn

file_key

The file key for an object in an S3 bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-customplugin-s3location.html#cfn-kafkaconnect-customplugin-s3location-filekey

object_version

The version of an object in an S3 bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-customplugin-s3location.html#cfn-kafkaconnect-customplugin-s3location-objectversion