CfnSkillPropsMixin

class aws_cdk.mixins_preview.alexa_ask.mixins.CfnSkillPropsMixin(props, *, strategy=None)

Bases: Mixin

The Alexa::ASK::Skill resource creates an Alexa skill that enables customers to access new abilities.

For more information about developing a skill, see the .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ask-skill.html
CloudformationResource:: Alexa::ASK::Skill
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.alexa_ask import mixins as alexa_ask_mixins

# manifest: Any

cfn_skill_props_mixin = alexa_ask_mixins.CfnSkillPropsMixin(alexa_ask_mixins.CfnSkillMixinProps(
    authentication_configuration=alexa_ask_mixins.CfnSkillPropsMixin.AuthenticationConfigurationProperty(
        client_id="clientId",
        client_secret="clientSecret",
        refresh_token="refreshToken"
    ),
    skill_package=alexa_ask_mixins.CfnSkillPropsMixin.SkillPackageProperty(
        overrides=alexa_ask_mixins.CfnSkillPropsMixin.OverridesProperty(
            manifest=manifest
        ),
        s3_bucket="s3Bucket",
        s3_bucket_role="s3BucketRole",
        s3_key="s3Key",
        s3_object_version="s3ObjectVersion"
    ),
    vendor_id="vendorId"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to Alexa::ASK::Skill.

Parameters:

props (Union[CfnSkillMixinProps, 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 = ['authenticationConfiguration', 'skillPackage', 'vendorId']

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

AuthenticationConfigurationProperty

class CfnSkillPropsMixin.AuthenticationConfigurationProperty(*, client_id=None, client_secret=None, refresh_token=None)

Bases: object

The AuthenticationConfiguration property type specifies the Login with Amazon (LWA) configuration used to authenticate with the Alexa service.

Only Login with Amazon security profiles created through the are supported for authentication. A client ID, client secret, and refresh token are required. You can generate a client ID and client secret by creating a new on the Amazon Developer Portal or you can retrieve them from an existing profile. You can then retrieve the refresh token using the Alexa Skills Kit CLI. For instructions, see in the .

AuthenticationConfiguration is a property of the Alexa::ASK::Skill resource.

Parameters:

client_id (Optional[str]) – Client ID from Login with Amazon (LWA).
client_secret (Optional[str]) – Client secret from Login with Amazon (LWA).
refresh_token (Optional[str]) – Refresh token from Login with Amazon (LWA). This token is secret.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-authenticationconfiguration.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.alexa_ask import mixins as alexa_ask_mixins

authentication_configuration_property = alexa_ask_mixins.CfnSkillPropsMixin.AuthenticationConfigurationProperty(
    client_id="clientId",
    client_secret="clientSecret",
    refresh_token="refreshToken"
)

Attributes

client_id

Client ID from Login with Amazon (LWA).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-authenticationconfiguration.html#cfn-ask-skill-authenticationconfiguration-clientid

client_secret

Client secret from Login with Amazon (LWA).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-authenticationconfiguration.html#cfn-ask-skill-authenticationconfiguration-clientsecret

refresh_token

Refresh token from Login with Amazon (LWA).

This token is secret.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-authenticationconfiguration.html#cfn-ask-skill-authenticationconfiguration-refreshtoken

OverridesProperty

class CfnSkillPropsMixin.OverridesProperty(*, manifest=None)

Bases: object

The Overrides property type provides overrides to the skill package to apply when creating or updating the skill.

Values provided here do not modify the contents of the original skill package. Currently, only overriding values inside of the skill manifest component of the package is supported.

Overrides is a property of the Alexa::ASK::Skill SkillPackage property type.

Parameters:: manifest (Any) – Overrides to apply to the skill manifest inside of the skill package. The skill manifest contains metadata about the skill. For more information, see .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-overrides.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.alexa_ask import mixins as alexa_ask_mixins

# manifest: Any

overrides_property = alexa_ask_mixins.CfnSkillPropsMixin.OverridesProperty(
    manifest=manifest
)

Attributes

manifest

Overrides to apply to the skill manifest inside of the skill package.

The skill manifest contains metadata about the skill. For more information, see .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-overrides.html#cfn-ask-skill-overrides-manifest

SkillPackageProperty

class CfnSkillPropsMixin.SkillPackageProperty(*, overrides=None, s3_bucket=None, s3_bucket_role=None, s3_key=None, s3_object_version=None)

Bases: object

The SkillPackage property type contains configuration details for the skill package that contains the components of the Alexa skill.

Skill packages are retrieved from an Amazon S3 bucket and key and used to create and update the skill. More details about the skill package format are located in the .

SkillPackage is a property of the Alexa::ASK::Skill resource.

Parameters:

overrides (Union[IResolvable, OverridesProperty, Dict[str, Any], None]) – Overrides to the skill package to apply when creating or updating the skill. Values provided here do not modify the contents of the original skill package. Currently, only overriding values inside of the skill manifest component of the package is supported.
s3_bucket (Optional[str]) – The name of the Amazon S3 bucket where the .zip file that contains the skill package is stored.
s3_bucket_role (Optional[str]) – ARN of the IAM role that grants the Alexa service ( alexa-appkit.amazon.com ) permission to access the bucket and retrieve the skill package. This property is optional. If you do not provide it, the bucket must be publicly accessible or configured with a policy that allows this access. Otherwise, CloudFormation cannot create the skill.
s3_key (Optional[str]) – The location and name of the skill package .zip file.
s3_object_version (Optional[str]) – If you have S3 versioning enabled, the version ID of the skill package.zip file.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-skillpackage.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.alexa_ask import mixins as alexa_ask_mixins

# manifest: Any

skill_package_property = alexa_ask_mixins.CfnSkillPropsMixin.SkillPackageProperty(
    overrides=alexa_ask_mixins.CfnSkillPropsMixin.OverridesProperty(
        manifest=manifest
    ),
    s3_bucket="s3Bucket",
    s3_bucket_role="s3BucketRole",
    s3_key="s3Key",
    s3_object_version="s3ObjectVersion"
)

Attributes

overrides

Overrides to the skill package to apply when creating or updating the skill.

Values provided here do not modify the contents of the original skill package. Currently, only overriding values inside of the skill manifest component of the package is supported.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-skillpackage.html#cfn-ask-skill-skillpackage-overrides

s3_bucket

The name of the Amazon S3 bucket where the .zip file that contains the skill package is stored.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-skillpackage.html#cfn-ask-skill-skillpackage-s3bucket

s3_bucket_role

ARN of the IAM role that grants the Alexa service ( alexa-appkit.amazon.com ) permission to access the bucket and retrieve the skill package. This property is optional. If you do not provide it, the bucket must be publicly accessible or configured with a policy that allows this access. Otherwise, CloudFormation cannot create the skill.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-skillpackage.html#cfn-ask-skill-skillpackage-s3bucketrole

s3_key

The location and name of the skill package .zip file.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-skillpackage.html#cfn-ask-skill-skillpackage-s3key

s3_object_version

If you have S3 versioning enabled, the version ID of the skill package.zip file.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-skillpackage.html#cfn-ask-skill-skillpackage-s3objectversion