Package 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(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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnSkill.SkillPackageProperty
static final class
An implementation forCfnSkill.SkillPackageProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
Overrides to the skill package to apply when creating or updating the skill.The name of the Amazon S3 bucket where the .zip file that contains the skill package is stored.default String
ARN of the IAM role that grants the Alexa service (alexa-appkit.amazon.com
) permission to access the bucket and retrieve the skill package.getS3Key()
The location and name of the skill package .zip file.default String
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 Details
-
getS3Bucket
The name of the Amazon S3 bucket where the .zip file that contains the skill package is stored.- See Also:
-
getS3Key
The location and name of the skill package .zip file.- See Also:
-
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.
- See Also:
-
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.- See Also:
-
getS3ObjectVersion
If you have S3 versioning enabled, the version ID of the skill package.zip file.- See Also:
-
builder
-