alexaask

Documentation

Index

• func CfnSkill_CFN_RESOURCE_TYPE_NAME() *string
• func CfnSkill_IsCfnElement(x interface{}) *bool
• func CfnSkill_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnSkill_IsConstruct(x interface{}) *bool
• func NewCfnSkill_Override(c CfnSkill, scope constructs.Construct, id *string, props *CfnSkillProps)
• type CfnSkill
  • func NewCfnSkill(scope constructs.Construct, id *string, props *CfnSkillProps) CfnSkill
• type CfnSkillProps
• type CfnSkill_AuthenticationConfigurationProperty
• type CfnSkill_OverridesProperty
• type CfnSkill_SkillPackageProperty

Functions

func CfnSkill_CFN_RESOURCE_TYPE_NAME

func CfnSkill_CFN_RESOURCE_TYPE_NAME() *string

func CfnSkill_IsCfnElement

func CfnSkill_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnSkill_IsCfnResource

func CfnSkill_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnSkill_IsConstruct

func CfnSkill_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.

func NewCfnSkill_Override

func NewCfnSkill_Override(c CfnSkill, scope constructs.Construct, id *string, props *CfnSkillProps)

Create a new `Alexa::ASK::Skill`.

Types

type CfnSkill

type CfnSkill interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// `Alexa::ASK::Skill.AuthenticationConfiguration`.
	AuthenticationConfiguration() interface{}
	SetAuthenticationConfiguration(val interface{})
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	// The logical ID for this CloudFormation stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The tree node.
	Node() constructs.Node
	// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// `Alexa::ASK::Skill.SkillPackage`.
	SkillPackage() interface{}
	SetSkillPackage(val interface{})
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	Stack() awscdk.Stack
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	// `Alexa::ASK::Skill.VendorId`.
	VendorId() *string
	SetVendorId(val *string)
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// To include a literal `.` in the property name, prefix with a `\`. In most
	// programming languages you will need to write this as `"\\."` because the
	// `\` itself will need to be escaped.
	//
	// For example,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`
	//
	// The `value` argument to `addOverride` will not be processed or translated
	// in any way. Pass raw JSON values in here with the correct capitalization
	// for CloudFormation. If you pass CDK classes or structs, they will be
	// rendered with lowercased key names, and CloudFormation will reject the
	// template.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// The Removal Policy controls what happens to this resource when it stops
	// being managed by CloudFormation, either because you've removed it from the
	// CDK application or because you've made a change that requires the resource
	// to be replaced.
	//
	// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
	// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	ShouldSynthesize() *bool
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `Alexa::ASK::Skill`.

Example:

import awscdk "github.com/aws/aws-cdk-go/awscdk"import alexa_ask "github.com/aws/aws-cdk-go/awscdk/alexa_ask"

var manifest interface{}
cfnSkill := alexa_ask.NewCfnSkill(this, jsii.String("MyCfnSkill"), &cfnSkillProps{
	authenticationConfiguration: &authenticationConfigurationProperty{
		clientId: jsii.String("clientId"),
		clientSecret: jsii.String("clientSecret"),
		refreshToken: jsii.String("refreshToken"),
	},
	skillPackage: &skillPackageProperty{
		s3Bucket: jsii.String("s3Bucket"),
		s3Key: jsii.String("s3Key"),

		// the properties below are optional
		overrides: &overridesProperty{
			manifest: manifest,
		},
		s3BucketRole: jsii.String("s3BucketRole"),
		s3ObjectVersion: jsii.String("s3ObjectVersion"),
	},
	vendorId: jsii.String("vendorId"),
})

func NewCfnSkill

func NewCfnSkill(scope constructs.Construct, id *string, props *CfnSkillProps) CfnSkill

Create a new `Alexa::ASK::Skill`.

type CfnSkillProps

type CfnSkillProps struct {
	// `Alexa::ASK::Skill.AuthenticationConfiguration`.
	AuthenticationConfiguration interface{} `json:"authenticationConfiguration" yaml:"authenticationConfiguration"`
	// `Alexa::ASK::Skill.SkillPackage`.
	SkillPackage interface{} `json:"skillPackage" yaml:"skillPackage"`
	// `Alexa::ASK::Skill.VendorId`.
	VendorId *string `json:"vendorId" yaml:"vendorId"`
}

