Documentation ¶
Index ¶
- func CfnFleet_CFN_RESOURCE_TYPE_NAME() *string
- func CfnFleet_IsCfnElement(x interface{}) *bool
- func CfnFleet_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnFleet_IsConstruct(x interface{}) *bool
- func CfnRobotApplicationVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnRobotApplicationVersion_IsCfnElement(x interface{}) *bool
- func CfnRobotApplicationVersion_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnRobotApplicationVersion_IsConstruct(x interface{}) *bool
- func CfnRobotApplication_CFN_RESOURCE_TYPE_NAME() *string
- func CfnRobotApplication_IsCfnElement(x interface{}) *bool
- func CfnRobotApplication_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnRobotApplication_IsConstruct(x interface{}) *bool
- func CfnRobot_CFN_RESOURCE_TYPE_NAME() *string
- func CfnRobot_IsCfnElement(x interface{}) *bool
- func CfnRobot_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnRobot_IsConstruct(x interface{}) *bool
- func CfnSimulationApplicationVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSimulationApplicationVersion_IsCfnElement(x interface{}) *bool
- func CfnSimulationApplicationVersion_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnSimulationApplicationVersion_IsConstruct(x interface{}) *bool
- func CfnSimulationApplication_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSimulationApplication_IsCfnElement(x interface{}) *bool
- func CfnSimulationApplication_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnSimulationApplication_IsConstruct(x interface{}) *bool
- func NewCfnFleet_Override(c CfnFleet, scope awscdk.Construct, id *string, props *CfnFleetProps)
- func NewCfnRobotApplicationVersion_Override(c CfnRobotApplicationVersion, scope awscdk.Construct, id *string, ...)
- func NewCfnRobotApplication_Override(c CfnRobotApplication, scope awscdk.Construct, id *string, ...)
- func NewCfnRobot_Override(c CfnRobot, scope awscdk.Construct, id *string, props *CfnRobotProps)
- func NewCfnSimulationApplicationVersion_Override(c CfnSimulationApplicationVersion, scope awscdk.Construct, id *string, ...)
- func NewCfnSimulationApplication_Override(c CfnSimulationApplication, scope awscdk.Construct, id *string, ...)
- type CfnFleet
- type CfnFleetProps
- type CfnRobot
- type CfnRobotApplication
- type CfnRobotApplicationProps
- type CfnRobotApplicationVersion
- type CfnRobotApplicationVersionProps
- type CfnRobotApplication_RobotSoftwareSuiteProperty
- type CfnRobotApplication_SourceConfigProperty
- type CfnRobotProps
- type CfnSimulationApplication
- type CfnSimulationApplicationProps
- type CfnSimulationApplicationVersion
- type CfnSimulationApplicationVersionProps
- type CfnSimulationApplication_RenderingEngineProperty
- type CfnSimulationApplication_RobotSoftwareSuiteProperty
- type CfnSimulationApplication_SimulationSoftwareSuiteProperty
- type CfnSimulationApplication_SourceConfigProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnFleet_CFN_RESOURCE_TYPE_NAME ¶
func CfnFleet_CFN_RESOURCE_TYPE_NAME() *string
func CfnFleet_IsCfnElement ¶
func CfnFleet_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 CfnFleet_IsCfnResource ¶
func CfnFleet_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnFleet_IsConstruct ¶
func CfnFleet_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnRobotApplicationVersion_CFN_RESOURCE_TYPE_NAME ¶
func CfnRobotApplicationVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnRobotApplicationVersion_IsCfnElement ¶
func CfnRobotApplicationVersion_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 CfnRobotApplicationVersion_IsCfnResource ¶
func CfnRobotApplicationVersion_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnRobotApplicationVersion_IsConstruct ¶
func CfnRobotApplicationVersion_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnRobotApplication_CFN_RESOURCE_TYPE_NAME ¶
func CfnRobotApplication_CFN_RESOURCE_TYPE_NAME() *string
func CfnRobotApplication_IsCfnElement ¶
func CfnRobotApplication_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 CfnRobotApplication_IsCfnResource ¶
func CfnRobotApplication_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnRobotApplication_IsConstruct ¶
func CfnRobotApplication_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnRobot_CFN_RESOURCE_TYPE_NAME ¶
func CfnRobot_CFN_RESOURCE_TYPE_NAME() *string
func CfnRobot_IsCfnElement ¶
func CfnRobot_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 CfnRobot_IsCfnResource ¶
func CfnRobot_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnRobot_IsConstruct ¶
func CfnRobot_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnSimulationApplicationVersion_CFN_RESOURCE_TYPE_NAME ¶
func CfnSimulationApplicationVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnSimulationApplicationVersion_IsCfnElement ¶
func CfnSimulationApplicationVersion_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 CfnSimulationApplicationVersion_IsCfnResource ¶
func CfnSimulationApplicationVersion_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnSimulationApplicationVersion_IsConstruct ¶
func CfnSimulationApplicationVersion_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnSimulationApplication_CFN_RESOURCE_TYPE_NAME ¶
func CfnSimulationApplication_CFN_RESOURCE_TYPE_NAME() *string
func CfnSimulationApplication_IsCfnElement ¶
func CfnSimulationApplication_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 CfnSimulationApplication_IsCfnResource ¶
func CfnSimulationApplication_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnSimulationApplication_IsConstruct ¶
func CfnSimulationApplication_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func NewCfnFleet_Override ¶
func NewCfnFleet_Override(c CfnFleet, scope awscdk.Construct, id *string, props *CfnFleetProps)
Create a new `AWS::RoboMaker::Fleet`.
func NewCfnRobotApplicationVersion_Override ¶
func NewCfnRobotApplicationVersion_Override(c CfnRobotApplicationVersion, scope awscdk.Construct, id *string, props *CfnRobotApplicationVersionProps)
Create a new `AWS::RoboMaker::RobotApplicationVersion`.
func NewCfnRobotApplication_Override ¶
func NewCfnRobotApplication_Override(c CfnRobotApplication, scope awscdk.Construct, id *string, props *CfnRobotApplicationProps)
Create a new `AWS::RoboMaker::RobotApplication`.
func NewCfnRobot_Override ¶
func NewCfnRobot_Override(c CfnRobot, scope awscdk.Construct, id *string, props *CfnRobotProps)
Create a new `AWS::RoboMaker::Robot`.
func NewCfnSimulationApplicationVersion_Override ¶
func NewCfnSimulationApplicationVersion_Override(c CfnSimulationApplicationVersion, scope awscdk.Construct, id *string, props *CfnSimulationApplicationVersionProps)
Create a new `AWS::RoboMaker::SimulationApplicationVersion`.
func NewCfnSimulationApplication_Override ¶
func NewCfnSimulationApplication_Override(c CfnSimulationApplication, scope awscdk.Construct, id *string, props *CfnSimulationApplicationProps)
Create a new `AWS::RoboMaker::SimulationApplication`.
Types ¶
type CfnFleet ¶
type CfnFleet interface { awscdk.CfnResource awscdk.IInspectable // The Amazon Resource Name (ARN) of the fleet, such as `arn:aws:robomaker:us-west-2:123456789012:deployment-fleet/MyFleet/1539894765711` . AttrArn() *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 name of the fleet. 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 stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // The list of all tags added to the fleet. 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::RoboMaker::Fleet`.
The `AWS::RoboMaker::Fleet` resource creates an AWS RoboMaker fleet. Fleets contain robots and can receive deployments.
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" cfnFleet := awscdk.Aws_robomaker.NewCfnFleet(this, jsii.String("MyCfnFleet"), &cfnFleetProps{ name: jsii.String("name"), tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, })
func NewCfnFleet ¶
func NewCfnFleet(scope awscdk.Construct, id *string, props *CfnFleetProps) CfnFleet
Create a new `AWS::RoboMaker::Fleet`.
type CfnFleetProps ¶
type CfnFleetProps struct { // The name of the fleet. Name *string `field:"optional" json:"name" yaml:"name"` // The list of all tags added to the fleet. Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnFleet`.
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" cfnFleetProps := &cfnFleetProps{ name: jsii.String("name"), tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, }
type CfnRobot ¶
type CfnRobot interface { awscdk.CfnResource awscdk.IInspectable // The architecture of the robot. Architecture() *string SetArchitecture(val *string) // The Amazon Resource Name (ARN) of the robot. AttrArn() *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 Amazon Resource Name (ARN) of the fleet to which the robot will be registered. Fleet() *string SetFleet(val *string) // The Greengrass group associated with the robot. GreengrassGroupId() *string SetGreengrassGroupId(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 // The name of the robot. 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 stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // A map that contains tag keys and tag values that are attached to the robot. 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::RoboMaker::Robot`.
The `AWS::RoboMaker::RobotApplication` resource creates an AWS RoboMaker robot.
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" cfnRobot := awscdk.Aws_robomaker.NewCfnRobot(this, jsii.String("MyCfnRobot"), &cfnRobotProps{ architecture: jsii.String("architecture"), greengrassGroupId: jsii.String("greengrassGroupId"), // the properties below are optional fleet: jsii.String("fleet"), name: jsii.String("name"), tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, })
func NewCfnRobot ¶
func NewCfnRobot(scope awscdk.Construct, id *string, props *CfnRobotProps) CfnRobot
Create a new `AWS::RoboMaker::Robot`.
type CfnRobotApplication ¶
type CfnRobotApplication interface { awscdk.CfnResource awscdk.IInspectable // The Amazon Resource Name (ARN) of the robot application. AttrArn() *string // The current revision id. AttrCurrentRevisionId() *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 current revision id. CurrentRevisionId() *string SetCurrentRevisionId(val *string) // The environment of the robot application. Environment() *string SetEnvironment(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 // The name of the robot application. 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 robot software suite used by the robot application. RobotSoftwareSuite() interface{} SetRobotSoftwareSuite(val interface{}) // The sources of the robot application. Sources() interface{} SetSources(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // A map that contains tag keys and tag values that are attached to the robot application. 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::RoboMaker::RobotApplication`.
The `AWS::RoboMaker::RobotApplication` resource creates an AWS RoboMaker robot application.
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" cfnRobotApplication := awscdk.Aws_robomaker.NewCfnRobotApplication(this, jsii.String("MyCfnRobotApplication"), &cfnRobotApplicationProps{ robotSoftwareSuite: &robotSoftwareSuiteProperty{ name: jsii.String("name"), // the properties below are optional version: jsii.String("version"), }, // the properties below are optional currentRevisionId: jsii.String("currentRevisionId"), environment: jsii.String("environment"), name: jsii.String("name"), sources: []interface{}{ &sourceConfigProperty{ architecture: jsii.String("architecture"), s3Bucket: jsii.String("s3Bucket"), s3Key: jsii.String("s3Key"), }, }, tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, })
func NewCfnRobotApplication ¶
func NewCfnRobotApplication(scope awscdk.Construct, id *string, props *CfnRobotApplicationProps) CfnRobotApplication
Create a new `AWS::RoboMaker::RobotApplication`.
type CfnRobotApplicationProps ¶
type CfnRobotApplicationProps struct { // The robot software suite used by the robot application. RobotSoftwareSuite interface{} `field:"required" json:"robotSoftwareSuite" yaml:"robotSoftwareSuite"` // The current revision id. CurrentRevisionId *string `field:"optional" json:"currentRevisionId" yaml:"currentRevisionId"` // The environment of the robot application. Environment *string `field:"optional" json:"environment" yaml:"environment"` // The name of the robot application. Name *string `field:"optional" json:"name" yaml:"name"` // The sources of the robot application. Sources interface{} `field:"optional" json:"sources" yaml:"sources"` // A map that contains tag keys and tag values that are attached to the robot application. Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnRobotApplication`.
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" cfnRobotApplicationProps := &cfnRobotApplicationProps{ robotSoftwareSuite: &robotSoftwareSuiteProperty{ name: jsii.String("name"), // the properties below are optional version: jsii.String("version"), }, // the properties below are optional currentRevisionId: jsii.String("currentRevisionId"), environment: jsii.String("environment"), name: jsii.String("name"), sources: []interface{}{ &sourceConfigProperty{ architecture: jsii.String("architecture"), s3Bucket: jsii.String("s3Bucket"), s3Key: jsii.String("s3Key"), }, }, tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, }
type CfnRobotApplicationVersion ¶
type CfnRobotApplicationVersion interface { awscdk.CfnResource awscdk.IInspectable // The application information for the robot application. Application() *string SetApplication(val *string) // The robot application version. AttrApplicationVersion() *string // The Amazon Resource Name (ARN) of the robot application version. AttrArn() *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 current revision id for the robot application. // // If you provide a value and it matches the latest revision ID, a new version will be created. CurrentRevisionId() *string SetCurrentRevisionId(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 // 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 stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. 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. // 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::RoboMaker::RobotApplicationVersion`.
The `AWS::RoboMaker::RobotApplicationVersion` resource creates an AWS RoboMaker robot 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" cfnRobotApplicationVersion := awscdk.Aws_robomaker.NewCfnRobotApplicationVersion(this, jsii.String("MyCfnRobotApplicationVersion"), &cfnRobotApplicationVersionProps{ application: jsii.String("application"), // the properties below are optional currentRevisionId: jsii.String("currentRevisionId"), })
func NewCfnRobotApplicationVersion ¶
func NewCfnRobotApplicationVersion(scope awscdk.Construct, id *string, props *CfnRobotApplicationVersionProps) CfnRobotApplicationVersion
Create a new `AWS::RoboMaker::RobotApplicationVersion`.
type CfnRobotApplicationVersionProps ¶
type CfnRobotApplicationVersionProps struct { // The application information for the robot application. Application *string `field:"required" json:"application" yaml:"application"` // The current revision id for the robot application. // // If you provide a value and it matches the latest revision ID, a new version will be created. CurrentRevisionId *string `field:"optional" json:"currentRevisionId" yaml:"currentRevisionId"` }
Properties for defining a `CfnRobotApplicationVersion`.
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" cfnRobotApplicationVersionProps := &cfnRobotApplicationVersionProps{ application: jsii.String("application"), // the properties below are optional currentRevisionId: jsii.String("currentRevisionId"), }
type CfnRobotApplication_RobotSoftwareSuiteProperty ¶
type CfnRobotApplication_RobotSoftwareSuiteProperty struct { // The name of the robot software suite. // // `General` is the only supported value. Name *string `field:"required" json:"name" yaml:"name"` // The version of the robot software suite. // // Not applicable for General software suite. Version *string `field:"optional" json:"version" yaml:"version"` }
Information about a robot software suite.
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" robotSoftwareSuiteProperty := &robotSoftwareSuiteProperty{ name: jsii.String("name"), // the properties below are optional version: jsii.String("version"), }
type CfnRobotApplication_SourceConfigProperty ¶
type CfnRobotApplication_SourceConfigProperty struct { // The target processor architecture for the application. Architecture *string `field:"required" json:"architecture" yaml:"architecture"` // The Amazon S3 bucket name. S3Bucket *string `field:"required" json:"s3Bucket" yaml:"s3Bucket"` // The s3 object key. S3Key *string `field:"required" json:"s3Key" yaml:"s3Key"` }
Information about a source configuration.
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" sourceConfigProperty := &sourceConfigProperty{ architecture: jsii.String("architecture"), s3Bucket: jsii.String("s3Bucket"), s3Key: jsii.String("s3Key"), }
type CfnRobotProps ¶
type CfnRobotProps struct { // The architecture of the robot. Architecture *string `field:"required" json:"architecture" yaml:"architecture"` // The Greengrass group associated with the robot. GreengrassGroupId *string `field:"required" json:"greengrassGroupId" yaml:"greengrassGroupId"` // The Amazon Resource Name (ARN) of the fleet to which the robot will be registered. Fleet *string `field:"optional" json:"fleet" yaml:"fleet"` // The name of the robot. Name *string `field:"optional" json:"name" yaml:"name"` // A map that contains tag keys and tag values that are attached to the robot. Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnRobot`.
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" cfnRobotProps := &cfnRobotProps{ architecture: jsii.String("architecture"), greengrassGroupId: jsii.String("greengrassGroupId"), // the properties below are optional fleet: jsii.String("fleet"), name: jsii.String("name"), tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, }
type CfnSimulationApplication ¶
type CfnSimulationApplication interface { awscdk.CfnResource awscdk.IInspectable // The Amazon Resource Name (ARN) of the simulation application. AttrArn() *string // The current revision id. AttrCurrentRevisionId() *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 current revision id. CurrentRevisionId() *string SetCurrentRevisionId(val *string) // The environment of the simulation application. Environment() *string SetEnvironment(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 // The name of the simulation application. 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 rendering engine for the simulation application. RenderingEngine() interface{} SetRenderingEngine(val interface{}) // The robot software suite used by the simulation application. RobotSoftwareSuite() interface{} SetRobotSoftwareSuite(val interface{}) // The simulation software suite used by the simulation application. SimulationSoftwareSuite() interface{} SetSimulationSoftwareSuite(val interface{}) // The sources of the simulation application. Sources() interface{} SetSources(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // A map that contains tag keys and tag values that are attached to the simulation application. 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::RoboMaker::SimulationApplication`.
The `AWS::RoboMaker::SimulationApplication` resource creates an AWS RoboMaker simulation application.
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" cfnSimulationApplication := awscdk.Aws_robomaker.NewCfnSimulationApplication(this, jsii.String("MyCfnSimulationApplication"), &cfnSimulationApplicationProps{ robotSoftwareSuite: &robotSoftwareSuiteProperty{ name: jsii.String("name"), // the properties below are optional version: jsii.String("version"), }, simulationSoftwareSuite: &simulationSoftwareSuiteProperty{ name: jsii.String("name"), // the properties below are optional version: jsii.String("version"), }, // the properties below are optional currentRevisionId: jsii.String("currentRevisionId"), environment: jsii.String("environment"), name: jsii.String("name"), renderingEngine: &renderingEngineProperty{ name: jsii.String("name"), version: jsii.String("version"), }, sources: []interface{}{ &sourceConfigProperty{ architecture: jsii.String("architecture"), s3Bucket: jsii.String("s3Bucket"), s3Key: jsii.String("s3Key"), }, }, tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, })
func NewCfnSimulationApplication ¶
func NewCfnSimulationApplication(scope awscdk.Construct, id *string, props *CfnSimulationApplicationProps) CfnSimulationApplication
Create a new `AWS::RoboMaker::SimulationApplication`.
type CfnSimulationApplicationProps ¶
type CfnSimulationApplicationProps struct { // The robot software suite used by the simulation application. RobotSoftwareSuite interface{} `field:"required" json:"robotSoftwareSuite" yaml:"robotSoftwareSuite"` // The simulation software suite used by the simulation application. SimulationSoftwareSuite interface{} `field:"required" json:"simulationSoftwareSuite" yaml:"simulationSoftwareSuite"` // The current revision id. CurrentRevisionId *string `field:"optional" json:"currentRevisionId" yaml:"currentRevisionId"` // The environment of the simulation application. Environment *string `field:"optional" json:"environment" yaml:"environment"` // The name of the simulation application. Name *string `field:"optional" json:"name" yaml:"name"` // The rendering engine for the simulation application. RenderingEngine interface{} `field:"optional" json:"renderingEngine" yaml:"renderingEngine"` // The sources of the simulation application. Sources interface{} `field:"optional" json:"sources" yaml:"sources"` // A map that contains tag keys and tag values that are attached to the simulation application. Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnSimulationApplication`.
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" cfnSimulationApplicationProps := &cfnSimulationApplicationProps{ robotSoftwareSuite: &robotSoftwareSuiteProperty{ name: jsii.String("name"), // the properties below are optional version: jsii.String("version"), }, simulationSoftwareSuite: &simulationSoftwareSuiteProperty{ name: jsii.String("name"), // the properties below are optional version: jsii.String("version"), }, // the properties below are optional currentRevisionId: jsii.String("currentRevisionId"), environment: jsii.String("environment"), name: jsii.String("name"), renderingEngine: &renderingEngineProperty{ name: jsii.String("name"), version: jsii.String("version"), }, sources: []interface{}{ &sourceConfigProperty{ architecture: jsii.String("architecture"), s3Bucket: jsii.String("s3Bucket"), s3Key: jsii.String("s3Key"), }, }, tags: map[string]*string{ "tagsKey": jsii.String("tags"), }, }
type CfnSimulationApplicationVersion ¶
type CfnSimulationApplicationVersion interface { awscdk.CfnResource awscdk.IInspectable // The application information for the simulation application. Application() *string SetApplication(val *string) // The simulation application version. AttrApplicationVersion() *string // The Amazon Resource Name (ARN) of the simulation application version. AttrArn() *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 current revision id for the simulation application. // // If you provide a value and it matches the latest revision ID, a new version will be created. CurrentRevisionId() *string SetCurrentRevisionId(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 // 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 stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. 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. // 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::RoboMaker::SimulationApplicationVersion`.
The `AWS::RoboMaker::SimulationApplicationVersion` resource creates a version of an AWS RoboMaker simulation application.
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" cfnSimulationApplicationVersion := awscdk.Aws_robomaker.NewCfnSimulationApplicationVersion(this, jsii.String("MyCfnSimulationApplicationVersion"), &cfnSimulationApplicationVersionProps{ application: jsii.String("application"), // the properties below are optional currentRevisionId: jsii.String("currentRevisionId"), })
func NewCfnSimulationApplicationVersion ¶
func NewCfnSimulationApplicationVersion(scope awscdk.Construct, id *string, props *CfnSimulationApplicationVersionProps) CfnSimulationApplicationVersion
Create a new `AWS::RoboMaker::SimulationApplicationVersion`.
type CfnSimulationApplicationVersionProps ¶
type CfnSimulationApplicationVersionProps struct { // The application information for the simulation application. Application *string `field:"required" json:"application" yaml:"application"` // The current revision id for the simulation application. // // If you provide a value and it matches the latest revision ID, a new version will be created. CurrentRevisionId *string `field:"optional" json:"currentRevisionId" yaml:"currentRevisionId"` }
Properties for defining a `CfnSimulationApplicationVersion`.
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" cfnSimulationApplicationVersionProps := &cfnSimulationApplicationVersionProps{ application: jsii.String("application"), // the properties below are optional currentRevisionId: jsii.String("currentRevisionId"), }
type CfnSimulationApplication_RenderingEngineProperty ¶
type CfnSimulationApplication_RenderingEngineProperty struct { // The name of the rendering engine. Name *string `field:"required" json:"name" yaml:"name"` // The version of the rendering engine. Version *string `field:"required" json:"version" yaml:"version"` }
Information about a rendering engine.
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" renderingEngineProperty := &renderingEngineProperty{ name: jsii.String("name"), version: jsii.String("version"), }
type CfnSimulationApplication_RobotSoftwareSuiteProperty ¶
type CfnSimulationApplication_RobotSoftwareSuiteProperty struct { // The name of the robot software suite. // // `General` is the only supported value. Name *string `field:"required" json:"name" yaml:"name"` // The version of the robot software suite. // // Not applicable for General software suite. Version *string `field:"optional" json:"version" yaml:"version"` }
Information about a robot software suite.
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" robotSoftwareSuiteProperty := &robotSoftwareSuiteProperty{ name: jsii.String("name"), // the properties below are optional version: jsii.String("version"), }
type CfnSimulationApplication_SimulationSoftwareSuiteProperty ¶
type CfnSimulationApplication_SimulationSoftwareSuiteProperty struct { // The name of the simulation software suite. // // `SimulationRuntime` is the only supported value. Name *string `field:"required" json:"name" yaml:"name"` // The version of the simulation software suite. // // Not applicable for `SimulationRuntime` . Version *string `field:"optional" json:"version" yaml:"version"` }
Information about a simulation software suite.
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" simulationSoftwareSuiteProperty := &simulationSoftwareSuiteProperty{ name: jsii.String("name"), // the properties below are optional version: jsii.String("version"), }
type CfnSimulationApplication_SourceConfigProperty ¶
type CfnSimulationApplication_SourceConfigProperty struct { // The target processor architecture for the application. Architecture *string `field:"required" json:"architecture" yaml:"architecture"` // The Amazon S3 bucket name. S3Bucket *string `field:"required" json:"s3Bucket" yaml:"s3Bucket"` // The s3 object key. S3Key *string `field:"required" json:"s3Key" yaml:"s3Key"` }
Information about a source configuration.
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" sourceConfigProperty := &sourceConfigProperty{ architecture: jsii.String("architecture"), s3Bucket: jsii.String("s3Bucket"), s3Key: jsii.String("s3Key"), }