awspanorama

Documentation

Index

• func CfnApplicationInstance_CFN_RESOURCE_TYPE_NAME() *string
• func CfnApplicationInstance_IsCfnElement(x interface{}) *bool
• func CfnApplicationInstance_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnApplicationInstance_IsConstruct(x interface{}) *bool
• func CfnPackageVersion_CFN_RESOURCE_TYPE_NAME() *string
• func CfnPackageVersion_IsCfnElement(x interface{}) *bool
• func CfnPackageVersion_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnPackageVersion_IsConstruct(x interface{}) *bool
• func CfnPackage_CFN_RESOURCE_TYPE_NAME() *string
• func CfnPackage_IsCfnElement(x interface{}) *bool
• func CfnPackage_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnPackage_IsConstruct(x interface{}) *bool
• func NewCfnApplicationInstance_Override(c CfnApplicationInstance, scope awscdk.Construct, id *string, ...)
• func NewCfnPackageVersion_Override(c CfnPackageVersion, scope awscdk.Construct, id *string, ...)
• func NewCfnPackage_Override(c CfnPackage, scope awscdk.Construct, id *string, props *CfnPackageProps)
• type CfnApplicationInstance
  • func NewCfnApplicationInstance(scope awscdk.Construct, id *string, props *CfnApplicationInstanceProps) CfnApplicationInstance
• type CfnApplicationInstanceProps
• type CfnApplicationInstance_ManifestOverridesPayloadProperty
• type CfnApplicationInstance_ManifestPayloadProperty
• type CfnPackage
  • func NewCfnPackage(scope awscdk.Construct, id *string, props *CfnPackageProps) CfnPackage
• type CfnPackageProps
• type CfnPackageVersion
  • func NewCfnPackageVersion(scope awscdk.Construct, id *string, props *CfnPackageVersionProps) CfnPackageVersion
• type CfnPackageVersionProps

Functions

func CfnApplicationInstance_CFN_RESOURCE_TYPE_NAME

func CfnApplicationInstance_CFN_RESOURCE_TYPE_NAME() *string

func CfnApplicationInstance_IsCfnElement

func CfnApplicationInstance_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. Experimental.

func CfnApplicationInstance_IsCfnResource

func CfnApplicationInstance_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnApplicationInstance_IsConstruct

func CfnApplicationInstance_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnPackageVersion_CFN_RESOURCE_TYPE_NAME

func CfnPackageVersion_CFN_RESOURCE_TYPE_NAME() *string

func CfnPackageVersion_IsCfnElement

func CfnPackageVersion_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. Experimental.

func CfnPackageVersion_IsCfnResource

func CfnPackageVersion_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnPackageVersion_IsConstruct

func CfnPackageVersion_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnPackage_CFN_RESOURCE_TYPE_NAME

func CfnPackage_CFN_RESOURCE_TYPE_NAME() *string

func CfnPackage_IsCfnElement

func CfnPackage_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. Experimental.

func CfnPackage_IsCfnResource

func CfnPackage_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnPackage_IsConstruct

func CfnPackage_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func NewCfnApplicationInstance_Override

func NewCfnApplicationInstance_Override(c CfnApplicationInstance, scope awscdk.Construct, id *string, props *CfnApplicationInstanceProps)

Create a new `AWS::Panorama::ApplicationInstance`.

func NewCfnPackageVersion_Override

func NewCfnPackageVersion_Override(c CfnPackageVersion, scope awscdk.Construct, id *string, props *CfnPackageVersionProps)

Create a new `AWS::Panorama::PackageVersion`.

func NewCfnPackage_Override

func NewCfnPackage_Override(c CfnPackage, scope awscdk.Construct, id *string, props *CfnPackageProps)

Create a new `AWS::Panorama::Package`.

Types

type CfnApplicationInstance

