awsiotfleethub

Documentation

Index

• func CfnApplication_CFN_RESOURCE_TYPE_NAME() *string
• func CfnApplication_IsCfnElement(x interface{}) *bool
• func CfnApplication_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnApplication_IsConstruct(x interface{}) *bool
• func NewCfnApplication_Override(c CfnApplication, scope constructs.Construct, id *string, ...)
• type CfnApplication
  • func NewCfnApplication(scope constructs.Construct, id *string, props *CfnApplicationProps) CfnApplication
• type CfnApplicationProps

Functions

func CfnApplication_CFN_RESOURCE_TYPE_NAME

func CfnApplication_CFN_RESOURCE_TYPE_NAME() *string

func CfnApplication_IsCfnElement

func CfnApplication_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 CfnApplication_IsCfnResource

func CfnApplication_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnApplication_IsConstruct

func CfnApplication_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 NewCfnApplication_Override

func NewCfnApplication_Override(c CfnApplication, scope constructs.Construct, id *string, props *CfnApplicationProps)

Create a new `AWS::IoTFleetHub::Application`.

Types

type CfnApplication

type CfnApplication interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApplicationDescription() *string
	SetApplicationDescription(val *string)
	ApplicationName() *string
	SetApplicationName(val *string)
	AttrApplicationArn() *string
	AttrApplicationCreationDate() *float64
	AttrApplicationId() *string
	AttrApplicationLastUpdateDate() *float64
	AttrApplicationState() *string
	AttrApplicationUrl() *string
	AttrErrorMessage() *string
	AttrSsoClientId() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	RoleArn() *string
	SetRoleArn(val *string)
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::IoTFleetHub::Application`.

Represents a Fleet Hub for AWS IoT Device Management web application.

TODO: EXAMPLE

func NewCfnApplication

func NewCfnApplication(scope constructs.Construct, id *string, props *CfnApplicationProps) CfnApplication

Create a new `AWS::IoTFleetHub::Application`.

type CfnApplicationProps

type CfnApplicationProps struct {
	// The name of the web application.
	ApplicationName *string `json:"applicationName" yaml:"applicationName"`
	// The ARN of the role that the web application assumes when it interacts with AWS IoT Core .
	//
	// > The name of the role must be in the form `FleetHub_random_string` .
	//
	// Pattern: `^arn:[!-~]+$`
	RoleArn *string `json:"roleArn" yaml:"roleArn"`
	// An optional description of the web application.
	ApplicationDescription *string `json:"applicationDescription" yaml:"applicationDescription"`
	// A set of key/value pairs that you can use to manage the web application resource.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnApplication`.

TODO: EXAMPLE