Package software.amazon.awscdk.services.quicksight

Class CfnActionConnector

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.quicksight.CfnActionConnector

All Implemented Interfaces:

IInspectable, IEnvironmentAware, IActionConnectorRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)",
           date="2026-01-19T12:03:58.835Z")
@Stability(Stable)
public class CfnActionConnector
extends CfnResource
implements IInspectable, IActionConnectorRef, ITaggableV2

Definition of the AWS::QuickSight::ActionConnector Resource Type.

Example:

 // 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.*;
 CfnActionConnector cfnActionConnector = CfnActionConnector.Builder.create(this, "MyCfnActionConnector")
         .actionConnectorId("actionConnectorId")
         .awsAccountId("awsAccountId")
         .name("name")
         .type("type")
         // the properties below are optional
         .authenticationConfig(AuthConfigProperty.builder()
                 .authenticationMetadata(AuthenticationMetadataProperty.builder()
                         .apiKeyConnectionMetadata(APIKeyConnectionMetadataProperty.builder()
                                 .apiKey("apiKey")
                                 .baseEndpoint("baseEndpoint")
                                 // the properties below are optional
                                 .email("email")
                                 .build())
                         .authorizationCodeGrantMetadata(AuthorizationCodeGrantMetadataProperty.builder()
                                 .baseEndpoint("baseEndpoint")
                                 .redirectUrl("redirectUrl")
                                 // the properties below are optional
                                 .authorizationCodeGrantCredentialsDetails(AuthorizationCodeGrantCredentialsDetailsProperty.builder()
                                         .authorizationCodeGrantDetails(AuthorizationCodeGrantDetailsProperty.builder()
                                                 .authorizationEndpoint("authorizationEndpoint")
                                                 .clientId("clientId")
                                                 .clientSecret("clientSecret")
                                                 .tokenEndpoint("tokenEndpoint")
                                                 .build())
                                         .build())
                                 .authorizationCodeGrantCredentialsSource("authorizationCodeGrantCredentialsSource")
                                 .build())
                         .basicAuthConnectionMetadata(BasicAuthConnectionMetadataProperty.builder()
                                 .baseEndpoint("baseEndpoint")
                                 .password("password")
                                 .username("username")
                                 .build())
                         .clientCredentialsGrantMetadata(ClientCredentialsGrantMetadataProperty.builder()
                                 .baseEndpoint("baseEndpoint")
                                 // the properties below are optional
                                 .clientCredentialsDetails(ClientCredentialsDetailsProperty.builder()
                                         .clientCredentialsGrantDetails(ClientCredentialsGrantDetailsProperty.builder()
                                                 .clientId("clientId")
                                                 .clientSecret("clientSecret")
                                                 .tokenEndpoint("tokenEndpoint")
                                                 .build())
                                         .build())
                                 .clientCredentialsSource("clientCredentialsSource")
                                 .build())
                         .iamConnectionMetadata(Map.of(
                                 "roleArn", "roleArn"))
                         .noneConnectionMetadata(NoneConnectionMetadataProperty.builder()
                                 .baseEndpoint("baseEndpoint")
                                 .build())
                         .build())
                 .authenticationType("authenticationType")
                 .build())
         .description("description")
         .permissions(List.of(ResourcePermissionProperty.builder()
                 .actions(List.of("actions"))
                 .principal("principal")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcConnectionArn("vpcConnectionArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-actionconnector.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnActionConnector.APIKeyConnectionMetadataProperty	Example:
static interface	CfnActionConnector.AuthConfigProperty	Example:
static interface	CfnActionConnector.AuthenticationMetadataProperty	Example:
static interface	CfnActionConnector.AuthorizationCodeGrantCredentialsDetailsProperty	Example:
static interface	CfnActionConnector.AuthorizationCodeGrantDetailsProperty	Example:
static interface	CfnActionConnector.AuthorizationCodeGrantMetadataProperty	Example:
static interface	CfnActionConnector.BasicAuthConnectionMetadataProperty	Example:
static final class	CfnActionConnector.Builder	A fluent builder for CfnActionConnector.
static interface	CfnActionConnector.ClientCredentialsDetailsProperty	Example:
static interface	CfnActionConnector.ClientCredentialsGrantDetailsProperty	Example:
static interface	CfnActionConnector.ClientCredentialsGrantMetadataProperty	Example:
static interface	CfnActionConnector.IAMConnectionMetadataProperty	Example:
static interface	CfnActionConnector.NoneConnectionMetadataProperty	Example:
static interface	CfnActionConnector.ResourcePermissionProperty	Permission for the resource.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.quicksight.IActionConnectorRef

IActionConnectorRef.Jsii$Default, IActionConnectorRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnActionConnector(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnActionConnector(software.amazon.jsii.JsiiObjectRef objRef)
	CfnActionConnector(software.constructs.Construct scope, String id, CfnActionConnectorProps props)	Create a new AWS::QuickSight::ActionConnector.

Method Summary

Modifier and Type	Method	Description
static String	arnForActionConnector(IActionConnectorRef resource)
String	getActionConnectorId()
ActionConnectorReference	getActionConnectorRef()	A reference to a ActionConnector resource.
String	getAttrArn()
String	getAttrCreatedTime()
List<String>	getAttrEnabledActions()
String	getAttrLastUpdatedTime()
String	getAttrStatus()
Object	getAuthenticationConfig()	Returns union: either IResolvable or CfnActionConnector.AuthConfigProperty
String	getAwsAccountId()
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
String	getDescription()
String	getName()
Object	getPermissions()	Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnActionConnector.ResourcePermissionProperty>
List<CfnTag>	getTags()
String	getType()
String	getVpcConnectionArn()
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnActionConnector(Object x)	Checks whether the given object is a CfnActionConnector.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setActionConnectorId(String value)
void	setAuthenticationConfig(IResolvable value)
void	setAuthenticationConfig(CfnActionConnector.AuthConfigProperty value)
void	setAwsAccountId(String value)
void	setDescription(String value)
void	setName(String value)
void	setPermissions(List<Object> value)
void	setPermissions(IResolvable value)
void	setTags(List<CfnTag> value)
void	setType(String value)
void	setVpcConnectionArn(String value)

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnActionConnector

protected CfnActionConnector(software.amazon.jsii.JsiiObjectRef objRef)

CfnActionConnector

protected CfnActionConnector(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnActionConnector

@Stability(Stable)
public CfnActionConnector(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnActionConnectorProps props)

Create a new AWS::QuickSight::ActionConnector.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

arnForActionConnector

@Stability(Stable)
@NotNull
public static String arnForActionConnector(@NotNull
 IActionConnectorRef resource)

Parameters:

resource - This parameter is required.

isCfnActionConnector

@Stability(Stable)
@NotNull
public static Boolean isCfnActionConnector(@NotNull
 Object x)

Checks whether the given object is a CfnActionConnector.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getActionConnectorRef

@Stability(Stable)
@NotNull
public ActionConnectorReference getActionConnectorRef()

A reference to a ActionConnector resource.

Specified by:

getActionConnectorRef in interface IActionConnectorRef

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

getAttrCreatedTime

@Stability(Stable)
@NotNull
public String getAttrCreatedTime()

getAttrEnabledActions

@Stability(Stable)
@NotNull
public List<String> getAttrEnabledActions()

getAttrLastUpdatedTime

@Stability(Stable)
@NotNull
public String getAttrLastUpdatedTime()

getAttrStatus

@Stability(Stable)
@NotNull
public String getAttrStatus()

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getActionConnectorId

@Stability(Stable)
@NotNull
public String getActionConnectorId()

setActionConnectorId

@Stability(Stable)
public void setActionConnectorId(@NotNull
 String value)

getAwsAccountId

@Stability(Stable)
@NotNull
public String getAwsAccountId()

setAwsAccountId

@Stability(Stable)
public void setAwsAccountId(@NotNull
 String value)

getName

@Stability(Stable)
@NotNull
public String getName()

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

getType

@Stability(Stable)
@NotNull
public String getType()

setType

@Stability(Stable)
public void setType(@NotNull
 String value)

getAuthenticationConfig

@Stability(Stable)
@Nullable
public Object getAuthenticationConfig()

Returns union: either IResolvable or CfnActionConnector.AuthConfigProperty

setAuthenticationConfig

@Stability(Stable)
public void setAuthenticationConfig(@Nullable
 IResolvable value)

setAuthenticationConfig

@Stability(Stable)
public void setAuthenticationConfig(@Nullable
 CfnActionConnector.AuthConfigProperty value)

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

getPermissions

@Stability(Stable)
@Nullable
public Object getPermissions()

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnActionConnector.ResourcePermissionProperty>

setPermissions

@Stability(Stable)
public void setPermissions(@Nullable
 IResolvable value)

setPermissions

@Stability(Stable)
public void setPermissions(@Nullable
 List<Object> value)

getTags

@Stability(Stable)
@Nullable
public List<CfnTag> getTags()

setTags

@Stability(Stable)
public void setTags(@Nullable
 List<CfnTag> value)

getVpcConnectionArn

@Stability(Stable)
@Nullable
public String getVpcConnectionArn()

setVpcConnectionArn

@Stability(Stable)
public void setVpcConnectionArn(@Nullable
 String value)