Package software.amazon.awscdk.alexa.ask

Class CfnSkill

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.alexa.ask.CfnSkill
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:55.206Z") @Stability(Stable) public class CfnSkill extends CfnResource implements IInspectable
A CloudFormation Alexa::ASK::Skill.

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 .

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;
 CfnSkill cfnSkill = CfnSkill.Builder.create(this, "MyCfnSkill")
         .authenticationConfiguration(AuthenticationConfigurationProperty.builder()
                 .clientId("clientId")
                 .clientSecret("clientSecret")
                 .refreshToken("refreshToken")
                 .build())
         .skillPackage(SkillPackageProperty.builder()
                 .s3Bucket("s3Bucket")
                 .s3Key("s3Key")
                 // the properties below are optional
                 .overrides(OverridesProperty.builder()
                         .manifest(manifest)
                         .build())
                 .s3BucketRole("s3BucketRole")
                 .s3ObjectVersion("s3ObjectVersion")
                 .build())
         .vendorId("vendorId")
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnSkill

      protected CfnSkill(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnSkill

      protected CfnSkill(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnSkill

      @Stability(Stable) public CfnSkill(@NotNull Construct scope, @NotNull String id, @NotNull CfnSkillProps props)
      Create a new Alexa::ASK::Skill.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getAuthenticationConfiguration

      @Stability(Stable) @NotNull public Object getAuthenticationConfiguration()
      Login with Amazon (LWA) configuration used to authenticate with the Alexa service.

      Only Login with Amazon clients created through the are supported. The client ID, client secret, and refresh token are required.

    • setAuthenticationConfiguration

      @Stability(Stable) public void setAuthenticationConfiguration(@NotNull CfnSkill.AuthenticationConfigurationProperty value)
      Login with Amazon (LWA) configuration used to authenticate with the Alexa service.

      Only Login with Amazon clients created through the are supported. The client ID, client secret, and refresh token are required.

    • setAuthenticationConfiguration

      @Stability(Stable) public void setAuthenticationConfiguration(@NotNull IResolvable value)
      Login with Amazon (LWA) configuration used to authenticate with the Alexa service.

      Only Login with Amazon clients created through the are supported. The client ID, client secret, and refresh token are required.

    • getSkillPackage

      @Stability(Stable) @NotNull public Object getSkillPackage()
      Configuration 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. For more information about the skill package format, see the .

    • setSkillPackage

      @Stability(Stable) public void setSkillPackage(@NotNull IResolvable value)
      Configuration 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. For more information about the skill package format, see the .

    • setSkillPackage

      @Stability(Stable) public void setSkillPackage(@NotNull CfnSkill.SkillPackageProperty value)
      Configuration 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. For more information about the skill package format, see the .

    • getVendorId

      @Stability(Stable) @NotNull public String getVendorId()
      The vendor ID associated with the Amazon developer account that will host the skill.

      Details for retrieving the vendor ID are in . The provided LWA credentials must be linked to the developer account associated with this vendor ID.

    • setVendorId

      @Stability(Stable) public void setVendorId(@NotNull String value)
      The vendor ID associated with the Amazon developer account that will host the skill.

      Details for retrieving the vendor ID are in . The provided LWA credentials must be linked to the developer account associated with this vendor ID.