aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
1,005 lines • 209 kB
TypeScript
import * as cdk from "../../core/lib";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
import { ConnectionReference, DataSourceReference, DomainReference, DomainUnitReference, EnvironmentActionsReference, EnvironmentBlueprintConfigurationReference, EnvironmentProfileReference, EnvironmentReference, FormTypeReference, GroupProfileReference, IConnectionRef, IDataSourceRef, IDomainRef, IDomainUnitRef, IEnvironmentActionsRef, IEnvironmentBlueprintConfigurationRef, IEnvironmentProfileRef, IEnvironmentRef, IFormTypeRef, IGroupProfileRef, IOwnerRef, IPolicyGrantRef, IProjectMembershipRef, IProjectProfileRef, IProjectRef, ISubscriptionTargetRef, IUserProfileRef, OwnerReference, PolicyGrantReference, ProjectMembershipReference, ProjectProfileReference, ProjectReference, SubscriptionTargetReference, UserProfileReference } from "../../interfaces/generated/aws-datazone-interfaces.generated";
/**
* In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.
*
* @cloudformationResource AWS::DataZone::Connection
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html
*/
export declare class CfnConnection extends cdk.CfnResource implements cdk.IInspectable, IConnectionRef {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnConnection from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnConnection;
/**
* Checks whether the given object is a CfnConnection
*/
static isCfnConnection(x: any): x is CfnConnection;
/**
* The ID of the connection.
*
* @cloudformationAttribute ConnectionId
*/
readonly attrConnectionId: string;
/**
* The domain ID of the connection.
*
* @cloudformationAttribute DomainId
*/
readonly attrDomainId: string;
/**
* The domain unit ID of the connection.
*
* @cloudformationAttribute DomainUnitId
*/
readonly attrDomainUnitId: string;
/**
* The ID of the environment.
*
* @cloudformationAttribute EnvironmentId
*/
readonly attrEnvironmentId: string;
/**
* The environment user role.
*
* @cloudformationAttribute EnvironmentUserRole
*/
readonly attrEnvironmentUserRole: string;
/**
* The ID of the project.
*
* @cloudformationAttribute ProjectId
*/
readonly attrProjectId: string;
/**
* The type of the connection.
*
* @cloudformationAttribute Type
*/
readonly attrType: string;
/**
* The location where the connection is created.
*/
awsLocation?: CfnConnection.AwsLocationProperty | cdk.IResolvable;
/**
* Connection description.
*/
description?: string;
/**
* The ID of the domain where the connection is created.
*/
domainIdentifier: string;
/**
* Specifies whether the trusted identity propagation is enabled.
*/
enableTrustedIdentityPropagation?: boolean | cdk.IResolvable;
/**
* The ID of the environment where the connection is created.
*/
environmentIdentifier?: string;
/**
* The name of the connection.
*/
name: string;
/**
* The identifier of the project in which the connection should be created.
*/
projectIdentifier?: string;
/**
* Connection props.
*/
props?: CfnConnection.ConnectionPropertiesInputProperty | cdk.IResolvable;
/**
* The scope of the connection.
*/
scope?: string;
/**
* Create a new `AWS::DataZone::Connection`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnConnectionProps);
get connectionRef(): ConnectionReference;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnConnection {
/**
* The location of a project.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-awslocation.html
*/
interface AwsLocationProperty {
/**
* The access role of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-awslocation.html#cfn-datazone-connection-awslocation-accessrole
*/
readonly accessRole?: string;
/**
* The account ID of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-awslocation.html#cfn-datazone-connection-awslocation-awsaccountid
*/
readonly awsAccountId?: string;
/**
* The Region of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-awslocation.html#cfn-datazone-connection-awslocation-awsregion
*/
readonly awsRegion?: string;
/**
* The IAM connection ID of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-awslocation.html#cfn-datazone-connection-awslocation-iamconnectionid
*/
readonly iamConnectionId?: string;
}
/**
* The properties of a connection.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html
*/
interface ConnectionPropertiesInputProperty {
/**
* Amazon Q properties of the connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-amazonqproperties
*/
readonly amazonQProperties?: CfnConnection.AmazonQPropertiesInputProperty | cdk.IResolvable;
/**
* The Amazon Athena properties of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-athenaproperties
*/
readonly athenaProperties?: CfnConnection.AthenaPropertiesInputProperty | cdk.IResolvable;
/**
* The AWS Glue properties of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-glueproperties
*/
readonly glueProperties?: CfnConnection.GluePropertiesInputProperty | cdk.IResolvable;
/**
* The hyper pod properties of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-hyperpodproperties
*/
readonly hyperPodProperties?: CfnConnection.HyperPodPropertiesInputProperty | cdk.IResolvable;
/**
* The IAM properties of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-iamproperties
*/
readonly iamProperties?: CfnConnection.IamPropertiesInputProperty | cdk.IResolvable;
/**
* MLflow Properties Input.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-mlflowproperties
*/
readonly mlflowProperties?: cdk.IResolvable | CfnConnection.MlflowPropertiesInputProperty;
/**
* The Amazon Redshift properties of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-redshiftproperties
*/
readonly redshiftProperties?: cdk.IResolvable | CfnConnection.RedshiftPropertiesInputProperty;
/**
* S3 Properties Input.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-s3properties
*/
readonly s3Properties?: cdk.IResolvable | CfnConnection.S3PropertiesInputProperty;
/**
* The Spark EMR properties of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-sparkemrproperties
*/
readonly sparkEmrProperties?: cdk.IResolvable | CfnConnection.SparkEmrPropertiesInputProperty;
/**
* The Spark AWS Glue properties of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-sparkglueproperties
*/
readonly sparkGlueProperties?: cdk.IResolvable | CfnConnection.SparkGluePropertiesInputProperty;
}
/**
* The Amazon Athena properties of a connection.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-athenapropertiesinput.html
*/
interface AthenaPropertiesInputProperty {
/**
* The Amazon Athena workgroup name of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-athenapropertiesinput.html#cfn-datazone-connection-athenapropertiesinput-workgroupname
*/
readonly workgroupName: string;
}
/**
* The AWS Glue properties of a connection.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-gluepropertiesinput.html
*/
interface GluePropertiesInputProperty {
/**
* The AWS Glue connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-gluepropertiesinput.html#cfn-datazone-connection-gluepropertiesinput-glueconnectioninput
*/
readonly glueConnectionInput?: CfnConnection.GlueConnectionInputProperty | cdk.IResolvable;
}
/**
* The AWS Glue connecton input.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html
*/
interface GlueConnectionInputProperty {
/**
* The Amazon Athena properties of the AWS Glue connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-athenaproperties
*/
readonly athenaProperties?: cdk.IResolvable | Record<string, string>;
/**
* The authentication configuration of the AWS Glue connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-authenticationconfiguration
*/
readonly authenticationConfiguration?: CfnConnection.AuthenticationConfigurationInputProperty | cdk.IResolvable;
/**
* The connection properties of the AWS Glue connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-connectionproperties
*/
readonly connectionProperties?: cdk.IResolvable | Record<string, string>;
/**
* The connection type of the AWS Glue connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-connectiontype
*/
readonly connectionType?: string;
/**
* The description of the AWS Glue connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-description
*/
readonly description?: string;
/**
* The match criteria of the AWS Glue connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-matchcriteria
*/
readonly matchCriteria?: string;
/**
* The name of the AWS Glue connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-name
*/
readonly name?: string;
/**
* The physical connection requirements for the AWS Glue connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-physicalconnectionrequirements
*/
readonly physicalConnectionRequirements?: cdk.IResolvable | CfnConnection.PhysicalConnectionRequirementsProperty;
/**
* The Python properties of the AWS Glue connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-pythonproperties
*/
readonly pythonProperties?: cdk.IResolvable | Record<string, string>;
/**
* The Spark properties of the AWS Glue connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-sparkproperties
*/
readonly sparkProperties?: cdk.IResolvable | Record<string, string>;
/**
* Speciefies whether to validate credentials of the AWS Glue connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-validatecredentials
*/
readonly validateCredentials?: boolean | cdk.IResolvable;
/**
* Speciefies whether to validate for compute environments of the AWS Glue connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-validateforcomputeenvironments
*/
readonly validateForComputeEnvironments?: Array<string>;
}
/**
* Physical connection requirements of a connection.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-physicalconnectionrequirements.html
*/
interface PhysicalConnectionRequirementsProperty {
/**
* The availability zone of the physical connection requirements of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-physicalconnectionrequirements.html#cfn-datazone-connection-physicalconnectionrequirements-availabilityzone
*/
readonly availabilityZone?: string;
/**
* The group ID list of the physical connection requirements of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-physicalconnectionrequirements.html#cfn-datazone-connection-physicalconnectionrequirements-securitygroupidlist
*/
readonly securityGroupIdList?: Array<string>;
/**
* The subnet ID of the physical connection requirements of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-physicalconnectionrequirements.html#cfn-datazone-connection-physicalconnectionrequirements-subnetid
*/
readonly subnetId?: string;
/**
* The subnet ID list of the physical connection requirements of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-physicalconnectionrequirements.html#cfn-datazone-connection-physicalconnectionrequirements-subnetidlist
*/
readonly subnetIdList?: Array<string>;
}
/**
* The authentication configuration of a connection.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-authenticationconfigurationinput.html
*/
interface AuthenticationConfigurationInputProperty {
/**
* The authentication type of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-authenticationconfigurationinput.html#cfn-datazone-connection-authenticationconfigurationinput-authenticationtype
*/
readonly authenticationType?: string;
/**
* The basic authentication credentials of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-authenticationconfigurationinput.html#cfn-datazone-connection-authenticationconfigurationinput-basicauthenticationcredentials
*/
readonly basicAuthenticationCredentials?: CfnConnection.BasicAuthenticationCredentialsProperty | cdk.IResolvable;
/**
* The custom authentication credentials of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-authenticationconfigurationinput.html#cfn-datazone-connection-authenticationconfigurationinput-customauthenticationcredentials
*/
readonly customAuthenticationCredentials?: cdk.IResolvable | Record<string, string>;
/**
* The KMS key ARN of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-authenticationconfigurationinput.html#cfn-datazone-connection-authenticationconfigurationinput-kmskeyarn
*/
readonly kmsKeyArn?: string;
/**
* The oAuth2 properties of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-authenticationconfigurationinput.html#cfn-datazone-connection-authenticationconfigurationinput-oauth2properties
*/
readonly oAuth2Properties?: cdk.IResolvable | CfnConnection.OAuth2PropertiesProperty;
/**
* The secret ARN of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-authenticationconfigurationinput.html#cfn-datazone-connection-authenticationconfigurationinput-secretarn
*/
readonly secretArn?: string;
}
/**
* The OAuth2 properties.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-oauth2properties.html
*/
interface OAuth2PropertiesProperty {
/**
* The authorization code properties of the OAuth2 properties.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-oauth2properties.html#cfn-datazone-connection-oauth2properties-authorizationcodeproperties
*/
readonly authorizationCodeProperties?: CfnConnection.AuthorizationCodePropertiesProperty | cdk.IResolvable;
/**
* The OAuth2 client application of the OAuth2 properties.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-oauth2properties.html#cfn-datazone-connection-oauth2properties-oauth2clientapplication
*/
readonly oAuth2ClientApplication?: cdk.IResolvable | CfnConnection.OAuth2ClientApplicationProperty;
/**
* The OAuth2 credentials of the OAuth2 properties.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-oauth2properties.html#cfn-datazone-connection-oauth2properties-oauth2credentials
*/
readonly oAuth2Credentials?: CfnConnection.GlueOAuth2CredentialsProperty | cdk.IResolvable;
/**
* The OAuth2 grant type of the OAuth2 properties.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-oauth2properties.html#cfn-datazone-connection-oauth2properties-oauth2granttype
*/
readonly oAuth2GrantType?: string;
/**
* The OAuth2 token URL of the OAuth2 properties.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-oauth2properties.html#cfn-datazone-connection-oauth2properties-tokenurl
*/
readonly tokenUrl?: string;
/**
* The OAuth2 token URL parameter map of the OAuth2 properties.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-oauth2properties.html#cfn-datazone-connection-oauth2properties-tokenurlparametersmap
*/
readonly tokenUrlParametersMap?: cdk.IResolvable | Record<string, string>;
}
/**
* The OAuth2Client application.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-oauth2clientapplication.html
*/
interface OAuth2ClientApplicationProperty {
/**
* The AWS managed client application reference in the OAuth2Client application.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-oauth2clientapplication.html#cfn-datazone-connection-oauth2clientapplication-awsmanagedclientapplicationreference
*/
readonly awsManagedClientApplicationReference?: string;
/**
* The user managed client application client ID in the OAuth2Client application.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-oauth2clientapplication.html#cfn-datazone-connection-oauth2clientapplication-usermanagedclientapplicationclientid
*/
readonly userManagedClientApplicationClientId?: string;
}
/**
* The authorization code properties of a connection.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-authorizationcodeproperties.html
*/
interface AuthorizationCodePropertiesProperty {
/**
* The authorization code of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-authorizationcodeproperties.html#cfn-datazone-connection-authorizationcodeproperties-authorizationcode
*/
readonly authorizationCode?: string;
/**
* The redirect URI of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-authorizationcodeproperties.html#cfn-datazone-connection-authorizationcodeproperties-redirecturi
*/
readonly redirectUri?: string;
}
/**
* The GlueOAuth2 credentials of a connection.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueoauth2credentials.html
*/
interface GlueOAuth2CredentialsProperty {
/**
* The access token of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueoauth2credentials.html#cfn-datazone-connection-glueoauth2credentials-accesstoken
*/
readonly accessToken?: string;
/**
* The jwt token of the connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueoauth2credentials.html#cfn-datazone-connection-glueoauth2credentials-jwttoken
*/
readonly jwtToken?: string;
/**
* The refresh token of the connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueoauth2credentials.html#cfn-datazone-connection-glueoauth2credentials-refreshtoken
*/
readonly refreshToken?: string;
/**
* The user managed client application client secret of the connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueoauth2credentials.html#cfn-datazone-connection-glueoauth2credentials-usermanagedclientapplicationclientsecret
*/
readonly userManagedClientApplicationClientSecret?: string;
}
/**
* The basic authentication credentials of a connection.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-basicauthenticationcredentials.html
*/
interface BasicAuthenticationCredentialsProperty {
/**
* The password for a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-basicauthenticationcredentials.html#cfn-datazone-connection-basicauthenticationcredentials-password
*/
readonly password?: string;
/**
* The user name for the connecion.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-basicauthenticationcredentials.html#cfn-datazone-connection-basicauthenticationcredentials-username
*/
readonly userName?: string;
}
/**
* The hyper pod properties of a AWS Glue properties patch.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-hyperpodpropertiesinput.html
*/
interface HyperPodPropertiesInputProperty {
/**
* The cluster name the hyper pod properties.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-hyperpodpropertiesinput.html#cfn-datazone-connection-hyperpodpropertiesinput-clustername
*/
readonly clusterName: string;
}
/**
* The IAM properties of a connection.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-iampropertiesinput.html
*/
interface IamPropertiesInputProperty {
/**
* Specifies whether AWS Glue lineage sync is enabled for a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-iampropertiesinput.html#cfn-datazone-connection-iampropertiesinput-gluelineagesyncenabled
*/
readonly glueLineageSyncEnabled?: boolean | cdk.IResolvable;
}
/**
* The Amazon Redshift properties.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftpropertiesinput.html
*/
interface RedshiftPropertiesInputProperty {
/**
* The Amaon Redshift credentials.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftpropertiesinput.html#cfn-datazone-connection-redshiftpropertiesinput-credentials
*/
readonly credentials?: cdk.IResolvable | CfnConnection.RedshiftCredentialsProperty;
/**
* The Amazon Redshift database name.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftpropertiesinput.html#cfn-datazone-connection-redshiftpropertiesinput-databasename
*/
readonly databaseName?: string;
/**
* The Amazon Redshift host.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftpropertiesinput.html#cfn-datazone-connection-redshiftpropertiesinput-host
*/
readonly host?: string;
/**
* The lineage sync of the Amazon Redshift.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftpropertiesinput.html#cfn-datazone-connection-redshiftpropertiesinput-lineagesync
*/
readonly lineageSync?: cdk.IResolvable | CfnConnection.RedshiftLineageSyncConfigurationInputProperty;
/**
* The Amaon Redshift port.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftpropertiesinput.html#cfn-datazone-connection-redshiftpropertiesinput-port
*/
readonly port?: number;
/**
* The Amazon Redshift storage.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftpropertiesinput.html#cfn-datazone-connection-redshiftpropertiesinput-storage
*/
readonly storage?: cdk.IResolvable | CfnConnection.RedshiftStoragePropertiesProperty;
}
/**
* The Amazon Redshift storage properties.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftstorageproperties.html
*/
interface RedshiftStoragePropertiesProperty {
/**
* The cluster name in the Amazon Redshift storage properties.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftstorageproperties.html#cfn-datazone-connection-redshiftstorageproperties-clustername
*/
readonly clusterName?: string;
/**
* The workgroup name in the Amazon Redshift storage properties.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftstorageproperties.html#cfn-datazone-connection-redshiftstorageproperties-workgroupname
*/
readonly workgroupName?: string;
}
/**
* Amazon Redshift credentials of a connection.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftcredentials.html
*/
interface RedshiftCredentialsProperty {
/**
* The secret ARN of the Amazon Redshift credentials of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftcredentials.html#cfn-datazone-connection-redshiftcredentials-secretarn
*/
readonly secretArn?: string;
/**
* The username and password of the Amazon Redshift credentials of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftcredentials.html#cfn-datazone-connection-redshiftcredentials-usernamepassword
*/
readonly usernamePassword?: cdk.IResolvable | CfnConnection.UsernamePasswordProperty;
}
/**
* The username and password of a connection.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-usernamepassword.html
*/
interface UsernamePasswordProperty {
/**
* The password of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-usernamepassword.html#cfn-datazone-connection-usernamepassword-password
*/
readonly password: string;
/**
* The username of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-usernamepassword.html#cfn-datazone-connection-usernamepassword-username
*/
readonly username: string;
}
/**
* The Amaon Redshift lineage sync configuration.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftlineagesyncconfigurationinput.html
*/
interface RedshiftLineageSyncConfigurationInputProperty {
/**
* Specifies whether the Amaon Redshift lineage sync configuration is enabled.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftlineagesyncconfigurationinput.html#cfn-datazone-connection-redshiftlineagesyncconfigurationinput-enabled
*/
readonly enabled?: boolean | cdk.IResolvable;
/**
* The schedule of the Amaon Redshift lineage sync configuration.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftlineagesyncconfigurationinput.html#cfn-datazone-connection-redshiftlineagesyncconfigurationinput-schedule
*/
readonly schedule?: cdk.IResolvable | CfnConnection.LineageSyncScheduleProperty;
}
/**
* The lineage sync schedule.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-lineagesyncschedule.html
*/
interface LineageSyncScheduleProperty {
/**
* The lineage sync schedule.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-lineagesyncschedule.html#cfn-datazone-connection-lineagesyncschedule-schedule
*/
readonly schedule?: string;
}
/**
* The Spark EMR properties.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkemrpropertiesinput.html
*/
interface SparkEmrPropertiesInputProperty {
/**
* The compute ARN of Spark EMR.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkemrpropertiesinput.html#cfn-datazone-connection-sparkemrpropertiesinput-computearn
*/
readonly computeArn?: string;
/**
* The instance profile ARN of Spark EMR.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkemrpropertiesinput.html#cfn-datazone-connection-sparkemrpropertiesinput-instanceprofilearn
*/
readonly instanceProfileArn?: string;
/**
* The java virtual env of the Spark EMR.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkemrpropertiesinput.html#cfn-datazone-connection-sparkemrpropertiesinput-javavirtualenv
*/
readonly javaVirtualEnv?: string;
/**
* The log URI of the Spark EMR.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkemrpropertiesinput.html#cfn-datazone-connection-sparkemrpropertiesinput-loguri
*/
readonly logUri?: string;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkemrpropertiesinput.html#cfn-datazone-connection-sparkemrpropertiesinput-managedendpointarn
*/
readonly managedEndpointArn?: string;
/**
* The Python virtual env of the Spark EMR.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkemrpropertiesinput.html#cfn-datazone-connection-sparkemrpropertiesinput-pythonvirtualenv
*/
readonly pythonVirtualEnv?: string;
/**
* The runtime role of the Spark EMR.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkemrpropertiesinput.html#cfn-datazone-connection-sparkemrpropertiesinput-runtimerole
*/
readonly runtimeRole?: string;
/**
* The certificates S3 URI of the Spark EMR.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkemrpropertiesinput.html#cfn-datazone-connection-sparkemrpropertiesinput-trustedcertificatess3uri
*/
readonly trustedCertificatesS3Uri?: string;
}
/**
* Amazon Q properties of the connection.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-amazonqpropertiesinput.html
*/
interface AmazonQPropertiesInputProperty {
/**
* The authentication mode of the connection's AmazonQ properties.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-amazonqpropertiesinput.html#cfn-datazone-connection-amazonqpropertiesinput-authmode
*/
readonly authMode?: string;
/**
* Specifies whether Amazon Q is enabled for the connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-amazonqpropertiesinput.html#cfn-datazone-connection-amazonqpropertiesinput-isenabled
*/
readonly isEnabled?: boolean | cdk.IResolvable;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-amazonqpropertiesinput.html#cfn-datazone-connection-amazonqpropertiesinput-profilearn
*/
readonly profileArn?: string;
}
/**
* The Spark AWS Glue properties.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkgluepropertiesinput.html
*/
interface SparkGluePropertiesInputProperty {
/**
* The additional args in the Spark AWS Glue properties.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkgluepropertiesinput.html#cfn-datazone-connection-sparkgluepropertiesinput-additionalargs
*/
readonly additionalArgs?: cdk.IResolvable | CfnConnection.SparkGlueArgsProperty;
/**
* The AWS Glue connection name in the Spark AWS Glue properties.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkgluepropertiesinput.html#cfn-datazone-connection-sparkgluepropertiesinput-glueconnectionname
*/
readonly glueConnectionName?: string;
/**
* The AWS Glue version in the Spark AWS Glue properties.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkgluepropertiesinput.html#cfn-datazone-connection-sparkgluepropertiesinput-glueversion
*/
readonly glueVersion?: string;
/**
* The idle timeout in the Spark AWS Glue properties.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkgluepropertiesinput.html#cfn-datazone-connection-sparkgluepropertiesinput-idletimeout
*/
readonly idleTimeout?: number;
/**
* The Java virtual env in the Spark AWS Glue properties.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkgluepropertiesinput.html#cfn-datazone-connection-sparkgluepropertiesinput-javavirtualenv
*/
readonly javaVirtualEnv?: string;
/**
* The number of workers in the Spark AWS Glue properties.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkgluepropertiesinput.html#cfn-datazone-connection-sparkgluepropertiesinput-numberofworkers
*/
readonly numberOfWorkers?: number;
/**
* The Python virtual env in the Spark AWS Glue properties.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkgluepropertiesinput.html#cfn-datazone-connection-sparkgluepropertiesinput-pythonvirtualenv
*/
readonly pythonVirtualEnv?: string;
/**
* The worker type in the Spark AWS Glue properties.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkgluepropertiesinput.html#cfn-datazone-connection-sparkgluepropertiesinput-workertype
*/
readonly workerType?: string;
}
/**
* The Spark AWS Glue args.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkglueargs.html
*/
interface SparkGlueArgsProperty {
/**
* The connection in the Spark AWS Glue args.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkglueargs.html#cfn-datazone-connection-sparkglueargs-connection
*/
readonly connection?: string;
}
/**
* S3 Properties Input.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-s3propertiesinput.html
*/
interface S3PropertiesInputProperty {
/**
* The Amazon S3 Access Grant location ID that's part of the Amazon S3 properties of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-s3propertiesinput.html#cfn-datazone-connection-s3propertiesinput-s3accessgrantlocationid
*/
readonly s3AccessGrantLocationId?: string;
/**
* The Amazon S3 URI that's part of the Amazon S3 properties of a connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-s3propertiesinput.html#cfn-datazone-connection-s3propertiesinput-s3uri
*/
readonly s3Uri: string;
}
/**
* MLflow Properties Input.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-mlflowpropertiesinput.html
*/
interface MlflowPropertiesInputProperty {
/**
* The ARN of the MLflow tracking server.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-mlflowpropertiesinput.html#cfn-datazone-connection-mlflowpropertiesinput-trackingserverarn
*/
readonly trackingServerArn?: string;
}
}
/**
* Properties for defining a `CfnConnection`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html
*/
export interface CfnConnectionProps {
/**
* The location where the connection is created.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-awslocation
*/
readonly awsLocation?: CfnConnection.AwsLocationProperty | cdk.IResolvable;
/**
* Connection description.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-description
*/
readonly description?: string;
/**
* The ID of the domain where the connection is created.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-domainidentifier
*/
readonly domainIdentifier: string;
/**
* Specifies whether the trusted identity propagation is enabled.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-enabletrustedidentitypropagation
*/
readonly enableTrustedIdentityPropagation?: boolean | cdk.IResolvable;
/**
* The ID of the environment where the connection is created.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-environmentidentifier
*/
readonly environmentIdentifier?: string;
/**
* The name of the connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-name
*/
readonly name: string;
/**
* The identifier of the project in which the connection should be created.
*
* If
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-projectidentifier
*/
readonly projectIdentifier?: string;
/**
* Connection props.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-props
*/
readonly props?: CfnConnection.ConnectionPropertiesInputProperty | cdk.IResolvable;
/**
* The scope of the connection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-scope
*/
readonly scope?: string;
}
/**
* The `AWS::DataZone::DataSource` resource specifies an Amazon DataZone data source that is used to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone.
*
* @cloudformationResource AWS::DataZone::DataSource
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html
*/
export declare class CfnDataSource extends cdk.CfnResource implements cdk.IInspectable, IDataSourceRef {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnDataSource from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudforma