CfnDatasetPropsMixin

class aws_cdk.cfn_property_mixins.aws_bedrockagentcore.CfnDatasetPropsMixin(props, *, strategy=None)

Bases: Mixin

Definition of AWS::BedrockAgentCore::Dataset Resource Type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-dataset.html
CloudformationResource:: AWS::BedrockAgentCore::Dataset
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.cfn_property_mixins import aws_bedrockagentcore as bedrockagentcore
import aws_cdk as cdk

# examples: Any
# merge_strategy: cdk.IMergeStrategy

cfn_dataset_props_mixin = bedrockagentcore.CfnDatasetPropsMixin(bedrockagentcore.CfnDatasetMixinProps(
    dataset_name="datasetName",
    description="description",
    kms_key_arn="kmsKeyArn",
    schema_type="schemaType",
    source=bedrockagentcore.CfnDatasetPropsMixin.DataSourceTypeProperty(
        inline_examples=bedrockagentcore.CfnDatasetPropsMixin.InlineExamplesSourceProperty(
            examples=[examples]
        ),
        s3_source=bedrockagentcore.CfnDatasetPropsMixin.S3SourceProperty(
            s3_uri="s3Uri"
        )
    ),
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::BedrockAgentCore::Dataset.

Parameters:

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

Methods

apply_to(construct)

Apply the mixin properties to the construct.

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

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

CFN_PROPERTY_KEYS = ['datasetName', 'description', 'kmsKeyArn', 'schemaType', 'source', 'tags']

Static Methods

classmethod is_mixin(x)

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.

DataSourceTypeProperty

class CfnDatasetPropsMixin.DataSourceTypeProperty(*, inline_examples=None, s3_source=None)

Bases: object

Source of initial examples.

Provide either inline examples or an S3 URI pointing to a JSONL file.

Parameters:

inline_examples (Union[IResolvable, InlineExamplesSourceProperty, Dict[str, Any], None]) – Inline examples provided directly in the request body.
s3_source (Union[IResolvable, S3SourceProperty, Dict[str, Any], None]) – S3 location of a JSONL file containing dataset examples.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-dataset-datasourcetype.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.cfn_property_mixins import aws_bedrockagentcore as bedrockagentcore

# examples: Any

data_source_type_property = bedrockagentcore.CfnDatasetPropsMixin.DataSourceTypeProperty(
    inline_examples=bedrockagentcore.CfnDatasetPropsMixin.InlineExamplesSourceProperty(
        examples=[examples]
    ),
    s3_source=bedrockagentcore.CfnDatasetPropsMixin.S3SourceProperty(
        s3_uri="s3Uri"
    )
)

Attributes

inline_examples

Inline examples provided directly in the request body.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-dataset-datasourcetype.html#cfn-bedrockagentcore-dataset-datasourcetype-inlineexamples

s3_source

S3 location of a JSONL file containing dataset examples.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-dataset-datasourcetype.html#cfn-bedrockagentcore-dataset-datasourcetype-s3source

InlineExamplesSourceProperty

class CfnDatasetPropsMixin.InlineExamplesSourceProperty(*, examples=None)

Bases: object

Inline examples provided directly in the request body.

Parameters:: examples (Union[Sequence[Any], IResolvable, None]) – Examples to add. Each example is a free-form JSON document validated against the declared schemaType.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-dataset-inlineexamplessource.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.cfn_property_mixins import aws_bedrockagentcore as bedrockagentcore

# examples: Any

inline_examples_source_property = bedrockagentcore.CfnDatasetPropsMixin.InlineExamplesSourceProperty(
    examples=[examples]
)

Attributes

examples

Examples to add.

Each example is a free-form JSON document validated against the declared schemaType.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-dataset-inlineexamplessource.html#cfn-bedrockagentcore-dataset-inlineexamplessource-examples

S3SourceProperty

class CfnDatasetPropsMixin.S3SourceProperty(*, s3_uri=None)

Bases: object

S3 location of a JSONL file containing dataset examples.

Parameters:: s3_uri (Optional[str]) – S3 URI of the JSONL file (e.g. s3://my-bucket/path/to/examples.jsonl).
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-dataset-s3source.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.cfn_property_mixins import aws_bedrockagentcore as bedrockagentcore

s3_source_property = bedrockagentcore.CfnDatasetPropsMixin.S3SourceProperty(
    s3_uri="s3Uri"
)

Attributes

s3_uri

//my-bucket/path/to/examples.jsonl).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-dataset-s3source.html#cfn-bedrockagentcore-dataset-s3source-s3uri
Type:: S3 URI of the JSONL file (e.g. s3