An image that is located on a sheet.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Actions" : [ ImageCustomAction, ... ]
,
"ImageContentAltText" : String
,
"Interactions" : ImageInteractionOptions
,
"Scaling" : SheetImageScalingConfiguration
,
"SheetImageId" : String
,
"Source" : SheetImageSource
,
"Tooltip" : SheetImageTooltipConfiguration
}
YAML
Actions:
- ImageCustomAction
ImageContentAltText: String
Interactions:
ImageInteractionOptions
Scaling:
SheetImageScalingConfiguration
SheetImageId: String
Source:
SheetImageSource
Tooltip:
SheetImageTooltipConfiguration
Properties
Actions
-
A list of custom actions that are configured for an image.
Required: No
Type: Array of ImageCustomAction
Minimum:
0
Maximum:
10
Update requires: No interruption
ImageContentAltText
-
The alt text for the image.
Required: No
Type: String
Minimum:
1
Maximum:
1024
Update requires: No interruption
Interactions
-
The general image interactions setup for an image.
Required: No
Type: ImageInteractionOptions
Update requires: No interruption
Scaling
-
Determines how the image is scaled.
Required: No
Type: SheetImageScalingConfiguration
Update requires: No interruption
SheetImageId
-
The ID of the sheet image.
Required: Yes
Type: String
Pattern:
^[\w\-]+$
Minimum:
1
Maximum:
512
Update requires: No interruption
Source
-
The source of the image.
Required: Yes
Type: SheetImageSource
Update requires: No interruption
Tooltip
-
The tooltip to be shown when hovering over the image.
Required: No
Type: SheetImageTooltipConfiguration
Update requires: No interruption