Skip to content
v2.277.0

CustomContentConfigurationProperty Struct ​

The configuration of a CustomContentVisual .

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const customContentConfigurationProperty: quicksight.CfnAnalysis.CustomContentConfigurationProperty = {
  contentType: 'contentType',
  contentUrl: 'contentUrl',
  imageScaling: 'imageScaling',
  interactions: {
    contextMenuOption: {
      availabilityStatus: 'availabilityStatus',
    },
    visualMenuOption: {
      availabilityStatus: 'availabilityStatus',
    },
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

custom_content_configuration_property = quicksight.CfnAnalysis.CustomContentConfigurationProperty(
    content_type="contentType",
    content_url="contentUrl",
    image_scaling="imageScaling",
    interactions=quicksight.CfnAnalysis.VisualInteractionOptionsProperty(
        context_menu_option=quicksight.CfnAnalysis.ContextMenuOptionProperty(
            availability_status="availabilityStatus"
        ),
        visual_menu_option=quicksight.CfnAnalysis.VisualMenuOptionProperty(
            availability_status="availabilityStatus"
        )
    )
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.quicksight.*;

CustomContentConfigurationProperty customContentConfigurationProperty = CustomContentConfigurationProperty.builder()
        .contentType("contentType")
        .contentUrl("contentUrl")
        .imageScaling("imageScaling")
        .interactions(VisualInteractionOptionsProperty.builder()
                .contextMenuOption(ContextMenuOptionProperty.builder()
                        .availabilityStatus("availabilityStatus")
                        .build())
                .visualMenuOption(VisualMenuOptionProperty.builder()
                        .availabilityStatus("availabilityStatus")
                        .build())
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;

var customContentConfigurationProperty = new CustomContentConfigurationProperty {
    ContentType = "contentType",
    ContentUrl = "contentUrl",
    ImageScaling = "imageScaling",
    Interactions = new VisualInteractionOptionsProperty {
        ContextMenuOption = new ContextMenuOptionProperty {
            AvailabilityStatus = "availabilityStatus"
        },
        VisualMenuOption = new VisualMenuOptionProperty {
            AvailabilityStatus = "availabilityStatus"
        }
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// 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"

customContentConfigurationProperty := &CustomContentConfigurationProperty{
	ContentType: jsii.String("contentType"),
	ContentUrl: jsii.String("contentUrl"),
	ImageScaling: jsii.String("imageScaling"),
	Interactions: &VisualInteractionOptionsProperty{
		ContextMenuOption: &ContextMenuOptionProperty{
			AvailabilityStatus: jsii.String("availabilityStatus"),
		},
		VisualMenuOption: &VisualMenuOptionProperty{
			AvailabilityStatus: jsii.String("availabilityStatus"),
		},
	},
}

Properties ​

contentTypeoptionalstringcontent_typeoptionalstrcontentTypeoptionalStringContentTypeoptionalstringContentTypeoptional*string#
The content type of the custom content visual.

You can use this to have the visual render as an image.

contentUrloptionalstringcontent_urloptionalstrcontentUrloptionalStringContentUrloptionalstringContentUrloptional*string#
The input URL that links to the custom content that you want in the custom visual.
imageScalingoptionalstringimage_scalingoptionalstrimageScalingoptionalStringImageScalingoptionalstringImageScalingoptional*string#
The sizing options for the size of the custom content visual.

This structure is required when the ContentType of the visual is 'IMAGE' .

interactionsoptionalIResolvable | CfnAnalysis.VisualInteractionOptionsPropertyinteractionsoptionaltyping.Union[IResolvable, VisualInteractionOptionsProperty]interactionsoptionalIResolvableInteractionsoptionalIResolvableInteractionsoptionalinterface{}#
The general visual interactions setup for a visual.