Package software.amazon.awscdk.services.quicksight

Interface CfnActionConnectorProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnActionConnectorProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)",
           date="2026-01-19T12:03:58.841Z")
@Stability(Stable)
public interface CfnActionConnectorProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnActionConnector.

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.*;
 CfnActionConnectorProps cfnActionConnectorProps = CfnActionConnectorProps.builder()
         .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	Interface	Description
static final class	CfnActionConnectorProps.Builder	A builder for CfnActionConnectorProps
static final class	CfnActionConnectorProps.Jsii$Proxy	An implementation for CfnActionConnectorProps

Method Summary

Modifier and Type	Method	Description
static CfnActionConnectorProps.Builder	builder()
String	getActionConnectorId()
default Object	getAuthenticationConfig()	Returns union: either IResolvable or CfnActionConnector.AuthConfigProperty
String	getAwsAccountId()
default String	getDescription()
String	getName()
default Object	getPermissions()	Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnActionConnector.ResourcePermissionProperty>
default List<CfnTag>	getTags()
String	getType()
default String	getVpcConnectionArn()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActionConnectorId

@Stability(Stable)
@NotNull
String getActionConnectorId()

See Also:

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

getAwsAccountId

@Stability(Stable)
@NotNull
String getAwsAccountId()

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

See Also:

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

getType

@Stability(Stable)
@NotNull
String getType()

See Also:

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

getAuthenticationConfig

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

Returns union: either IResolvable or CfnActionConnector.AuthConfigProperty

See Also:

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

getDescription

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

See Also:

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

getPermissions

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

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

See Also:

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

getTags

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

See Also:

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

getVpcConnectionArn

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

See Also:

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

builder

@Stability(Stable)
static CfnActionConnectorProps.Builder builder()

Returns:

a CfnActionConnectorProps.Builder of CfnActionConnectorProps