type CfnApplicationInstance interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApplicationInstanceIdToReplace() *string
	SetApplicationInstanceIdToReplace(val *string)
	AttrApplicationInstanceId() *string
	AttrArn() *string
	AttrCreatedTime() *float64
	AttrDefaultRuntimeContextDeviceName() *string
	AttrHealthStatus() *string
	AttrLastUpdatedTime() *float64
	AttrStatus() *string
	AttrStatusDescription() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DefaultRuntimeContextDevice() *string
	SetDefaultRuntimeContextDevice(val *string)
	Description() *string
	SetDescription(val *string)
	DeviceId() *string
	SetDeviceId(val *string)
	LogicalId() *string
	ManifestOverridesPayload() interface{}
	SetManifestOverridesPayload(val interface{})
	ManifestPayload() interface{}
	SetManifestPayload(val interface{})
	Name() *string
	SetName(val *string)
	Node() awscdk.ConstructNode
	Ref() *string
	RuntimeRoleArn() *string
	SetRuntimeRoleArn(val *string)
	Stack() awscdk.Stack
	StatusFilter() *string
	SetStatusFilter(val *string)
	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)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Panorama::ApplicationInstance`.

Creates an application instance and deploys it to a device.

TODO: EXAMPLE

func NewCfnApplicationInstance

func NewCfnApplicationInstance(scope awscdk.Construct, id *string, props *CfnApplicationInstanceProps) CfnApplicationInstance

Create a new `AWS::Panorama::ApplicationInstance`.

type CfnApplicationInstanceProps

type CfnApplicationInstanceProps struct {
	// The device's ID.
	DefaultRuntimeContextDevice *string `json:"defaultRuntimeContextDevice" yaml:"defaultRuntimeContextDevice"`
	// The application's manifest document.
	ManifestPayload interface{} `json:"manifestPayload" yaml:"manifestPayload"`
	// The ID of an application instance to replace with the new instance.
	ApplicationInstanceIdToReplace *string `json:"applicationInstanceIdToReplace" yaml:"applicationInstanceIdToReplace"`
	// A description for the application instance.
	Description *string `json:"description" yaml:"description"`
	// A device's ID.
	DeviceId *string `json:"deviceId" yaml:"deviceId"`
	// Setting overrides for the application manifest.
	ManifestOverridesPayload interface{} `json:"manifestOverridesPayload" yaml:"manifestOverridesPayload"`
	// A name for the application instance.
	Name *string `json:"name" yaml:"name"`
	// The ARN of a runtime role for the application instance.
	RuntimeRoleArn *string `json:"runtimeRoleArn" yaml:"runtimeRoleArn"`
	// Only include instances with a specific status.
	StatusFilter *string `json:"statusFilter" yaml:"statusFilter"`
	// Tags for the application instance.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnApplicationInstance`.

TODO: EXAMPLE

type CfnApplicationInstance_ManifestOverridesPayloadProperty

type CfnApplicationInstance_ManifestOverridesPayloadProperty struct {
	// The overrides document.
	PayloadData *string `json:"payloadData" yaml:"payloadData"`
}

Parameter overrides for an application instance.

This is a JSON document that has a single key ( `PayloadData` ) where the value is an escaped string representation of the overrides document.

TODO: EXAMPLE

type CfnApplicationInstance_ManifestPayloadProperty

type CfnApplicationInstance_ManifestPayloadProperty struct {
	// The application manifest.
	PayloadData *string `json:"payloadData" yaml:"payloadData"`
}

A application verion's manifest file.

This is a JSON document that has a single key ( `PayloadData` ) where the value is an escaped string representation of the application manifest ( `graph.json` ). This file is located in the `graphs` folder in your application source.

TODO: EXAMPLE

type CfnPackage

type CfnPackage interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrCreatedTime() *float64
	AttrPackageId() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() awscdk.ConstructNode
	PackageName() *string
	SetPackageName(val *string)
	Ref() *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)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Panorama::Package`.

Creates a package and storage location in an Amazon S3 access point.

TODO: EXAMPLE

func NewCfnPackage

func NewCfnPackage(scope awscdk.Construct, id *string, props *CfnPackageProps) CfnPackage

Create a new `AWS::Panorama::Package`.

type CfnPackageProps

type CfnPackageProps struct {
	// A name for the package.
	PackageName *string `json:"packageName" yaml:"packageName"`
	// Tags for the package.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnPackage`.

TODO: EXAMPLE

type CfnPackageVersion

type CfnPackageVersion interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrIsLatestPatch() awscdk.IResolvable
	AttrPackageArn() *string
	AttrPackageName() *string
	AttrRegisteredTime() *float64
	AttrStatus() *string
	AttrStatusDescription() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	MarkLatest() interface{}
	SetMarkLatest(val interface{})
	Node() awscdk.ConstructNode
	OwnerAccount() *string
	SetOwnerAccount(val *string)
	PackageId() *string
	SetPackageId(val *string)
	PackageVersion() *string
	SetPackageVersion(val *string)
	PatchVersion() *string
	SetPatchVersion(val *string)
	Ref() *string
	Stack() awscdk.Stack
	UpdatedLatestPatchVersion() *string
	SetUpdatedLatestPatchVersion(val *string)
	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)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Panorama::PackageVersion`.

Registers a package version.

TODO: EXAMPLE

func NewCfnPackageVersion

func NewCfnPackageVersion(scope awscdk.Construct, id *string, props *CfnPackageVersionProps) CfnPackageVersion

Create a new `AWS::Panorama::PackageVersion`.

type CfnPackageVersionProps

type CfnPackageVersionProps struct {
	// A package ID.
	PackageId *string `json:"packageId" yaml:"packageId"`
	// A package version.
	PackageVersion *string `json:"packageVersion" yaml:"packageVersion"`
	// A patch version.
	PatchVersion *string `json:"patchVersion" yaml:"patchVersion"`
	// Whether to mark the new version as the latest version.
	MarkLatest interface{} `json:"markLatest" yaml:"markLatest"`
	// An owner account.
	OwnerAccount *string `json:"ownerAccount" yaml:"ownerAccount"`
	// If the version was marked latest, the new version to maker as latest.
	UpdatedLatestPatchVersion *string `json:"updatedLatestPatchVersion" yaml:"updatedLatestPatchVersion"`
}

Properties for defining a `CfnPackageVersion`.

TODO: EXAMPLE