Properties for defining a `CfnSkill`.

Example:

import awscdk "github.com/aws/aws-cdk-go/awscdk"import alexa_ask "github.com/aws/aws-cdk-go/awscdk/alexa_ask"

var manifest interface{}
cfnSkillProps := &cfnSkillProps{
	authenticationConfiguration: &authenticationConfigurationProperty{
		clientId: jsii.String("clientId"),
		clientSecret: jsii.String("clientSecret"),
		refreshToken: jsii.String("refreshToken"),
	},
	skillPackage: &skillPackageProperty{
		s3Bucket: jsii.String("s3Bucket"),
		s3Key: jsii.String("s3Key"),

		// the properties below are optional
		overrides: &overridesProperty{
			manifest: manifest,
		},
		s3BucketRole: jsii.String("s3BucketRole"),
		s3ObjectVersion: jsii.String("s3ObjectVersion"),
	},
	vendorId: jsii.String("vendorId"),
}

type CfnSkill_AuthenticationConfigurationProperty

type CfnSkill_AuthenticationConfigurationProperty struct {
	// `CfnSkill.AuthenticationConfigurationProperty.ClientId`.
	ClientId *string `json:"clientId" yaml:"clientId"`
	// `CfnSkill.AuthenticationConfigurationProperty.ClientSecret`.
	ClientSecret *string `json:"clientSecret" yaml:"clientSecret"`
	// `CfnSkill.AuthenticationConfigurationProperty.RefreshToken`.
	RefreshToken *string `json:"refreshToken" yaml:"refreshToken"`
}

Example:

import awscdk "github.com/aws/aws-cdk-go/awscdk"import alexa_ask "github.com/aws/aws-cdk-go/awscdk/alexa_ask"
authenticationConfigurationProperty := &authenticationConfigurationProperty{
	clientId: jsii.String("clientId"),
	clientSecret: jsii.String("clientSecret"),
	refreshToken: jsii.String("refreshToken"),
}

type CfnSkill_OverridesProperty

type CfnSkill_OverridesProperty struct {
	// `CfnSkill.OverridesProperty.Manifest`.
	Manifest interface{} `json:"manifest" yaml:"manifest"`
}

Example:

import awscdk "github.com/aws/aws-cdk-go/awscdk"import alexa_ask "github.com/aws/aws-cdk-go/awscdk/alexa_ask"

var manifest interface{}
overridesProperty := &overridesProperty{
	manifest: manifest,
}

type CfnSkill_SkillPackageProperty

type CfnSkill_SkillPackageProperty struct {
	// `CfnSkill.SkillPackageProperty.S3Bucket`.
	S3Bucket *string `json:"s3Bucket" yaml:"s3Bucket"`
	// `CfnSkill.SkillPackageProperty.S3Key`.
	S3Key *string `json:"s3Key" yaml:"s3Key"`
	// `CfnSkill.SkillPackageProperty.Overrides`.
	Overrides interface{} `json:"overrides" yaml:"overrides"`
	// `CfnSkill.SkillPackageProperty.S3BucketRole`.
	S3BucketRole *string `json:"s3BucketRole" yaml:"s3BucketRole"`
	// `CfnSkill.SkillPackageProperty.S3ObjectVersion`.
	S3ObjectVersion *string `json:"s3ObjectVersion" yaml:"s3ObjectVersion"`
}

Example:

import awscdk "github.com/aws/aws-cdk-go/awscdk"import alexa_ask "github.com/aws/aws-cdk-go/awscdk/alexa_ask"

var manifest interface{}
skillPackageProperty := &skillPackageProperty{
	s3Bucket: jsii.String("s3Bucket"),
	s3Key: jsii.String("s3Key"),

	// the properties below are optional
	overrides: &overridesProperty{
		manifest: manifest,
	},
	s3BucketRole: jsii.String("s3BucketRole"),
	s3ObjectVersion: jsii.String("s3ObjectVersion"),
}