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
- type CfnApplicationInstanceProps
- type CfnApplicationInstance_ManifestOverridesPayloadProperty
- type CfnApplicationInstance_ManifestPayloadProperty
- type CfnPackage
- type CfnPackageProps
- type CfnPackageVersion
- type CfnPackageVersionProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
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
// The ID of an application instance to replace with the new instance.
ApplicationInstanceIdToReplace() *string
SetApplicationInstanceIdToReplace(val *string)
// The application instance's ID.
AttrApplicationInstanceId() *string
// The application instance's ARN.
AttrArn() *string
// The application instance's created time.
AttrCreatedTime() *float64
// The application instance's default runtime context device name.
AttrDefaultRuntimeContextDeviceName() *string
// The application instance's health status.
AttrHealthStatus() *string
// The application instance's last updated time.
AttrLastUpdatedTime() *float64
// The application instance's status.
AttrStatus() *string
// The application instance's status description.
AttrStatusDescription() *string
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
CreationStack() *[]*string
// The device's ID.
DefaultRuntimeContextDevice() *string
SetDefaultRuntimeContextDevice(val *string)
// A description for the application instance.
Description() *string
SetDescription(val *string)
// A device's ID.
DeviceId() *string
SetDeviceId(val *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.
// Experimental.
LogicalId() *string
// Setting overrides for the application manifest.
ManifestOverridesPayload() interface{}
SetManifestOverridesPayload(val interface{})
// The application's manifest document.
ManifestPayload() interface{}
SetManifestPayload(val interface{})
// A name for the application instance.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// 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 })`.
// Experimental.
Ref() *string
// The ARN of a runtime role for the application instance.
RuntimeRoleArn() *string
SetRuntimeRoleArn(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// Only include instances with a specific status.
StatusFilter() *string
SetStatusFilter(val *string)
// Tags for the application instance.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Panorama::ApplicationInstance`.
Creates an application instance and deploys it to a device.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnApplicationInstance := awscdk.Aws_panorama.NewCfnApplicationInstance(this, jsii.String("MyCfnApplicationInstance"), &cfnApplicationInstanceProps{
defaultRuntimeContextDevice: jsii.String("defaultRuntimeContextDevice"),
manifestPayload: &manifestPayloadProperty{
payloadData: jsii.String("payloadData"),
},
// the properties below are optional
applicationInstanceIdToReplace: jsii.String("applicationInstanceIdToReplace"),
description: jsii.String("description"),
deviceId: jsii.String("deviceId"),
manifestOverridesPayload: &manifestOverridesPayloadProperty{
payloadData: jsii.String("payloadData"),
},
name: jsii.String("name"),
runtimeRoleArn: jsii.String("runtimeRoleArn"),
statusFilter: jsii.String("statusFilter"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
})
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 `field:"required" json:"defaultRuntimeContextDevice" yaml:"defaultRuntimeContextDevice"`
// The application's manifest document.
ManifestPayload interface{} `field:"required" json:"manifestPayload" yaml:"manifestPayload"`
// The ID of an application instance to replace with the new instance.
ApplicationInstanceIdToReplace *string `field:"optional" json:"applicationInstanceIdToReplace" yaml:"applicationInstanceIdToReplace"`
// A description for the application instance.
Description *string `field:"optional" json:"description" yaml:"description"`
// A device's ID.
DeviceId *string `field:"optional" json:"deviceId" yaml:"deviceId"`
// Setting overrides for the application manifest.
ManifestOverridesPayload interface{} `field:"optional" json:"manifestOverridesPayload" yaml:"manifestOverridesPayload"`
// A name for the application instance.
Name *string `field:"optional" json:"name" yaml:"name"`
// The ARN of a runtime role for the application instance.
RuntimeRoleArn *string `field:"optional" json:"runtimeRoleArn" yaml:"runtimeRoleArn"`
// Only include instances with a specific status.
StatusFilter *string `field:"optional" json:"statusFilter" yaml:"statusFilter"`
// Tags for the application instance.
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnApplicationInstance`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnApplicationInstanceProps := &cfnApplicationInstanceProps{
defaultRuntimeContextDevice: jsii.String("defaultRuntimeContextDevice"),
manifestPayload: &manifestPayloadProperty{
payloadData: jsii.String("payloadData"),
},
// the properties below are optional
applicationInstanceIdToReplace: jsii.String("applicationInstanceIdToReplace"),
description: jsii.String("description"),
deviceId: jsii.String("deviceId"),
manifestOverridesPayload: &manifestOverridesPayloadProperty{
payloadData: jsii.String("payloadData"),
},
name: jsii.String("name"),
runtimeRoleArn: jsii.String("runtimeRoleArn"),
statusFilter: jsii.String("statusFilter"),
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}
type CfnApplicationInstance_ManifestOverridesPayloadProperty ¶
type CfnApplicationInstance_ManifestOverridesPayloadProperty struct {
// The overrides document.
PayloadData *string `field:"optional" 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.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
manifestOverridesPayloadProperty := &manifestOverridesPayloadProperty{
payloadData: jsii.String("payloadData"),
}
type CfnApplicationInstance_ManifestPayloadProperty ¶
type CfnApplicationInstance_ManifestPayloadProperty struct {
// The application manifest.
PayloadData *string `field:"optional" 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.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
manifestPayloadProperty := &manifestPayloadProperty{
payloadData: jsii.String("payloadData"),
}
type CfnPackage ¶
type CfnPackage interface {
awscdk.CfnResource
awscdk.IInspectable
// The package's ARN.
AttrArn() *string
// The item's created time.
AttrCreatedTime() *float64
// The package's ID.
AttrPackageId() *string
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
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.
// Experimental.
LogicalId() *string
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// A name for the package.
PackageName() *string
SetPackageName(val *string)
// 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 })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// Tags for the package.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Panorama::Package`.
Creates a package and storage location in an Amazon S3 access point.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnPackage := awscdk.Aws_panorama.NewCfnPackage(this, jsii.String("MyCfnPackage"), &cfnPackageProps{
packageName: jsii.String("packageName"),
// the properties below are optional
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
})
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 `field:"required" json:"packageName" yaml:"packageName"`
// Tags for the package.
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnPackage`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnPackageProps := &cfnPackageProps{
packageName: jsii.String("packageName"),
// the properties below are optional
tags: []cfnTag{
&cfnTag{
key: jsii.String("key"),
value: jsii.String("value"),
},
},
}
type CfnPackageVersion ¶
type CfnPackageVersion interface {
awscdk.CfnResource
awscdk.IInspectable
// Whether the package version is the latest version.
AttrIsLatestPatch() awscdk.IResolvable
// The package version's ARN.
AttrPackageArn() *string
// The package version's name.
AttrPackageName() *string
// The package version's registered time.
AttrRegisteredTime() *float64
// The package version's status.
AttrStatus() *string
// The package version's status description.
AttrStatusDescription() *string
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
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.
// Experimental.
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.
// Experimental.
LogicalId() *string
// Whether to mark the new version as the latest version.
MarkLatest() interface{}
SetMarkLatest(val interface{})
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// An owner account.
OwnerAccount() *string
SetOwnerAccount(val *string)
// A package ID.
PackageId() *string
SetPackageId(val *string)
// A package version.
PackageVersion() *string
SetPackageVersion(val *string)
// A patch version.
PatchVersion() *string
SetPatchVersion(val *string)
// 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 })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// If the version was marked latest, the new version to maker as latest.
UpdatedLatestPatchVersion() *string
SetUpdatedLatestPatchVersion(val *string)
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
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.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
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`).
// Experimental.
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.
// Experimental.
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.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
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.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Panorama::PackageVersion`.
Registers a package version.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnPackageVersion := awscdk.Aws_panorama.NewCfnPackageVersion(this, jsii.String("MyCfnPackageVersion"), &cfnPackageVersionProps{
packageId: jsii.String("packageId"),
packageVersion: jsii.String("packageVersion"),
patchVersion: jsii.String("patchVersion"),
// the properties below are optional
markLatest: jsii.Boolean(false),
ownerAccount: jsii.String("ownerAccount"),
updatedLatestPatchVersion: jsii.String("updatedLatestPatchVersion"),
})
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 `field:"required" json:"packageId" yaml:"packageId"`
// A package version.
PackageVersion *string `field:"required" json:"packageVersion" yaml:"packageVersion"`
// A patch version.
PatchVersion *string `field:"required" json:"patchVersion" yaml:"patchVersion"`
// Whether to mark the new version as the latest version.
MarkLatest interface{} `field:"optional" json:"markLatest" yaml:"markLatest"`
// An owner account.
OwnerAccount *string `field:"optional" json:"ownerAccount" yaml:"ownerAccount"`
// If the version was marked latest, the new version to maker as latest.
UpdatedLatestPatchVersion *string `field:"optional" json:"updatedLatestPatchVersion" yaml:"updatedLatestPatchVersion"`
}
Properties for defining a `CfnPackageVersion`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnPackageVersionProps := &cfnPackageVersionProps{
packageId: jsii.String("packageId"),
packageVersion: jsii.String("packageVersion"),
patchVersion: jsii.String("patchVersion"),
// the properties below are optional
markLatest: jsii.Boolean(false),
ownerAccount: jsii.String("ownerAccount"),
updatedLatestPatchVersion: jsii.String("updatedLatestPatchVersion"),
}