CfnActionConnector

class aws_cdk.aws_quicksight.CfnActionConnector(scope, id, *, action_connector_id, aws_account_id, name, type, authentication_config=None, description=None, permissions=None, tags=None, vpc_connection_arn=None)

Bases: CfnResource

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

See:

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

CloudformationResource:

AWS::QuickSight::ActionConnector

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 = quicksight.CfnActionConnector(self, "MyCfnActionConnector",
    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"
)

Create a new AWS::QuickSight::ActionConnector.

Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • 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])

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource)

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str)

  • value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

  • policy (Optional[RemovalPolicy])

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str)

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::QuickSight::ActionConnector'
action_connector_id
action_connector_ref

A reference to a ActionConnector resource.

attr_arn

Arn

Type:

cloudformationAttribute

attr_created_time

CreatedTime

Type:

cloudformationAttribute

attr_enabled_actions

EnabledActions

Type:

cloudformationAttribute

attr_last_updated_time

LastUpdatedTime

Type:

cloudformationAttribute

attr_status

Status

Type:

cloudformationAttribute

authentication_config
aws_account_id
cdk_tag_manager

Tag Manager which manages the tags for this resource.

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description
env
logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name
node

The tree node.

permissions
ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags
type
vpc_connection_arn

Static Methods

classmethod arn_for_action_connector(resource)
Parameters:

resource (IActionConnectorRef)

Return type:

str

classmethod is_cfn_action_connector(x)

Checks whether the given object is a CfnActionConnector.

Parameters:

x (Any)

Return type:

bool

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any)

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any)

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

APIKeyConnectionMetadataProperty

class CfnActionConnector.APIKeyConnectionMetadataProperty(*, api_key, base_endpoint, email=None)

Bases: object

Parameters:

  • api_key (str)

  • base_endpoint (str)

  • email (Optional[str])

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

a_pIKey_connection_metadata_property = quicksight.CfnActionConnector.APIKeyConnectionMetadataProperty(
    api_key="apiKey",
    base_endpoint="baseEndpoint",

    # the properties below are optional
    email="email"
)

Attributes

api_key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-apikeyconnectionmetadata.html#cfn-quicksight-actionconnector-apikeyconnectionmetadata-apikey

Type:

see

base_endpoint

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-apikeyconnectionmetadata.html#cfn-quicksight-actionconnector-apikeyconnectionmetadata-baseendpoint

Type:

see

email

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-apikeyconnectionmetadata.html#cfn-quicksight-actionconnector-apikeyconnectionmetadata-email

Type:

see

AuthConfigProperty

class CfnActionConnector.AuthConfigProperty(*, authentication_metadata, authentication_type)

Bases: object

Parameters:
See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

auth_config_property = 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"
)

Attributes

authentication_metadata

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-authconfig.html#cfn-quicksight-actionconnector-authconfig-authenticationmetadata

Type:

see

authentication_type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-authconfig.html#cfn-quicksight-actionconnector-authconfig-authenticationtype

Type:

see

AuthenticationMetadataProperty

class CfnActionConnector.AuthenticationMetadataProperty(*, api_key_connection_metadata=None, authorization_code_grant_metadata=None, basic_auth_connection_metadata=None, client_credentials_grant_metadata=None, iam_connection_metadata=None, none_connection_metadata=None)

Bases: object

Parameters:
See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

authentication_metadata_property = 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"
    )
)

Attributes

api_key_connection_metadata

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-authenticationmetadata.html#cfn-quicksight-actionconnector-authenticationmetadata-apikeyconnectionmetadata

Type:

see

authorization_code_grant_metadata

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-authenticationmetadata.html#cfn-quicksight-actionconnector-authenticationmetadata-authorizationcodegrantmetadata

Type:

see

basic_auth_connection_metadata

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-authenticationmetadata.html#cfn-quicksight-actionconnector-authenticationmetadata-basicauthconnectionmetadata

Type:

see

client_credentials_grant_metadata

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-authenticationmetadata.html#cfn-quicksight-actionconnector-authenticationmetadata-clientcredentialsgrantmetadata

Type:

see

iam_connection_metadata

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-authenticationmetadata.html#cfn-quicksight-actionconnector-authenticationmetadata-iamconnectionmetadata

Type:

see

none_connection_metadata

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-authenticationmetadata.html#cfn-quicksight-actionconnector-authenticationmetadata-noneconnectionmetadata

Type:

see

AuthorizationCodeGrantCredentialsDetailsProperty

class CfnActionConnector.AuthorizationCodeGrantCredentialsDetailsProperty(*, authorization_code_grant_details)

Bases: object

Parameters:

authorization_code_grant_details (Union[IResolvable, AuthorizationCodeGrantDetailsProperty, Dict[str, Any]])

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

authorization_code_grant_credentials_details_property = quicksight.CfnActionConnector.AuthorizationCodeGrantCredentialsDetailsProperty(
    authorization_code_grant_details=quicksight.CfnActionConnector.AuthorizationCodeGrantDetailsProperty(
        authorization_endpoint="authorizationEndpoint",
        client_id="clientId",
        client_secret="clientSecret",
        token_endpoint="tokenEndpoint"
    )
)

Attributes

authorization_code_grant_details

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-authorizationcodegrantcredentialsdetails.html#cfn-quicksight-actionconnector-authorizationcodegrantcredentialsdetails-authorizationcodegrantdetails

Type:

see

AuthorizationCodeGrantDetailsProperty

class CfnActionConnector.AuthorizationCodeGrantDetailsProperty(*, authorization_endpoint, client_id, client_secret, token_endpoint)

Bases: object

Parameters:

  • authorization_endpoint (str)

  • client_id (str)

  • client_secret (str)

  • token_endpoint (str)

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

authorization_code_grant_details_property = quicksight.CfnActionConnector.AuthorizationCodeGrantDetailsProperty(
    authorization_endpoint="authorizationEndpoint",
    client_id="clientId",
    client_secret="clientSecret",
    token_endpoint="tokenEndpoint"
)

Attributes

authorization_endpoint

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-authorizationcodegrantdetails.html#cfn-quicksight-actionconnector-authorizationcodegrantdetails-authorizationendpoint

Type:

see

client_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-authorizationcodegrantdetails.html#cfn-quicksight-actionconnector-authorizationcodegrantdetails-clientid

Type:

see

client_secret

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-authorizationcodegrantdetails.html#cfn-quicksight-actionconnector-authorizationcodegrantdetails-clientsecret

Type:

see

token_endpoint

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-authorizationcodegrantdetails.html#cfn-quicksight-actionconnector-authorizationcodegrantdetails-tokenendpoint

Type:

see

AuthorizationCodeGrantMetadataProperty

class CfnActionConnector.AuthorizationCodeGrantMetadataProperty(*, base_endpoint, redirect_url, authorization_code_grant_credentials_details=None, authorization_code_grant_credentials_source=None)

Bases: object

Parameters:
See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

authorization_code_grant_metadata_property = 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"
)

Attributes

authorization_code_grant_credentials_details

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-authorizationcodegrantmetadata.html#cfn-quicksight-actionconnector-authorizationcodegrantmetadata-authorizationcodegrantcredentialsdetails

Type:

see

authorization_code_grant_credentials_source

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-authorizationcodegrantmetadata.html#cfn-quicksight-actionconnector-authorizationcodegrantmetadata-authorizationcodegrantcredentialssource

Type:

see

base_endpoint

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-authorizationcodegrantmetadata.html#cfn-quicksight-actionconnector-authorizationcodegrantmetadata-baseendpoint

Type:

see

redirect_url

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-authorizationcodegrantmetadata.html#cfn-quicksight-actionconnector-authorizationcodegrantmetadata-redirecturl

Type:

see

BasicAuthConnectionMetadataProperty

class CfnActionConnector.BasicAuthConnectionMetadataProperty(*, base_endpoint, password, username)

Bases: object

Parameters:

  • base_endpoint (str)

  • password (str)

  • username (str)

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

basic_auth_connection_metadata_property = quicksight.CfnActionConnector.BasicAuthConnectionMetadataProperty(
    base_endpoint="baseEndpoint",
    password="password",
    username="username"
)

Attributes

base_endpoint

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-basicauthconnectionmetadata.html#cfn-quicksight-actionconnector-basicauthconnectionmetadata-baseendpoint

Type:

see

password

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-basicauthconnectionmetadata.html#cfn-quicksight-actionconnector-basicauthconnectionmetadata-password

Type:

see

username

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-basicauthconnectionmetadata.html#cfn-quicksight-actionconnector-basicauthconnectionmetadata-username

Type:

see

ClientCredentialsDetailsProperty

class CfnActionConnector.ClientCredentialsDetailsProperty(*, client_credentials_grant_details)

Bases: object

Parameters:

client_credentials_grant_details (Union[IResolvable, ClientCredentialsGrantDetailsProperty, Dict[str, Any]])

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

client_credentials_details_property = quicksight.CfnActionConnector.ClientCredentialsDetailsProperty(
    client_credentials_grant_details=quicksight.CfnActionConnector.ClientCredentialsGrantDetailsProperty(
        client_id="clientId",
        client_secret="clientSecret",
        token_endpoint="tokenEndpoint"
    )
)

Attributes

client_credentials_grant_details

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-clientcredentialsdetails.html#cfn-quicksight-actionconnector-clientcredentialsdetails-clientcredentialsgrantdetails

Type:

see

ClientCredentialsGrantDetailsProperty

class CfnActionConnector.ClientCredentialsGrantDetailsProperty(*, client_id, client_secret, token_endpoint)

Bases: object

Parameters:

  • client_id (str)

  • client_secret (str)

  • token_endpoint (str)

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

client_credentials_grant_details_property = quicksight.CfnActionConnector.ClientCredentialsGrantDetailsProperty(
    client_id="clientId",
    client_secret="clientSecret",
    token_endpoint="tokenEndpoint"
)

Attributes

client_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-clientcredentialsgrantdetails.html#cfn-quicksight-actionconnector-clientcredentialsgrantdetails-clientid

Type:

see

client_secret

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-clientcredentialsgrantdetails.html#cfn-quicksight-actionconnector-clientcredentialsgrantdetails-clientsecret

Type:

see

token_endpoint

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-clientcredentialsgrantdetails.html#cfn-quicksight-actionconnector-clientcredentialsgrantdetails-tokenendpoint

Type:

see

ClientCredentialsGrantMetadataProperty

class CfnActionConnector.ClientCredentialsGrantMetadataProperty(*, base_endpoint, client_credentials_details=None, client_credentials_source=None)

Bases: object

Parameters:
See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

client_credentials_grant_metadata_property = 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"
)

Attributes

base_endpoint

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-clientcredentialsgrantmetadata.html#cfn-quicksight-actionconnector-clientcredentialsgrantmetadata-baseendpoint

Type:

see

client_credentials_details

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-clientcredentialsgrantmetadata.html#cfn-quicksight-actionconnector-clientcredentialsgrantmetadata-clientcredentialsdetails

Type:

see

client_credentials_source

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-clientcredentialsgrantmetadata.html#cfn-quicksight-actionconnector-clientcredentialsgrantmetadata-clientcredentialssource

Type:

see

IAMConnectionMetadataProperty

class CfnActionConnector.IAMConnectionMetadataProperty(*, role_arn)

Bases: object

Parameters:

role_arn (str)

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

i_aMConnection_metadata_property = {
    "role_arn": "roleArn"
}

Attributes

role_arn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-iamconnectionmetadata.html#cfn-quicksight-actionconnector-iamconnectionmetadata-rolearn

Type:

see

NoneConnectionMetadataProperty

class CfnActionConnector.NoneConnectionMetadataProperty(*, base_endpoint)

Bases: object

Parameters:

base_endpoint (str)

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

none_connection_metadata_property = quicksight.CfnActionConnector.NoneConnectionMetadataProperty(
    base_endpoint="baseEndpoint"
)

Attributes

base_endpoint

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-noneconnectionmetadata.html#cfn-quicksight-actionconnector-noneconnectionmetadata-baseendpoint

Type:

see

ResourcePermissionProperty

class CfnActionConnector.ResourcePermissionProperty(*, actions, principal)

Bases: object

Parameters:

  • actions (Sequence[str])

  • principal (str) – This can be one of the following: The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

resource_permission_property = quicksight.CfnActionConnector.ResourcePermissionProperty(
    actions=["actions"],
    principal="principal"
)

Attributes

actions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-resourcepermission.html#cfn-quicksight-actionconnector-resourcepermission-actions

Type:

see

principal

This can be one of the following:

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-resourcepermission.html#cfn-quicksight-actionconnector-resourcepermission-principal