CfnUsageProfilePropsMixin

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

Bases: Mixin

Creates an AWS Glue usage profile.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-usageprofile.html
CloudformationResource:: AWS::Glue::UsageProfile
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_usage_profile_props_mixin = glue_mixins.CfnUsageProfilePropsMixin(glue_mixins.CfnUsageProfileMixinProps(
    configuration=glue_mixins.CfnUsageProfilePropsMixin.ProfileConfigurationProperty(
        job_configuration={
            "job_configuration_key": glue_mixins.CfnUsageProfilePropsMixin.ConfigurationObjectProperty(
                allowed_values=["allowedValues"],
                default_value="defaultValue",
                max_value="maxValue",
                min_value="minValue"
            )
        },
        session_configuration={
            "session_configuration_key": glue_mixins.CfnUsageProfilePropsMixin.ConfigurationObjectProperty(
                allowed_values=["allowedValues"],
                default_value="defaultValue",
                max_value="maxValue",
                min_value="minValue"
            )
        }
    ),
    description="description",
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnUsageProfileMixinProps, 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 = ['configuration', 'description', '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

ConfigurationObjectProperty

class CfnUsageProfilePropsMixin.ConfigurationObjectProperty(*, allowed_values=None, default_value=None, max_value=None, min_value=None)

Bases: object

Specifies the values that an admin sets for each job or session parameter configured in a AWS Glue usage profile.

Parameters:

allowed_values (Optional[Sequence[str]]) – A list of allowed values for the parameter.
default_value (Optional[str]) – A default value for the parameter.
max_value (Optional[str]) – A maximum allowed value for the parameter.
min_value (Optional[str]) – A minimum allowed value for the parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-usageprofile-configurationobject.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

configuration_object_property = glue_mixins.CfnUsageProfilePropsMixin.ConfigurationObjectProperty(
    allowed_values=["allowedValues"],
    default_value="defaultValue",
    max_value="maxValue",
    min_value="minValue"
)

Attributes

allowed_values

A list of allowed values for the parameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-usageprofile-configurationobject.html#cfn-glue-usageprofile-configurationobject-allowedvalues

default_value

A default value for the parameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-usageprofile-configurationobject.html#cfn-glue-usageprofile-configurationobject-defaultvalue

max_value

A maximum allowed value for the parameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-usageprofile-configurationobject.html#cfn-glue-usageprofile-configurationobject-maxvalue

min_value

A minimum allowed value for the parameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-usageprofile-configurationobject.html#cfn-glue-usageprofile-configurationobject-minvalue

ProfileConfigurationProperty

class CfnUsageProfilePropsMixin.ProfileConfigurationProperty(*, job_configuration=None, session_configuration=None)

Bases: object

Specifies the job and session values that an admin configures in an AWS Glue usage profile.

Parameters:

job_configuration (Union[IResolvable, Mapping[str, Union[IResolvable, ConfigurationObjectProperty, Dict[str, Any]]], None]) – A key-value map of configuration parameters for AWS Glue jobs.
session_configuration (Union[IResolvable, Mapping[str, Union[IResolvable, ConfigurationObjectProperty, Dict[str, Any]]], None]) – A key-value map of configuration parameters for AWS Glue sessions.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-usageprofile-profileconfiguration.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

profile_configuration_property = glue_mixins.CfnUsageProfilePropsMixin.ProfileConfigurationProperty(
    job_configuration={
        "job_configuration_key": glue_mixins.CfnUsageProfilePropsMixin.ConfigurationObjectProperty(
            allowed_values=["allowedValues"],
            default_value="defaultValue",
            max_value="maxValue",
            min_value="minValue"
        )
    },
    session_configuration={
        "session_configuration_key": glue_mixins.CfnUsageProfilePropsMixin.ConfigurationObjectProperty(
            allowed_values=["allowedValues"],
            default_value="defaultValue",
            max_value="maxValue",
            min_value="minValue"
        )
    }
)

Attributes

job_configuration

A key-value map of configuration parameters for AWS Glue jobs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-usageprofile-profileconfiguration.html#cfn-glue-usageprofile-profileconfiguration-jobconfiguration

session_configuration

A key-value map of configuration parameters for AWS Glue sessions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-usageprofile-profileconfiguration.html#cfn-glue-usageprofile-profileconfiguration-sessionconfiguration