CfnActionConnectorPropsMixin
- class aws_cdk.mixins_preview.aws_quicksight.mixins.CfnActionConnectorPropsMixin(props, *, strategy=None)
Bases:
MixinDefinition of the AWS::QuickSight::ActionConnector Resource Type.
- See:
- CloudformationResource:
AWS::QuickSight::ActionConnector
- Mixin:
true
- 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.mixins_preview import mixins from aws_cdk.mixins_preview.aws_quicksight import mixins as quicksight_mixins cfn_action_connector_props_mixin = quicksight_mixins.CfnActionConnectorPropsMixin(quicksight_mixins.CfnActionConnectorMixinProps( action_connector_id="actionConnectorId", authentication_config=quicksight_mixins.CfnActionConnectorPropsMixin.AuthConfigProperty( authentication_metadata=quicksight_mixins.CfnActionConnectorPropsMixin.AuthenticationMetadataProperty( api_key_connection_metadata=quicksight_mixins.CfnActionConnectorPropsMixin.APIKeyConnectionMetadataProperty( api_key="apiKey", base_endpoint="baseEndpoint", email="email" ), authorization_code_grant_metadata=quicksight_mixins.CfnActionConnectorPropsMixin.AuthorizationCodeGrantMetadataProperty( authorization_code_grant_credentials_details=quicksight_mixins.CfnActionConnectorPropsMixin.AuthorizationCodeGrantCredentialsDetailsProperty( authorization_code_grant_details=quicksight_mixins.CfnActionConnectorPropsMixin.AuthorizationCodeGrantDetailsProperty( authorization_endpoint="authorizationEndpoint", client_id="clientId", client_secret="clientSecret", token_endpoint="tokenEndpoint" ) ), authorization_code_grant_credentials_source="authorizationCodeGrantCredentialsSource", base_endpoint="baseEndpoint", redirect_url="redirectUrl" ), basic_auth_connection_metadata=quicksight_mixins.CfnActionConnectorPropsMixin.BasicAuthConnectionMetadataProperty( base_endpoint="baseEndpoint", password="password", username="username" ), client_credentials_grant_metadata=quicksight_mixins.CfnActionConnectorPropsMixin.ClientCredentialsGrantMetadataProperty( base_endpoint="baseEndpoint", client_credentials_details=quicksight_mixins.CfnActionConnectorPropsMixin.ClientCredentialsDetailsProperty( client_credentials_grant_details=quicksight_mixins.CfnActionConnectorPropsMixin.ClientCredentialsGrantDetailsProperty( client_id="clientId", client_secret="clientSecret", token_endpoint="tokenEndpoint" ) ), client_credentials_source="clientCredentialsSource" ), iam_connection_metadata={ "role_arn": "roleArn" }, none_connection_metadata=quicksight_mixins.CfnActionConnectorPropsMixin.NoneConnectionMetadataProperty( base_endpoint="baseEndpoint" ) ), authentication_type="authenticationType" ), aws_account_id="awsAccountId", description="description", name="name", permissions=[quicksight_mixins.CfnActionConnectorPropsMixin.ResourcePermissionProperty( actions=["actions"], principal="principal" )], tags=[CfnTag( key="key", value="value" )], type="type", vpc_connection_arn="vpcConnectionArn" ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::QuickSight::ActionConnector.- Parameters:
props (
Union[CfnActionConnectorMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['actionConnectorId', 'authenticationConfig', 'awsAccountId', 'description', 'name', 'permissions', 'tags', 'type', 'vpcConnectionArn']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
APIKeyConnectionMetadataProperty
- class CfnActionConnectorPropsMixin.APIKeyConnectionMetadataProperty(*, api_key=None, base_endpoint=None, email=None)
Bases:
object- Parameters:
api_key (
Optional[str])base_endpoint (
Optional[str])email (
Optional[str])
- See:
- 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.mixins_preview.aws_quicksight import mixins as quicksight_mixins a_pIKey_connection_metadata_property = quicksight_mixins.CfnActionConnectorPropsMixin.APIKeyConnectionMetadataProperty( api_key="apiKey", base_endpoint="baseEndpoint", email="email" )
Attributes
- api_key
-
- Type:
see
- base_endpoint
-
- Type:
see
AuthConfigProperty
- class CfnActionConnectorPropsMixin.AuthConfigProperty(*, authentication_metadata=None, authentication_type=None)
Bases:
object- Parameters:
authentication_metadata (
Union[IResolvable,AuthenticationMetadataProperty,Dict[str,Any],None])authentication_type (
Optional[str])
- See:
- 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.mixins_preview.aws_quicksight import mixins as quicksight_mixins auth_config_property = quicksight_mixins.CfnActionConnectorPropsMixin.AuthConfigProperty( authentication_metadata=quicksight_mixins.CfnActionConnectorPropsMixin.AuthenticationMetadataProperty( api_key_connection_metadata=quicksight_mixins.CfnActionConnectorPropsMixin.APIKeyConnectionMetadataProperty( api_key="apiKey", base_endpoint="baseEndpoint", email="email" ), authorization_code_grant_metadata=quicksight_mixins.CfnActionConnectorPropsMixin.AuthorizationCodeGrantMetadataProperty( authorization_code_grant_credentials_details=quicksight_mixins.CfnActionConnectorPropsMixin.AuthorizationCodeGrantCredentialsDetailsProperty( authorization_code_grant_details=quicksight_mixins.CfnActionConnectorPropsMixin.AuthorizationCodeGrantDetailsProperty( authorization_endpoint="authorizationEndpoint", client_id="clientId", client_secret="clientSecret", token_endpoint="tokenEndpoint" ) ), authorization_code_grant_credentials_source="authorizationCodeGrantCredentialsSource", base_endpoint="baseEndpoint", redirect_url="redirectUrl" ), basic_auth_connection_metadata=quicksight_mixins.CfnActionConnectorPropsMixin.BasicAuthConnectionMetadataProperty( base_endpoint="baseEndpoint", password="password", username="username" ), client_credentials_grant_metadata=quicksight_mixins.CfnActionConnectorPropsMixin.ClientCredentialsGrantMetadataProperty( base_endpoint="baseEndpoint", client_credentials_details=quicksight_mixins.CfnActionConnectorPropsMixin.ClientCredentialsDetailsProperty( client_credentials_grant_details=quicksight_mixins.CfnActionConnectorPropsMixin.ClientCredentialsGrantDetailsProperty( client_id="clientId", client_secret="clientSecret", token_endpoint="tokenEndpoint" ) ), client_credentials_source="clientCredentialsSource" ), iam_connection_metadata={ "role_arn": "roleArn" }, none_connection_metadata=quicksight_mixins.CfnActionConnectorPropsMixin.NoneConnectionMetadataProperty( base_endpoint="baseEndpoint" ) ), authentication_type="authenticationType" )
Attributes
- authentication_metadata
-
- Type:
see
AuthenticationMetadataProperty
- class CfnActionConnectorPropsMixin.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:
api_key_connection_metadata (
Union[IResolvable,APIKeyConnectionMetadataProperty,Dict[str,Any],None])authorization_code_grant_metadata (
Union[IResolvable,AuthorizationCodeGrantMetadataProperty,Dict[str,Any],None])basic_auth_connection_metadata (
Union[IResolvable,BasicAuthConnectionMetadataProperty,Dict[str,Any],None])client_credentials_grant_metadata (
Union[IResolvable,ClientCredentialsGrantMetadataProperty,Dict[str,Any],None])iam_connection_metadata (
Union[IResolvable,IAMConnectionMetadataProperty,Dict[str,Any],None])none_connection_metadata (
Union[IResolvable,NoneConnectionMetadataProperty,Dict[str,Any],None])
- See:
- 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.mixins_preview.aws_quicksight import mixins as quicksight_mixins authentication_metadata_property = quicksight_mixins.CfnActionConnectorPropsMixin.AuthenticationMetadataProperty( api_key_connection_metadata=quicksight_mixins.CfnActionConnectorPropsMixin.APIKeyConnectionMetadataProperty( api_key="apiKey", base_endpoint="baseEndpoint", email="email" ), authorization_code_grant_metadata=quicksight_mixins.CfnActionConnectorPropsMixin.AuthorizationCodeGrantMetadataProperty( authorization_code_grant_credentials_details=quicksight_mixins.CfnActionConnectorPropsMixin.AuthorizationCodeGrantCredentialsDetailsProperty( authorization_code_grant_details=quicksight_mixins.CfnActionConnectorPropsMixin.AuthorizationCodeGrantDetailsProperty( authorization_endpoint="authorizationEndpoint", client_id="clientId", client_secret="clientSecret", token_endpoint="tokenEndpoint" ) ), authorization_code_grant_credentials_source="authorizationCodeGrantCredentialsSource", base_endpoint="baseEndpoint", redirect_url="redirectUrl" ), basic_auth_connection_metadata=quicksight_mixins.CfnActionConnectorPropsMixin.BasicAuthConnectionMetadataProperty( base_endpoint="baseEndpoint", password="password", username="username" ), client_credentials_grant_metadata=quicksight_mixins.CfnActionConnectorPropsMixin.ClientCredentialsGrantMetadataProperty( base_endpoint="baseEndpoint", client_credentials_details=quicksight_mixins.CfnActionConnectorPropsMixin.ClientCredentialsDetailsProperty( client_credentials_grant_details=quicksight_mixins.CfnActionConnectorPropsMixin.ClientCredentialsGrantDetailsProperty( client_id="clientId", client_secret="clientSecret", token_endpoint="tokenEndpoint" ) ), client_credentials_source="clientCredentialsSource" ), iam_connection_metadata={ "role_arn": "roleArn" }, none_connection_metadata=quicksight_mixins.CfnActionConnectorPropsMixin.NoneConnectionMetadataProperty( base_endpoint="baseEndpoint" ) )
Attributes
- api_key_connection_metadata
-
- Type:
see
- authorization_code_grant_metadata
-
- Type:
see
- basic_auth_connection_metadata
-
- Type:
see
- client_credentials_grant_metadata
-
- Type:
see
- iam_connection_metadata
-
- Type:
see
BasicAuthConnectionMetadataProperty
- class CfnActionConnectorPropsMixin.BasicAuthConnectionMetadataProperty(*, base_endpoint=None, password=None, username=None)
Bases:
object- Parameters:
base_endpoint (
Optional[str])password (
Optional[str])username (
Optional[str])
- See:
- 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.mixins_preview.aws_quicksight import mixins as quicksight_mixins basic_auth_connection_metadata_property = quicksight_mixins.CfnActionConnectorPropsMixin.BasicAuthConnectionMetadataProperty( base_endpoint="baseEndpoint", password="password", username="username" )
Attributes
- base_endpoint
-
- Type:
see
- password
-
- Type:
see
ClientCredentialsDetailsProperty
- class CfnActionConnectorPropsMixin.ClientCredentialsDetailsProperty(*, client_credentials_grant_details=None)
Bases:
object- Parameters:
client_credentials_grant_details (
Union[IResolvable,ClientCredentialsGrantDetailsProperty,Dict[str,Any],None])- See:
- 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.mixins_preview.aws_quicksight import mixins as quicksight_mixins client_credentials_details_property = quicksight_mixins.CfnActionConnectorPropsMixin.ClientCredentialsDetailsProperty( client_credentials_grant_details=quicksight_mixins.CfnActionConnectorPropsMixin.ClientCredentialsGrantDetailsProperty( client_id="clientId", client_secret="clientSecret", token_endpoint="tokenEndpoint" ) )
Attributes
ClientCredentialsGrantDetailsProperty
- class CfnActionConnectorPropsMixin.ClientCredentialsGrantDetailsProperty(*, client_id=None, client_secret=None, token_endpoint=None)
Bases:
object- Parameters:
client_id (
Optional[str])client_secret (
Optional[str])token_endpoint (
Optional[str])
- See:
- 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.mixins_preview.aws_quicksight import mixins as quicksight_mixins client_credentials_grant_details_property = quicksight_mixins.CfnActionConnectorPropsMixin.ClientCredentialsGrantDetailsProperty( client_id="clientId", client_secret="clientSecret", token_endpoint="tokenEndpoint" )
Attributes
- client_id
-
- Type:
see
- client_secret
-
- Type:
see
ClientCredentialsGrantMetadataProperty
- class CfnActionConnectorPropsMixin.ClientCredentialsGrantMetadataProperty(*, base_endpoint=None, client_credentials_details=None, client_credentials_source=None)
Bases:
object- Parameters:
base_endpoint (
Optional[str])client_credentials_details (
Union[IResolvable,ClientCredentialsDetailsProperty,Dict[str,Any],None])client_credentials_source (
Optional[str])
- See:
- 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.mixins_preview.aws_quicksight import mixins as quicksight_mixins client_credentials_grant_metadata_property = quicksight_mixins.CfnActionConnectorPropsMixin.ClientCredentialsGrantMetadataProperty( base_endpoint="baseEndpoint", client_credentials_details=quicksight_mixins.CfnActionConnectorPropsMixin.ClientCredentialsDetailsProperty( client_credentials_grant_details=quicksight_mixins.CfnActionConnectorPropsMixin.ClientCredentialsGrantDetailsProperty( client_id="clientId", client_secret="clientSecret", token_endpoint="tokenEndpoint" ) ), client_credentials_source="clientCredentialsSource" )
Attributes
- base_endpoint
-
- Type:
see
- client_credentials_details
-
- Type:
see
IAMConnectionMetadataProperty
- class CfnActionConnectorPropsMixin.IAMConnectionMetadataProperty(*, role_arn=None)
Bases:
object- Parameters:
role_arn (
Optional[str])- See:
- 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.mixins_preview.aws_quicksight import mixins as quicksight_mixins i_aMConnection_metadata_property = { "role_arn": "roleArn" }
Attributes
NoneConnectionMetadataProperty
- class CfnActionConnectorPropsMixin.NoneConnectionMetadataProperty(*, base_endpoint=None)
Bases:
object- Parameters:
base_endpoint (
Optional[str])- See:
- 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.mixins_preview.aws_quicksight import mixins as quicksight_mixins none_connection_metadata_property = quicksight_mixins.CfnActionConnectorPropsMixin.NoneConnectionMetadataProperty( base_endpoint="baseEndpoint" )
Attributes
ResourcePermissionProperty
- class CfnActionConnectorPropsMixin.ResourcePermissionProperty(*, actions=None, principal=None)
Bases:
object- Parameters:
actions (
Optional[Sequence[str]])principal (
Optional[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:
- 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.mixins_preview.aws_quicksight import mixins as quicksight_mixins resource_permission_property = quicksight_mixins.CfnActionConnectorPropsMixin.ResourcePermissionProperty( actions=["actions"], principal="principal" )
Attributes
- actions
-
- Type:
see
- principal
This can be one of the following: