software.amazon.awscdk.alexa.ask

Interface CfnSkill.SkillPackageProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSkill.SkillPackageProperty.Jsii$Proxy

Enclosing class:

CfnSkill

@Stability(value=Stable)
public static interface CfnSkill.SkillPackageProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.alexa.ask.*;
 Object manifest;
 SkillPackageProperty skillPackageProperty = SkillPackageProperty.builder()
         .s3Bucket("s3Bucket")
         .s3Key("s3Key")
         // the properties below are optional
         .overrides(OverridesProperty.builder()
                 .manifest(manifest)
                 .build())
         .s3BucketRole("s3BucketRole")
         .s3ObjectVersion("s3ObjectVersion")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnSkill.SkillPackageProperty.Builder A builder for CfnSkill.SkillPackageProperty
static class	CfnSkill.SkillPackageProperty.Jsii$Proxy An implementation for CfnSkill.SkillPackageProperty

Method Summary

Modifier and Type	Method and Description
static CfnSkill.SkillPackageProperty.Builder	builder()
default Object	getOverrides() Overrides to the skill package to apply when creating or updating the skill.
String	getS3Bucket() The name of the Amazon S3 bucket where the .zip file that contains the skill package is stored.
default String	getS3BucketRole() ARN of the IAM role that grants the Alexa service ( `alexa-appkit.amazon.com` ) permission to access the bucket and retrieve the skill package.
String	getS3Key() The location and name of the skill package .zip file.
default String	getS3ObjectVersion() If you have S3 versioning enabled, the version ID of the skill package.zip file.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getS3Bucket

@Stability(value=Stable)
 @NotNull
String getS3Bucket()

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

getS3Key

@Stability(value=Stable)
 @NotNull
String getS3Key()

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

getOverrides

@Stability(value=Stable)
 @Nullable
default Object getOverrides()

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.

getS3BucketRole

@Stability(value=Stable)
 @Nullable
default String getS3BucketRole()

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, AWS CloudFormation cannot create the skill.

getS3ObjectVersion

@Stability(value=Stable)
 @Nullable
default String getS3ObjectVersion()

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

builder

@Stability(value=Stable)
static CfnSkill.SkillPackageProperty.Builder builder()

Returns:

a CfnSkill.SkillPackageProperty.Builder of CfnSkill.SkillPackageProperty