This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html). # Amazon DataZone **Resource types** + [AWS::DataZone::Connection](aws-resource-datazone-connection.md) + [AWS::DataZone::DataSource](aws-resource-datazone-datasource.md) + [AWS::DataZone::Domain](aws-resource-datazone-domain.md) + [AWS::DataZone::DomainUnit](aws-resource-datazone-domainunit.md) + [AWS::DataZone::Environment](aws-resource-datazone-environment.md) + [AWS::DataZone::EnvironmentActions](aws-resource-datazone-environmentactions.md) + [AWS::DataZone::EnvironmentBlueprintConfiguration](aws-resource-datazone-environmentblueprintconfiguration.md) + [AWS::DataZone::EnvironmentProfile](aws-resource-datazone-environmentprofile.md) + [AWS::DataZone::FormType](aws-resource-datazone-formtype.md) + [AWS::DataZone::GroupProfile](aws-resource-datazone-groupprofile.md) + [AWS::DataZone::Owner](aws-resource-datazone-owner.md) + [AWS::DataZone::PolicyGrant](aws-resource-datazone-policygrant.md) + [AWS::DataZone::Project](aws-resource-datazone-project.md) + [AWS::DataZone::ProjectMembership](aws-resource-datazone-projectmembership.md) + [AWS::DataZone::ProjectProfile](aws-resource-datazone-projectprofile.md) + [AWS::DataZone::SubscriptionTarget](aws-resource-datazone-subscriptiontarget.md) + [AWS::DataZone::UserProfile](aws-resource-datazone-userprofile.md) # AWS::DataZone::Connection In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataZone::Connection", "Properties" : { "[AwsLocation](#cfn-datazone-connection-awslocation)" : AwsLocation, "[Description](#cfn-datazone-connection-description)" : String, "[DomainIdentifier](#cfn-datazone-connection-domainidentifier)" : String, "[EnableTrustedIdentityPropagation](#cfn-datazone-connection-enabletrustedidentitypropagation)" : Boolean, "[EnvironmentIdentifier](#cfn-datazone-connection-environmentidentifier)" : String, "[Name](#cfn-datazone-connection-name)" : String, "[ProjectIdentifier](#cfn-datazone-connection-projectidentifier)" : String, "[Props](#cfn-datazone-connection-props)" : ConnectionPropertiesInput, "[Scope](#cfn-datazone-connection-scope)" : String } } ``` ### YAML ``` Type: AWS::DataZone::Connection Properties: [AwsLocation](#cfn-datazone-connection-awslocation): AwsLocation [Description](#cfn-datazone-connection-description): String [DomainIdentifier](#cfn-datazone-connection-domainidentifier): String [EnableTrustedIdentityPropagation](#cfn-datazone-connection-enabletrustedidentitypropagation): Boolean [EnvironmentIdentifier](#cfn-datazone-connection-environmentidentifier): String [Name](#cfn-datazone-connection-name): String [ProjectIdentifier](#cfn-datazone-connection-projectidentifier): String [Props](#cfn-datazone-connection-props): ConnectionPropertiesInput [Scope](#cfn-datazone-connection-scope): String ``` ## Properties `AwsLocation` The location where the connection is created. *Required*: No *Type*: [AwsLocation](aws-properties-datazone-connection-awslocation.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` Connection description. *Required*: No *Type*: String *Pattern*: `^[\S\s]*$` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DomainIdentifier` The ID of the domain where the connection is created. *Required*: Yes *Type*: String *Pattern*: `^dzd[_-][a-zA-Z0-9_-]{1,36}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EnableTrustedIdentityPropagation` Specifies whether the trusted identity propagation is enabled. *Required*: No *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EnvironmentIdentifier` The ID of the environment where the connection is created. *Required*: No *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Name` The name of the connection. *Required*: Yes *Type*: String *Pattern*: `^[\w][\w\.\-\_]*$` *Maximum*: `64` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ProjectIdentifier` The ID of the project where you want to list connections. *Required*: No *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Props` Connection props. *Required*: No *Type*: [ConnectionPropertiesInput](aws-properties-datazone-connection-connectionpropertiesinput.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Scope` The scope of the connection. *Required*: No *Type*: String *Allowed values*: `DOMAIN | PROJECT` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainId` and `ConnectionId`, which uniquely identifies a connection. For example: `{ "Ref": "MyConnection" }` for the resource with the logical ID `MyConnection`, `Ref` returns `DomainId|ConnectionId`. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `ConnectionId` The ID of the connection. `DomainId` The domain ID of the connection. `DomainUnitId` The domain unit ID of the connection. `EnvironmentId` The ID of the environment. `EnvironmentUserRole` The environment user role. `ProjectId` The ID of the project. `Type` The type of the connection. # AWS::DataZone::Connection AmazonQPropertiesInput The Amazon Q properties of the connection. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AuthMode](#cfn-datazone-connection-amazonqpropertiesinput-authmode)" : String, "[IsEnabled](#cfn-datazone-connection-amazonqpropertiesinput-isenabled)" : Boolean, "[ProfileArn](#cfn-datazone-connection-amazonqpropertiesinput-profilearn)" : String } ``` ### YAML ``` [AuthMode](#cfn-datazone-connection-amazonqpropertiesinput-authmode): String [IsEnabled](#cfn-datazone-connection-amazonqpropertiesinput-isenabled): Boolean [ProfileArn](#cfn-datazone-connection-amazonqpropertiesinput-profilearn): String ``` ## Properties `AuthMode` The authentication mode of the connection's Amazon Q properties. *Required*: No *Type*: String *Minimum*: `0` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IsEnabled` Specifies whether Amazon Q is enabled for the connection. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ProfileArn` The profile ARN of the connection's Amazon Q properties. *Required*: No *Type*: String *Pattern*: `arn:aws[a-z\-]*:[a-z0-9\-]+:[a-z0-9\-]*:[0-9]*:.*` *Minimum*: `0` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Connection AthenaPropertiesInput The Amazon Athena properties of a connection. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[WorkgroupName](#cfn-datazone-connection-athenapropertiesinput-workgroupname)" : String } ``` ### YAML ``` [WorkgroupName](#cfn-datazone-connection-athenapropertiesinput-workgroupname): String ``` ## Properties `WorkgroupName` The Amazon Athena workgroup name of a connection. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9._-]+$` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Connection AuthenticationConfigurationInput The authentication configuration of a connection. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AuthenticationType](#cfn-datazone-connection-authenticationconfigurationinput-authenticationtype)" : String, "[BasicAuthenticationCredentials](#cfn-datazone-connection-authenticationconfigurationinput-basicauthenticationcredentials)" : BasicAuthenticationCredentials, "[CustomAuthenticationCredentials](#cfn-datazone-connection-authenticationconfigurationinput-customauthenticationcredentials)" : {Key: Value, ...}, "[KmsKeyArn](#cfn-datazone-connection-authenticationconfigurationinput-kmskeyarn)" : String, "[OAuth2Properties](#cfn-datazone-connection-authenticationconfigurationinput-oauth2properties)" : OAuth2Properties, "[SecretArn](#cfn-datazone-connection-authenticationconfigurationinput-secretarn)" : String } ``` ### YAML ``` [AuthenticationType](#cfn-datazone-connection-authenticationconfigurationinput-authenticationtype): String [BasicAuthenticationCredentials](#cfn-datazone-connection-authenticationconfigurationinput-basicauthenticationcredentials): BasicAuthenticationCredentials [CustomAuthenticationCredentials](#cfn-datazone-connection-authenticationconfigurationinput-customauthenticationcredentials): Key: Value [KmsKeyArn](#cfn-datazone-connection-authenticationconfigurationinput-kmskeyarn): String [OAuth2Properties](#cfn-datazone-connection-authenticationconfigurationinput-oauth2properties): OAuth2Properties [SecretArn](#cfn-datazone-connection-authenticationconfigurationinput-secretarn): String ``` ## Properties `AuthenticationType` The authentication type of a connection. *Required*: No *Type*: String *Allowed values*: `BASIC | OAUTH2 | CUSTOM` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BasicAuthenticationCredentials` The basic authentication credentials of a connection. *Required*: No *Type*: [BasicAuthenticationCredentials](aws-properties-datazone-connection-basicauthenticationcredentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CustomAuthenticationCredentials` The custom authentication credentials of a connection. *Required*: No *Type*: Object of String *Pattern*: `.+` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KmsKeyArn` The KMS key ARN of a connection. *Required*: No *Type*: String *Pattern*: `^$|arn:aws[a-z0-9-]*:kms:.*$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OAuth2Properties` The oAuth2 properties of a connection. *Required*: No *Type*: [OAuth2Properties](aws-properties-datazone-connection-oauth2properties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecretArn` The secret ARN of a connection. *Required*: No *Type*: String *Pattern*: `^arn:aws(-(cn|us-gov|iso(-[bef])?))?:secretsmanager:.*$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Connection AuthorizationCodeProperties The authorization code properties of a connection. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AuthorizationCode](#cfn-datazone-connection-authorizationcodeproperties-authorizationcode)" : String, "[RedirectUri](#cfn-datazone-connection-authorizationcodeproperties-redirecturi)" : String } ``` ### YAML ``` [AuthorizationCode](#cfn-datazone-connection-authorizationcodeproperties-authorizationcode): String [RedirectUri](#cfn-datazone-connection-authorizationcodeproperties-redirecturi): String ``` ## Properties `AuthorizationCode` The authorization code of a connection. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RedirectUri` The redirect URI of a connection. *Required*: No *Type*: String *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Connection AwsLocation The location of a project. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AccessRole](#cfn-datazone-connection-awslocation-accessrole)" : String, "[AwsAccountId](#cfn-datazone-connection-awslocation-awsaccountid)" : String, "[AwsRegion](#cfn-datazone-connection-awslocation-awsregion)" : String, "[IamConnectionId](#cfn-datazone-connection-awslocation-iamconnectionid)" : String } ``` ### YAML ``` [AccessRole](#cfn-datazone-connection-awslocation-accessrole): String [AwsAccountId](#cfn-datazone-connection-awslocation-awsaccountid): String [AwsRegion](#cfn-datazone-connection-awslocation-awsregion): String [IamConnectionId](#cfn-datazone-connection-awslocation-iamconnectionid): String ``` ## Properties `AccessRole` The access role of a connection. *Required*: No *Type*: String *Pattern*: `^arn:aws[^:]*:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AwsAccountId` The account ID of a connection. *Required*: No *Type*: String *Pattern*: `^\d{12}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AwsRegion` The Region of a connection. *Required*: No *Type*: String *Pattern*: `^[a-z]{2}-[a-z]{4,10}-\d$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IamConnectionId` The IAM connection ID of a connection. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9]+$` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Connection BasicAuthenticationCredentials The basic authentication credentials of a connection. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Password](#cfn-datazone-connection-basicauthenticationcredentials-password)" : String, "[UserName](#cfn-datazone-connection-basicauthenticationcredentials-username)" : String } ``` ### YAML ``` [Password](#cfn-datazone-connection-basicauthenticationcredentials-password): String [UserName](#cfn-datazone-connection-basicauthenticationcredentials-username): String ``` ## Properties `Password` The password for a connection. *Required*: No *Type*: String *Pattern*: `^.*$` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UserName` The user name for the connecion. *Required*: No *Type*: String *Pattern*: `^\S+$` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Connection ConnectionPropertiesInput The properties of a connection. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AmazonQProperties](#cfn-datazone-connection-connectionpropertiesinput-amazonqproperties)" : AmazonQPropertiesInput, "[AthenaProperties](#cfn-datazone-connection-connectionpropertiesinput-athenaproperties)" : AthenaPropertiesInput, "[GlueProperties](#cfn-datazone-connection-connectionpropertiesinput-glueproperties)" : GluePropertiesInput, "[HyperPodProperties](#cfn-datazone-connection-connectionpropertiesinput-hyperpodproperties)" : HyperPodPropertiesInput, "[IamProperties](#cfn-datazone-connection-connectionpropertiesinput-iamproperties)" : IamPropertiesInput, "[MlflowProperties](#cfn-datazone-connection-connectionpropertiesinput-mlflowproperties)" : MlflowPropertiesInput, "[RedshiftProperties](#cfn-datazone-connection-connectionpropertiesinput-redshiftproperties)" : RedshiftPropertiesInput, "[S3Properties](#cfn-datazone-connection-connectionpropertiesinput-s3properties)" : S3PropertiesInput, "[SparkEmrProperties](#cfn-datazone-connection-connectionpropertiesinput-sparkemrproperties)" : SparkEmrPropertiesInput, "[SparkGlueProperties](#cfn-datazone-connection-connectionpropertiesinput-sparkglueproperties)" : SparkGluePropertiesInput, "[WorkflowsMwaaProperties](#cfn-datazone-connection-connectionpropertiesinput-workflowsmwaaproperties)" : WorkflowsMwaaPropertiesInput, "[WorkflowsServerlessProperties](#cfn-datazone-connection-connectionpropertiesinput-workflowsserverlessproperties)" : Json } ``` ### YAML ``` [AmazonQProperties](#cfn-datazone-connection-connectionpropertiesinput-amazonqproperties): AmazonQPropertiesInput [AthenaProperties](#cfn-datazone-connection-connectionpropertiesinput-athenaproperties): AthenaPropertiesInput [GlueProperties](#cfn-datazone-connection-connectionpropertiesinput-glueproperties): GluePropertiesInput [HyperPodProperties](#cfn-datazone-connection-connectionpropertiesinput-hyperpodproperties): HyperPodPropertiesInput [IamProperties](#cfn-datazone-connection-connectionpropertiesinput-iamproperties): IamPropertiesInput [MlflowProperties](#cfn-datazone-connection-connectionpropertiesinput-mlflowproperties): MlflowPropertiesInput [RedshiftProperties](#cfn-datazone-connection-connectionpropertiesinput-redshiftproperties): RedshiftPropertiesInput [S3Properties](#cfn-datazone-connection-connectionpropertiesinput-s3properties): S3PropertiesInput [SparkEmrProperties](#cfn-datazone-connection-connectionpropertiesinput-sparkemrproperties): SparkEmrPropertiesInput [SparkGlueProperties](#cfn-datazone-connection-connectionpropertiesinput-sparkglueproperties): SparkGluePropertiesInput [WorkflowsMwaaProperties](#cfn-datazone-connection-connectionpropertiesinput-workflowsmwaaproperties): WorkflowsMwaaPropertiesInput [WorkflowsServerlessProperties](#cfn-datazone-connection-connectionpropertiesinput-workflowsserverlessproperties): Json ``` ## Properties `AmazonQProperties` The Amazon Q properties of the connection. *Required*: No *Type*: [AmazonQPropertiesInput](aws-properties-datazone-connection-amazonqpropertiesinput.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AthenaProperties` The Amazon Athena properties of a connection. *Required*: No *Type*: [AthenaPropertiesInput](aws-properties-datazone-connection-athenapropertiesinput.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GlueProperties` The AWS Glue properties of a connection. *Required*: No *Type*: [GluePropertiesInput](aws-properties-datazone-connection-gluepropertiesinput.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `HyperPodProperties` The hyper pod properties of a connection. *Required*: No *Type*: [HyperPodPropertiesInput](aws-properties-datazone-connection-hyperpodpropertiesinput.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IamProperties` The IAM properties of a connection. *Required*: No *Type*: [IamPropertiesInput](aws-properties-datazone-connection-iampropertiesinput.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MlflowProperties` The MLflow properties of a connection. *Required*: No *Type*: [MlflowPropertiesInput](aws-properties-datazone-connection-mlflowpropertiesinput.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RedshiftProperties` The Amazon Redshift properties of a connection. *Required*: No *Type*: [RedshiftPropertiesInput](aws-properties-datazone-connection-redshiftpropertiesinput.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3Properties` The Amazon S3 properties of a connection. *Required*: No *Type*: [S3PropertiesInput](aws-properties-datazone-connection-s3propertiesinput.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SparkEmrProperties` The Spark EMR properties of a connection. *Required*: No *Type*: [SparkEmrPropertiesInput](aws-properties-datazone-connection-sparkemrpropertiesinput.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SparkGlueProperties` The Spark AWS Glue properties of a connection. *Required*: No *Type*: [SparkGluePropertiesInput](aws-properties-datazone-connection-sparkgluepropertiesinput.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `WorkflowsMwaaProperties` The Amazon MWAA properties of a connection. *Required*: No *Type*: [WorkflowsMwaaPropertiesInput](aws-properties-datazone-connection-workflowsmwaapropertiesinput.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `WorkflowsServerlessProperties` The MWAA serverless properties of a connection. *Required*: No *Type*: Json *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Connection GlueConnectionInput The AWS Glue connecton input. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AthenaProperties](#cfn-datazone-connection-glueconnectioninput-athenaproperties)" : {Key: Value, ...}, "[AuthenticationConfiguration](#cfn-datazone-connection-glueconnectioninput-authenticationconfiguration)" : AuthenticationConfigurationInput, "[ConnectionProperties](#cfn-datazone-connection-glueconnectioninput-connectionproperties)" : {Key: Value, ...}, "[ConnectionType](#cfn-datazone-connection-glueconnectioninput-connectiontype)" : String, "[Description](#cfn-datazone-connection-glueconnectioninput-description)" : String, "[MatchCriteria](#cfn-datazone-connection-glueconnectioninput-matchcriteria)" : String, "[Name](#cfn-datazone-connection-glueconnectioninput-name)" : String, "[PhysicalConnectionRequirements](#cfn-datazone-connection-glueconnectioninput-physicalconnectionrequirements)" : PhysicalConnectionRequirements, "[PythonProperties](#cfn-datazone-connection-glueconnectioninput-pythonproperties)" : {Key: Value, ...}, "[SparkProperties](#cfn-datazone-connection-glueconnectioninput-sparkproperties)" : {Key: Value, ...}, "[ValidateCredentials](#cfn-datazone-connection-glueconnectioninput-validatecredentials)" : Boolean, "[ValidateForComputeEnvironments](#cfn-datazone-connection-glueconnectioninput-validateforcomputeenvironments)" : [ String, ... ] } ``` ### YAML ``` [AthenaProperties](#cfn-datazone-connection-glueconnectioninput-athenaproperties): Key: Value [AuthenticationConfiguration](#cfn-datazone-connection-glueconnectioninput-authenticationconfiguration): AuthenticationConfigurationInput [ConnectionProperties](#cfn-datazone-connection-glueconnectioninput-connectionproperties): Key: Value [ConnectionType](#cfn-datazone-connection-glueconnectioninput-connectiontype): String [Description](#cfn-datazone-connection-glueconnectioninput-description): String [MatchCriteria](#cfn-datazone-connection-glueconnectioninput-matchcriteria): String [Name](#cfn-datazone-connection-glueconnectioninput-name): String [PhysicalConnectionRequirements](#cfn-datazone-connection-glueconnectioninput-physicalconnectionrequirements): PhysicalConnectionRequirements [PythonProperties](#cfn-datazone-connection-glueconnectioninput-pythonproperties): Key: Value [SparkProperties](#cfn-datazone-connection-glueconnectioninput-sparkproperties): Key: Value [ValidateCredentials](#cfn-datazone-connection-glueconnectioninput-validatecredentials): Boolean [ValidateForComputeEnvironments](#cfn-datazone-connection-glueconnectioninput-validateforcomputeenvironments): - String ``` ## Properties `AthenaProperties` The Amazon Athena properties of the AWS Glue connection. *Required*: No *Type*: Object of String *Pattern*: `^[\u0020-\uD7FF\uE000-\uFFFF\t]*$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AuthenticationConfiguration` The authentication configuration of the AWS Glue connection. *Required*: No *Type*: [AuthenticationConfigurationInput](aws-properties-datazone-connection-authenticationconfigurationinput.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ConnectionProperties` The connection properties of the AWS Glue connection. *Required*: No *Type*: Object of String *Pattern*: `.+` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ConnectionType` The connection type of the AWS Glue connection. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` The description of the AWS Glue connection. *Required*: No *Type*: String *Pattern*: `^[\u0020-\uD7FF\uE000-\uFFFF\r\n\t]*$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MatchCriteria` The match criteria of the AWS Glue connection. *Required*: No *Type*: String *Minimum*: `0` *Maximum*: `10` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the AWS Glue connection. *Required*: No *Type*: String *Pattern*: `^[\u0020-\uD7FF\uE000-\uFFFF\t]*$` *Minimum*: `1` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PhysicalConnectionRequirements` The physical connection requirements for the AWS Glue connection. *Required*: No *Type*: [PhysicalConnectionRequirements](aws-properties-datazone-connection-physicalconnectionrequirements.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PythonProperties` The Python properties of the AWS Glue connection. *Required*: No *Type*: Object of String *Pattern*: `^[\u0020-\uD7FF\uE000-\uFFFF\t]*$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SparkProperties` The Spark properties of the AWS Glue connection. *Required*: No *Type*: Object of String *Pattern*: `^[\u0020-\uD7FF\uE000-\uFFFF\t]*$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ValidateCredentials` Speciefies whether to validate credentials of the AWS Glue connection. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ValidateForComputeEnvironments` Speciefies whether to validate for compute environments of the AWS Glue connection. *Required*: No *Type*: Array of String *Minimum*: `1` *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Connection GlueOAuth2Credentials The GlueOAuth2 credentials of a connection. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AccessToken](#cfn-datazone-connection-glueoauth2credentials-accesstoken)" : String, "[JwtToken](#cfn-datazone-connection-glueoauth2credentials-jwttoken)" : String, "[RefreshToken](#cfn-datazone-connection-glueoauth2credentials-refreshtoken)" : String, "[UserManagedClientApplicationClientSecret](#cfn-datazone-connection-glueoauth2credentials-usermanagedclientapplicationclientsecret)" : String } ``` ### YAML ``` [AccessToken](#cfn-datazone-connection-glueoauth2credentials-accesstoken): String [JwtToken](#cfn-datazone-connection-glueoauth2credentials-jwttoken): String [RefreshToken](#cfn-datazone-connection-glueoauth2credentials-refreshtoken): String [UserManagedClientApplicationClientSecret](#cfn-datazone-connection-glueoauth2credentials-usermanagedclientapplicationclientsecret): String ``` ## Properties `AccessToken` The access token of a connection. *Required*: No *Type*: String *Pattern*: `^[\x20-\x7E]*$` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `JwtToken` The jwt token of the connection. *Required*: No *Type*: String *Pattern*: `^([a-zA-Z0-9_=]+)\.([a-zA-Z0-9_=]+)\.([a-zA-Z0-9_\-\+\/=]*)$` *Maximum*: `8000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RefreshToken` The refresh token of the connection. *Required*: No *Type*: String *Pattern*: `^[\x20-\x7E]*$` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UserManagedClientApplicationClientSecret` The user managed client application client secret of the connection. *Required*: No *Type*: String *Pattern*: `^[\x20-\x7E]*$` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Connection GluePropertiesInput The AWS Glue properties of a connection. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[GlueConnectionInput](#cfn-datazone-connection-gluepropertiesinput-glueconnectioninput)" : GlueConnectionInput } ``` ### YAML ``` [GlueConnectionInput](#cfn-datazone-connection-gluepropertiesinput-glueconnectioninput): GlueConnectionInput ``` ## Properties `GlueConnectionInput` The AWS Glue connection. *Required*: No *Type*: [GlueConnectionInput](aws-properties-datazone-connection-glueconnectioninput.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Connection HyperPodPropertiesInput The hyper pod properties of a AWS Glue properties patch. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ClusterName](#cfn-datazone-connection-hyperpodpropertiesinput-clustername)" : String } ``` ### YAML ``` [ClusterName](#cfn-datazone-connection-hyperpodpropertiesinput-clustername): String ``` ## Properties `ClusterName` The cluster name the hyper pod properties. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$` *Minimum*: `1` *Maximum*: `63` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Connection IamPropertiesInput The IAM properties of a connection. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[GlueLineageSyncEnabled](#cfn-datazone-connection-iampropertiesinput-gluelineagesyncenabled)" : Boolean } ``` ### YAML ``` [GlueLineageSyncEnabled](#cfn-datazone-connection-iampropertiesinput-gluelineagesyncenabled): Boolean ``` ## Properties `GlueLineageSyncEnabled` Specifies whether AWS Glue lineage sync is enabled for a connection. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Connection LineageSyncSchedule The lineage sync schedule. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Schedule](#cfn-datazone-connection-lineagesyncschedule-schedule)" : String } ``` ### YAML ``` [Schedule](#cfn-datazone-connection-lineagesyncschedule-schedule): String ``` ## Properties `Schedule` The lineage sync schedule. *Required*: No *Type*: String *Pattern*: `^cron$(\b[0-5]?[0-9]\b) (\b2[0-3]\b|\b[0-1]?[0-9]\b) ([-?*,/\dLW]){1,83} ([-*,/\d]|[a-zA-Z]{3}){1,23} ([-?#*,/\dL]|[a-zA-Z]{3}){1,13} ([^$]+)\)$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Connection MlflowPropertiesInput The MLflow properties of a connection. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[TrackingServerArn](#cfn-datazone-connection-mlflowpropertiesinput-trackingserverarn)" : String } ``` ### YAML ``` [TrackingServerArn](#cfn-datazone-connection-mlflowpropertiesinput-trackingserverarn): String ``` ## Properties `TrackingServerArn` The tracking server ARN as part of the MLflow properties of a connection. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Connection OAuth2ClientApplication The OAuth2Client application. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AWSManagedClientApplicationReference](#cfn-datazone-connection-oauth2clientapplication-awsmanagedclientapplicationreference)" : String, "[UserManagedClientApplicationClientId](#cfn-datazone-connection-oauth2clientapplication-usermanagedclientapplicationclientid)" : String } ``` ### YAML ``` [AWSManagedClientApplicationReference](#cfn-datazone-connection-oauth2clientapplication-awsmanagedclientapplicationreference): String [UserManagedClientApplicationClientId](#cfn-datazone-connection-oauth2clientapplication-usermanagedclientapplicationclientid): String ``` ## Properties `AWSManagedClientApplicationReference` The AWS managed client application reference in the OAuth2Client application. *Required*: No *Type*: String *Pattern*: `^\S+$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UserManagedClientApplicationClientId` The user managed client application client ID in the OAuth2Client application. *Required*: No *Type*: String *Pattern*: `^\S+$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Connection OAuth2Properties The OAuth2 properties. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AuthorizationCodeProperties](#cfn-datazone-connection-oauth2properties-authorizationcodeproperties)" : AuthorizationCodeProperties, "[OAuth2ClientApplication](#cfn-datazone-connection-oauth2properties-oauth2clientapplication)" : OAuth2ClientApplication, "[OAuth2Credentials](#cfn-datazone-connection-oauth2properties-oauth2credentials)" : GlueOAuth2Credentials, "[OAuth2GrantType](#cfn-datazone-connection-oauth2properties-oauth2granttype)" : String, "[TokenUrl](#cfn-datazone-connection-oauth2properties-tokenurl)" : String, "[TokenUrlParametersMap](#cfn-datazone-connection-oauth2properties-tokenurlparametersmap)" : {Key: Value, ...} } ``` ### YAML ``` [AuthorizationCodeProperties](#cfn-datazone-connection-oauth2properties-authorizationcodeproperties): AuthorizationCodeProperties [OAuth2ClientApplication](#cfn-datazone-connection-oauth2properties-oauth2clientapplication): OAuth2ClientApplication [OAuth2Credentials](#cfn-datazone-connection-oauth2properties-oauth2credentials): GlueOAuth2Credentials [OAuth2GrantType](#cfn-datazone-connection-oauth2properties-oauth2granttype): String [TokenUrl](#cfn-datazone-connection-oauth2properties-tokenurl): String [TokenUrlParametersMap](#cfn-datazone-connection-oauth2properties-tokenurlparametersmap): Key: Value ``` ## Properties `AuthorizationCodeProperties` The authorization code properties of the OAuth2 properties. *Required*: No *Type*: [AuthorizationCodeProperties](aws-properties-datazone-connection-authorizationcodeproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OAuth2ClientApplication` The OAuth2 client application of the OAuth2 properties. *Required*: No *Type*: [OAuth2ClientApplication](aws-properties-datazone-connection-oauth2clientapplication.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OAuth2Credentials` The OAuth2 credentials of the OAuth2 properties. *Required*: No *Type*: [GlueOAuth2Credentials](aws-properties-datazone-connection-glueoauth2credentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OAuth2GrantType` The OAuth2 grant type of the OAuth2 properties. *Required*: No *Type*: String *Allowed values*: `AUTHORIZATION_CODE | CLIENT_CREDENTIALS | JWT_BEARER` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TokenUrl` The OAuth2 token URL of the OAuth2 properties. *Required*: No *Type*: String *Pattern*: `^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]$` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TokenUrlParametersMap` The OAuth2 token URL parameter map of the OAuth2 properties. *Required*: No *Type*: Object of String *Pattern*: `.+` *Minimum*: `1` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Connection PhysicalConnectionRequirements Physical connection requirements of a connection. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AvailabilityZone](#cfn-datazone-connection-physicalconnectionrequirements-availabilityzone)" : String, "[SecurityGroupIdList](#cfn-datazone-connection-physicalconnectionrequirements-securitygroupidlist)" : [ String, ... ], "[SubnetId](#cfn-datazone-connection-physicalconnectionrequirements-subnetid)" : String, "[SubnetIdList](#cfn-datazone-connection-physicalconnectionrequirements-subnetidlist)" : [ String, ... ] } ``` ### YAML ``` [AvailabilityZone](#cfn-datazone-connection-physicalconnectionrequirements-availabilityzone): String [SecurityGroupIdList](#cfn-datazone-connection-physicalconnectionrequirements-securitygroupidlist): - String [SubnetId](#cfn-datazone-connection-physicalconnectionrequirements-subnetid): String [SubnetIdList](#cfn-datazone-connection-physicalconnectionrequirements-subnetidlist): - String ``` ## Properties `AvailabilityZone` The availability zone of the physical connection requirements of a connection. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecurityGroupIdList` The group ID list of the physical connection requirements of a connection. *Required*: No *Type*: Array of String *Minimum*: `1 | 0` *Maximum*: `255 | 50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SubnetId` The subnet ID of the physical connection requirements of a connection. *Required*: No *Type*: String *Pattern*: `^subnet-[a-z0-9]+$` *Maximum*: `32` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SubnetIdList` The subnet ID list of the physical connection requirements of a connection. *Required*: No *Type*: Array of String *Minimum*: `1` *Maximum*: `32 | 50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Connection RedshiftCredentials Amazon Redshift credentials of a connection. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SecretArn](#cfn-datazone-connection-redshiftcredentials-secretarn)" : String, "[UsernamePassword](#cfn-datazone-connection-redshiftcredentials-usernamepassword)" : UsernamePassword } ``` ### YAML ``` [SecretArn](#cfn-datazone-connection-redshiftcredentials-secretarn): String [UsernamePassword](#cfn-datazone-connection-redshiftcredentials-usernamepassword): UsernamePassword ``` ## Properties `SecretArn` The secret ARN of the Amazon Redshift credentials of a connection. *Required*: No *Type*: String *Pattern*: `^arn:aws[^:]*:secretsmanager:[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]:\d{12}:secret:.*$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UsernamePassword` The username and password of the Amazon Redshift credentials of a connection. *Required*: No *Type*: [UsernamePassword](aws-properties-datazone-connection-usernamepassword.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Connection RedshiftLineageSyncConfigurationInput The Amaon Redshift lineage sync configuration. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Enabled](#cfn-datazone-connection-redshiftlineagesyncconfigurationinput-enabled)" : Boolean, "[Schedule](#cfn-datazone-connection-redshiftlineagesyncconfigurationinput-schedule)" : LineageSyncSchedule } ``` ### YAML ``` [Enabled](#cfn-datazone-connection-redshiftlineagesyncconfigurationinput-enabled): Boolean [Schedule](#cfn-datazone-connection-redshiftlineagesyncconfigurationinput-schedule): LineageSyncSchedule ``` ## Properties `Enabled` Specifies whether the Amaon Redshift lineage sync configuration is enabled. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Schedule` The schedule of the Amaon Redshift lineage sync configuration. *Required*: No *Type*: [LineageSyncSchedule](aws-properties-datazone-connection-lineagesyncschedule.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Connection RedshiftPropertiesInput The Amazon Redshift properties. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Credentials](#cfn-datazone-connection-redshiftpropertiesinput-credentials)" : RedshiftCredentials, "[DatabaseName](#cfn-datazone-connection-redshiftpropertiesinput-databasename)" : String, "[Host](#cfn-datazone-connection-redshiftpropertiesinput-host)" : String, "[LineageSync](#cfn-datazone-connection-redshiftpropertiesinput-lineagesync)" : RedshiftLineageSyncConfigurationInput, "[Port](#cfn-datazone-connection-redshiftpropertiesinput-port)" : Number, "[Storage](#cfn-datazone-connection-redshiftpropertiesinput-storage)" : RedshiftStorageProperties } ``` ### YAML ``` [Credentials](#cfn-datazone-connection-redshiftpropertiesinput-credentials): RedshiftCredentials [DatabaseName](#cfn-datazone-connection-redshiftpropertiesinput-databasename): String [Host](#cfn-datazone-connection-redshiftpropertiesinput-host): String [LineageSync](#cfn-datazone-connection-redshiftpropertiesinput-lineagesync): RedshiftLineageSyncConfigurationInput [Port](#cfn-datazone-connection-redshiftpropertiesinput-port): Number [Storage](#cfn-datazone-connection-redshiftpropertiesinput-storage): RedshiftStorageProperties ``` ## Properties `Credentials` The Amaon Redshift credentials. *Required*: No *Type*: [RedshiftCredentials](aws-properties-datazone-connection-redshiftcredentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DatabaseName` The Amazon Redshift database name. *Required*: No *Type*: String *Pattern*: `^[a-z0-9_-]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Host` The Amazon Redshift host. *Required*: No *Type*: String *Pattern*: `^[\S]*$` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LineageSync` The lineage sync of the Amazon Redshift. *Required*: No *Type*: [RedshiftLineageSyncConfigurationInput](aws-properties-datazone-connection-redshiftlineagesyncconfigurationinput.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Port` The Amaon Redshift port. *Required*: No *Type*: Number *Minimum*: `0` *Maximum*: `65535` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Storage` The Amazon Redshift storage. *Required*: No *Type*: [RedshiftStorageProperties](aws-properties-datazone-connection-redshiftstorageproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Connection RedshiftStorageProperties The Amazon Redshift storage properties. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ClusterName](#cfn-datazone-connection-redshiftstorageproperties-clustername)" : String, "[WorkgroupName](#cfn-datazone-connection-redshiftstorageproperties-workgroupname)" : String } ``` ### YAML ``` [ClusterName](#cfn-datazone-connection-redshiftstorageproperties-clustername): String [WorkgroupName](#cfn-datazone-connection-redshiftstorageproperties-workgroupname): String ``` ## Properties `ClusterName` The cluster name in the Amazon Redshift storage properties. *Required*: No *Type*: String *Pattern*: `^[a-z0-9-]+$` *Minimum*: `0` *Maximum*: `63` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `WorkgroupName` The workgroup name in the Amazon Redshift storage properties. *Required*: No *Type*: String *Pattern*: `^[a-z0-9-]+$` *Minimum*: `3` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Connection S3PropertiesInput The Amazon S3 properties of a connection. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[S3AccessGrantLocationId](#cfn-datazone-connection-s3propertiesinput-s3accessgrantlocationid)" : String, "[S3Uri](#cfn-datazone-connection-s3propertiesinput-s3uri)" : String } ``` ### YAML ``` [S3AccessGrantLocationId](#cfn-datazone-connection-s3propertiesinput-s3accessgrantlocationid): String [S3Uri](#cfn-datazone-connection-s3propertiesinput-s3uri): String ``` ## Properties `S3AccessGrantLocationId` The Amazon S3 Access Grant location ID that's part of the Amazon S3 properties of a connection. *Required*: No *Type*: String *Pattern*: `[a-zA-Z0-9\-]+` *Minimum*: `0` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3Uri` The Amazon S3 URI that's part of the Amazon S3 properties of a connection. *Required*: Yes *Type*: String *Pattern*: `s3://.+` *Minimum*: `0` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Connection SparkEmrPropertiesInput The Spark EMR properties. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ComputeArn](#cfn-datazone-connection-sparkemrpropertiesinput-computearn)" : String, "[InstanceProfileArn](#cfn-datazone-connection-sparkemrpropertiesinput-instanceprofilearn)" : String, "[JavaVirtualEnv](#cfn-datazone-connection-sparkemrpropertiesinput-javavirtualenv)" : String, "[LogUri](#cfn-datazone-connection-sparkemrpropertiesinput-loguri)" : String, "[ManagedEndpointArn](#cfn-datazone-connection-sparkemrpropertiesinput-managedendpointarn)" : String, "[PythonVirtualEnv](#cfn-datazone-connection-sparkemrpropertiesinput-pythonvirtualenv)" : String, "[RuntimeRole](#cfn-datazone-connection-sparkemrpropertiesinput-runtimerole)" : String, "[TrustedCertificatesS3Uri](#cfn-datazone-connection-sparkemrpropertiesinput-trustedcertificatess3uri)" : String } ``` ### YAML ``` [ComputeArn](#cfn-datazone-connection-sparkemrpropertiesinput-computearn): String [InstanceProfileArn](#cfn-datazone-connection-sparkemrpropertiesinput-instanceprofilearn): String [JavaVirtualEnv](#cfn-datazone-connection-sparkemrpropertiesinput-javavirtualenv): String [LogUri](#cfn-datazone-connection-sparkemrpropertiesinput-loguri): String [ManagedEndpointArn](#cfn-datazone-connection-sparkemrpropertiesinput-managedendpointarn): String [PythonVirtualEnv](#cfn-datazone-connection-sparkemrpropertiesinput-pythonvirtualenv): String [RuntimeRole](#cfn-datazone-connection-sparkemrpropertiesinput-runtimerole): String [TrustedCertificatesS3Uri](#cfn-datazone-connection-sparkemrpropertiesinput-trustedcertificatess3uri): String ``` ## Properties `ComputeArn` The compute ARN of Spark EMR. *Required*: No *Type*: String *Pattern*: `^arn:aws(-(cn|us-gov|iso(-[bef])?))?:(elasticmapreduce|emr-serverless|emr-containers):.*` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InstanceProfileArn` The instance profile ARN of Spark EMR. *Required*: No *Type*: String *Pattern*: `^arn:aws[^:]*:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `JavaVirtualEnv` The java virtual env of the Spark EMR. *Required*: No *Type*: String *Pattern*: `^[\S]*$` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LogUri` The log URI of the Spark EMR. *Required*: No *Type*: String *Pattern*: `^s3://.+$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ManagedEndpointArn` The managed endpoint ARN of the EMR on EKS cluster. *Required*: No *Type*: String *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PythonVirtualEnv` The Python virtual env of the Spark EMR. *Required*: No *Type*: String *Pattern*: `^[\S]*$` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RuntimeRole` The runtime role of the Spark EMR. *Required*: No *Type*: String *Pattern*: `^arn:aws[^:]*:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TrustedCertificatesS3Uri` The certificates S3 URI of the Spark EMR. *Required*: No *Type*: String *Pattern*: `^s3://.+$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Connection SparkGlueArgs The Spark AWS Glue args. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Connection](#cfn-datazone-connection-sparkglueargs-connection)" : String } ``` ### YAML ``` [Connection](#cfn-datazone-connection-sparkglueargs-connection): String ``` ## Properties `Connection` The connection in the Spark AWS Glue args. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9]+$` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Connection SparkGluePropertiesInput The Spark AWS Glue properties. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AdditionalArgs](#cfn-datazone-connection-sparkgluepropertiesinput-additionalargs)" : SparkGlueArgs, "[GlueConnectionName](#cfn-datazone-connection-sparkgluepropertiesinput-glueconnectionname)" : String, "[GlueVersion](#cfn-datazone-connection-sparkgluepropertiesinput-glueversion)" : String, "[IdleTimeout](#cfn-datazone-connection-sparkgluepropertiesinput-idletimeout)" : Number, "[JavaVirtualEnv](#cfn-datazone-connection-sparkgluepropertiesinput-javavirtualenv)" : String, "[NumberOfWorkers](#cfn-datazone-connection-sparkgluepropertiesinput-numberofworkers)" : Number, "[PythonVirtualEnv](#cfn-datazone-connection-sparkgluepropertiesinput-pythonvirtualenv)" : String, "[WorkerType](#cfn-datazone-connection-sparkgluepropertiesinput-workertype)" : String } ``` ### YAML ``` [AdditionalArgs](#cfn-datazone-connection-sparkgluepropertiesinput-additionalargs): SparkGlueArgs [GlueConnectionName](#cfn-datazone-connection-sparkgluepropertiesinput-glueconnectionname): String [GlueVersion](#cfn-datazone-connection-sparkgluepropertiesinput-glueversion): String [IdleTimeout](#cfn-datazone-connection-sparkgluepropertiesinput-idletimeout): Number [JavaVirtualEnv](#cfn-datazone-connection-sparkgluepropertiesinput-javavirtualenv): String [NumberOfWorkers](#cfn-datazone-connection-sparkgluepropertiesinput-numberofworkers): Number [PythonVirtualEnv](#cfn-datazone-connection-sparkgluepropertiesinput-pythonvirtualenv): String [WorkerType](#cfn-datazone-connection-sparkgluepropertiesinput-workertype): String ``` ## Properties `AdditionalArgs` The additional args in the Spark AWS Glue properties. *Required*: No *Type*: [SparkGlueArgs](aws-properties-datazone-connection-sparkglueargs.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GlueConnectionName` The AWS Glue connection name in the Spark AWS Glue properties. Specify either `glueConnectionName` or `glueConnectionNames`, but not both. *Required*: No *Type*: String *Pattern*: `^[\S]*$` *Minimum*: `1` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GlueVersion` The AWS Glue version in the Spark AWS Glue properties. *Required*: No *Type*: String *Pattern*: `^\w+\.\w+$` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IdleTimeout` The idle timeout in the Spark AWS Glue properties. *Required*: No *Type*: Number *Minimum*: `1` *Maximum*: `3000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `JavaVirtualEnv` The Java virtual env in the Spark AWS Glue properties. *Required*: No *Type*: String *Pattern*: `^[\S]*$` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NumberOfWorkers` The number of workers in the Spark AWS Glue properties. *Required*: No *Type*: Number *Minimum*: `1` *Maximum*: `1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PythonVirtualEnv` The Python virtual env in the Spark AWS Glue properties. *Required*: No *Type*: String *Pattern*: `^[\S]*$` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `WorkerType` The worker type in the Spark AWS Glue properties. *Required*: No *Type*: String *Pattern*: `^[G|Z].*$` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Connection UsernamePassword The username and password of a connection. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Password](#cfn-datazone-connection-usernamepassword-password)" : String, "[Username](#cfn-datazone-connection-usernamepassword-username)" : String } ``` ### YAML ``` [Password](#cfn-datazone-connection-usernamepassword-password): String [Username](#cfn-datazone-connection-usernamepassword-username): String ``` ## Properties `Password` The password of a connection. *Required*: Yes *Type*: String *Pattern*: `^[\S]*$` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Username` The username of a connection. *Required*: Yes *Type*: String *Pattern*: `^[\S]*$` *Minimum*: `1` *Maximum*: `127` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Connection WorkflowsMwaaPropertiesInput The Amazon MWAA properties. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MwaaEnvironmentName](#cfn-datazone-connection-workflowsmwaapropertiesinput-mwaaenvironmentname)" : String } ``` ### YAML ``` [MwaaEnvironmentName](#cfn-datazone-connection-workflowsmwaapropertiesinput-mwaaenvironmentname): String ``` ## Properties `MwaaEnvironmentName` The MWAA environment name. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::DataSource 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. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataZone::DataSource", "Properties" : { "[AssetFormsInput](#cfn-datazone-datasource-assetformsinput)" : [ FormInput, ... ], "[Configuration](#cfn-datazone-datasource-configuration)" : DataSourceConfigurationInput, "[ConnectionIdentifier](#cfn-datazone-datasource-connectionidentifier)" : String, "[Description](#cfn-datazone-datasource-description)" : String, "[DomainIdentifier](#cfn-datazone-datasource-domainidentifier)" : String, "[EnableSetting](#cfn-datazone-datasource-enablesetting)" : String, "[EnvironmentIdentifier](#cfn-datazone-datasource-environmentidentifier)" : String, "[Name](#cfn-datazone-datasource-name)" : String, "[ProjectIdentifier](#cfn-datazone-datasource-projectidentifier)" : String, "[PublishOnImport](#cfn-datazone-datasource-publishonimport)" : Boolean, "[Recommendation](#cfn-datazone-datasource-recommendation)" : RecommendationConfiguration, "[Schedule](#cfn-datazone-datasource-schedule)" : ScheduleConfiguration, "[Type](#cfn-datazone-datasource-type)" : String } } ``` ### YAML ``` Type: AWS::DataZone::DataSource Properties: [AssetFormsInput](#cfn-datazone-datasource-assetformsinput): - FormInput [Configuration](#cfn-datazone-datasource-configuration): DataSourceConfigurationInput [ConnectionIdentifier](#cfn-datazone-datasource-connectionidentifier): String [Description](#cfn-datazone-datasource-description): String [DomainIdentifier](#cfn-datazone-datasource-domainidentifier): String [EnableSetting](#cfn-datazone-datasource-enablesetting): String [EnvironmentIdentifier](#cfn-datazone-datasource-environmentidentifier): String [Name](#cfn-datazone-datasource-name): String [ProjectIdentifier](#cfn-datazone-datasource-projectidentifier): String [PublishOnImport](#cfn-datazone-datasource-publishonimport): Boolean [Recommendation](#cfn-datazone-datasource-recommendation): RecommendationConfiguration [Schedule](#cfn-datazone-datasource-schedule): ScheduleConfiguration [Type](#cfn-datazone-datasource-type): String ``` ## Properties `AssetFormsInput` The metadata forms attached to the assets that the data source works with. *Required*: No *Type*: Array of [FormInput](aws-properties-datazone-datasource-forminput.md) *Minimum*: `0` *Maximum*: `10` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Configuration` The configuration of the data source. *Required*: No *Type*: [DataSourceConfigurationInput](aws-properties-datazone-datasource-datasourceconfigurationinput.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ConnectionIdentifier` The ID of the connection. *Required*: No *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Description` The description of the data source. *Required*: No *Type*: String *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DomainIdentifier` The ID of the Amazon DataZone domain where the data source is created. *Required*: Yes *Type*: String *Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EnableSetting` Specifies whether the data source is enabled. *Required*: No *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EnvironmentIdentifier` The unique identifier of the Amazon DataZone environment to which the data source publishes assets. *Required*: No *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Name` The name of the data source. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ProjectIdentifier` The identifier of the Amazon DataZone project in which you want to add this data source. *Required*: Yes *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `PublishOnImport` Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Recommendation` Specifies whether the business name generation is to be enabled for this data source. *Required*: No *Type*: [RecommendationConfiguration](aws-properties-datazone-datasource-recommendationconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Schedule` The schedule of the data source runs. *Required*: No *Type*: [ScheduleConfiguration](aws-properties-datazone-datasource-scheduleconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The type of the data source. In Amazon DataZone, you can use data sources to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone. In the current release of Amazon DataZone, you can create and run data sources for AWS Glue and Amazon Redshift. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `256` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainId` and the `DataSourceId`, which uniquely identifies the data source. For example: `{ "Ref": "MyDataSource" }` for the resource with the logical ID `MyDataSource`, `Ref` returns `DomainId|DataSourceId`. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `ConnectionId` The connection ID that's part of the data source summary. `CreatedAt` The timestamp of when the data source was created. `DomainId` The ID of the Amazon DataZone domain in which the data source exists. `EnvironmentId` The ID of the environment in which the data source exists. `Id` The identifier of the data source run. `LastRunAssetCount` The count of the assets created during the last data source run. `LastRunAt` The timestamp of when the data source run was last performed. `LastRunStatus` The status of the last data source run. `ProjectId` The project ID included in the data source run activity. `Status` The status of the data source. `UpdatedAt` The timestamp of when the data source was updated. # AWS::DataZone::DataSource DataSourceConfigurationInput The configuration of the data source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[GlueRunConfiguration](#cfn-datazone-datasource-datasourceconfigurationinput-gluerunconfiguration)" : GlueRunConfigurationInput, "[RedshiftRunConfiguration](#cfn-datazone-datasource-datasourceconfigurationinput-redshiftrunconfiguration)" : RedshiftRunConfigurationInput, "[SageMakerRunConfiguration](#cfn-datazone-datasource-datasourceconfigurationinput-sagemakerrunconfiguration)" : SageMakerRunConfigurationInput } ``` ### YAML ``` [GlueRunConfiguration](#cfn-datazone-datasource-datasourceconfigurationinput-gluerunconfiguration): GlueRunConfigurationInput [RedshiftRunConfiguration](#cfn-datazone-datasource-datasourceconfigurationinput-redshiftrunconfiguration): RedshiftRunConfigurationInput [SageMakerRunConfiguration](#cfn-datazone-datasource-datasourceconfigurationinput-sagemakerrunconfiguration): SageMakerRunConfigurationInput ``` ## Properties `GlueRunConfiguration` The configuration of the AWS Glue data source. *Required*: No *Type*: [GlueRunConfigurationInput](aws-properties-datazone-datasource-gluerunconfigurationinput.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RedshiftRunConfiguration` The configuration of the Amazon Redshift data source. *Required*: No *Type*: [RedshiftRunConfigurationInput](aws-properties-datazone-datasource-redshiftrunconfigurationinput.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SageMakerRunConfiguration` The Amazon SageMaker run configuration. *Required*: No *Type*: [SageMakerRunConfigurationInput](aws-properties-datazone-datasource-sagemakerrunconfigurationinput.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::DataSource FilterExpression A filter expression in Amazon DataZone. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Expression](#cfn-datazone-datasource-filterexpression-expression)" : String, "[Type](#cfn-datazone-datasource-filterexpression-type)" : String } ``` ### YAML ``` [Expression](#cfn-datazone-datasource-filterexpression-expression): String [Type](#cfn-datazone-datasource-filterexpression-type): String ``` ## Properties `Expression` The search filter expression. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The search filter explresison type. *Required*: Yes *Type*: String *Allowed values*: `INCLUDE | EXCLUDE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::DataSource FormInput The details of a metadata form. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Content](#cfn-datazone-datasource-forminput-content)" : String, "[FormName](#cfn-datazone-datasource-forminput-formname)" : String, "[TypeIdentifier](#cfn-datazone-datasource-forminput-typeidentifier)" : String, "[TypeRevision](#cfn-datazone-datasource-forminput-typerevision)" : String } ``` ### YAML ``` [Content](#cfn-datazone-datasource-forminput-content): String [FormName](#cfn-datazone-datasource-forminput-formname): String [TypeIdentifier](#cfn-datazone-datasource-forminput-typeidentifier): String [TypeRevision](#cfn-datazone-datasource-forminput-typerevision): String ``` ## Properties `Content` The content of the metadata form. *Required*: No *Type*: String *Maximum*: `75000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FormName` The name of the metadata form. *Required*: Yes *Type*: String *Pattern*: `^(?![0-9_])\w+$|^_\w*[a-zA-Z0-9]\w*$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TypeIdentifier` The ID of the metadata form type. *Required*: No *Type*: String *Pattern*: `^(?!\.)[\w\.]*\w$` *Minimum*: `1` *Maximum*: `385` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TypeRevision` The revision of the metadata form type. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::DataSource GlueRunConfigurationInput The configuration details of the AWS Glue data source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AutoImportDataQualityResult](#cfn-datazone-datasource-gluerunconfigurationinput-autoimportdataqualityresult)" : Boolean, "[CatalogName](#cfn-datazone-datasource-gluerunconfigurationinput-catalogname)" : String, "[DataAccessRole](#cfn-datazone-datasource-gluerunconfigurationinput-dataaccessrole)" : String, "[RelationalFilterConfigurations](#cfn-datazone-datasource-gluerunconfigurationinput-relationalfilterconfigurations)" : [ RelationalFilterConfiguration, ... ] } ``` ### YAML ``` [AutoImportDataQualityResult](#cfn-datazone-datasource-gluerunconfigurationinput-autoimportdataqualityresult): Boolean [CatalogName](#cfn-datazone-datasource-gluerunconfigurationinput-catalogname): String [DataAccessRole](#cfn-datazone-datasource-gluerunconfigurationinput-dataaccessrole): String [RelationalFilterConfigurations](#cfn-datazone-datasource-gluerunconfigurationinput-relationalfilterconfigurations): - RelationalFilterConfiguration ``` ## Properties `AutoImportDataQualityResult` Specifies whether to automatically import data quality metrics as part of the data source run. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CatalogName` The catalog name in the AWS Glue run configuration. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DataAccessRole` The data access role included in the configuration details of the AWS Glue data source. *Required*: No *Type*: String *Pattern*: `^arn:aws[^:]*:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RelationalFilterConfigurations` The relational filter configurations included in the configuration details of the AWS Glue data source. *Required*: Yes *Type*: Array of [RelationalFilterConfiguration](aws-properties-datazone-datasource-relationalfilterconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::DataSource RecommendationConfiguration The recommendation configuration for the data source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[EnableBusinessNameGeneration](#cfn-datazone-datasource-recommendationconfiguration-enablebusinessnamegeneration)" : Boolean } ``` ### YAML ``` [EnableBusinessNameGeneration](#cfn-datazone-datasource-recommendationconfiguration-enablebusinessnamegeneration): Boolean ``` ## Properties `EnableBusinessNameGeneration` Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::DataSource RedshiftClusterStorage The details of the Amazon Redshift cluster storage. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ClusterName](#cfn-datazone-datasource-redshiftclusterstorage-clustername)" : String } ``` ### YAML ``` [ClusterName](#cfn-datazone-datasource-redshiftclusterstorage-clustername): String ``` ## Properties `ClusterName` The name of an Amazon Redshift cluster. *Required*: Yes *Type*: String *Pattern*: `^[0-9a-z].[a-z0-9\-]*$` *Minimum*: `1` *Maximum*: `63` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::DataSource RedshiftCredentialConfiguration The details of the credentials required to access an Amazon Redshift cluster. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SecretManagerArn](#cfn-datazone-datasource-redshiftcredentialconfiguration-secretmanagerarn)" : String } ``` ### YAML ``` [SecretManagerArn](#cfn-datazone-datasource-redshiftcredentialconfiguration-secretmanagerarn): String ``` ## Properties `SecretManagerArn` The ARN of a secret manager for an Amazon Redshift cluster. *Required*: Yes *Type*: String *Pattern*: `^arn:aws[^:]*:secretsmanager:[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]:\d{12}:secret:.*$` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::DataSource RedshiftRunConfigurationInput The relational filter configurations included in the configuration details of the Amazon Redshift data source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DataAccessRole](#cfn-datazone-datasource-redshiftrunconfigurationinput-dataaccessrole)" : String, "[RedshiftCredentialConfiguration](#cfn-datazone-datasource-redshiftrunconfigurationinput-redshiftcredentialconfiguration)" : RedshiftCredentialConfiguration, "[RedshiftStorage](#cfn-datazone-datasource-redshiftrunconfigurationinput-redshiftstorage)" : RedshiftStorage, "[RelationalFilterConfigurations](#cfn-datazone-datasource-redshiftrunconfigurationinput-relationalfilterconfigurations)" : [ RelationalFilterConfiguration, ... ] } ``` ### YAML ``` [DataAccessRole](#cfn-datazone-datasource-redshiftrunconfigurationinput-dataaccessrole): String [RedshiftCredentialConfiguration](#cfn-datazone-datasource-redshiftrunconfigurationinput-redshiftcredentialconfiguration): RedshiftCredentialConfiguration [RedshiftStorage](#cfn-datazone-datasource-redshiftrunconfigurationinput-redshiftstorage): RedshiftStorage [RelationalFilterConfigurations](#cfn-datazone-datasource-redshiftrunconfigurationinput-relationalfilterconfigurations): - RelationalFilterConfiguration ``` ## Properties `DataAccessRole` The data access role included in the configuration details of the Amazon Redshift data source. *Required*: No *Type*: String *Pattern*: `^arn:aws[^:]*:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RedshiftCredentialConfiguration` The details of the credentials required to access an Amazon Redshift cluster. *Required*: No *Type*: [RedshiftCredentialConfiguration](aws-properties-datazone-datasource-redshiftcredentialconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RedshiftStorage` The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run. *Required*: No *Type*: [RedshiftStorage](aws-properties-datazone-datasource-redshiftstorage.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RelationalFilterConfigurations` The relational filter configurations included in the configuration details of the AWS Glue data source. *Required*: Yes *Type*: Array of [RelationalFilterConfiguration](aws-properties-datazone-datasource-relationalfilterconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::DataSource RedshiftServerlessStorage The details of the Amazon Redshift Serverless workgroup storage. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[WorkgroupName](#cfn-datazone-datasource-redshiftserverlessstorage-workgroupname)" : String } ``` ### YAML ``` [WorkgroupName](#cfn-datazone-datasource-redshiftserverlessstorage-workgroupname): String ``` ## Properties `WorkgroupName` The name of the Amazon Redshift Serverless workgroup. *Required*: Yes *Type*: String *Pattern*: `^[a-z0-9-]+$` *Minimum*: `3` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::DataSource RedshiftStorage The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[RedshiftClusterSource](#cfn-datazone-datasource-redshiftstorage-redshiftclustersource)" : RedshiftClusterStorage, "[RedshiftServerlessSource](#cfn-datazone-datasource-redshiftstorage-redshiftserverlesssource)" : RedshiftServerlessStorage } ``` ### YAML ``` [RedshiftClusterSource](#cfn-datazone-datasource-redshiftstorage-redshiftclustersource): RedshiftClusterStorage [RedshiftServerlessSource](#cfn-datazone-datasource-redshiftstorage-redshiftserverlesssource): RedshiftServerlessStorage ``` ## Properties `RedshiftClusterSource` The details of the Amazon Redshift cluster source. *Required*: No *Type*: [RedshiftClusterStorage](aws-properties-datazone-datasource-redshiftclusterstorage.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RedshiftServerlessSource` The details of the Amazon Redshift Serverless workgroup source. *Required*: No *Type*: [RedshiftServerlessStorage](aws-properties-datazone-datasource-redshiftserverlessstorage.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::DataSource RelationalFilterConfiguration The relational filter configuration for the data source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DatabaseName](#cfn-datazone-datasource-relationalfilterconfiguration-databasename)" : String, "[FilterExpressions](#cfn-datazone-datasource-relationalfilterconfiguration-filterexpressions)" : [ FilterExpression, ... ], "[SchemaName](#cfn-datazone-datasource-relationalfilterconfiguration-schemaname)" : String } ``` ### YAML ``` [DatabaseName](#cfn-datazone-datasource-relationalfilterconfiguration-databasename): String [FilterExpressions](#cfn-datazone-datasource-relationalfilterconfiguration-filterexpressions): - FilterExpression [SchemaName](#cfn-datazone-datasource-relationalfilterconfiguration-schemaname): String ``` ## Properties `DatabaseName` The database name specified in the relational filter configuration for the data source. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FilterExpressions` The filter expressions specified in the relational filter configuration for the data source. *Required*: No *Type*: Array of [FilterExpression](aws-properties-datazone-datasource-filterexpression.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SchemaName` The schema name specified in the relational filter configuration for the data source. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::DataSource SageMakerRunConfigurationInput The Amazon SageMaker run configuration. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[TrackingAssets](#cfn-datazone-datasource-sagemakerrunconfigurationinput-trackingassets)" : {Key: Value, ...} } ``` ### YAML ``` [TrackingAssets](#cfn-datazone-datasource-sagemakerrunconfigurationinput-trackingassets): Key: Value ``` ## Properties `TrackingAssets` The tracking assets of the Amazon SageMaker run. *Required*: Yes *Type*: Object of Array *Pattern*: `^.{1,64}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::DataSource ScheduleConfiguration The details of the schedule of the data source runs. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Schedule](#cfn-datazone-datasource-scheduleconfiguration-schedule)" : String, "[Timezone](#cfn-datazone-datasource-scheduleconfiguration-timezone)" : String } ``` ### YAML ``` [Schedule](#cfn-datazone-datasource-scheduleconfiguration-schedule): String [Timezone](#cfn-datazone-datasource-scheduleconfiguration-timezone): String ``` ## Properties `Schedule` The schedule of the data source runs. *Required*: No *Type*: String *Pattern*: `cron$(\b[0-5]?[0-9]\b) (\b2[0-3]\b|\b[0-1]?[0-9]\b) (.*){1,5} (.*){1,5} (.*){1,5} (.*){1,5}$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Timezone` The timezone of the data source run. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Domain The `AWS::DataZone::Domain`resource specifies an Amazon DataZone domain. You can use domains to organize your assets, users, and their projects. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataZone::Domain", "Properties" : { "[Description](#cfn-datazone-domain-description)" : String, "[DomainExecutionRole](#cfn-datazone-domain-domainexecutionrole)" : String, "[DomainVersion](#cfn-datazone-domain-domainversion)" : String, "[KmsKeyIdentifier](#cfn-datazone-domain-kmskeyidentifier)" : String, "[Name](#cfn-datazone-domain-name)" : String, "[ServiceRole](#cfn-datazone-domain-servicerole)" : String, "[SingleSignOn](#cfn-datazone-domain-singlesignon)" : SingleSignOn, "[Tags](#cfn-datazone-domain-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::DataZone::Domain Properties: [Description](#cfn-datazone-domain-description): String [DomainExecutionRole](#cfn-datazone-domain-domainexecutionrole): String [DomainVersion](#cfn-datazone-domain-domainversion): String [KmsKeyIdentifier](#cfn-datazone-domain-kmskeyidentifier): String [Name](#cfn-datazone-domain-name): String [ServiceRole](#cfn-datazone-domain-servicerole): String [SingleSignOn](#cfn-datazone-domain-singlesignon): SingleSignOn [Tags](#cfn-datazone-domain-tags): - Tag ``` ## Properties `Description` The description of the Amazon DataZone domain. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DomainExecutionRole` The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the AWS account that houses the Amazon DataZone domain. *Required*: Yes *Type*: String *Pattern*: `^arn:aws[^:]*:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DomainVersion` The domain version. *Required*: No *Type*: String *Allowed values*: `V1 | V2` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `KmsKeyIdentifier` The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data. *Required*: No *Type*: String *Pattern*: `^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$` *Minimum*: `1` *Maximum*: `1024` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Name` The name of the Amazon DataZone domain. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ServiceRole` The service role of the domain. *Required*: No *Type*: String *Pattern*: `^arn:aws[^:]*:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SingleSignOn` The single sign-on details in Amazon DataZone. *Required*: No *Type*: [SingleSignOn](aws-properties-datazone-domain-singlesignon.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` The tags specified for the Amazon DataZone domain. *Required*: No *Type*: Array of [Tag](aws-properties-datazone-domain-tag.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the Amazon DataZone domain. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `Arn` The ARN of the Amazon DataZone domain. `CreatedAt` A timestamp of when a Amazon DataZone domain was created. `Id` The ID of the Amazon DataZone domain. `LastUpdatedAt` A timestamp of when a Amazon DataZone domain was last updated. `ManagedAccountId` The identifier of the AWS account that manages the domain. `PortalUrl` The data portal URL for the Amazon DataZone domain. `RootDomainUnitId` The ID of the root domain unit. `Status` The status of the Amazon DataZone domain. # AWS::DataZone::Domain SingleSignOn The single sign-on details in Amazon DataZone. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IdcInstanceArn](#cfn-datazone-domain-singlesignon-idcinstancearn)" : String, "[Type](#cfn-datazone-domain-singlesignon-type)" : String, "[UserAssignment](#cfn-datazone-domain-singlesignon-userassignment)" : String } ``` ### YAML ``` [IdcInstanceArn](#cfn-datazone-domain-singlesignon-idcinstancearn): String [Type](#cfn-datazone-domain-singlesignon-type): String [UserAssignment](#cfn-datazone-domain-singlesignon-userassignment): String ``` ## Properties `IdcInstanceArn` The ARN of the IDC instance. *Required*: No *Type*: String *Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}` *Minimum*: `10` *Maximum*: `1224` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The type of single sign-on in Amazon DataZone. *Required*: No *Type*: String *Allowed values*: `IAM_IDC | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UserAssignment` The single sign-on user assignment in Amazon DataZone. *Required*: No *Type*: String *Allowed values*: `AUTOMATIC | MANUAL` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Domain Tag The tags specified for the Amazon DataZone domain. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-datazone-domain-tag-key)" : String, "[Value](#cfn-datazone-domain-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-datazone-domain-tag-key): String [Value](#cfn-datazone-domain-tag-value): String ``` ## Properties `Key` The tag key. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The tag value. *Required*: Yes *Type*: String *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::DomainUnit The summary of the domain unit. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataZone::DomainUnit", "Properties" : { "[Description](#cfn-datazone-domainunit-description)" : String, "[DomainIdentifier](#cfn-datazone-domainunit-domainidentifier)" : String, "[Name](#cfn-datazone-domainunit-name)" : String, "[ParentDomainUnitIdentifier](#cfn-datazone-domainunit-parentdomainunitidentifier)" : String } } ``` ### YAML ``` Type: AWS::DataZone::DomainUnit Properties: [Description](#cfn-datazone-domainunit-description): String [DomainIdentifier](#cfn-datazone-domainunit-domainidentifier): String [Name](#cfn-datazone-domainunit-name): String [ParentDomainUnitIdentifier](#cfn-datazone-domainunit-parentdomainunitidentifier): String ``` ## Properties `Description` The description of the domain unit. *Required*: No *Type*: String *Minimum*: `0` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DomainIdentifier` The ID of the domain where you want to crate a domain unit. *Required*: Yes *Type*: String *Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Name` The name of the domain unit. *Required*: Yes *Type*: String *Pattern*: `^[\w -]+$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ParentDomainUnitIdentifier` The ID of the parent domain unit. *Required*: Yes *Type*: String *Pattern*: `^[a-z0-9_-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainId` and `DomainUnitId`, which uniquely identifies a domain unit. For example: \$1 `"Ref": "MyDomainUnit"` \$1 for the resource with the logical ID MyDomainUnit, Ref returns `DomainId|DomainUnitId`. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `CreatedAt` The time stamp at which the domain unit was created. `DomainId` The ID of the domain in which the domain unit lives. `Id` The ID of the domain unit. `Identifier` The identifier of the domain unit that you want to get. `LastUpdatedAt` The timestamp at which the domain unit was last updated. `ParentDomainUnitId` The ID of the parent domain unit. # AWS::DataZone::Environment The `AWS::DataZone::Environment`resource specifies an Amazon DataZone environment, which is a collection of zero or more configured resources with a given set of IAM principals who can operate on those resources. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataZone::Environment", "Properties" : { "[DeploymentOrder](#cfn-datazone-environment-deploymentorder)" : Integer, "[Description](#cfn-datazone-environment-description)" : String, "[DomainIdentifier](#cfn-datazone-environment-domainidentifier)" : String, "[EnvironmentAccountIdentifier](#cfn-datazone-environment-environmentaccountidentifier)" : String, "[EnvironmentAccountRegion](#cfn-datazone-environment-environmentaccountregion)" : String, "[EnvironmentBlueprintIdentifier](#cfn-datazone-environment-environmentblueprintidentifier)" : String, "[EnvironmentConfigurationId](#cfn-datazone-environment-environmentconfigurationid)" : String, "[EnvironmentProfileIdentifier](#cfn-datazone-environment-environmentprofileidentifier)" : String, "[EnvironmentRoleArn](#cfn-datazone-environment-environmentrolearn)" : String, "[GlossaryTerms](#cfn-datazone-environment-glossaryterms)" : [ String, ... ], "[Name](#cfn-datazone-environment-name)" : String, "[ProjectIdentifier](#cfn-datazone-environment-projectidentifier)" : String, "[UserParameters](#cfn-datazone-environment-userparameters)" : [ EnvironmentParameter, ... ] } } ``` ### YAML ``` Type: AWS::DataZone::Environment Properties: [DeploymentOrder](#cfn-datazone-environment-deploymentorder): Integer [Description](#cfn-datazone-environment-description): String [DomainIdentifier](#cfn-datazone-environment-domainidentifier): String [EnvironmentAccountIdentifier](#cfn-datazone-environment-environmentaccountidentifier): String [EnvironmentAccountRegion](#cfn-datazone-environment-environmentaccountregion): String [EnvironmentBlueprintIdentifier](#cfn-datazone-environment-environmentblueprintidentifier): String [EnvironmentConfigurationId](#cfn-datazone-environment-environmentconfigurationid): String [EnvironmentProfileIdentifier](#cfn-datazone-environment-environmentprofileidentifier): String [EnvironmentRoleArn](#cfn-datazone-environment-environmentrolearn): String [GlossaryTerms](#cfn-datazone-environment-glossaryterms): - String [Name](#cfn-datazone-environment-name): String [ProjectIdentifier](#cfn-datazone-environment-projectidentifier): String [UserParameters](#cfn-datazone-environment-userparameters): - EnvironmentParameter ``` ## Properties `DeploymentOrder` The deployment order of the environment. *Required*: No *Type*: Integer *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Description` The description of the environment. *Required*: No *Type*: String *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DomainIdentifier` The identifier of the Amazon DataZone domain in which the environment is created. *Required*: Yes *Type*: String *Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EnvironmentAccountIdentifier` The identifier of the AWS account in which an environment exists. *Required*: No *Type*: String *Pattern*: `^\d{12}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EnvironmentAccountRegion` The AWS Region in which an environment exists. *Required*: No *Type*: String *Pattern*: `^[a-z]{2}-[a-z]{4,10}-\d$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EnvironmentBlueprintIdentifier` The ID of the blueprint with which the environment is being created. *Required*: No *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EnvironmentConfigurationId` The configuration ID with which the environment is created. *Required*: No *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EnvironmentProfileIdentifier` The identifier of the environment profile that is used to create this Amazon DataZone environment. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_-]{0,36}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EnvironmentRoleArn` The ARN of the environment role. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GlossaryTerms` The glossary terms that can be used in this Amazon DataZone environment. *Required*: No *Type*: Array of String *Minimum*: `1` *Maximum*: `20` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the Amazon DataZone environment. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ProjectIdentifier` The identifier of the Amazon DataZone project in which this environment is created. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_-]{1,36}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `UserParameters` The user parameters of this Amazon DataZone environment. *Required*: No *Type*: Array of [EnvironmentParameter](aws-properties-datazone-environment-environmentparameter.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainId` and `EnvironmentId`, which uniquely identifies the environment. For example: `{ "Ref": "MyEnvironment" }` for the resource with the logical ID `MyEnvironment`, `Ref` returns `DomainId|EnvironmentId`. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `AwsAccountId` The identifier of the AWS account in which an environment exists. `AwsAccountRegion` The AWS Region in which an environment exists. `CreatedAt` The timestamp of when the environment was created. `CreatedBy` The Amazon DataZone user who created the environment. `DomainId` The identifier of the Amazon DataZone domain in which the environment exists. `EnvironmentBlueprintId` The identifier of a blueprint with which an environment profile is created. `EnvironmentProfileId` The identifier of the environment profile with which the environment was created. `Id` The identifier of the environment. `ProjectId` The identifier of the project in which the environment exists. `Provider` The provider of the environment. `Status` The status of the environment. `UpdatedAt` The timestamp of when the environment was updated. # AWS::DataZone::Environment EnvironmentParameter The parameter details of the environment. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Name](#cfn-datazone-environment-environmentparameter-name)" : String, "[Value](#cfn-datazone-environment-environmentparameter-value)" : String } ``` ### YAML ``` [Name](#cfn-datazone-environment-environmentparameter-name): String [Value](#cfn-datazone-environment-environmentparameter-value): String ``` ## Properties `Name` The name of the environment parameter. *Required*: No *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Value` The value of the environment parameter. *Required*: No *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::DataZone::EnvironmentActions The details about the specified action configured for an environment. For example, the details of the specified console links for an analytics tool that is available in this environment. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataZone::EnvironmentActions", "Properties" : { "[Description](#cfn-datazone-environmentactions-description)" : String, "[DomainIdentifier](#cfn-datazone-environmentactions-domainidentifier)" : String, "[EnvironmentIdentifier](#cfn-datazone-environmentactions-environmentidentifier)" : String, "[Identifier](#cfn-datazone-environmentactions-identifier)" : String, "[Name](#cfn-datazone-environmentactions-name)" : String, "[Parameters](#cfn-datazone-environmentactions-parameters)" : AwsConsoleLinkParameters } } ``` ### YAML ``` Type: AWS::DataZone::EnvironmentActions Properties: [Description](#cfn-datazone-environmentactions-description): String [DomainIdentifier](#cfn-datazone-environmentactions-domainidentifier): String [EnvironmentIdentifier](#cfn-datazone-environmentactions-environmentidentifier): String [Identifier](#cfn-datazone-environmentactions-identifier): String [Name](#cfn-datazone-environmentactions-name): String [Parameters](#cfn-datazone-environmentactions-parameters): AwsConsoleLinkParameters ``` ## Properties `Description` The environment action description. *Required*: No *Type*: String *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DomainIdentifier` The Amazon DataZone domain ID of the environment action. *Required*: No *Type*: String *Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EnvironmentIdentifier` The environment ID of the environment action. *Required*: No *Type*: String *Pattern*: `[a-zA-Z0-9_-]{1,36}$` *Minimum*: `1` *Maximum*: `36` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Identifier` The ID of the environment action. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_-]{1,36}$` *Minimum*: `1` *Maximum*: `36` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the environment action. *Required*: Yes *Type*: String *Pattern*: `^[\w -]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Parameters` The parameters of the environment action. *Required*: No *Type*: [AwsConsoleLinkParameters](aws-properties-datazone-environmentactions-awsconsolelinkparameters.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainId` and `EnvironmentActionId`, which uniquely identifies the environment action. For example: `{ "Ref": "MyEnvironmentAction" }` for the resource with the logical ID `MyEnvironmentAction`, `Ref` returns `DomainId|EnvironmentActionId`. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `DomainId` The Amazon DataZone domain ID of the environment action. `EnvironmentId` The environment ID of the environment action. `Id` The ID of the environment action. # AWS::DataZone::EnvironmentActions AwsConsoleLinkParameters The parameters of the console link specified as part of the environment action. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Uri](#cfn-datazone-environmentactions-awsconsolelinkparameters-uri)" : String } ``` ### YAML ``` [Uri](#cfn-datazone-environmentactions-awsconsolelinkparameters-uri): String ``` ## Properties `Uri` The URI of the console link specified as part of the environment action. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::EnvironmentBlueprintConfiguration The configuration details of an environment blueprint. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataZone::EnvironmentBlueprintConfiguration", "Properties" : { "[DomainIdentifier](#cfn-datazone-environmentblueprintconfiguration-domainidentifier)" : String, "[EnabledRegions](#cfn-datazone-environmentblueprintconfiguration-enabledregions)" : [ String, ... ], "[EnvironmentBlueprintIdentifier](#cfn-datazone-environmentblueprintconfiguration-environmentblueprintidentifier)" : String, "[EnvironmentRolePermissionBoundary](#cfn-datazone-environmentblueprintconfiguration-environmentrolepermissionboundary)" : String, "[GlobalParameters](#cfn-datazone-environmentblueprintconfiguration-globalparameters)" : {Key: Value, ...}, "[ManageAccessRoleArn](#cfn-datazone-environmentblueprintconfiguration-manageaccessrolearn)" : String, "[ProvisioningConfigurations](#cfn-datazone-environmentblueprintconfiguration-provisioningconfigurations)" : [ ProvisioningConfiguration, ... ], "[ProvisioningRoleArn](#cfn-datazone-environmentblueprintconfiguration-provisioningrolearn)" : String, "[RegionalParameters](#cfn-datazone-environmentblueprintconfiguration-regionalparameters)" : [ RegionalParameter, ... ] } } ``` ### YAML ``` Type: AWS::DataZone::EnvironmentBlueprintConfiguration Properties: [DomainIdentifier](#cfn-datazone-environmentblueprintconfiguration-domainidentifier): String [EnabledRegions](#cfn-datazone-environmentblueprintconfiguration-enabledregions): - String [EnvironmentBlueprintIdentifier](#cfn-datazone-environmentblueprintconfiguration-environmentblueprintidentifier): String [EnvironmentRolePermissionBoundary](#cfn-datazone-environmentblueprintconfiguration-environmentrolepermissionboundary): String [GlobalParameters](#cfn-datazone-environmentblueprintconfiguration-globalparameters): Key: Value [ManageAccessRoleArn](#cfn-datazone-environmentblueprintconfiguration-manageaccessrolearn): String [ProvisioningConfigurations](#cfn-datazone-environmentblueprintconfiguration-provisioningconfigurations): - ProvisioningConfiguration [ProvisioningRoleArn](#cfn-datazone-environmentblueprintconfiguration-provisioningrolearn): String [RegionalParameters](#cfn-datazone-environmentblueprintconfiguration-regionalparameters): - RegionalParameter ``` ## Properties `DomainIdentifier` The identifier of the Amazon DataZone domain in which an environment blueprint exists. *Required*: Yes *Type*: String *Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EnabledRegions` The enabled AWS Regions specified in a blueprint configuration. *Required*: Yes *Type*: Array of String *Maximum*: `16` *Minimum*: `4 | 0` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EnvironmentBlueprintIdentifier` The identifier of the environment blueprint. In the current release, only the following values are supported: `DefaultDataLake` and `DefaultDataWarehouse`. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_-]{1,36}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EnvironmentRolePermissionBoundary` The environment role permission boundary. *Required*: No *Type*: String *Pattern*: `^arn:aws[^:]*:iam::(aws|\d{12}):policy/[\w+=,.@-]*$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GlobalParameters` Region-agnostic environment blueprint parameters. *Required*: No *Type*: Object of String *Pattern*: `.+` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ManageAccessRoleArn` The ARN of the manage access role. *Required*: No *Type*: String *Pattern*: `^arn:aws[^:]*:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ProvisioningConfigurations` The provisioning configuration of a blueprint. *Required*: No *Type*: Array of [ProvisioningConfiguration](aws-properties-datazone-environmentblueprintconfiguration-provisioningconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ProvisioningRoleArn` The ARN of the provisioning role. *Required*: No *Type*: String *Pattern*: `^arn:aws[^:]*:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RegionalParameters` The regional parameters of the environment blueprint. *Required*: No *Type*: Array of [RegionalParameter](aws-properties-datazone-environmentblueprintconfiguration-regionalparameter.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainId` and the `EnvironmentBlueprintId`, which uniquely identifies the environment blueprint configuration. For example: `{ "Ref": "MyBlueprintConfiguration" }` for the resource with the logical ID `MyBlueprintConfiguration`, `Ref` returns `DomainId|BlueprintConfigurationId`. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `CreatedAt` The timestamp of when an environment blueprint was created. `DomainId` The identifier of the Amazon DataZone domain in which an environment blueprint exists. `EnvironmentBlueprintId` The identifier of the environment blueprint. This identifier should be used when creating environment profiles. `UpdatedAt` The timestamp of when the environment blueprint was updated. # AWS::DataZone::EnvironmentBlueprintConfiguration LakeFormationConfiguration The Lake Formation configuration of the Data Lake blueprint. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[LocationRegistrationExcludeS3Locations](#cfn-datazone-environmentblueprintconfiguration-lakeformationconfiguration-locationregistrationexcludes3locations)" : [ String, ... ], "[LocationRegistrationRole](#cfn-datazone-environmentblueprintconfiguration-lakeformationconfiguration-locationregistrationrole)" : String } ``` ### YAML ``` [LocationRegistrationExcludeS3Locations](#cfn-datazone-environmentblueprintconfiguration-lakeformationconfiguration-locationregistrationexcludes3locations): - String [LocationRegistrationRole](#cfn-datazone-environmentblueprintconfiguration-lakeformationconfiguration-locationregistrationrole): String ``` ## Properties `LocationRegistrationExcludeS3Locations` Specifies certain Amazon S3 locations if you do not want Amazon DataZone to automatically register them in hybrid mode. *Required*: No *Type*: Array of String *Minimum*: `1 | 0` *Maximum*: `1024 | 20` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LocationRegistrationRole` The role that is used to manage read/write access to the chosen Amazon S3 bucket(s) for Data Lake using AWS Lake Formation hybrid access mode. *Required*: No *Type*: String *Pattern*: `^arn:aws[^:]*:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::EnvironmentBlueprintConfiguration ProvisioningConfiguration The provisioning configuration of the blueprint. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[LakeFormationConfiguration](#cfn-datazone-environmentblueprintconfiguration-provisioningconfiguration-lakeformationconfiguration)" : LakeFormationConfiguration } ``` ### YAML ``` [LakeFormationConfiguration](#cfn-datazone-environmentblueprintconfiguration-provisioningconfiguration-lakeformationconfiguration): LakeFormationConfiguration ``` ## Properties `LakeFormationConfiguration` The Lake Formation configuration of the Data Lake blueprint. *Required*: Yes *Type*: [LakeFormationConfiguration](aws-properties-datazone-environmentblueprintconfiguration-lakeformationconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::EnvironmentBlueprintConfiguration RegionalParameter The regional parameters in the environment blueprint. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Parameters](#cfn-datazone-environmentblueprintconfiguration-regionalparameter-parameters)" : {Key: Value, ...}, "[Region](#cfn-datazone-environmentblueprintconfiguration-regionalparameter-region)" : String } ``` ### YAML ``` [Parameters](#cfn-datazone-environmentblueprintconfiguration-regionalparameter-parameters): Key: Value [Region](#cfn-datazone-environmentblueprintconfiguration-regionalparameter-region): String ``` ## Properties `Parameters` A string to string map containing parameters for the region. *Required*: No *Type*: Object of String *Pattern*: `.+` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Region` The region specified in the environment parameter. *Required*: No *Type*: String *Pattern*: `^[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::EnvironmentProfile The details of an environment profile. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataZone::EnvironmentProfile", "Properties" : { "[AwsAccountId](#cfn-datazone-environmentprofile-awsaccountid)" : String, "[AwsAccountRegion](#cfn-datazone-environmentprofile-awsaccountregion)" : String, "[Description](#cfn-datazone-environmentprofile-description)" : String, "[DomainIdentifier](#cfn-datazone-environmentprofile-domainidentifier)" : String, "[EnvironmentBlueprintIdentifier](#cfn-datazone-environmentprofile-environmentblueprintidentifier)" : String, "[Name](#cfn-datazone-environmentprofile-name)" : String, "[ProjectIdentifier](#cfn-datazone-environmentprofile-projectidentifier)" : String, "[UserParameters](#cfn-datazone-environmentprofile-userparameters)" : [ EnvironmentParameter, ... ] } } ``` ### YAML ``` Type: AWS::DataZone::EnvironmentProfile Properties: [AwsAccountId](#cfn-datazone-environmentprofile-awsaccountid): String [AwsAccountRegion](#cfn-datazone-environmentprofile-awsaccountregion): String [Description](#cfn-datazone-environmentprofile-description): String [DomainIdentifier](#cfn-datazone-environmentprofile-domainidentifier): String [EnvironmentBlueprintIdentifier](#cfn-datazone-environmentprofile-environmentblueprintidentifier): String [Name](#cfn-datazone-environmentprofile-name): String [ProjectIdentifier](#cfn-datazone-environmentprofile-projectidentifier): String [UserParameters](#cfn-datazone-environmentprofile-userparameters): - EnvironmentParameter ``` ## Properties `AwsAccountId` The identifier of an AWS account in which an environment profile exists. *Required*: Yes *Type*: String *Pattern*: `^\d{12}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AwsAccountRegion` The AWS Region in which an environment profile exists. *Required*: Yes *Type*: String *Pattern*: `^[a-z]{2}-[a-z]{4,10}-\d$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` The description of the environment profile. *Required*: No *Type*: String *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DomainIdentifier` The identifier of the Amazon DataZone domain in which the environment profile exists. *Required*: Yes *Type*: String *Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EnvironmentBlueprintIdentifier` The identifier of a blueprint with which an environment profile is created. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_-]{1,36}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Name` The name of the environment profile. *Required*: Yes *Type*: String *Pattern*: `^[\w -]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ProjectIdentifier` The identifier of a project in which an environment profile exists. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_-]{1,36}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `UserParameters` The user parameters of this Amazon DataZone environment profile. *Required*: No *Type*: Array of [EnvironmentParameter](aws-properties-datazone-environmentprofile-environmentparameter.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainId` and the `EnvironmentProfileId`, which uniquely identifies the environment profile. For example: `{ "Ref": "MyEnvironmentProfile" }` for the resource with the logical `ID MyEnvironmentProfile`, `Ref` returns `DomainId|EnvironmentProfileId`. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `CreatedAt` The timestamp of when an environment profile was created. `CreatedBy` The Amazon DataZone user who created the environment profile. `DomainId` The identifier of the Amazon DataZone domain in which the environment profile exists. `EnvironmentBlueprintId` The identifier of a blueprint with which an environment profile is created. `Id` The identifier of the environment profile. `ProjectId` The identifier of a project in which an environment profile exists. `UpdatedAt` The timestamp of when the environment profile was updated. # AWS::DataZone::EnvironmentProfile EnvironmentParameter The parameter details of an environment profile. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Name](#cfn-datazone-environmentprofile-environmentparameter-name)" : String, "[Value](#cfn-datazone-environmentprofile-environmentparameter-value)" : String } ``` ### YAML ``` [Name](#cfn-datazone-environmentprofile-environmentparameter-name): String [Value](#cfn-datazone-environmentprofile-environmentparameter-value): String ``` ## Properties `Name` The name specified in the environment parameter. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value of the environment profile. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::FormType The details of the metadata form type. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataZone::FormType", "Properties" : { "[Description](#cfn-datazone-formtype-description)" : String, "[DomainIdentifier](#cfn-datazone-formtype-domainidentifier)" : String, "[Model](#cfn-datazone-formtype-model)" : Model, "[Name](#cfn-datazone-formtype-name)" : String, "[OwningProjectIdentifier](#cfn-datazone-formtype-owningprojectidentifier)" : String, "[Status](#cfn-datazone-formtype-status)" : String } } ``` ### YAML ``` Type: AWS::DataZone::FormType Properties: [Description](#cfn-datazone-formtype-description): String [DomainIdentifier](#cfn-datazone-formtype-domainidentifier): String [Model](#cfn-datazone-formtype-model): Model [Name](#cfn-datazone-formtype-name): String [OwningProjectIdentifier](#cfn-datazone-formtype-owningprojectidentifier): String [Status](#cfn-datazone-formtype-status): String ``` ## Properties `Description` The description of the metadata form type. *Required*: No *Type*: String *Minimum*: `0` *Maximum*: `2048` *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `DomainIdentifier` The identifier of the Amazon DataZone domain in which the form type exists. *Required*: Yes *Type*: String *Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Model` The model of the form type. *Required*: Yes *Type*: [Model](aws-properties-datazone-formtype-model.md) *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `Name` The name of the form type. *Required*: Yes *Type*: String *Pattern*: `^(?![0-9_])\w+$|^_\w*[a-zA-Z0-9]\w*$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `OwningProjectIdentifier` The identifier of the project that owns the form type. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_-]{1,36}$` *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) `Status` The status of the form type. *Required*: No *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainIdentifier` and `FormTypeIdentifier`, which uniquely identifies a form type. For example: `{"Ref": "MyFormType" }` for the resource with the logical ID `MyFormType`, `Ref` returns `DomainIdentifier|FormTypeIdentifier`. ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `CreatedAt` The timestamp of when the metadata form type was created. `CreatedBy` The Amazon DataZone user who created teh metadata form type. `DomainId` The identifier of the Amazon DataZone domain in which the form type exists. `FormTypeIdentifier` The ID of the metadata form type. `OwningProjectId` The identifier of the project that owns the form type. `Revision` The revision of the form type. # AWS::DataZone::FormType Model The model of the API. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Smithy](#cfn-datazone-formtype-model-smithy)" : String } ``` ### YAML ``` [Smithy](#cfn-datazone-formtype-model-smithy): String ``` ## Properties `Smithy` Indicates the smithy model of the API. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `100000` *Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) # AWS::DataZone::GroupProfile The details of a group profile in Amazon DataZone. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataZone::GroupProfile", "Properties" : { "[DomainIdentifier](#cfn-datazone-groupprofile-domainidentifier)" : String, "[GroupIdentifier](#cfn-datazone-groupprofile-groupidentifier)" : String, "[Status](#cfn-datazone-groupprofile-status)" : String } } ``` ### YAML ``` Type: AWS::DataZone::GroupProfile Properties: [DomainIdentifier](#cfn-datazone-groupprofile-domainidentifier): String [GroupIdentifier](#cfn-datazone-groupprofile-groupidentifier): String [Status](#cfn-datazone-groupprofile-status): String ``` ## Properties `DomainIdentifier` The identifier of the Amazon DataZone domain in which a group profile exists. *Required*: Yes *Type*: String *Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `GroupIdentifier` The ID of the group of a project member. *Required*: Yes *Type*: String *Pattern*: `(^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+)` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Status` The status of a group profile. *Required*: No *Type*: String *Allowed values*: `ASSIGNED | NOT_ASSIGNED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainId` and `GroupProfileId` that uniquely identify the group profile. For example: `{ "Ref": "MyGroupProfile" }` for the resource with the logical ID `MyGroupProfile`, `Ref` returns `DomainId|GroupProfileId`. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `DomainId` The identifier of the Amazon DataZone domain in which a group profile exists. `GroupName` The name of a group profile. `Id` The ID of a group profile. # AWS::DataZone::Owner The owner that you want to add to the entity. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataZone::Owner", "Properties" : { "[DomainIdentifier](#cfn-datazone-owner-domainidentifier)" : String, "[EntityIdentifier](#cfn-datazone-owner-entityidentifier)" : String, "[EntityType](#cfn-datazone-owner-entitytype)" : String, "[Owner](#cfn-datazone-owner-owner)" : OwnerProperties } } ``` ### YAML ``` Type: AWS::DataZone::Owner Properties: [DomainIdentifier](#cfn-datazone-owner-domainidentifier): String [EntityIdentifier](#cfn-datazone-owner-entityidentifier): String [EntityType](#cfn-datazone-owner-entitytype): String [Owner](#cfn-datazone-owner-owner): OwnerProperties ``` ## Properties `DomainIdentifier` The ID of the domain in which you want to add the entity owner. *Required*: Yes *Type*: String *Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EntityIdentifier` The ID of the entity to which you want to add an owner. *Required*: Yes *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EntityType` The type of an entity. *Required*: Yes *Type*: String *Allowed values*: `DOMAIN_UNIT` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Owner` The owner that you want to add to the entity. *Required*: Yes *Type*: [OwnerProperties](aws-properties-datazone-owner-ownerproperties.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainId`, `EntityType`, `EntityId`, `OwnerType`, and `OwnerId`, which uniquely identifies an owner. For example: `{ "Ref": "MyOwner" }` for the resource with the logical ID MyOwner, Ref returns `DomainId|EntityType|EntityId|OwnerType|OwnerId`. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `OwnerIdentifier` The ID of the entity to which you want to add an owner. `OwnerType` The owner that you want to add to the entity. # AWS::DataZone::Owner OwnerGroupProperties The properties of the domain unit owners group. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[GroupIdentifier](#cfn-datazone-owner-ownergroupproperties-groupidentifier)" : String } ``` ### YAML ``` [GroupIdentifier](#cfn-datazone-owner-ownergroupproperties-groupidentifier): String ``` ## Properties `GroupIdentifier` The ID of the domain unit owners group. *Required*: No *Type*: String *Pattern*: `(^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+)` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::DataZone::Owner OwnerProperties The properties of a domain unit's owner. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Group](#cfn-datazone-owner-ownerproperties-group)" : OwnerGroupProperties, "[User](#cfn-datazone-owner-ownerproperties-user)" : OwnerUserProperties } ``` ### YAML ``` [Group](#cfn-datazone-owner-ownerproperties-group): OwnerGroupProperties [User](#cfn-datazone-owner-ownerproperties-user): OwnerUserProperties ``` ## Properties `Group` Specifies that the domain unit owner is a group. *Required*: No *Type*: [OwnerGroupProperties](aws-properties-datazone-owner-ownergroupproperties.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `User` Specifies that the domain unit owner is a user. *Required*: No *Type*: [OwnerUserProperties](aws-properties-datazone-owner-owneruserproperties.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::DataZone::Owner OwnerUserProperties The properties of the owner user. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[UserIdentifier](#cfn-datazone-owner-owneruserproperties-useridentifier)" : String } ``` ### YAML ``` [UserIdentifier](#cfn-datazone-owner-owneruserproperties-useridentifier): String ``` ## Properties `UserIdentifier` The ID of the owner user. *Required*: No *Type*: String *Pattern*: `(^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|^[a-zA-Z_0-9+=,.@-]+$|^arn:aws:iam::\d{12}:.+$)` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::DataZone::PolicyGrant Adds a policy grant (an authorization policy) to a specified entity, including domain units, environment blueprint configurations, or environment profiles. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataZone::PolicyGrant", "Properties" : { "[Detail](#cfn-datazone-policygrant-detail)" : PolicyGrantDetail, "[DomainIdentifier](#cfn-datazone-policygrant-domainidentifier)" : String, "[EntityIdentifier](#cfn-datazone-policygrant-entityidentifier)" : String, "[EntityType](#cfn-datazone-policygrant-entitytype)" : String, "[PolicyType](#cfn-datazone-policygrant-policytype)" : String, "[Principal](#cfn-datazone-policygrant-principal)" : PolicyGrantPrincipal } } ``` ### YAML ``` Type: AWS::DataZone::PolicyGrant Properties: [Detail](#cfn-datazone-policygrant-detail): PolicyGrantDetail [DomainIdentifier](#cfn-datazone-policygrant-domainidentifier): String [EntityIdentifier](#cfn-datazone-policygrant-entityidentifier): String [EntityType](#cfn-datazone-policygrant-entitytype): String [PolicyType](#cfn-datazone-policygrant-policytype): String [Principal](#cfn-datazone-policygrant-principal): PolicyGrantPrincipal ``` ## Properties `Detail` The details of the policy grant member. *Required*: No *Type*: [PolicyGrantDetail](aws-properties-datazone-policygrant-policygrantdetail.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `DomainIdentifier` The ID of the domain where you want to add a policy grant. *Required*: Yes *Type*: String *Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EntityIdentifier` The ID of the entity (resource) to which you want to add a policy grant. *Required*: Yes *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EntityType` The type of entity (resource) to which the grant is added. *Required*: Yes *Type*: String *Allowed values*: `DOMAIN_UNIT | ENVIRONMENT_BLUEPRINT_CONFIGURATION | ENVIRONMENT_PROFILE | ASSET_TYPE` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `PolicyType` The type of policy that you want to grant. *Required*: Yes *Type*: String *Allowed values*: `CREATE_DOMAIN_UNIT | OVERRIDE_DOMAIN_UNIT_OWNERS | ADD_TO_PROJECT_MEMBER_POOL | OVERRIDE_PROJECT_OWNERS | CREATE_GLOSSARY | CREATE_FORM_TYPE | CREATE_ASSET_TYPE | CREATE_PROJECT | CREATE_ENVIRONMENT_PROFILE | DELEGATE_CREATE_ENVIRONMENT_PROFILE | CREATE_ENVIRONMENT | CREATE_ENVIRONMENT_FROM_BLUEPRINT | CREATE_PROJECT_FROM_PROJECT_PROFILE` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Principal` The principal of the policy grant member. *Required*: No *Type*: [PolicyGrantPrincipal](aws-properties-datazone-policygrant-policygrantprincipal.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) ## Return values ### Ref ### Fn::GetAtt #### `CreatedAt` Specifies the timestamp at which policy grant member was created. `CreatedBy` Specifies the user who created the policy grant member. `GrantId` The ID of the policy grant. # AWS::DataZone::PolicyGrant AddToProjectMemberPoolPolicyGrantDetail The details of the policy grant. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IncludeChildDomainUnits](#cfn-datazone-policygrant-addtoprojectmemberpoolpolicygrantdetail-includechilddomainunits)" : Boolean } ``` ### YAML ``` [IncludeChildDomainUnits](#cfn-datazone-policygrant-addtoprojectmemberpoolpolicygrantdetail-includechilddomainunits): Boolean ``` ## Properties `IncludeChildDomainUnits` Specifies whether the policy grant is applied to child domain units. *Required*: No *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::DataZone::PolicyGrant CreateAssetTypePolicyGrantDetail The details of the policy grant. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IncludeChildDomainUnits](#cfn-datazone-policygrant-createassettypepolicygrantdetail-includechilddomainunits)" : Boolean } ``` ### YAML ``` [IncludeChildDomainUnits](#cfn-datazone-policygrant-createassettypepolicygrantdetail-includechilddomainunits): Boolean ``` ## Properties `IncludeChildDomainUnits` Specifies whether the policy grant is applied to child domain units. *Required*: No *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::DataZone::PolicyGrant CreateDomainUnitPolicyGrantDetail The details of the policy grant. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IncludeChildDomainUnits](#cfn-datazone-policygrant-createdomainunitpolicygrantdetail-includechilddomainunits)" : Boolean } ``` ### YAML ``` [IncludeChildDomainUnits](#cfn-datazone-policygrant-createdomainunitpolicygrantdetail-includechilddomainunits): Boolean ``` ## Properties `IncludeChildDomainUnits` Specifies whether the policy grant is applied to child domain units. *Required*: No *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::DataZone::PolicyGrant CreateEnvironmentProfilePolicyGrantDetail The details of the policy grant. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DomainUnitId](#cfn-datazone-policygrant-createenvironmentprofilepolicygrantdetail-domainunitid)" : String } ``` ### YAML ``` [DomainUnitId](#cfn-datazone-policygrant-createenvironmentprofilepolicygrantdetail-domainunitid): String ``` ## Properties `DomainUnitId` The ID of the domain unit. *Required*: No *Type*: String *Pattern*: `^[a-z0-9_\-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::DataZone::PolicyGrant CreateFormTypePolicyGrantDetail The details of the policy grant. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IncludeChildDomainUnits](#cfn-datazone-policygrant-createformtypepolicygrantdetail-includechilddomainunits)" : Boolean } ``` ### YAML ``` [IncludeChildDomainUnits](#cfn-datazone-policygrant-createformtypepolicygrantdetail-includechilddomainunits): Boolean ``` ## Properties `IncludeChildDomainUnits` Specifies whether the policy grant is applied to child domain units. *Required*: No *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::DataZone::PolicyGrant CreateGlossaryPolicyGrantDetail The details of the policy grant. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IncludeChildDomainUnits](#cfn-datazone-policygrant-createglossarypolicygrantdetail-includechilddomainunits)" : Boolean } ``` ### YAML ``` [IncludeChildDomainUnits](#cfn-datazone-policygrant-createglossarypolicygrantdetail-includechilddomainunits): Boolean ``` ## Properties `IncludeChildDomainUnits` Specifies whether the policy grant is applied to child domain units. *Required*: No *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::DataZone::PolicyGrant CreateProjectFromProjectProfilePolicyGrantDetail Specifies whether to create a project from project profile policy grant details. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IncludeChildDomainUnits](#cfn-datazone-policygrant-createprojectfromprojectprofilepolicygrantdetail-includechilddomainunits)" : Boolean, "[ProjectProfiles](#cfn-datazone-policygrant-createprojectfromprojectprofilepolicygrantdetail-projectprofiles)" : [ String, ... ] } ``` ### YAML ``` [IncludeChildDomainUnits](#cfn-datazone-policygrant-createprojectfromprojectprofilepolicygrantdetail-includechilddomainunits): Boolean [ProjectProfiles](#cfn-datazone-policygrant-createprojectfromprojectprofilepolicygrantdetail-projectprofiles): - String ``` ## Properties `IncludeChildDomainUnits` Specifies whether to include child domain units when creating a project from project profile policy grant details *Required*: No *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ProjectProfiles` Specifies project profiles when creating a project from project profile policy grant details *Required*: No *Type*: Array of String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::DataZone::PolicyGrant CreateProjectPolicyGrantDetail The details of the policy grant. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IncludeChildDomainUnits](#cfn-datazone-policygrant-createprojectpolicygrantdetail-includechilddomainunits)" : Boolean } ``` ### YAML ``` [IncludeChildDomainUnits](#cfn-datazone-policygrant-createprojectpolicygrantdetail-includechilddomainunits): Boolean ``` ## Properties `IncludeChildDomainUnits` Specifies whether the policy grant is applied to child domain units. *Required*: No *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::DataZone::PolicyGrant DomainUnitFilterForProject The domain unit filter of the project grant filter. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DomainUnit](#cfn-datazone-policygrant-domainunitfilterforproject-domainunit)" : String, "[IncludeChildDomainUnits](#cfn-datazone-policygrant-domainunitfilterforproject-includechilddomainunits)" : Boolean } ``` ### YAML ``` [DomainUnit](#cfn-datazone-policygrant-domainunitfilterforproject-domainunit): String [IncludeChildDomainUnits](#cfn-datazone-policygrant-domainunitfilterforproject-includechilddomainunits): Boolean ``` ## Properties `DomainUnit` The domain unit ID to use in the filter. *Required*: Yes *Type*: String *Pattern*: `^[a-z0-9_\-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `IncludeChildDomainUnits` Specifies whether to include child domain units. *Required*: No *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::DataZone::PolicyGrant DomainUnitGrantFilter The grant filter for the domain unit. In the current release of Amazon DataZone, the only supported filter is the `allDomainUnitsGrantFilter`. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AllDomainUnitsGrantFilter](#cfn-datazone-policygrant-domainunitgrantfilter-alldomainunitsgrantfilter)" : Json } ``` ### YAML ``` [AllDomainUnitsGrantFilter](#cfn-datazone-policygrant-domainunitgrantfilter-alldomainunitsgrantfilter): Json ``` ## Properties `AllDomainUnitsGrantFilter` Specifies a grant filter containing all domain units. *Required*: Yes *Type*: Json *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::DataZone::PolicyGrant DomainUnitPolicyGrantPrincipal The domain unit principal to whom the policy is granted. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DomainUnitDesignation](#cfn-datazone-policygrant-domainunitpolicygrantprincipal-domainunitdesignation)" : String, "[DomainUnitGrantFilter](#cfn-datazone-policygrant-domainunitpolicygrantprincipal-domainunitgrantfilter)" : DomainUnitGrantFilter, "[DomainUnitIdentifier](#cfn-datazone-policygrant-domainunitpolicygrantprincipal-domainunitidentifier)" : String } ``` ### YAML ``` [DomainUnitDesignation](#cfn-datazone-policygrant-domainunitpolicygrantprincipal-domainunitdesignation): String [DomainUnitGrantFilter](#cfn-datazone-policygrant-domainunitpolicygrantprincipal-domainunitgrantfilter): DomainUnitGrantFilter [DomainUnitIdentifier](#cfn-datazone-policygrant-domainunitpolicygrantprincipal-domainunitidentifier): String ``` ## Properties `DomainUnitDesignation` Specifes the designation of the domain unit users. *Required*: No *Type*: String *Allowed values*: `OWNER` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `DomainUnitGrantFilter` The grant filter for the domain unit. *Required*: No *Type*: [DomainUnitGrantFilter](aws-properties-datazone-policygrant-domainunitgrantfilter.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `DomainUnitIdentifier` The ID of the domain unit. *Required*: No *Type*: String *Pattern*: `^[a-z0-9_\-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::DataZone::PolicyGrant GroupPolicyGrantPrincipal The group principal to whom the policy is granted. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[GroupIdentifier](#cfn-datazone-policygrant-grouppolicygrantprincipal-groupidentifier)" : String } ``` ### YAML ``` [GroupIdentifier](#cfn-datazone-policygrant-grouppolicygrantprincipal-groupidentifier): String ``` ## Properties `GroupIdentifier` The ID Of the group of the group principal. *Required*: Yes *Type*: String *Pattern*: `(^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+)` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::DataZone::PolicyGrant OverrideDomainUnitOwnersPolicyGrantDetail The grant details of the override domain unit owners policy. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IncludeChildDomainUnits](#cfn-datazone-policygrant-overridedomainunitownerspolicygrantdetail-includechilddomainunits)" : Boolean } ``` ### YAML ``` [IncludeChildDomainUnits](#cfn-datazone-policygrant-overridedomainunitownerspolicygrantdetail-includechilddomainunits): Boolean ``` ## Properties `IncludeChildDomainUnits` Specifies whether the policy is inherited by child domain units. *Required*: No *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::DataZone::PolicyGrant OverrideProjectOwnersPolicyGrantDetail The details of the override project owners policy grant. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IncludeChildDomainUnits](#cfn-datazone-policygrant-overrideprojectownerspolicygrantdetail-includechilddomainunits)" : Boolean } ``` ### YAML ``` [IncludeChildDomainUnits](#cfn-datazone-policygrant-overrideprojectownerspolicygrantdetail-includechilddomainunits): Boolean ``` ## Properties `IncludeChildDomainUnits` Specifies whether the policy is inherited by child domain units. *Required*: No *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::DataZone::PolicyGrant PolicyGrantDetail The details of the policy grant. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AddToProjectMemberPool](#cfn-datazone-policygrant-policygrantdetail-addtoprojectmemberpool)" : AddToProjectMemberPoolPolicyGrantDetail, "[CreateAssetType](#cfn-datazone-policygrant-policygrantdetail-createassettype)" : CreateAssetTypePolicyGrantDetail, "[CreateDomainUnit](#cfn-datazone-policygrant-policygrantdetail-createdomainunit)" : CreateDomainUnitPolicyGrantDetail, "[CreateEnvironment](#cfn-datazone-policygrant-policygrantdetail-createenvironment)" : Json, "[CreateEnvironmentFromBlueprint](#cfn-datazone-policygrant-policygrantdetail-createenvironmentfromblueprint)" : Json, "[CreateEnvironmentProfile](#cfn-datazone-policygrant-policygrantdetail-createenvironmentprofile)" : CreateEnvironmentProfilePolicyGrantDetail, "[CreateFormType](#cfn-datazone-policygrant-policygrantdetail-createformtype)" : CreateFormTypePolicyGrantDetail, "[CreateGlossary](#cfn-datazone-policygrant-policygrantdetail-createglossary)" : CreateGlossaryPolicyGrantDetail, "[CreateProject](#cfn-datazone-policygrant-policygrantdetail-createproject)" : CreateProjectPolicyGrantDetail, "[CreateProjectFromProjectProfile](#cfn-datazone-policygrant-policygrantdetail-createprojectfromprojectprofile)" : CreateProjectFromProjectProfilePolicyGrantDetail, "[DelegateCreateEnvironmentProfile](#cfn-datazone-policygrant-policygrantdetail-delegatecreateenvironmentprofile)" : Json, "[OverrideDomainUnitOwners](#cfn-datazone-policygrant-policygrantdetail-overridedomainunitowners)" : OverrideDomainUnitOwnersPolicyGrantDetail, "[OverrideProjectOwners](#cfn-datazone-policygrant-policygrantdetail-overrideprojectowners)" : OverrideProjectOwnersPolicyGrantDetail } ``` ### YAML ``` [AddToProjectMemberPool](#cfn-datazone-policygrant-policygrantdetail-addtoprojectmemberpool): AddToProjectMemberPoolPolicyGrantDetail [CreateAssetType](#cfn-datazone-policygrant-policygrantdetail-createassettype): CreateAssetTypePolicyGrantDetail [CreateDomainUnit](#cfn-datazone-policygrant-policygrantdetail-createdomainunit): CreateDomainUnitPolicyGrantDetail [CreateEnvironment](#cfn-datazone-policygrant-policygrantdetail-createenvironment): Json [CreateEnvironmentFromBlueprint](#cfn-datazone-policygrant-policygrantdetail-createenvironmentfromblueprint): Json [CreateEnvironmentProfile](#cfn-datazone-policygrant-policygrantdetail-createenvironmentprofile): CreateEnvironmentProfilePolicyGrantDetail [CreateFormType](#cfn-datazone-policygrant-policygrantdetail-createformtype): CreateFormTypePolicyGrantDetail [CreateGlossary](#cfn-datazone-policygrant-policygrantdetail-createglossary): CreateGlossaryPolicyGrantDetail [CreateProject](#cfn-datazone-policygrant-policygrantdetail-createproject): CreateProjectPolicyGrantDetail [CreateProjectFromProjectProfile](#cfn-datazone-policygrant-policygrantdetail-createprojectfromprojectprofile): CreateProjectFromProjectProfilePolicyGrantDetail [DelegateCreateEnvironmentProfile](#cfn-datazone-policygrant-policygrantdetail-delegatecreateenvironmentprofile): Json [OverrideDomainUnitOwners](#cfn-datazone-policygrant-policygrantdetail-overridedomainunitowners): OverrideDomainUnitOwnersPolicyGrantDetail [OverrideProjectOwners](#cfn-datazone-policygrant-policygrantdetail-overrideprojectowners): OverrideProjectOwnersPolicyGrantDetail ``` ## Properties `AddToProjectMemberPool` Specifies that the policy grant is to be added to the members of the project. *Required*: No *Type*: [AddToProjectMemberPoolPolicyGrantDetail](aws-properties-datazone-policygrant-addtoprojectmemberpoolpolicygrantdetail.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `CreateAssetType` Specifies that this is a create asset type policy. *Required*: No *Type*: [CreateAssetTypePolicyGrantDetail](aws-properties-datazone-policygrant-createassettypepolicygrantdetail.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `CreateDomainUnit` Specifies that this is a create domain unit policy. *Required*: No *Type*: [CreateDomainUnitPolicyGrantDetail](aws-properties-datazone-policygrant-createdomainunitpolicygrantdetail.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `CreateEnvironment` Specifies that this is a create environment policy. *Required*: No *Type*: Json *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `CreateEnvironmentFromBlueprint` Specifies that this is a create environment from blueprint policy. *Required*: No *Type*: Json *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `CreateEnvironmentProfile` Specifies that this is a create environment profile policy. *Required*: No *Type*: [CreateEnvironmentProfilePolicyGrantDetail](aws-properties-datazone-policygrant-createenvironmentprofilepolicygrantdetail.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `CreateFormType` Specifies that this is a create form type policy. *Required*: No *Type*: [CreateFormTypePolicyGrantDetail](aws-properties-datazone-policygrant-createformtypepolicygrantdetail.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `CreateGlossary` Specifies that this is a create glossary policy. *Required*: No *Type*: [CreateGlossaryPolicyGrantDetail](aws-properties-datazone-policygrant-createglossarypolicygrantdetail.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `CreateProject` Specifies that this is a create project policy. *Required*: No *Type*: [CreateProjectPolicyGrantDetail](aws-properties-datazone-policygrant-createprojectpolicygrantdetail.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `CreateProjectFromProjectProfile` Specifies whether to create a project from project profile. *Required*: No *Type*: [CreateProjectFromProjectProfilePolicyGrantDetail](aws-properties-datazone-policygrant-createprojectfromprojectprofilepolicygrantdetail.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `DelegateCreateEnvironmentProfile` Specifies that this is the delegation of the create environment profile policy. *Required*: No *Type*: Json *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `OverrideDomainUnitOwners` Specifies whether to override domain unit owners. *Required*: No *Type*: [OverrideDomainUnitOwnersPolicyGrantDetail](aws-properties-datazone-policygrant-overridedomainunitownerspolicygrantdetail.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `OverrideProjectOwners` Specifies whether to override project owners. *Required*: No *Type*: [OverrideProjectOwnersPolicyGrantDetail](aws-properties-datazone-policygrant-overrideprojectownerspolicygrantdetail.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::DataZone::PolicyGrant PolicyGrantPrincipal The policy grant principal. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DomainUnit](#cfn-datazone-policygrant-policygrantprincipal-domainunit)" : DomainUnitPolicyGrantPrincipal, "[Group](#cfn-datazone-policygrant-policygrantprincipal-group)" : GroupPolicyGrantPrincipal, "[Project](#cfn-datazone-policygrant-policygrantprincipal-project)" : ProjectPolicyGrantPrincipal, "[User](#cfn-datazone-policygrant-policygrantprincipal-user)" : UserPolicyGrantPrincipal } ``` ### YAML ``` [DomainUnit](#cfn-datazone-policygrant-policygrantprincipal-domainunit): DomainUnitPolicyGrantPrincipal [Group](#cfn-datazone-policygrant-policygrantprincipal-group): GroupPolicyGrantPrincipal [Project](#cfn-datazone-policygrant-policygrantprincipal-project): ProjectPolicyGrantPrincipal [User](#cfn-datazone-policygrant-policygrantprincipal-user): UserPolicyGrantPrincipal ``` ## Properties `DomainUnit` The domain unit of the policy grant principal. *Required*: No *Type*: [DomainUnitPolicyGrantPrincipal](aws-properties-datazone-policygrant-domainunitpolicygrantprincipal.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Group` The group of the policy grant principal. *Required*: No *Type*: [GroupPolicyGrantPrincipal](aws-properties-datazone-policygrant-grouppolicygrantprincipal.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Project` The project of the policy grant principal. *Required*: No *Type*: [ProjectPolicyGrantPrincipal](aws-properties-datazone-policygrant-projectpolicygrantprincipal.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `User` The user of the policy grant principal. *Required*: No *Type*: [UserPolicyGrantPrincipal](aws-properties-datazone-policygrant-userpolicygrantprincipal.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::DataZone::PolicyGrant ProjectGrantFilter The project grant filter. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DomainUnitFilter](#cfn-datazone-policygrant-projectgrantfilter-domainunitfilter)" : DomainUnitFilterForProject } ``` ### YAML ``` [DomainUnitFilter](#cfn-datazone-policygrant-projectgrantfilter-domainunitfilter): DomainUnitFilterForProject ``` ## Properties `DomainUnitFilter` The domain unit filter of the project grant filter. *Required*: Yes *Type*: [DomainUnitFilterForProject](aws-properties-datazone-policygrant-domainunitfilterforproject.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::DataZone::PolicyGrant ProjectPolicyGrantPrincipal The project policy grant principal. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ProjectDesignation](#cfn-datazone-policygrant-projectpolicygrantprincipal-projectdesignation)" : String, "[ProjectGrantFilter](#cfn-datazone-policygrant-projectpolicygrantprincipal-projectgrantfilter)" : ProjectGrantFilter, "[ProjectIdentifier](#cfn-datazone-policygrant-projectpolicygrantprincipal-projectidentifier)" : String } ``` ### YAML ``` [ProjectDesignation](#cfn-datazone-policygrant-projectpolicygrantprincipal-projectdesignation): String [ProjectGrantFilter](#cfn-datazone-policygrant-projectpolicygrantprincipal-projectgrantfilter): ProjectGrantFilter [ProjectIdentifier](#cfn-datazone-policygrant-projectpolicygrantprincipal-projectidentifier): String ``` ## Properties `ProjectDesignation` The project designation of the project policy grant principal. *Required*: No *Type*: String *Allowed values*: `OWNER | CONTRIBUTOR | PROJECT_CATALOG_STEWARD` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ProjectGrantFilter` The project grant filter of the project policy grant principal. *Required*: No *Type*: [ProjectGrantFilter](aws-properties-datazone-policygrant-projectgrantfilter.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ProjectIdentifier` The project ID of the project policy grant principal. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_-]{1,36}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::DataZone::PolicyGrant UserPolicyGrantPrincipal The user policy grant principal. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AllUsersGrantFilter](#cfn-datazone-policygrant-userpolicygrantprincipal-allusersgrantfilter)" : Json, "[UserIdentifier](#cfn-datazone-policygrant-userpolicygrantprincipal-useridentifier)" : String } ``` ### YAML ``` [AllUsersGrantFilter](#cfn-datazone-policygrant-userpolicygrantprincipal-allusersgrantfilter): Json [UserIdentifier](#cfn-datazone-policygrant-userpolicygrantprincipal-useridentifier): String ``` ## Properties `AllUsersGrantFilter` The all users grant filter of the user policy grant principal. *Required*: No *Type*: Json *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `UserIdentifier` The user ID of the user policy grant principal. *Required*: No *Type*: String *Pattern*: `(^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|^[a-zA-Z_0-9+=,.@-]+$|^arn:aws[^:]*:iam::\d{12}:.+$)` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::DataZone::Project The `AWS::DataZone::Project`resource specifies an Amazon DataZone project. Projects enable a group of users to collaborate on various business use cases that involve publishing, discovering, subscribing to, and consuming data in the Amazon DataZone catalog. Project members consume assets from the Amazon DataZone catalog and produce new assets using one or more analytical workflows. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataZone::Project", "Properties" : { "[Description](#cfn-datazone-project-description)" : String, "[DomainIdentifier](#cfn-datazone-project-domainidentifier)" : String, "[DomainUnitId](#cfn-datazone-project-domainunitid)" : String, "[GlossaryTerms](#cfn-datazone-project-glossaryterms)" : [ String, ... ], "[Name](#cfn-datazone-project-name)" : String, "[ProjectProfileId](#cfn-datazone-project-projectprofileid)" : String, "[ProjectProfileVersion](#cfn-datazone-project-projectprofileversion)" : String, "[ResourceTags](#cfn-datazone-project-resourcetags)" : [ ResourceTag, ... ], "[UserParameters](#cfn-datazone-project-userparameters)" : [ EnvironmentConfigurationUserParameter, ... ] } } ``` ### YAML ``` Type: AWS::DataZone::Project Properties: [Description](#cfn-datazone-project-description): String [DomainIdentifier](#cfn-datazone-project-domainidentifier): String [DomainUnitId](#cfn-datazone-project-domainunitid): String [GlossaryTerms](#cfn-datazone-project-glossaryterms): - String [Name](#cfn-datazone-project-name): String [ProjectProfileId](#cfn-datazone-project-projectprofileid): String [ProjectProfileVersion](#cfn-datazone-project-projectprofileversion): String [ResourceTags](#cfn-datazone-project-resourcetags): - ResourceTag [UserParameters](#cfn-datazone-project-userparameters): - EnvironmentConfigurationUserParameter ``` ## Properties `Description` The description of a project. *Required*: No *Type*: String *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DomainIdentifier` The identifier of a Amazon DataZone domain where the project exists. *Required*: Yes *Type*: String *Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `DomainUnitId` The ID of the domain unit. This parameter is not required and if it is not specified, then the project is created at the root domain unit level. *Required*: No *Type*: String *Pattern*: `^[a-z0-9_\-]+$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GlossaryTerms` The glossary terms that can be used in this Amazon DataZone project. *Required*: No *Type*: Array of String *Minimum*: `1` *Maximum*: `20` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of a project. *Required*: Yes *Type*: String *Pattern*: `^[\w -]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ProjectProfileId` The ID of the project profile. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_-]{1,36}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ProjectProfileVersion` The project profile version to which the project should be updated. You can only specify the following string for this parameter: `latest`. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ResourceTags` The resource tags of the project. *Required*: No *Type*: Array of [ResourceTag](aws-properties-datazone-project-resourcetag.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UserParameters` The user parameters of the project. *Required*: No *Type*: Array of [EnvironmentConfigurationUserParameter](aws-properties-datazone-project-environmentconfigurationuserparameter.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainId` and the `ProjectId` that uniquely identify the project. For example: `{ "Ref": "MyProject" }` for the resource with the logical ID `MyProject`, `Ref` returns `DomainId|ProjectId`. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `CreatedAt` The timestamp of when a project was created. `CreatedBy` The Amazon DataZone user who created the project. `DomainId` The identifier of a Amazon DataZone domain where the project exists. `Id` The identifier of a project. `LastUpdatedAt` The timestamp of when the project was last updated. `ProjectStatus` The status of the project. # AWS::DataZone::Project EnvironmentConfigurationUserParameter The environment configuration user parameters. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[EnvironmentConfigurationName](#cfn-datazone-project-environmentconfigurationuserparameter-environmentconfigurationname)" : String, "[EnvironmentId](#cfn-datazone-project-environmentconfigurationuserparameter-environmentid)" : String, "[EnvironmentParameters](#cfn-datazone-project-environmentconfigurationuserparameter-environmentparameters)" : [ EnvironmentParameter, ... ] } ``` ### YAML ``` [EnvironmentConfigurationName](#cfn-datazone-project-environmentconfigurationuserparameter-environmentconfigurationname): String [EnvironmentId](#cfn-datazone-project-environmentconfigurationuserparameter-environmentid): String [EnvironmentParameters](#cfn-datazone-project-environmentconfigurationuserparameter-environmentparameters): - EnvironmentParameter ``` ## Properties `EnvironmentConfigurationName` The environment configuration name. *Required*: No *Type*: String *Pattern*: `^[\w -]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EnvironmentId` The ID of the environment. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_-]{1,36}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EnvironmentParameters` The environment parameters. *Required*: No *Type*: Array of [EnvironmentParameter](aws-properties-datazone-project-environmentparameter.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Project EnvironmentParameter The parameter details of an evironment profile. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Name](#cfn-datazone-project-environmentparameter-name)" : String, "[Value](#cfn-datazone-project-environmentparameter-value)" : String } ``` ### YAML ``` [Name](#cfn-datazone-project-environmentparameter-name): String [Value](#cfn-datazone-project-environmentparameter-value): String ``` ## Properties `Name` The name of an environment profile parameter. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value of an environment profile parameter. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::Project ResourceTag The resource tag of the project. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-datazone-project-resourcetag-key)" : String, "[Value](#cfn-datazone-project-resourcetag-value)" : String } ``` ### YAML ``` [Key](#cfn-datazone-project-resourcetag-key): String [Value](#cfn-datazone-project-resourcetag-value): String ``` ## Properties `Key` The key of the resource tag of the project. *Required*: Yes *Type*: String *Pattern*: `^[\w \.:/=+@-]+$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value of the resource tag parameter key of the project profile. *Required*: Yes *Type*: String *Pattern*: `^[\w \.:/=+@-]*$` *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::ProjectMembership The `AWS::DataZone::ProjectMembership` resource adds a member to an Amazon DataZone project. Project members consume assets from the Amazon DataZone catalog and produce new assets using one or more analytical workflows. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataZone::ProjectMembership", "Properties" : { "[Designation](#cfn-datazone-projectmembership-designation)" : String, "[DomainIdentifier](#cfn-datazone-projectmembership-domainidentifier)" : String, "[Member](#cfn-datazone-projectmembership-member)" : Member, "[ProjectIdentifier](#cfn-datazone-projectmembership-projectidentifier)" : String } } ``` ### YAML ``` Type: AWS::DataZone::ProjectMembership Properties: [Designation](#cfn-datazone-projectmembership-designation): String [DomainIdentifier](#cfn-datazone-projectmembership-domainidentifier): String [Member](#cfn-datazone-projectmembership-member): Member [ProjectIdentifier](#cfn-datazone-projectmembership-projectidentifier): String ``` ## Properties `Designation` The designated role of a project member. *Required*: Yes *Type*: String *Allowed values*: `PROJECT_OWNER | PROJECT_CONTRIBUTOR | PROJECT_CATALOG_VIEWER | PROJECT_CATALOG_CONSUMER | PROJECT_CATALOG_STEWARD` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DomainIdentifier` The ID of the Amazon DataZone domain in which project membership is created. *Required*: Yes *Type*: String *Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Member` The details about a project member. *Required*: Yes *Type*: [Member](aws-properties-datazone-projectmembership-member.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ProjectIdentifier` The ID of the project for which this project membership was created. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_-]{1,36}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainId`, `MemberId`, `MemberType`, and `ProjectId` that uniquely identify the project membership. For example: `{ "Ref": "MyProjectMembership" }` for the resource with the logical ID `MyProjectMembership`, `Ref` returns `DomainId|MemberId|MemberType|ProjectId`. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt #### `MemberIdentifier` The identifier of the project member. `MemberIdentifierType` The type of the project member identifier. # AWS::DataZone::ProjectMembership Member The details about a project member. Important - this data type is a UNION, so only one of the following members can be specified when used or returned. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[GroupIdentifier](#cfn-datazone-projectmembership-member-groupidentifier)" : String, "[UserIdentifier](#cfn-datazone-projectmembership-member-useridentifier)" : String } ``` ### YAML ``` [GroupIdentifier](#cfn-datazone-projectmembership-member-groupidentifier): String [UserIdentifier](#cfn-datazone-projectmembership-member-useridentifier): String ``` ## Properties `GroupIdentifier` The ID of the group of a project member. *Required*: No *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `UserIdentifier` The user ID of a project member. *Required*: No *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::DataZone::ProjectProfile The summary of a project profile. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataZone::ProjectProfile", "Properties" : { "[AllowCustomProjectResourceTags](#cfn-datazone-projectprofile-allowcustomprojectresourcetags)" : Boolean, "[Description](#cfn-datazone-projectprofile-description)" : String, "[DomainIdentifier](#cfn-datazone-projectprofile-domainidentifier)" : String, "[DomainUnitIdentifier](#cfn-datazone-projectprofile-domainunitidentifier)" : String, "[EnvironmentConfigurations](#cfn-datazone-projectprofile-environmentconfigurations)" : [ EnvironmentConfiguration, ... ], "[Name](#cfn-datazone-projectprofile-name)" : String, "[ProjectResourceTags](#cfn-datazone-projectprofile-projectresourcetags)" : [ ResourceTagParameter, ... ], "[ProjectResourceTagsDescription](#cfn-datazone-projectprofile-projectresourcetagsdescription)" : String, "[Status](#cfn-datazone-projectprofile-status)" : String, "[UseDefaultConfigurations](#cfn-datazone-projectprofile-usedefaultconfigurations)" : Boolean } } ``` ### YAML ``` Type: AWS::DataZone::ProjectProfile Properties: [AllowCustomProjectResourceTags](#cfn-datazone-projectprofile-allowcustomprojectresourcetags): Boolean [Description](#cfn-datazone-projectprofile-description): String [DomainIdentifier](#cfn-datazone-projectprofile-domainidentifier): String [DomainUnitIdentifier](#cfn-datazone-projectprofile-domainunitidentifier): String [EnvironmentConfigurations](#cfn-datazone-projectprofile-environmentconfigurations): - EnvironmentConfiguration [Name](#cfn-datazone-projectprofile-name): String [ProjectResourceTags](#cfn-datazone-projectprofile-projectresourcetags): - ResourceTagParameter [ProjectResourceTagsDescription](#cfn-datazone-projectprofile-projectresourcetagsdescription): String [Status](#cfn-datazone-projectprofile-status): String [UseDefaultConfigurations](#cfn-datazone-projectprofile-usedefaultconfigurations): Boolean ``` ## Properties `AllowCustomProjectResourceTags` Specifies whether custom project resource tags are supported. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` The description of the project profile. *Required*: No *Type*: String *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DomainIdentifier` A domain ID of the project profile. *Required*: No *Type*: String *Pattern*: `^dzd[_-][a-zA-Z0-9_-]{1,36}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `DomainUnitIdentifier` A domain unit ID of the project profile. *Required*: No *Type*: String *Pattern*: `^[a-z0-9_\-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EnvironmentConfigurations` Environment configurations of a project profile. *Required*: No *Type*: Array of [EnvironmentConfiguration](aws-properties-datazone-projectprofile-environmentconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of a project profile. *Required*: Yes *Type*: String *Pattern*: `^[\w -]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ProjectResourceTags` The resource tag of the project. *Required*: No *Type*: Array of [ResourceTagParameter](aws-properties-datazone-projectprofile-resourcetagparameter.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ProjectResourceTagsDescription` Field viewable through the UI that provides a project user with the allowed resource tag specifications. *Required*: No *Type*: String *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Status` The status of a project profile. *Required*: No *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UseDefaultConfigurations` Property description not available. *Required*: No *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainId` and `DomainUnitId`, which uniquely identifies a domain unit. For example: \$1 `"Ref": "MyDomainUnit"` \$1 for the resource with the logical ID MyDomainUnit, Ref returns `DomainId|DomainUnitId`. ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `CreatedAt` The timestamp of when the project profile was created. `CreatedBy` The user who created the project profile. `DomainId` The domain ID of the project profile. `DomainUnitId` The domain unit ID of the project profile. `Id` The ID of the project profile. `Identifier` Project profile ID. `LastUpdatedAt` The timestamp at which a project profile was last updated. # AWS::DataZone::ProjectProfile AwsAccount The AWS account of the environment. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AwsAccountId](#cfn-datazone-projectprofile-awsaccount-awsaccountid)" : String } ``` ### YAML ``` [AwsAccountId](#cfn-datazone-projectprofile-awsaccount-awsaccountid): String ``` ## Properties `AwsAccountId` The account ID of a project. *Required*: Yes *Type*: String *Pattern*: `^\d{12}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::ProjectProfile EnvironmentConfiguration The configuration of an environment. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AwsAccount](#cfn-datazone-projectprofile-environmentconfiguration-awsaccount)" : AwsAccount, "[AwsRegion](#cfn-datazone-projectprofile-environmentconfiguration-awsregion)" : Region, "[ConfigurationParameters](#cfn-datazone-projectprofile-environmentconfiguration-configurationparameters)" : EnvironmentConfigurationParametersDetails, "[DeploymentMode](#cfn-datazone-projectprofile-environmentconfiguration-deploymentmode)" : String, "[DeploymentOrder](#cfn-datazone-projectprofile-environmentconfiguration-deploymentorder)" : Number, "[Description](#cfn-datazone-projectprofile-environmentconfiguration-description)" : String, "[EnvironmentBlueprintId](#cfn-datazone-projectprofile-environmentconfiguration-environmentblueprintid)" : String, "[EnvironmentConfigurationId](#cfn-datazone-projectprofile-environmentconfiguration-environmentconfigurationid)" : String, "[Name](#cfn-datazone-projectprofile-environmentconfiguration-name)" : String } ``` ### YAML ``` [AwsAccount](#cfn-datazone-projectprofile-environmentconfiguration-awsaccount): AwsAccount [AwsRegion](#cfn-datazone-projectprofile-environmentconfiguration-awsregion): Region [ConfigurationParameters](#cfn-datazone-projectprofile-environmentconfiguration-configurationparameters): EnvironmentConfigurationParametersDetails [DeploymentMode](#cfn-datazone-projectprofile-environmentconfiguration-deploymentmode): String [DeploymentOrder](#cfn-datazone-projectprofile-environmentconfiguration-deploymentorder): Number [Description](#cfn-datazone-projectprofile-environmentconfiguration-description): String [EnvironmentBlueprintId](#cfn-datazone-projectprofile-environmentconfiguration-environmentblueprintid): String [EnvironmentConfigurationId](#cfn-datazone-projectprofile-environmentconfiguration-environmentconfigurationid): String [Name](#cfn-datazone-projectprofile-environmentconfiguration-name): String ``` ## Properties `AwsAccount` The AWS account of the environment. *Required*: No *Type*: [AwsAccount](aws-properties-datazone-projectprofile-awsaccount.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AwsRegion` The AWS Region of the environment. *Required*: Yes *Type*: [Region](aws-properties-datazone-projectprofile-region.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ConfigurationParameters` The configuration parameters of the environment. *Required*: No *Type*: [EnvironmentConfigurationParametersDetails](aws-properties-datazone-projectprofile-environmentconfigurationparametersdetails.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DeploymentMode` The deployment mode of the environment. *Required*: No *Type*: String *Allowed values*: `ON_CREATE | ON_DEMAND` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DeploymentOrder` The deployment order of the environment. *Required*: No *Type*: Number *Minimum*: `0` *Maximum*: `16` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` The environment description. *Required*: No *Type*: String *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EnvironmentBlueprintId` The environment blueprint ID. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_-]{1,36}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EnvironmentConfigurationId` The configuration ID with which the environment is created. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_-]{1,36}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The environment name. *Required*: Yes *Type*: String *Pattern*: `^[\w -]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::ProjectProfile EnvironmentConfigurationParameter The environment configuration parameter. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IsEditable](#cfn-datazone-projectprofile-environmentconfigurationparameter-iseditable)" : Boolean, "[Name](#cfn-datazone-projectprofile-environmentconfigurationparameter-name)" : String, "[Value](#cfn-datazone-projectprofile-environmentconfigurationparameter-value)" : String } ``` ### YAML ``` [IsEditable](#cfn-datazone-projectprofile-environmentconfigurationparameter-iseditable): Boolean [Name](#cfn-datazone-projectprofile-environmentconfigurationparameter-name): String [Value](#cfn-datazone-projectprofile-environmentconfigurationparameter-value): String ``` ## Properties `IsEditable` Specifies whether the environment parameter is editable. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the environment configuration parameter. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z_][a-zA-Z0-9_]*$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value of the environment configuration parameter. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::ProjectProfile EnvironmentConfigurationParametersDetails The details of the environment configuration parameter. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ParameterOverrides](#cfn-datazone-projectprofile-environmentconfigurationparametersdetails-parameteroverrides)" : [ EnvironmentConfigurationParameter, ... ], "[ResolvedParameters](#cfn-datazone-projectprofile-environmentconfigurationparametersdetails-resolvedparameters)" : [ EnvironmentConfigurationParameter, ... ], "[SsmPath](#cfn-datazone-projectprofile-environmentconfigurationparametersdetails-ssmpath)" : String } ``` ### YAML ``` [ParameterOverrides](#cfn-datazone-projectprofile-environmentconfigurationparametersdetails-parameteroverrides): - EnvironmentConfigurationParameter [ResolvedParameters](#cfn-datazone-projectprofile-environmentconfigurationparametersdetails-resolvedparameters): - EnvironmentConfigurationParameter [SsmPath](#cfn-datazone-projectprofile-environmentconfigurationparametersdetails-ssmpath): String ``` ## Properties `ParameterOverrides` The parameter overrides. *Required*: No *Type*: Array of [EnvironmentConfigurationParameter](aws-properties-datazone-projectprofile-environmentconfigurationparameter.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ResolvedParameters` The resolved environment configuration parameters. *Required*: No *Type*: Array of [EnvironmentConfigurationParameter](aws-properties-datazone-projectprofile-environmentconfigurationparameter.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SsmPath` Ssm path environment configuration parameters. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::ProjectProfile Region The AWS Region. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[RegionName](#cfn-datazone-projectprofile-region-regionname)" : String } ``` ### YAML ``` [RegionName](#cfn-datazone-projectprofile-region-regionname): String ``` ## Properties `RegionName` The AWS Region name. *Required*: Yes *Type*: String *Pattern*: `^[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]$` *Minimum*: `4` *Maximum*: `16` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::ProjectProfile ResourceTagParameter The resource tag parameter of the project profile. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IsValueEditable](#cfn-datazone-projectprofile-resourcetagparameter-isvalueeditable)" : Boolean, "[Key](#cfn-datazone-projectprofile-resourcetagparameter-key)" : String, "[Value](#cfn-datazone-projectprofile-resourcetagparameter-value)" : String } ``` ### YAML ``` [IsValueEditable](#cfn-datazone-projectprofile-resourcetagparameter-isvalueeditable): Boolean [Key](#cfn-datazone-projectprofile-resourcetagparameter-key): String [Value](#cfn-datazone-projectprofile-resourcetagparameter-value): String ``` ## Properties `IsValueEditable` Specifies whether the value of the resource tag parameter of the project profile is editable at the project level. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Key` The key of the resource tag parameter of the project profile. *Required*: Yes *Type*: String *Pattern*: `^[\w \.:/=+@-]+$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value of the resource tag parameter key of the project profile. *Required*: Yes *Type*: String *Pattern*: `^[\w \.:/=+@-]*$` *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::SubscriptionTarget The `AWS::DataZone::SubscriptionTarget`resource specifies an Amazon DataZone subscription target. Subscription targets enable you to access the data to which you have subscribed in your projects. A subscription target specifies the location (for example, a database or a schema) and the required permissions (for example, an IAM role) that Amazon DataZone can use to establish a connection with the source data and to create the necessary grants so that members of the Amazon DataZone project can start querying the data to which they have subscribed. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataZone::SubscriptionTarget", "Properties" : { "[ApplicableAssetTypes](#cfn-datazone-subscriptiontarget-applicableassettypes)" : [ String, ... ], "[AuthorizedPrincipals](#cfn-datazone-subscriptiontarget-authorizedprincipals)" : [ String, ... ], "[DomainIdentifier](#cfn-datazone-subscriptiontarget-domainidentifier)" : String, "[EnvironmentIdentifier](#cfn-datazone-subscriptiontarget-environmentidentifier)" : String, "[ManageAccessRole](#cfn-datazone-subscriptiontarget-manageaccessrole)" : String, "[Name](#cfn-datazone-subscriptiontarget-name)" : String, "[Provider](#cfn-datazone-subscriptiontarget-provider)" : String, "[SubscriptionTargetConfig](#cfn-datazone-subscriptiontarget-subscriptiontargetconfig)" : [ SubscriptionTargetForm, ... ], "[Type](#cfn-datazone-subscriptiontarget-type)" : String } } ``` ### YAML ``` Type: AWS::DataZone::SubscriptionTarget Properties: [ApplicableAssetTypes](#cfn-datazone-subscriptiontarget-applicableassettypes): - String [AuthorizedPrincipals](#cfn-datazone-subscriptiontarget-authorizedprincipals): - String [DomainIdentifier](#cfn-datazone-subscriptiontarget-domainidentifier): String [EnvironmentIdentifier](#cfn-datazone-subscriptiontarget-environmentidentifier): String [ManageAccessRole](#cfn-datazone-subscriptiontarget-manageaccessrole): String [Name](#cfn-datazone-subscriptiontarget-name): String [Provider](#cfn-datazone-subscriptiontarget-provider): String [SubscriptionTargetConfig](#cfn-datazone-subscriptiontarget-subscriptiontargetconfig): - SubscriptionTargetForm [Type](#cfn-datazone-subscriptiontarget-type): String ``` ## Properties `ApplicableAssetTypes` The asset types included in the subscription target. *Required*: Yes *Type*: Array of String *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AuthorizedPrincipals` The authorized principals included in the subscription target. *Required*: Yes *Type*: Array of String *Minimum*: `1` *Maximum*: `10` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DomainIdentifier` The ID of the Amazon DataZone domain in which subscription target is created. *Required*: Yes *Type*: String *Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EnvironmentIdentifier` The ID of the environment in which subscription target is created. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_-]{1,36}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ManageAccessRole` The manage access role that is used to create the subscription target. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the subscription target. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Provider` The provider of the subscription target. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SubscriptionTargetConfig` The configuration of the subscription target. *Required*: Yes *Type*: Array of [SubscriptionTargetForm](aws-properties-datazone-subscriptiontarget-subscriptiontargetform.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The type of the subscription target. *Required*: Yes *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainId`, `EnvironmentId` and the `SubscriptionTargetId` that uniquely identify the subscription target. For example: `{ "Ref": "MySubscriptionTarget" }` for the resource with the logical ID `MySubscriptionTarget`, `Ref` returns `DomainId|EnvironmentId|SubscriptionTargetId`. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `CreatedAt` The timestamp of when the subscription target was created. `CreatedBy` The Amazon DataZone user who created the subscription target. `DomainId` The identifier of the Amazon DataZone domain in which the subscription target exists. `EnvironmentId` The identifier of the environment of the subscription target. `Id` The identifier of the subscription target. `ProjectId` The identifier of the project specified in the subscription target. `UpdatedAt` The timestamp of when the subscription target was updated. `UpdatedBy` The Amazon DataZone user who updated the subscription target. # AWS::DataZone::SubscriptionTarget SubscriptionTargetForm The details of the subscription target configuration. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Content](#cfn-datazone-subscriptiontarget-subscriptiontargetform-content)" : String, "[FormName](#cfn-datazone-subscriptiontarget-subscriptiontargetform-formname)" : String } ``` ### YAML ``` [Content](#cfn-datazone-subscriptiontarget-subscriptiontargetform-content): String [FormName](#cfn-datazone-subscriptiontarget-subscriptiontargetform-formname): String ``` ## Properties `Content` The content of the subscription target configuration. *Required*: Yes *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FormName` The form name included in the subscription target configuration. *Required*: Yes *Type*: String *Pattern*: `^(?![0-9_])\w+$|^_\w*[a-zA-Z0-9]\w*$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::UserProfile The user type of the user for which the user profile is created. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataZone::UserProfile", "Properties" : { "[DomainIdentifier](#cfn-datazone-userprofile-domainidentifier)" : String, "[Status](#cfn-datazone-userprofile-status)" : String, "[UserIdentifier](#cfn-datazone-userprofile-useridentifier)" : String, "[UserType](#cfn-datazone-userprofile-usertype)" : String } } ``` ### YAML ``` Type: AWS::DataZone::UserProfile Properties: [DomainIdentifier](#cfn-datazone-userprofile-domainidentifier): String [Status](#cfn-datazone-userprofile-status): String [UserIdentifier](#cfn-datazone-userprofile-useridentifier): String [UserType](#cfn-datazone-userprofile-usertype): String ``` ## Properties `DomainIdentifier` The identifier of a Amazon DataZone domain in which a user profile exists. *Required*: Yes *Type*: String *Pattern*: `^dzd[-_][a-zA-Z0-9_-]{1,36}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Status` The status of the user profile. *Required*: No *Type*: String *Allowed values*: `ASSIGNED | NOT_ASSIGNED | ACTIVATED | DEACTIVATED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UserIdentifier` The identifier of the user for which the user profile is created. *Required*: Yes *Type*: String *Pattern*: `(^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|^[a-zA-Z_0-9+=,.@-]+$|^arn:aws:iam::\d{12}:.+$)` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `UserType` The user type of the user for which the user profile is created. *Required*: No *Type*: String *Allowed values*: `IAM_USER | IAM_ROLE | SSO_USER` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a string containing pipe-separated `DomainId` and `UserProfileId` that uniquely identify the user profile. For example: `{ "Ref": "MyUserProfile" }` for the resource with the logical ID `MyUserProfile`, `Ref` returns `DomainId|UserProfileId`. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `DomainId` The identifier of a Amazon DataZone domain in which a user profile exists. `Id` The ID of the user profile. `Type` The type of the user profile. # AWS::DataZone::UserProfile IamUserProfileDetails The details of the IAM user profile. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Arn](#cfn-datazone-userprofile-iamuserprofiledetails-arn)" : String } ``` ### YAML ``` [Arn](#cfn-datazone-userprofile-iamuserprofiledetails-arn): String ``` ## Properties `Arn` The ARN of the IAM user. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::UserProfile SsoUserProfileDetails The SSO user profile detail. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[FirstName](#cfn-datazone-userprofile-ssouserprofiledetails-firstname)" : String, "[LastName](#cfn-datazone-userprofile-ssouserprofiledetails-lastname)" : String, "[Username](#cfn-datazone-userprofile-ssouserprofiledetails-username)" : String } ``` ### YAML ``` [FirstName](#cfn-datazone-userprofile-ssouserprofiledetails-firstname): String [LastName](#cfn-datazone-userprofile-ssouserprofiledetails-lastname): String [Username](#cfn-datazone-userprofile-ssouserprofiledetails-username): String ``` ## Properties `FirstName` The first name as part of the SSO user profile detail. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LastName` The last name as part of the SSO user profile detail. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Username` The username as part of the SSO user profile detail. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z_0-9+=,.@-]+$` *Minimum*: `1` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataZone::UserProfile UserProfileDetails The user profile details. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Iam](#cfn-datazone-userprofile-userprofiledetails-iam)" : IamUserProfileDetails, "[Sso](#cfn-datazone-userprofile-userprofiledetails-sso)" : SsoUserProfileDetails } ``` ### YAML ``` [Iam](#cfn-datazone-userprofile-userprofiledetails-iam): IamUserProfileDetails [Sso](#cfn-datazone-userprofile-userprofiledetails-sso): SsoUserProfileDetails ``` ## Properties `Iam` The IAM details of the user profile. *Required*: No *Type*: [IamUserProfileDetails](aws-properties-datazone-userprofile-iamuserprofiledetails.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Sso` The SSO details of the user profile. *Required*: No *Type*: [SsoUserProfileDetails](aws-properties-datazone-userprofile-ssouserprofiledetails.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)