software.amazon.awscdk.alexa.ask

Class CfnSkill

java.lang.Object

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.126Z")
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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnSkill.AuthenticationConfigurationProperty The `AuthenticationConfiguration` property type specifies the Login with Amazon (LWA) configuration used to authenticate with the Alexa service.
static class	CfnSkill.Builder A fluent builder for CfnSkill.
static interface	CfnSkill.OverridesProperty The `Overrides` property type provides overrides to the skill package to apply when creating or updating the skill.
static interface	CfnSkill.SkillPackageProperty The `SkillPackage` property type contains configuration details for the skill package that contains the components of the Alexa skill.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSkill(Construct scope, java.lang.String id, CfnSkillProps props) Create a new `Alexa::ASK::Skill`.
protected	CfnSkill(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSkill(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getAuthenticationConfiguration() Login with Amazon (LWA) configuration used to authenticate with the Alexa service.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getSkillPackage() Configuration for the skill package that contains the components of the Alexa skill.
java.lang.String	getVendorId() The vendor ID associated with the Amazon developer account that will host the skill.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAuthenticationConfiguration(CfnSkill.AuthenticationConfigurationProperty value) Login with Amazon (LWA) configuration used to authenticate with the Alexa service.
void	setAuthenticationConfiguration(IResolvable value) Login with Amazon (LWA) configuration used to authenticate with the Alexa service.
void	setSkillPackage(CfnSkill.SkillPackageProperty value) Configuration for the skill package that contains the components of the Alexa skill.
void	setSkillPackage(IResolvable value) Configuration for the skill package that contains the components of the Alexa skill.
void	setVendorId(java.lang.String value) The vendor ID associated with the Amazon developer account that will host the skill.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnSkill

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

CfnSkill

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

CfnSkill

public CfnSkill(Construct scope,
                java.lang.String id,
                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 Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAuthenticationConfiguration

public java.lang.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

public void setAuthenticationConfiguration(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

public void setAuthenticationConfiguration(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

public java.lang.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

public void setSkillPackage(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

public void setSkillPackage(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

public java.lang.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

public void setVendorId(java.lang.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.