CfnActionConnectorProps

class aws_cdk.aws_quicksight.CfnActionConnectorProps(*, action_connector_id, aws_account_id, name, type, authentication_config=None, description=None, permissions=None, tags=None, vpc_connection_arn=None)

Bases: object

Properties for defining a CfnActionConnector.

Parameters:

action_connector_id (str)
aws_account_id (str)
name (str)
type (str)
authentication_config (Union[IResolvable, AuthConfigProperty, Dict[str, Any], None])
description (Optional[str])
permissions (Union[IResolvable, Sequence[Union[IResolvable, ResourcePermissionProperty, Dict[str, Any]]], None])
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]])
vpc_connection_arn (Optional[str])

See:

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

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# 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

cfn_action_connector_props = quicksight.CfnActionConnectorProps(
    action_connector_id="actionConnectorId",
    aws_account_id="awsAccountId",
    name="name",
    type="type",

    # the properties below are optional
    authentication_config=quicksight.CfnActionConnector.AuthConfigProperty(
        authentication_metadata=quicksight.CfnActionConnector.AuthenticationMetadataProperty(
            api_key_connection_metadata=quicksight.CfnActionConnector.APIKeyConnectionMetadataProperty(
                api_key="apiKey",
                base_endpoint="baseEndpoint",

                # the properties below are optional
                email="email"
            ),
            authorization_code_grant_metadata=quicksight.CfnActionConnector.AuthorizationCodeGrantMetadataProperty(
                base_endpoint="baseEndpoint",
                redirect_url="redirectUrl",

                # the properties below are optional
                authorization_code_grant_credentials_details=quicksight.CfnActionConnector.AuthorizationCodeGrantCredentialsDetailsProperty(
                    authorization_code_grant_details=quicksight.CfnActionConnector.AuthorizationCodeGrantDetailsProperty(
                        authorization_endpoint="authorizationEndpoint",
                        client_id="clientId",
                        client_secret="clientSecret",
                        token_endpoint="tokenEndpoint"
                    )
                ),
                authorization_code_grant_credentials_source="authorizationCodeGrantCredentialsSource"
            ),
            basic_auth_connection_metadata=quicksight.CfnActionConnector.BasicAuthConnectionMetadataProperty(
                base_endpoint="baseEndpoint",
                password="password",
                username="username"
            ),
            client_credentials_grant_metadata=quicksight.CfnActionConnector.ClientCredentialsGrantMetadataProperty(
                base_endpoint="baseEndpoint",

                # the properties below are optional
                client_credentials_details=quicksight.CfnActionConnector.ClientCredentialsDetailsProperty(
                    client_credentials_grant_details=quicksight.CfnActionConnector.ClientCredentialsGrantDetailsProperty(
                        client_id="clientId",
                        client_secret="clientSecret",
                        token_endpoint="tokenEndpoint"
                    )
                ),
                client_credentials_source="clientCredentialsSource"
            ),
            iam_connection_metadata={
                "role_arn": "roleArn"
            },
            none_connection_metadata=quicksight.CfnActionConnector.NoneConnectionMetadataProperty(
                base_endpoint="baseEndpoint"
            )
        ),
        authentication_type="authenticationType"
    ),
    description="description",
    permissions=[quicksight.CfnActionConnector.ResourcePermissionProperty(
        actions=["actions"],
        principal="principal"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vpc_connection_arn="vpcConnectionArn"
)