Schema Docs
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - bucketName | No | string | No | - | S3 bucket name for project storage (scripts, artifacts, temp files). Auto-resolved from project when projectName is set. Use cases: Script storage; Processing artifacts; Centralized project storage AWS: S3 bucket Validation: Optional; auto-wired from project if projectName provided |
| - deploymentRoleArn | No | string | No | - | IAM role ARN for deployment operations and resource management. Auto-resolved from project when projectName is set. Use cases: Deployment permissions; Resource provisioning AWS: IAM role Validation: Optional; auto-wired from project if projectName provided |
| + dms | No | object | No | In #/definitions/DMSProps | DMS migration and replication configuration including instances, endpoints, and tasks. Use cases: Database migration; Real-time replication; Cross-engine data movement AWS: AWS Database Migration Service Validation: Required; valid DMSProps |
| - kmsArn | No | string | No | - | KMS key ARN for encrypting DataOps resources and data. Auto-resolved from project when projectName is set. Use cases: Data encryption; Security compliance AWS: KMS key Validation: Optional; auto-wired from project if projectName provided |
| - nag_suppressions | No | object | No | In #/definitions/MdaaNagSuppressionConfigs | Q-ENHANCED-PROPERTY Optional CDK Nag suppression configurations for compliance rule management enabling controlled security rule exceptions and compliance documentation. Provides structured approach to managing security rule suppressions with proper justification and documentation for compliance auditing. Use cases: Compliance management; Security rule exceptions; Audit documentation; Controlled suppressions AWS: CDK Nag suppressions for compliance rule management and security exception documentation Validation: Must be valid MdaaNagSuppressionConfigs if provided; enables structured compliance rule management |
| - notificationTopicArn | No | string | No | - | SNS topic ARN for job notifications and workflow alerts. Auto-resolved from project when projectName is set. Use cases: Job failure alerts; Workflow status notifications AWS: SNS topic Validation: Optional; auto-wired from project if projectName provided |
| - projectName | No | string | No | - | DataOps project name enabling auto-wiring of shared resources (bucket, KMS key, SNS topic, deployment role, security configuration) via SSM parameters. Use cases: Project resource coordination; Shared infrastructure reuse AWS: DataOps project SSM parameter references Validation: Optional; must match an existing deployed project |
| - sagemakerBlueprint | No | object | No | In #/definitions/MdaaSageMakerCustomBluePrintConfig | Q-ENHANCED-PROPERTY Optional SageMaker blueprint configuration for governed self-service deployment enabling controlled infrastructure provisioning and governance. When specified, deploys the module as a SageMaker blueprint instead of direct deployment for governed access and compliance. Use cases: Governed deployment; Self-service provisioning; SageMaker integration; Controlled access AWS: SageMaker blueprint configuration for governed infrastructure deployment and self-service provisioning Validation: Must be valid MdaaServiceCatalogProductConfig if provided; enables SageMaker deployment mode |
| - securityConfigurationName | No | string | No | - | Glue security configuration name for job encryption (at rest, in transit, CloudWatch logs). Auto-resolved from project when projectName is set. Use cases: Job encryption; Security compliance AWS: Glue security configuration Validation: Optional; auto-wired from project if projectName provided |
| - service_catalog_product_config | No | object | No | In #/definitions/MdaaServiceCatalogProductConfig | Q-ENHANCED-PROPERTY Optional Service Catalog product configuration for governed self-service deployment enabling controlled infrastructure provisioning and governance. When specified, deploys the module as a Service Catalog product instead of direct deployment for governed access and compliance. Use cases: Governed deployment; Self-service provisioning; Service Catalog integration; Controlled access AWS: Service Catalog product configuration for governed infrastructure deployment and self-service provisioning Validation: Must be valid MdaaServiceCatalogProductConfig if provided; enables Service Catalog deployment mode |
1. Property root > bucketName
| Type | string |
| Required | No |
Description: S3 bucket name for project storage (scripts, artifacts, temp files). Auto-resolved from project when projectName is set.
Use cases: Script storage; Processing artifacts; Centralized project storage
AWS: S3 bucket
Validation: Optional; auto-wired from project if projectName provided
2. Property root > deploymentRoleArn
| Type | string |
| Required | No |
Description: IAM role ARN for deployment operations and resource management. Auto-resolved from project when projectName is set.
Use cases: Deployment permissions; Resource provisioning
AWS: IAM role
Validation: Optional; auto-wired from project if projectName provided
3. Property root > dms
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/DMSProps |
Description: DMS migration and replication configuration including instances, endpoints, and tasks.
Use cases: Database migration; Real-time replication; Cross-engine data movement
AWS: AWS Database Migration Service
Validation: Required; valid DMSProps
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - createDmsLogRole | No | boolean | No | - | Whether to create the DMS CloudWatch Logs service role. |
| - createDmsVpcRole | No | boolean | No | - | Whether to create the DMS VPC service role. |
| - dmsRoleArn | No | string | No | - | Custom IAM role ARN for DMS operations. |
| - endpoints | No | object | No | In #/definitions/NamedEndpointProps | Named endpoint configurations for source and target databases. |
| - replicationInstances | No | object | No | In #/definitions/NamedReplicationInstanceProps | Named replication instance configurations. |
| - replicationTasks | No | object | No | In #/definitions/NamedReplicationTaskProps | Named replication task configurations. |
3.1. Property root > dms > createDmsLogRole
| Type | boolean |
| Required | No |
Description: Whether to create the DMS CloudWatch Logs service role.
3.2. Property root > dms > createDmsVpcRole
| Type | boolean |
| Required | No |
Description: Whether to create the DMS VPC service role.
3.3. Property root > dms > dmsRoleArn
| Type | string |
| Required | No |
Description: Custom IAM role ARN for DMS operations.
3.4. Property root > dms > endpoints
| Type | object |
| Required | No |
| Additional properties | Each additional property must conform to the schema |
| Defined in | #/definitions/NamedEndpointProps |
Description: Named endpoint configurations for source and target databases.
3.4.1. Property root > dms > endpoints > EndpointProps
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/EndpointProps |
Description: Configuration for a DMS endpoint defining database connection settings.
Use cases: Database migration; Database replication; Data migration workflows; Database connectivity
AWS: AWS Database Migration Service configuration for database migration and replication
Validation: Configuration must be valid for deployment; properties must conform to AWS DMS and MDAA requirements
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - databaseName | No | string | No | - | The optional name of the endpoint database. Required for certain endpoint types. |
| - docDbSettings | No | object | No | In #/definitions/DocDbSettingsProperty | Settings in JSON format for the source and target DocumentDB endpoint. For more information about other available settings, see Using extra connections attributes with Amazon DocumentDB as a source and Using Amazon DocumentDB as a target for AWS Database Migration Service in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-docdbsettings |
| - dynamoDbSettings | No | object | No | In #/definitions/DynamoDbSettingsProperty | Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using object mapping to migrate data to DynamoDB in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-dynamodbsettings |
| - elasticsearchSettings | No | object | No | In #/definitions/ElasticsearchSettingsProperty | Settings in JSON format for the target OpenSearch endpoint. For more information about the available settings, see Extra connection attributes when using OpenSearch as a target for AWS DMS in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-elasticsearchsettings |
| + endpointType | No | enum (of string) | No | In #/definitions/MdaaEndpointType | The type of Endpoint ("source" or "target") |
| + engineName | No | enum (of string) | No | In #/definitions/MdaaEndpointEngine | The name of the endpoint engine |
| - ibmDb2Settings | No | object | No | In #/definitions/IbmDb2SettingsProperty | Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for AWS DMS in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-ibmdb2settings |
| - kinesisSettings | No | object | No | In #/definitions/KinesisSettingsProperty | Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about other available settings, see Using object mapping to migrate data to a Kinesis data stream in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-kinesissettings |
| - microsoftSqlServerSettings | No | object | No | In #/definitions/MicrosoftSqlServerSettingsProperty | Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see Extra connection attributes when using SQL Server as a source for AWS DMS and Extra connection attributes when using SQL Server as a target for AWS DMS in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-microsoftsqlserversettings |
| - mongoDbSettings | No | object | No | In #/definitions/MongoDbSettingsProperty | Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see Using MongoDB as a target for AWS Database Migration Service in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-mongodbsettings |
| - mySqlSettings | No | object | No | In #/definitions/MySqlSettingsProperty | Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see Extra connection attributes when using MySQL as a source for AWS DMS and Extra connection attributes when using a MySQL-compatible database as a target for AWS DMS in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-mysqlsettings |
| - neptuneSettings | No | object | No | In #/definitions/NeptuneSettingsProperty | Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying endpoint settings for Amazon Neptune as a target in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-neptunesettings |
| - oracleSettings | No | object | No | In #/definitions/OracleSettingsProperty | Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see Extra connection attributes when using Oracle as a source for AWS DMS and Extra connection attributes when using Oracle as a target for AWS DMS in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-oraclesettings |
| - postgreSqlSettings | No | object | No | In #/definitions/PostgreSqlSettingsProperty | Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for AWS DMS and Extra connection attributes when using PostgreSQL as a target for AWS DMS in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-postgresqlsettings |
| - redshiftSettings | No | object | No | In #/definitions/RedshiftSettingsProperty | Settings in JSON format for the Amazon Redshift endpoint. For more information about other available settings, see Extra connection attributes when using Amazon Redshift as a target for AWS DMS in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-redshiftsettings |
| - s3Settings | No | object | No | In #/definitions/S3SettingsProperty | Settings in JSON format for the source and target Amazon S3 endpoint. For more information about other available settings, see Extra connection attributes when using Amazon S3 as a source for AWS DMS and Extra connection attributes when using Amazon S3 as a target for AWS DMS in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-s3settings |
| - sybaseSettings | No | object | No | In #/definitions/SybaseSettingsProperty | Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see Extra connection attributes when using SAP ASE as a source for AWS DMS and Extra connection attributes when using SAP ASE as a target for AWS DMS in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-sybasesettings |
3.4.1.1. Property root > dms > endpoints > additionalProperties > databaseName
| Type | string |
| Required | No |
Description: The optional name of the endpoint database. Required for certain endpoint types.
3.4.1.2. Property root > dms > endpoints > additionalProperties > docDbSettings
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/DocDbSettingsProperty |
Description: Settings in JSON format for the source and target DocumentDB endpoint. For more information about other available settings, see Using extra connections attributes with Amazon DocumentDB as a source and Using Amazon DocumentDB as a target for AWS Database Migration Service in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-docdbsettings
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - docsToInvestigate | No | number | No | - | Number of documents to preview for determining document organization and schema inference |
| - extractDocId | No | boolean | No | - | - |
| - nestingLevel | No | string | No | - | Nesting level specification for DocumentDB migration mode selection enabling document or table mode migration |
| - secretsManagerAccessRoleArn | No | string | No | - | - |
| + secretsManagerSecretArn | No | string | No | - | Secrets Manager secret ARN containing DocumentDB endpoint connection details enabling |
| - secretsManagerSecretKMSArn | No | string | No | - | - |
3.4.1.2.1. Property root > dms > endpoints > additionalProperties > docDbSettings > docsToInvestigate
| Type | number |
| Required | No |
Description: Number of documents to preview for determining document organization and schema inference
3.4.1.2.2. Property root > dms > endpoints > additionalProperties > docDbSettings > extractDocId
| Type | boolean |
| Required | No |
3.4.1.2.3. Property root > dms > endpoints > additionalProperties > docDbSettings > nestingLevel
| Type | string |
| Required | No |
Description: Nesting level specification for DocumentDB migration mode selection enabling document or table mode migration
3.4.1.2.4. Property root > dms > endpoints > additionalProperties > docDbSettings > secretsManagerAccessRoleArn
| Type | string |
| Required | No |
3.4.1.2.5. Property root > dms > endpoints > additionalProperties > docDbSettings > secretsManagerSecretArn
| Type | string |
| Required | Yes |
Description: Secrets Manager secret ARN containing DocumentDB endpoint connection details enabling
3.4.1.2.6. Property root > dms > endpoints > additionalProperties > docDbSettings > secretsManagerSecretKMSArn
| Type | string |
| Required | No |
3.4.1.3. Property root > dms > endpoints > additionalProperties > dynamoDbSettings
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/DynamoDbSettingsProperty |
Description: Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using object mapping to migrate data to DynamoDB in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-dynamodbsettings
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - serviceAccessRoleArn | No | string | No | - | IAM service role ARN for DMS DynamoDB endpoint access enabling secure authentication and |
3.4.1.3.1. Property root > dms > endpoints > additionalProperties > dynamoDbSettings > serviceAccessRoleArn
| Type | string |
| Required | No |
Description: IAM service role ARN for DMS DynamoDB endpoint access enabling secure authentication and
3.4.1.4. Property root > dms > endpoints > additionalProperties > elasticsearchSettings
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/ElasticsearchSettingsProperty |
Description: Settings in JSON format for the target OpenSearch endpoint. For more information about the available settings, see Extra connection attributes when using OpenSearch as a target for AWS DMS in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-elasticsearchsettings
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - endpointUri | No | string | No | - | OpenSearch cluster endpoint URI for DMS target connectivity enabling search engine data migration and indexing |
| - errorRetryDuration | No | number | No | - | - |
| - fullLoadErrorPercentage | No | number | No | - | Maximum percentage of failed records before stopping full load operation enabling |
| - serviceAccessRoleArn | No | string | No | - | - |
3.4.1.4.1. Property root > dms > endpoints > additionalProperties > elasticsearchSettings > endpointUri
| Type | string |
| Required | No |
Description: OpenSearch cluster endpoint URI for DMS target connectivity enabling search engine data migration and indexing
3.4.1.4.2. Property root > dms > endpoints > additionalProperties > elasticsearchSettings > errorRetryDuration
| Type | number |
| Required | No |
3.4.1.4.3. Property root > dms > endpoints > additionalProperties > elasticsearchSettings > fullLoadErrorPercentage
| Type | number |
| Required | No |
Description: Maximum percentage of failed records before stopping full load operation enabling
3.4.1.4.4. Property root > dms > endpoints > additionalProperties > elasticsearchSettings > serviceAccessRoleArn
| Type | string |
| Required | No |
3.4.1.5. Property root > dms > endpoints > additionalProperties > endpointType
| Type | enum (of string) |
| Required | Yes |
| Defined in | #/definitions/MdaaEndpointType |
Description: The type of Endpoint ("source" or "target")
Must be one of: * "source" * "target"
3.4.1.6. Property root > dms > endpoints > additionalProperties > engineName
| Type | enum (of string) |
| Required | Yes |
| Defined in | #/definitions/MdaaEndpointEngine |
Description: The name of the endpoint engine
Must be one of: * "aurora" * "aurora-postgresql" * "azuredb" * "db2" * "docdb" * "dynamodb" * "elasticsearch" * "kafka" * "kinesis" * "mariadb" * "mongodb" * "mysql" * "neptune" * "opensearch" * "oracle" * "postgres" * "redshift" * "redshift-serverless" * "s3" * "sqlserver" * "sybase"
3.4.1.7. Property root > dms > endpoints > additionalProperties > ibmDb2Settings
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/IbmDb2SettingsProperty |
Description: Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for AWS DMS in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-ibmdb2settings
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - currentLsn | No | string | No | - | Log sequence number (LSN) for IBM DB2 change data capture (CDC) replication starting point |
| - maxKBytesPerRead | No | number | No | - | Maximum bytes per read operation for IBM DB2 data transfer performance optimization enabling throughput tuning |
| - secretsManagerAccessRoleArn | No | string | No | - | The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret` . The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value ofthe AWS Secrets Manager secret that allows access to the Db2 LUW endpoint. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-secretsmanageraccessrolearn |
| + secretsManagerSecretArn | No | string | No | - | The full ARN of the `SecretsManagerSecret` that contains the IBMDB2 endpoint connection details. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-secretsmanagersecretid |
| - secretsManagerSecretKMSArn | No | string | No | - | The ID of the KMS key used to encrypt the credentials secret. |
| - setDataCaptureChanges | No | boolean | No | - | Enables ongoing replication (CDC) as a BOOLEAN value. The default is true. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-setdatacapturechanges |
3.4.1.7.1. Property root > dms > endpoints > additionalProperties > ibmDb2Settings > currentLsn
| Type | string |
| Required | No |
Description: Log sequence number (LSN) for IBM DB2 change data capture (CDC) replication starting point
3.4.1.7.2. Property root > dms > endpoints > additionalProperties > ibmDb2Settings > maxKBytesPerRead
| Type | number |
| Required | No |
Description: Maximum bytes per read operation for IBM DB2 data transfer performance optimization enabling throughput tuning
3.4.1.7.3. Property root > dms > endpoints > additionalProperties > ibmDb2Settings > secretsManagerAccessRoleArn
| Type | string |
| Required | No |
Description: The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret .
The role must allow the iam:PassRole action. SecretsManagerSecret has the value ofthe AWS Secrets Manager secret that allows access to the Db2 LUW endpoint.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-secretsmanageraccessrolearn
3.4.1.7.4. Property root > dms > endpoints > additionalProperties > ibmDb2Settings > secretsManagerSecretArn
| Type | string |
| Required | Yes |
Description: The full ARN of the SecretsManagerSecret that contains the IBMDB2 endpoint connection details.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-secretsmanagersecretid
3.4.1.7.5. Property root > dms > endpoints > additionalProperties > ibmDb2Settings > secretsManagerSecretKMSArn
| Type | string |
| Required | No |
Description: The ID of the KMS key used to encrypt the credentials secret.
3.4.1.7.6. Property root > dms > endpoints > additionalProperties > ibmDb2Settings > setDataCaptureChanges
| Type | boolean |
| Required | No |
Description: Enables ongoing replication (CDC) as a BOOLEAN value. The default is true. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html#cfn-dms-endpoint-ibmdb2settings-setdatacapturechanges
3.4.1.8. Property root > dms > endpoints > additionalProperties > kinesisSettings
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/KinesisSettingsProperty |
Description: Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about other available settings, see Using object mapping to migrate data to a Kinesis data stream in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-kinesissettings
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - includeControlDetails | No | boolean | No | - | Flag to show detailed control information for table and column changes in Kinesis message |
| - includeNullAndEmpty | No | boolean | No | - | Flag to include NULL and empty columns in records migrated to Kinesis endpoint for complete |
| - includePartitionValue | No | boolean | No | - | Flag to show partition value in Kinesis message output unless partition type is schema-table-type |
| - includeTableAlterOperations | No | boolean | No | - | Flag to include DDL operations that change table structure in control data for schema change tracking |
| - includeTransactionDetails | No | boolean | No | - | Flag to provide detailed transaction information from source database for transaction tracking |
| - messageFormat | No | string | No | - | Output format specification for records created on Kinesis endpoint for streaming data format control |
| - noHexPrefix | No | boolean | No | - | Flag to avoid adding '0x' prefix to raw data in hexadecimal format for cleaner data representation |
| - partitionIncludeSchemaTable | No | boolean | No | - | Flag to prefix schema and table names to partition values for improved data distribution across Kinesis shards |
| - serviceAccessRoleArn | No | string | No | - | IAM role ARN for DMS service access to Kinesis data stream for secure streaming operations |
| + streamArn | No | string | No | - | Amazon Kinesis Data Streams endpoint ARN for DMS streaming destination configuration |
3.4.1.8.1. Property root > dms > endpoints > additionalProperties > kinesisSettings > includeControlDetails
| Type | boolean |
| Required | No |
Description: Flag to show detailed control information for table and column changes in Kinesis message
3.4.1.8.2. Property root > dms > endpoints > additionalProperties > kinesisSettings > includeNullAndEmpty
| Type | boolean |
| Required | No |
Description: Flag to include NULL and empty columns in records migrated to Kinesis endpoint for complete
3.4.1.8.3. Property root > dms > endpoints > additionalProperties > kinesisSettings > includePartitionValue
| Type | boolean |
| Required | No |
Description: Flag to show partition value in Kinesis message output unless partition type is schema-table-type
3.4.1.8.4. Property root > dms > endpoints > additionalProperties > kinesisSettings > includeTableAlterOperations
| Type | boolean |
| Required | No |
Description: Flag to include DDL operations that change table structure in control data for schema change tracking
3.4.1.8.5. Property root > dms > endpoints > additionalProperties > kinesisSettings > includeTransactionDetails
| Type | boolean |
| Required | No |
Description: Flag to provide detailed transaction information from source database for transaction tracking
3.4.1.8.6. Property root > dms > endpoints > additionalProperties > kinesisSettings > messageFormat
| Type | string |
| Required | No |
Description: Output format specification for records created on Kinesis endpoint for streaming data format control
3.4.1.8.7. Property root > dms > endpoints > additionalProperties > kinesisSettings > noHexPrefix
| Type | boolean |
| Required | No |
Description: Flag to avoid adding '0x' prefix to raw data in hexadecimal format for cleaner data representation
3.4.1.8.8. Property root > dms > endpoints > additionalProperties > kinesisSettings > partitionIncludeSchemaTable
| Type | boolean |
| Required | No |
Description: Flag to prefix schema and table names to partition values for improved data distribution across Kinesis shards
3.4.1.8.9. Property root > dms > endpoints > additionalProperties > kinesisSettings > serviceAccessRoleArn
| Type | string |
| Required | No |
Description: IAM role ARN for DMS service access to Kinesis data stream for secure streaming operations
3.4.1.8.10. Property root > dms > endpoints > additionalProperties > kinesisSettings > streamArn
| Type | string |
| Required | Yes |
Description: Amazon Kinesis Data Streams endpoint ARN for DMS streaming destination configuration
3.4.1.9. Property root > dms > endpoints > additionalProperties > microsoftSqlServerSettings
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/MicrosoftSqlServerSettingsProperty |
Description: Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see Extra connection attributes when using SQL Server as a source for AWS DMS and Extra connection attributes when using SQL Server as a target for AWS DMS in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-microsoftsqlserversettings
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - bcpPacketSize | No | number | No | - | BCP packet size in bytes for SQL Server data transfer optimization enabling performance |
| - controlTablesFileGroup | No | string | No | - | - |
| - databaseName | No | string | No | - | Database name for SQL Server endpoint connectivity enabling specific database targeting |
| - forceLobLookup | No | boolean | No | - | - |
| - port | No | number | No | - | TCP port number for SQL Server endpoint connectivity enabling custom port configuration for |
| - querySingleAlwaysOnNode | No | boolean | No | - | - |
| - readBackupOnly | No | boolean | No | - | Flag to read changes only from transaction log backups enabling controlled transaction log |
| - safeguardPolicy | No | string | No | - | - |
| - secretsManagerAccessRoleArn | No | string | No | - | IAM role ARN for DMS to access Secrets Manager secret containing SQL Server credentials |
| + secretsManagerSecretArn | No | string | No | - | - |
| - secretsManagerSecretKMSArn | No | string | No | - | KMS key ARN for encrypting Secrets Manager secret containing SQL Server credentials |
| - serverName | No | string | No | - | - |
| - tlogAccessMode | No | string | No | - | Transaction log access mode for CDC data fetching enabling optimized change data capture in |
| - trimSpaceInChar | No | boolean | No | - | - |
| - useBcpFullLoad | No | boolean | No | - | Flag to use BCP for full-load operations enabling optimized bulk data transfer in SQL Server migration |
| - useThirdPartyBackupDevice | No | boolean | No | - | - |
3.4.1.9.1. Property root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > bcpPacketSize
| Type | number |
| Required | No |
Description: BCP packet size in bytes for SQL Server data transfer optimization enabling performance
3.4.1.9.2. Property root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > controlTablesFileGroup
| Type | string |
| Required | No |
3.4.1.9.3. Property root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > databaseName
| Type | string |
| Required | No |
Description: Database name for SQL Server endpoint connectivity enabling specific database targeting
3.4.1.9.4. Property root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > forceLobLookup
| Type | boolean |
| Required | No |
3.4.1.9.5. Property root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > port
| Type | number |
| Required | No |
Description: TCP port number for SQL Server endpoint connectivity enabling custom port configuration for
3.4.1.9.6. Property root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > querySingleAlwaysOnNode
| Type | boolean |
| Required | No |
3.4.1.9.7. Property root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > readBackupOnly
| Type | boolean |
| Required | No |
Description: Flag to read changes only from transaction log backups enabling controlled transaction log
3.4.1.9.8. Property root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > safeguardPolicy
| Type | string |
| Required | No |
3.4.1.9.9. Property root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > secretsManagerAccessRoleArn
| Type | string |
| Required | No |
Description: IAM role ARN for DMS to access Secrets Manager secret containing SQL Server credentials
3.4.1.9.10. Property root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > secretsManagerSecretArn
| Type | string |
| Required | Yes |
3.4.1.9.11. Property root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > secretsManagerSecretKMSArn
| Type | string |
| Required | No |
Description: KMS key ARN for encrypting Secrets Manager secret containing SQL Server credentials
3.4.1.9.12. Property root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > serverName
| Type | string |
| Required | No |
3.4.1.9.13. Property root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > tlogAccessMode
| Type | string |
| Required | No |
Description: Transaction log access mode for CDC data fetching enabling optimized change data capture in
3.4.1.9.14. Property root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > trimSpaceInChar
| Type | boolean |
| Required | No |
3.4.1.9.15. Property root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > useBcpFullLoad
| Type | boolean |
| Required | No |
Description: Flag to use BCP for full-load operations enabling optimized bulk data transfer in SQL Server migration
3.4.1.9.16. Property root > dms > endpoints > additionalProperties > microsoftSqlServerSettings > useThirdPartyBackupDevice
| Type | boolean |
| Required | No |
3.4.1.10. Property root > dms > endpoints > additionalProperties > mongoDbSettings
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/MongoDbSettingsProperty |
Description: Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see Using MongoDB as a target for AWS Database Migration Service in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-mongodbsettings
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - authMechanism | No | string | No | - | Authentication mechanism for MongoDB source endpoint access with version-specific defaults |
| - authSource | No | string | No | - | MongoDB database name for authentication with default "admin" database |
| - authType | No | string | No | - | Authentication type for MongoDB source endpoint access control |
| - databaseName | No | string | No | - | Database name on MongoDB source endpoint for migration scope specification |
| - docsToInvestigate | No | string | No | - | Number of documents to preview for document organization analysis when using table mode |
| - extractDocId | No | string | No | - | Flag to specify document ID extraction when using document mode |
| - nestingLevel | No | string | No | - | Nesting level specification for document or table mode selection |
| - port | No | number | No | - | The port value for the MongoDB source endpoint. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-port |
| - secretsManagerAccessRoleArn | No | string | No | - | The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret` . The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the MongoDB endpoint. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-secretsmanageraccessrolearn |
| + secretsManagerSecretArn | No | string | No | - | The full ARN of the `SecretsManagerSecret` that contains the MongoDB endpoint connection details. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-secretsmanagersecretid |
| - secretsManagerSecretKMSArn | No | string | No | - | The ID of the KMS key used to encrypt the credentials secret. |
| - serverName | No | string | No | - | The name of the server on the MongoDB source endpoint. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-servername |
3.4.1.10.1. Property root > dms > endpoints > additionalProperties > mongoDbSettings > authMechanism
| Type | string |
| Required | No |
Description: Authentication mechanism for MongoDB source endpoint access with version-specific defaults
3.4.1.10.2. Property root > dms > endpoints > additionalProperties > mongoDbSettings > authSource
| Type | string |
| Required | No |
Description: MongoDB database name for authentication with default "admin" database
3.4.1.10.3. Property root > dms > endpoints > additionalProperties > mongoDbSettings > authType
| Type | string |
| Required | No |
Description: Authentication type for MongoDB source endpoint access control
3.4.1.10.4. Property root > dms > endpoints > additionalProperties > mongoDbSettings > databaseName
| Type | string |
| Required | No |
Description: Database name on MongoDB source endpoint for migration scope specification
3.4.1.10.5. Property root > dms > endpoints > additionalProperties > mongoDbSettings > docsToInvestigate
| Type | string |
| Required | No |
Description: Number of documents to preview for document organization analysis when using table mode
3.4.1.10.6. Property root > dms > endpoints > additionalProperties > mongoDbSettings > extractDocId
| Type | string |
| Required | No |
Description: Flag to specify document ID extraction when using document mode
3.4.1.10.7. Property root > dms > endpoints > additionalProperties > mongoDbSettings > nestingLevel
| Type | string |
| Required | No |
Description: Nesting level specification for document or table mode selection
3.4.1.10.8. Property root > dms > endpoints > additionalProperties > mongoDbSettings > port
| Type | number |
| Required | No |
Description: The port value for the MongoDB source endpoint. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-port
3.4.1.10.9. Property root > dms > endpoints > additionalProperties > mongoDbSettings > secretsManagerAccessRoleArn
| Type | string |
| Required | No |
Description: The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret .
The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the MongoDB endpoint.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-secretsmanageraccessrolearn
3.4.1.10.10. Property root > dms > endpoints > additionalProperties > mongoDbSettings > secretsManagerSecretArn
| Type | string |
| Required | Yes |
Description: The full ARN of the SecretsManagerSecret that contains the MongoDB endpoint connection details.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-secretsmanagersecretid
3.4.1.10.11. Property root > dms > endpoints > additionalProperties > mongoDbSettings > secretsManagerSecretKMSArn
| Type | string |
| Required | No |
Description: The ID of the KMS key used to encrypt the credentials secret.
3.4.1.10.12. Property root > dms > endpoints > additionalProperties > mongoDbSettings > serverName
| Type | string |
| Required | No |
Description: The name of the server on the MongoDB source endpoint. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html#cfn-dms-endpoint-mongodbsettings-servername
3.4.1.11. Property root > dms > endpoints > additionalProperties > mySqlSettings
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/MySqlSettingsProperty |
Description: Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see Extra connection attributes when using MySQL as a source for AWS DMS and Extra connection attributes when using a MySQL-compatible database as a target for AWS DMS in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-mysqlsettings
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - afterConnectScript | No | string | No | - | SQL script to execute immediately after DMS connects to the MySQL endpoint for initialization tasks |
| - cleanSourceMetadataOnMismatch | No | boolean | No | - | Flag to clean and recreate table metadata on replication instance when mismatches occur |
| - eventsPollInterval | No | number | No | - | Polling interval in seconds for checking MySQL binary log changes when database is idle |
| - maxFileSize | No | number | No | - | Maximum CSV file size in KB for MySQL data transfer operations |
| - parallelLoadThreads | No | number | No | - | Number of parallel threads for loading data into MySQL-compatible target databases for |
| - secretsManagerAccessRoleArn | No | string | No | - | IAM role ARN for AWS Secrets Manager access to MySQL endpoint credentials |
| + secretsManagerSecretArn | No | string | No | - | Secrets Manager secret ARN containing MySQL endpoint connection details for secure credential management |
| - secretsManagerSecretKMSArn | No | string | No | - | KMS key ARN for encrypting MySQL endpoint credentials secret in Secrets Manager |
| - serverTimezone | No | string | No | - | Time zone specification for MySQL source database configuration |
| - targetDbType | No | string | No | - | Target database type specification for MySQL migration destination configuration |
3.4.1.11.1. Property root > dms > endpoints > additionalProperties > mySqlSettings > afterConnectScript
| Type | string |
| Required | No |
Description: SQL script to execute immediately after DMS connects to the MySQL endpoint for initialization tasks
3.4.1.11.2. Property root > dms > endpoints > additionalProperties > mySqlSettings > cleanSourceMetadataOnMismatch
| Type | boolean |
| Required | No |
Description: Flag to clean and recreate table metadata on replication instance when mismatches occur
3.4.1.11.3. Property root > dms > endpoints > additionalProperties > mySqlSettings > eventsPollInterval
| Type | number |
| Required | No |
Description: Polling interval in seconds for checking MySQL binary log changes when database is idle
3.4.1.11.4. Property root > dms > endpoints > additionalProperties > mySqlSettings > maxFileSize
| Type | number |
| Required | No |
Description: Maximum CSV file size in KB for MySQL data transfer operations
3.4.1.11.5. Property root > dms > endpoints > additionalProperties > mySqlSettings > parallelLoadThreads
| Type | number |
| Required | No |
Description: Number of parallel threads for loading data into MySQL-compatible target databases for
3.4.1.11.6. Property root > dms > endpoints > additionalProperties > mySqlSettings > secretsManagerAccessRoleArn
| Type | string |
| Required | No |
Description: IAM role ARN for AWS Secrets Manager access to MySQL endpoint credentials
3.4.1.11.7. Property root > dms > endpoints > additionalProperties > mySqlSettings > secretsManagerSecretArn
| Type | string |
| Required | Yes |
Description: Secrets Manager secret ARN containing MySQL endpoint connection details for secure credential management
3.4.1.11.8. Property root > dms > endpoints > additionalProperties > mySqlSettings > secretsManagerSecretKMSArn
| Type | string |
| Required | No |
Description: KMS key ARN for encrypting MySQL endpoint credentials secret in Secrets Manager
3.4.1.11.9. Property root > dms > endpoints > additionalProperties > mySqlSettings > serverTimezone
| Type | string |
| Required | No |
Description: Time zone specification for MySQL source database configuration
3.4.1.11.10. Property root > dms > endpoints > additionalProperties > mySqlSettings > targetDbType
| Type | string |
| Required | No |
Description: Target database type specification for MySQL migration destination configuration
3.4.1.12. Property root > dms > endpoints > additionalProperties > neptuneSettings
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/NeptuneSettingsProperty |
Description: Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying endpoint settings for Amazon Neptune as a target in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-neptunesettings
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - errorRetryDuration | No | number | No | - | Retry duration in milliseconds for DMS bulk-load operations to Neptune target database |
| - maxFileSize | No | number | No | - | - |
| - maxRetryCount | No | number | No | - | Maximum retry count for DMS bulk-load operations to Neptune target database enabling |
| - s3BucketFolder | No | string | No | - | - |
| + s3BucketName | No | string | No | - | S3 bucket name for temporary storage of migrated graph data during DMS Neptune migration |
| - serviceAccessRoleArn | No | string | No | - | - |
3.4.1.12.1. Property root > dms > endpoints > additionalProperties > neptuneSettings > errorRetryDuration
| Type | number |
| Required | No |
Description: Retry duration in milliseconds for DMS bulk-load operations to Neptune target database
3.4.1.12.2. Property root > dms > endpoints > additionalProperties > neptuneSettings > maxFileSize
| Type | number |
| Required | No |
3.4.1.12.3. Property root > dms > endpoints > additionalProperties > neptuneSettings > maxRetryCount
| Type | number |
| Required | No |
Description: Maximum retry count for DMS bulk-load operations to Neptune target database enabling
3.4.1.12.4. Property root > dms > endpoints > additionalProperties > neptuneSettings > s3BucketFolder
| Type | string |
| Required | No |
3.4.1.12.5. Property root > dms > endpoints > additionalProperties > neptuneSettings > s3BucketName
| Type | string |
| Required | Yes |
Description: S3 bucket name for temporary storage of migrated graph data during DMS Neptune migration
3.4.1.12.6. Property root > dms > endpoints > additionalProperties > neptuneSettings > serviceAccessRoleArn
| Type | string |
| Required | No |
3.4.1.13. Property root > dms > endpoints > additionalProperties > oracleSettings
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/OracleSettingsProperty |
Description: Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see Extra connection attributes when using Oracle as a source for AWS DMS and Extra connection attributes when using Oracle as a target for AWS DMS in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-oraclesettings
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - accessAlternateDirectly | No | boolean | No | - | Flag to disable Binary Reader access to redo logs through direct file access for Oracle RDS sources |
| - addSupplementalLogging | No | boolean | No | - | Flag to enable table-level supplemental logging for Oracle database migration tasks |
| - additionalArchivedLogDestId | No | number | No | - | Additional archived log destination ID for Oracle primary/standby switchover scenarios |
| - allowSelectNestedTables | No | boolean | No | - | Flag to enable replication of Oracle tables with nested tables or defined types for complex |
| - archivedLogDestId | No | number | No | - | Archived redo log destination ID for Oracle change data capture configuration |
| - archivedLogsOnly | No | boolean | No | - | Flag to restrict DMS access to archived redo logs only for Oracle replication |
| - asmServer | No | string | No | - | ASM server address for Oracle source endpoint Binary Reader configuration |
| - charLengthSemantics | No | string | No | - | Character length semantics specification for Oracle character column interpretation |
| - directPathNoLog | No | boolean | No | - | Flag to enable direct path loading without database logging for Oracle target performance optimization |
| - directPathParallelLoad | No | boolean | No | - | Flag to enable parallel loading when direct path full load is active for Oracle target |
| - enableHomogenousTablespace | No | boolean | No | - | Flag to enable homogeneous tablespace replication for Oracle target database consistency |
| - extraArchivedLogDestIds | No | array of number | No | - | Array of additional archived log destination IDs for Oracle Data Guard switchover scenarios |
| - failTasksOnLobTruncation | No | boolean | No | - | Flag to cause task failure when LOB column size exceeds specified LobMaxSize limit |
| - numberDatatypeScale | No | number | No | - | Number data type scale specification for Oracle NUMBER data type conversion precision |
| - oraclePathPrefix | No | string | No | - | Oracle path prefix for Binary Reader redo log access configuration |
| - parallelAsmReadThreads | No | number | No | - | Number of parallel ASM read threads for Oracle change data capture performance optimization |
| - readAheadBlocks | No | number | No | - | Number of read-ahead blocks for Oracle ASM change data capture performance optimization |
| - readTableSpaceName | No | boolean | No | - | Flag to enable tablespace name reading for Oracle tablespace replication support |
| - replacePathPrefix | No | boolean | No | - | Flag to enable path prefix replacement for Binary Reader redo log access |
| - retryInterval | No | number | No | - | Retry interval in seconds for Oracle connection query retry operations |
| - secretsManagerAccessRoleArn | No | string | No | - | IAM role ARN for AWS Secrets Manager access to Oracle endpoint credentials |
| - secretsManagerOracleAsmAccessRoleArn | No | string | No | - | IAM role ARN for AWS Secrets Manager access to Oracle ASM credentials when using Advanced Storage Manager |
| - secretsManagerOracleAsmSecretArn | No | string | No | - | Secrets Manager secret ARN containing Oracle ASM connection details for Advanced Storage Manager endpoints |
| + secretsManagerSecretArn | No | string | No | - | Secrets Manager secret ARN containing Oracle endpoint connection details for secure credential management |
| - secretsManagerSecretKMSArn | No | string | No | - | KMS key ARN for encrypting Oracle endpoint credentials secret in Secrets Manager |
| - spatialDataOptionToGeoJsonFunctionName | No | string | No | - | Custom function name for converting Oracle SDO_GEOMETRY to GEOJSON format during spatial data migration |
| - standbyDelayTime | No | number | No | - | Standby delay time in minutes for Oracle Active Data Guard standby database synchronization |
| - useAlternateFolderForOnline | No | boolean | No | - | Flag to enable alternate folder usage for online redo logs with Binary Reader for Oracle RDS sources |
| - useBFile | No | boolean | No | - | Flag to enable Binary Reader utility for Oracle change data capture operations |
| - useDirectPathFullLoad | No | boolean | No | - | Flag to enable direct path full load for Oracle target database performance optimization |
| - useLogminerReader | No | boolean | No | - | Flag to enable Oracle LogMiner utility for change data capture operations (default method) |
| - usePathPrefix | No | string | No | - | Path prefix for Binary Reader redo log access replacement in Oracle RDS sources |
3.4.1.13.1. Property root > dms > endpoints > additionalProperties > oracleSettings > accessAlternateDirectly
| Type | boolean |
| Required | No |
Description: Flag to disable Binary Reader access to redo logs through direct file access for Oracle RDS sources
3.4.1.13.2. Property root > dms > endpoints > additionalProperties > oracleSettings > addSupplementalLogging
| Type | boolean |
| Required | No |
Description: Flag to enable table-level supplemental logging for Oracle database migration tasks
3.4.1.13.3. Property root > dms > endpoints > additionalProperties > oracleSettings > additionalArchivedLogDestId
| Type | number |
| Required | No |
Description: Additional archived log destination ID for Oracle primary/standby switchover scenarios
3.4.1.13.4. Property root > dms > endpoints > additionalProperties > oracleSettings > allowSelectNestedTables
| Type | boolean |
| Required | No |
Description: Flag to enable replication of Oracle tables with nested tables or defined types for complex
3.4.1.13.5. Property root > dms > endpoints > additionalProperties > oracleSettings > archivedLogDestId
| Type | number |
| Required | No |
Description: Archived redo log destination ID for Oracle change data capture configuration
3.4.1.13.6. Property root > dms > endpoints > additionalProperties > oracleSettings > archivedLogsOnly
| Type | boolean |
| Required | No |
Description: Flag to restrict DMS access to archived redo logs only for Oracle replication
3.4.1.13.7. Property root > dms > endpoints > additionalProperties > oracleSettings > asmServer
| Type | string |
| Required | No |
Description: ASM server address for Oracle source endpoint Binary Reader configuration
3.4.1.13.8. Property root > dms > endpoints > additionalProperties > oracleSettings > charLengthSemantics
| Type | string |
| Required | No |
Description: Character length semantics specification for Oracle character column interpretation
3.4.1.13.9. Property root > dms > endpoints > additionalProperties > oracleSettings > directPathNoLog
| Type | boolean |
| Required | No |
Description: Flag to enable direct path loading without database logging for Oracle target performance optimization
3.4.1.13.10. Property root > dms > endpoints > additionalProperties > oracleSettings > directPathParallelLoad
| Type | boolean |
| Required | No |
Description: Flag to enable parallel loading when direct path full load is active for Oracle target
3.4.1.13.11. Property root > dms > endpoints > additionalProperties > oracleSettings > enableHomogenousTablespace
| Type | boolean |
| Required | No |
Description: Flag to enable homogeneous tablespace replication for Oracle target database consistency
3.4.1.13.12. Property root > dms > endpoints > additionalProperties > oracleSettings > extraArchivedLogDestIds
| Type | array of number |
| Required | No |
Description: Array of additional archived log destination IDs for Oracle Data Guard switchover scenarios
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| extraArchivedLogDestIds items | - |
3.4.1.13.12.1. root > dms > endpoints > additionalProperties > oracleSettings > extraArchivedLogDestIds > extraArchivedLogDestIds items
| Type | number |
| Required | No |
3.4.1.13.13. Property root > dms > endpoints > additionalProperties > oracleSettings > failTasksOnLobTruncation
| Type | boolean |
| Required | No |
Description: Flag to cause task failure when LOB column size exceeds specified LobMaxSize limit
3.4.1.13.14. Property root > dms > endpoints > additionalProperties > oracleSettings > numberDatatypeScale
| Type | number |
| Required | No |
Description: Number data type scale specification for Oracle NUMBER data type conversion precision
3.4.1.13.15. Property root > dms > endpoints > additionalProperties > oracleSettings > oraclePathPrefix
| Type | string |
| Required | No |
Description: Oracle path prefix for Binary Reader redo log access configuration
3.4.1.13.16. Property root > dms > endpoints > additionalProperties > oracleSettings > parallelAsmReadThreads
| Type | number |
| Required | No |
Description: Number of parallel ASM read threads for Oracle change data capture performance optimization
3.4.1.13.17. Property root > dms > endpoints > additionalProperties > oracleSettings > readAheadBlocks
| Type | number |
| Required | No |
Description: Number of read-ahead blocks for Oracle ASM change data capture performance optimization
3.4.1.13.18. Property root > dms > endpoints > additionalProperties > oracleSettings > readTableSpaceName
| Type | boolean |
| Required | No |
Description: Flag to enable tablespace name reading for Oracle tablespace replication support
3.4.1.13.19. Property root > dms > endpoints > additionalProperties > oracleSettings > replacePathPrefix
| Type | boolean |
| Required | No |
Description: Flag to enable path prefix replacement for Binary Reader redo log access
3.4.1.13.20. Property root > dms > endpoints > additionalProperties > oracleSettings > retryInterval
| Type | number |
| Required | No |
Description: Retry interval in seconds for Oracle connection query retry operations
3.4.1.13.21. Property root > dms > endpoints > additionalProperties > oracleSettings > secretsManagerAccessRoleArn
| Type | string |
| Required | No |
Description: IAM role ARN for AWS Secrets Manager access to Oracle endpoint credentials
3.4.1.13.22. Property root > dms > endpoints > additionalProperties > oracleSettings > secretsManagerOracleAsmAccessRoleArn
| Type | string |
| Required | No |
Description: IAM role ARN for AWS Secrets Manager access to Oracle ASM credentials when using Advanced Storage Manager
3.4.1.13.23. Property root > dms > endpoints > additionalProperties > oracleSettings > secretsManagerOracleAsmSecretArn
| Type | string |
| Required | No |
Description: Secrets Manager secret ARN containing Oracle ASM connection details for Advanced Storage Manager endpoints
3.4.1.13.24. Property root > dms > endpoints > additionalProperties > oracleSettings > secretsManagerSecretArn
| Type | string |
| Required | Yes |
Description: Secrets Manager secret ARN containing Oracle endpoint connection details for secure credential management
3.4.1.13.25. Property root > dms > endpoints > additionalProperties > oracleSettings > secretsManagerSecretKMSArn
| Type | string |
| Required | No |
Description: KMS key ARN for encrypting Oracle endpoint credentials secret in Secrets Manager
3.4.1.13.26. Property root > dms > endpoints > additionalProperties > oracleSettings > spatialDataOptionToGeoJsonFunctionName
| Type | string |
| Required | No |
Description: Custom function name for converting Oracle SDO_GEOMETRY to GEOJSON format during spatial data migration
3.4.1.13.27. Property root > dms > endpoints > additionalProperties > oracleSettings > standbyDelayTime
| Type | number |
| Required | No |
Description: Standby delay time in minutes for Oracle Active Data Guard standby database synchronization
3.4.1.13.28. Property root > dms > endpoints > additionalProperties > oracleSettings > useAlternateFolderForOnline
| Type | boolean |
| Required | No |
Description: Flag to enable alternate folder usage for online redo logs with Binary Reader for Oracle RDS sources
3.4.1.13.29. Property root > dms > endpoints > additionalProperties > oracleSettings > useBFile
| Type | boolean |
| Required | No |
Description: Flag to enable Binary Reader utility for Oracle change data capture operations
3.4.1.13.30. Property root > dms > endpoints > additionalProperties > oracleSettings > useDirectPathFullLoad
| Type | boolean |
| Required | No |
Description: Flag to enable direct path full load for Oracle target database performance optimization
3.4.1.13.31. Property root > dms > endpoints > additionalProperties > oracleSettings > useLogminerReader
| Type | boolean |
| Required | No |
Description: Flag to enable Oracle LogMiner utility for change data capture operations (default method)
3.4.1.13.32. Property root > dms > endpoints > additionalProperties > oracleSettings > usePathPrefix
| Type | string |
| Required | No |
Description: Path prefix for Binary Reader redo log access replacement in Oracle RDS sources
3.4.1.14. Property root > dms > endpoints > additionalProperties > postgreSqlSettings
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/PostgreSqlSettingsProperty |
Description: Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for AWS DMS and Extra connection attributes when using PostgreSQL as a target for AWS DMS in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-postgresqlsettings
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - afterConnectScript | No | string | No | - | SQL script executed after connecting to PostgreSQL source for change data capture (CDC) |
| - babelfishDatabaseName | No | string | No | - | Babelfish for Aurora PostgreSQL database name for DMS endpoint configuration enabling SQL |
| - captureDdls | No | boolean | No | - | Boolean flag to enable DDL event capture for PostgreSQL DMS migration enabling schema |
| - databaseMode | No | string | No | - | Database mode specification for PostgreSQL-compatible endpoints requiring additional |
| - ddlArtifactsSchema | No | string | No | - | The schema in which the operational DDL database artifacts are created. Example: `ddlArtifactsSchema=xyzddlschema;` See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-ddlartifactsschema |
| - executeTimeout | No | number | No | - | Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds. Example: `executeTimeout=100;` See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-executetimeout |
| - failTasksOnLobTruncation | No | boolean | No | - | When set to `true` , this value causes a task to fail if the actual size of a LOB column is greater than the specified `LobMaxSize` . If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-failtasksonlobtruncation |
| - heartbeatEnable | No | boolean | No | - | Boolean flag to enable WAL heartbeat feature for PostgreSQL DMS migration preventing |
| - heartbeatFrequency | No | number | No | - | WAL heartbeat frequency in minutes for PostgreSQL DMS migration enabling configurable |
| - heartbeatSchema | No | string | No | - | Sets the schema in which the heartbeat artifacts are created. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-heartbeatschema |
| - mapBooleanAsBoolean | No | boolean | No | - | When true, lets PostgreSQL migrate the boolean type as boolean. By default, PostgreSQL migrates booleans as `varchar(5)` . You must set this setting on both the source and target endpoints for it to take effect. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-mapbooleanasboolean |
| - maxFileSize | No | number | No | - | Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL. Example: `maxFileSize=512` See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-maxfilesize |
| - pluginName | No | string | No | - | Specifies the plugin to use to create a replication slot. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-pluginname |
| - secretsManagerAccessRoleArn | No | string | No | - | The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret` . The role must allow the `iam:PassRole` action. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the PostgreSQL endpoint. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-secretsmanageraccessrolearn |
| + secretsManagerSecretArn | No | string | No | - | The full ARN of the `SecretsManagerSecret` that contains the PostgreSQL endpoint connection details. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-secretsmanagersecretid |
| - secretsManagerSecretKMSArn | No | string | No | - | The ID of the KMS key used to encrypt the credentials secret. |
| - slotName | No | string | No | - | Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance. When used with the `CdcStartPosition` request parameter for the AWS DMS API , this attribute also makes it possible to use native CDC start points. DMS verifies that the specified logical replication slot exists before starting the CDC load task. It also verifies that the task was created with a valid setting of `CdcStartPosition` . If the specified slot doesn't exist or the task doesn't have a valid `CdcStartPosition` setting, DMS raises an error. For more information about setting the `CdcStartPosition` request parameter, see Determining a CDC native start point in the AWS Database Migration Service User Guide . For more information about using `CdcStartPosition` , see CreateReplicationTask , StartReplicationTask , and ModifyReplicationTask . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-slotname |
3.4.1.14.1. Property root > dms > endpoints > additionalProperties > postgreSqlSettings > afterConnectScript
| Type | string |
| Required | No |
Description: SQL script executed after connecting to PostgreSQL source for change data capture (CDC)
3.4.1.14.2. Property root > dms > endpoints > additionalProperties > postgreSqlSettings > babelfishDatabaseName
| Type | string |
| Required | No |
Description: Babelfish for Aurora PostgreSQL database name for DMS endpoint configuration enabling SQL
3.4.1.14.3. Property root > dms > endpoints > additionalProperties > postgreSqlSettings > captureDdls
| Type | boolean |
| Required | No |
Description: Boolean flag to enable DDL event capture for PostgreSQL DMS migration enabling schema
3.4.1.14.4. Property root > dms > endpoints > additionalProperties > postgreSqlSettings > databaseMode
| Type | string |
| Required | No |
Description: Database mode specification for PostgreSQL-compatible endpoints requiring additional
3.4.1.14.5. Property root > dms > endpoints > additionalProperties > postgreSqlSettings > ddlArtifactsSchema
| Type | string |
| Required | No |
Description: The schema in which the operational DDL database artifacts are created.
Example: ddlArtifactsSchema=xyzddlschema;
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-ddlartifactsschema
3.4.1.14.6. Property root > dms > endpoints > additionalProperties > postgreSqlSettings > executeTimeout
| Type | number |
| Required | No |
Description: Sets the client statement timeout for the PostgreSQL instance, in seconds. The default value is 60 seconds.
Example: executeTimeout=100;
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-executetimeout
3.4.1.14.7. Property root > dms > endpoints > additionalProperties > postgreSqlSettings > failTasksOnLobTruncation
| Type | boolean |
| Required | No |
Description: When set to true , this value causes a task to fail if the actual size of a LOB column is greater than the specified LobMaxSize .
If task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-failtasksonlobtruncation
3.4.1.14.8. Property root > dms > endpoints > additionalProperties > postgreSqlSettings > heartbeatEnable
| Type | boolean |
| Required | No |
Description: Boolean flag to enable WAL heartbeat feature for PostgreSQL DMS migration preventing
3.4.1.14.9. Property root > dms > endpoints > additionalProperties > postgreSqlSettings > heartbeatFrequency
| Type | number |
| Required | No |
Description: WAL heartbeat frequency in minutes for PostgreSQL DMS migration enabling configurable
3.4.1.14.10. Property root > dms > endpoints > additionalProperties > postgreSqlSettings > heartbeatSchema
| Type | string |
| Required | No |
Description: Sets the schema in which the heartbeat artifacts are created. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-heartbeatschema
3.4.1.14.11. Property root > dms > endpoints > additionalProperties > postgreSqlSettings > mapBooleanAsBoolean
| Type | boolean |
| Required | No |
Description: When true, lets PostgreSQL migrate the boolean type as boolean.
By default, PostgreSQL migrates booleans as varchar(5) . You must set this setting on both the source and target endpoints for it to take effect.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-mapbooleanasboolean
3.4.1.14.12. Property root > dms > endpoints > additionalProperties > postgreSqlSettings > maxFileSize
| Type | number |
| Required | No |
Description: Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL.
Example: maxFileSize=512
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-maxfilesize
3.4.1.14.13. Property root > dms > endpoints > additionalProperties > postgreSqlSettings > pluginName
| Type | string |
| Required | No |
Description: Specifies the plugin to use to create a replication slot. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-pluginname
3.4.1.14.14. Property root > dms > endpoints > additionalProperties > postgreSqlSettings > secretsManagerAccessRoleArn
| Type | string |
| Required | No |
Description: The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret .
The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the PostgreSQL endpoint.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-secretsmanageraccessrolearn
3.4.1.14.15. Property root > dms > endpoints > additionalProperties > postgreSqlSettings > secretsManagerSecretArn
| Type | string |
| Required | Yes |
Description: The full ARN of the SecretsManagerSecret that contains the PostgreSQL endpoint connection details.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-secretsmanagersecretid
3.4.1.14.16. Property root > dms > endpoints > additionalProperties > postgreSqlSettings > secretsManagerSecretKMSArn
| Type | string |
| Required | No |
Description: The ID of the KMS key used to encrypt the credentials secret.
3.4.1.14.17. Property root > dms > endpoints > additionalProperties > postgreSqlSettings > slotName
| Type | string |
| Required | No |
Description: Sets the name of a previously created logical replication slot for a change data capture (CDC) load of the PostgreSQL source instance.
When used with the CdcStartPosition request parameter for the AWS DMS API , this attribute also makes it possible to use native CDC start points. DMS verifies that the specified logical replication slot exists before starting the CDC load task. It also verifies that the task was created with a valid setting of CdcStartPosition . If the specified slot doesn't exist or the task doesn't have a valid CdcStartPosition setting, DMS raises an error.
For more information about setting the CdcStartPosition request parameter, see Determining a CDC native start point in the AWS Database Migration Service User Guide . For more information about using CdcStartPosition , see CreateReplicationTask , StartReplicationTask , and ModifyReplicationTask .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html#cfn-dms-endpoint-postgresqlsettings-slotname
3.4.1.15. Property root > dms > endpoints > additionalProperties > redshiftSettings
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/RedshiftSettingsProperty |
Description: Settings in JSON format for the Amazon Redshift endpoint. For more information about other available settings, see Extra connection attributes when using Amazon Redshift as a target for AWS DMS in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-redshiftsettings
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - acceptAnyDate | No | boolean | No | - | Flag to allow any date format including invalid formats for flexible date handling in Redshift data warehouse |
| - afterConnectScript | No | string | No | - | SQL script to execute after connecting to Redshift endpoint for initialization and setup tasks |
| - bucketFolder | No | string | No | - | S3 folder for storing CSV files before uploading to Redshift cluster for staged data loading |
| + bucketName | No | string | No | - | S3 bucket name for intermediate CSV file storage before Redshift data loading operations |
| - caseSensitiveNames | No | boolean | No | - | Flag to enable case-sensitive schema names in Redshift data warehouse for precise schema handling |
| - compUpdate | No | boolean | No | - | Flag to enable automatic compression for empty Redshift tables for storage optimization |
| - connectionTimeout | No | number | No | - | Connection timeout in milliseconds for Redshift endpoint connection establishment |
| - dateFormat | No | string | No | - | Date format specification for Redshift data loading and date handling |
| - emptyAsNull | No | boolean | No | - | Flag to migrate empty CHAR and VARCHAR fields as NULL for consistent null handling |
| - explicitIds | No | boolean | No | - | Flag to override auto-generated IDENTITY column values with explicit source values for full-load migration |
| - fileTransferUploadStreams | No | number | No | - | Number of parallel threads for single file upload to optimize S3 multipart upload performance |
| - loadTimeout | No | number | No | - | Timeout in milliseconds for Redshift cluster operations including COPY, INSERT, DELETE, and UPDATE |
| - mapBooleanAsBoolean | No | boolean | No | - | Flag to migrate boolean type as native boolean in Redshift for proper data type representation |
| - maxFileSize | No | number | No | - | Maximum CSV file size in KB for S3 staging and Redshift data transfer optimization |
| - removeQuotes | No | boolean | No | - | Flag to remove surrounding quotation marks from strings in incoming data for cleaner data processing |
| - replaceChars | No | string | No | - | Replacement character for invalid characters specified in ReplaceInvalidChars for data cleaning |
| - replaceInvalidChars | No | string | No | - | List of characters to replace during data migration for data cleaning |
| - secretsManagerAccessRoleArn | No | string | No | - | IAM role ARN for AWS Secrets Manager access to Redshift endpoint credentials |
| + secretsManagerSecretArn | No | string | No | - | Secrets Manager secret ARN containing Redshift endpoint connection details for secure credential management |
| - secretsManagerSecretKMSArn | No | string | No | - | KMS key ARN for encrypting Redshift endpoint credentials secret in Secrets Manager |
| + serverSideEncryptionKmsKeyId | No | string | No | - | KMS key ID for server-side encryption when using SSE_KMS encryption mode for Redshift S3 staging security |
| - serviceAccessRoleArn | No | string | No | - | IAM role ARN for DMS service access to Redshift service operations for data warehouse integration |
| - timeFormat | No | string | No | - | Time format specification for Redshift data loading and time handling |
| - trimBlanks | No | boolean | No | - | Flag to remove trailing white space characters from VARCHAR strings for cleaner data processing |
| - truncateColumns | No | boolean | No | - | Flag to truncate data in columns to fit column size limits for data integrity in Redshift |
| - writeBufferSize | No | number | No | - | In-memory file write buffer size in KB for CSV file generation performance optimization |
3.4.1.15.1. Property root > dms > endpoints > additionalProperties > redshiftSettings > acceptAnyDate
| Type | boolean |
| Required | No |
Description: Flag to allow any date format including invalid formats for flexible date handling in Redshift data warehouse
3.4.1.15.2. Property root > dms > endpoints > additionalProperties > redshiftSettings > afterConnectScript
| Type | string |
| Required | No |
Description: SQL script to execute after connecting to Redshift endpoint for initialization and setup tasks
3.4.1.15.3. Property root > dms > endpoints > additionalProperties > redshiftSettings > bucketFolder
| Type | string |
| Required | No |
Description: S3 folder for storing CSV files before uploading to Redshift cluster for staged data loading
3.4.1.15.4. Property root > dms > endpoints > additionalProperties > redshiftSettings > bucketName
| Type | string |
| Required | Yes |
Description: S3 bucket name for intermediate CSV file storage before Redshift data loading operations
3.4.1.15.5. Property root > dms > endpoints > additionalProperties > redshiftSettings > caseSensitiveNames
| Type | boolean |
| Required | No |
Description: Flag to enable case-sensitive schema names in Redshift data warehouse for precise schema handling
3.4.1.15.6. Property root > dms > endpoints > additionalProperties > redshiftSettings > compUpdate
| Type | boolean |
| Required | No |
Description: Flag to enable automatic compression for empty Redshift tables for storage optimization
3.4.1.15.7. Property root > dms > endpoints > additionalProperties > redshiftSettings > connectionTimeout
| Type | number |
| Required | No |
Description: Connection timeout in milliseconds for Redshift endpoint connection establishment
3.4.1.15.8. Property root > dms > endpoints > additionalProperties > redshiftSettings > dateFormat
| Type | string |
| Required | No |
Description: Date format specification for Redshift data loading and date handling
3.4.1.15.9. Property root > dms > endpoints > additionalProperties > redshiftSettings > emptyAsNull
| Type | boolean |
| Required | No |
Description: Flag to migrate empty CHAR and VARCHAR fields as NULL for consistent null handling
3.4.1.15.10. Property root > dms > endpoints > additionalProperties > redshiftSettings > explicitIds
| Type | boolean |
| Required | No |
Description: Flag to override auto-generated IDENTITY column values with explicit source values for full-load migration
3.4.1.15.11. Property root > dms > endpoints > additionalProperties > redshiftSettings > fileTransferUploadStreams
| Type | number |
| Required | No |
Description: Number of parallel threads for single file upload to optimize S3 multipart upload performance
3.4.1.15.12. Property root > dms > endpoints > additionalProperties > redshiftSettings > loadTimeout
| Type | number |
| Required | No |
Description: Timeout in milliseconds for Redshift cluster operations including COPY, INSERT, DELETE, and UPDATE
3.4.1.15.13. Property root > dms > endpoints > additionalProperties > redshiftSettings > mapBooleanAsBoolean
| Type | boolean |
| Required | No |
Description: Flag to migrate boolean type as native boolean in Redshift for proper data type representation
3.4.1.15.14. Property root > dms > endpoints > additionalProperties > redshiftSettings > maxFileSize
| Type | number |
| Required | No |
Description: Maximum CSV file size in KB for S3 staging and Redshift data transfer optimization
3.4.1.15.15. Property root > dms > endpoints > additionalProperties > redshiftSettings > removeQuotes
| Type | boolean |
| Required | No |
Description: Flag to remove surrounding quotation marks from strings in incoming data for cleaner data processing
3.4.1.15.16. Property root > dms > endpoints > additionalProperties > redshiftSettings > replaceChars
| Type | string |
| Required | No |
Description: Replacement character for invalid characters specified in ReplaceInvalidChars for data cleaning
3.4.1.15.17. Property root > dms > endpoints > additionalProperties > redshiftSettings > replaceInvalidChars
| Type | string |
| Required | No |
Description: List of characters to replace during data migration for data cleaning
3.4.1.15.18. Property root > dms > endpoints > additionalProperties > redshiftSettings > secretsManagerAccessRoleArn
| Type | string |
| Required | No |
Description: IAM role ARN for AWS Secrets Manager access to Redshift endpoint credentials
3.4.1.15.19. Property root > dms > endpoints > additionalProperties > redshiftSettings > secretsManagerSecretArn
| Type | string |
| Required | Yes |
Description: Secrets Manager secret ARN containing Redshift endpoint connection details for secure credential management
3.4.1.15.20. Property root > dms > endpoints > additionalProperties > redshiftSettings > secretsManagerSecretKMSArn
| Type | string |
| Required | No |
Description: KMS key ARN for encrypting Redshift endpoint credentials secret in Secrets Manager
3.4.1.15.21. Property root > dms > endpoints > additionalProperties > redshiftSettings > serverSideEncryptionKmsKeyId
| Type | string |
| Required | Yes |
Description: KMS key ID for server-side encryption when using SSE_KMS encryption mode for Redshift S3 staging security
3.4.1.15.22. Property root > dms > endpoints > additionalProperties > redshiftSettings > serviceAccessRoleArn
| Type | string |
| Required | No |
Description: IAM role ARN for DMS service access to Redshift service operations for data warehouse integration
3.4.1.15.23. Property root > dms > endpoints > additionalProperties > redshiftSettings > timeFormat
| Type | string |
| Required | No |
Description: Time format specification for Redshift data loading and time handling
3.4.1.15.24. Property root > dms > endpoints > additionalProperties > redshiftSettings > trimBlanks
| Type | boolean |
| Required | No |
Description: Flag to remove trailing white space characters from VARCHAR strings for cleaner data processing
3.4.1.15.25. Property root > dms > endpoints > additionalProperties > redshiftSettings > truncateColumns
| Type | boolean |
| Required | No |
Description: Flag to truncate data in columns to fit column size limits for data integrity in Redshift
3.4.1.15.26. Property root > dms > endpoints > additionalProperties > redshiftSettings > writeBufferSize
| Type | number |
| Required | No |
Description: In-memory file write buffer size in KB for CSV file generation performance optimization
3.4.1.16. Property root > dms > endpoints > additionalProperties > s3Settings
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/S3SettingsProperty |
Description: Settings in JSON format for the source and target Amazon S3 endpoint. For more information about other available settings, see Extra connection attributes when using Amazon S3 as a source for AWS DMS and Extra connection attributes when using Amazon S3 as a target for AWS DMS in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-s3settings
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - addColumnName | No | boolean | No | - | Flag to add column name information to CSV output files for S3 data lake integration |
| - bucketFolder | No | string | No | - | S3 bucket folder name for organizing migrated data with hierarchical structure |
| + bucketName | No | string | No | - | S3 bucket name for DMS data migration destination in data lake architecture |
| - cannedAclForObjects | No | string | No | - | Predefined access control list (ACL) for S3 objects created during data migration |
| - cdcInsertsAndUpdates | No | boolean | No | - | Flag to enable CDC INSERT and UPDATE operations capture to S3 files for change tracking |
| - cdcInsertsOnly | No | boolean | No | - | Flag to enable CDC INSERT-only operations capture to S3 files for insert-focused change tracking |
| - cdcMaxBatchInterval | No | number | No | - | Maximum batch interval in seconds for CDC file output to S3 for time-based file creation |
| - cdcMinFileSize | No | number | No | - | Minimum file size in kilobytes for CDC file output to S3 for size-based file creation |
| - cdcPath | No | string | No | - | CDC folder path specification for change data capture file organization in S3 |
| - compressionType | No | string | No | - | Compression type for S3 target files to optimize storage and transfer performance |
| - csvDelimiter | No | string | No | - | Column delimiter for CSV file format in S3 data lake integration |
| - csvNoSupValue | No | string | No | - | String value for columns not included in supplemental log during CDC CSV operations |
| - csvNullValue | No | string | No | - | Null value representation for CSV files in S3 data lake operations |
| - csvRowDelimiter | No | string | No | - | Row delimiter for CSV files in S3 data lake integration |
| - dataFormat | No | string | No | - | Data format specification for S3 output files in data lake architecture |
| - dataPageSize | No | number | No | - | Data page size in bytes for Parquet file format optimization |
| - datePartitionDelimiter | No | string | No | - | Date partition delimiter for S3 folder partitioning organization |
| - datePartitionEnabled | No | boolean | No | - | Flag to enable date-based folder partitioning for S3 bucket organization |
| - datePartitionSequence | No | string | No | - | Date format sequence for folder partitioning organization in S3 data lake |
| - datePartitionTimezone | No | string | No | - | Time zone specification for date partition folder creation and CDC file naming |
| - dictPageSizeLimit | No | number | No | - | Maximum dictionary page size limit for Parquet column encoding optimization |
| - enableStatistics | No | boolean | No | - | Flag to enable statistics collection for Parquet pages and row groups for query optimization |
| - encodingType | No | string | No | - | Encoding type specification for Parquet file compression and storage optimization |
| - externalTableDefinition | No | string | No | - | External table definition for S3 source configuration in data lake integration |
| - ignoreHeaderRows | No | number | No | - | Number of header rows to ignore in CSV files for S3 source processing |
| - includeOpForFullLoad | No | boolean | No | - | Flag to include INSERT operation indicators in full load CSV output for consistency with CDC operations |
| - maxFileSize | No | number | No | - | Maximum CSV file size in KB for S3 target during full load migration operations |
| - parquetTimestampInMillisecond | No | boolean | No | - | Flag to set TIMESTAMP column precision to milliseconds in Parquet files for Athena and Glue compatibility |
| - parquetVersion | No | string | No | - | Apache Parquet format version specification for S3 data lake columnar storage |
| - preserveTransactions | No | boolean | No | - | Flag to preserve transaction order for CDC loads in S3 target for data consistency |
| - rfc4180 | No | boolean | No | - | Flag to enable RFC 4180 compliance for CSV quotation mark handling in S3 operations |
| - rowGroupLength | No | number | No | - | Number of rows in Parquet row group for read/write performance optimization |
| + serverSideEncryptionKmsKeyId | No | string | No | - | KMS key ID for server-side encryption when using SSE_KMS encryption mode for S3 data lake security |
| - serviceAccessRoleArn | No | string | No | - | IAM role ARN for DMS service access to S3 bucket operations for data lake integration |
| - timestampColumnName | No | string | No | - | Timestamp column name for adding migration timing information to S3 data lake files |
| - useCsvNoSupValue | No | boolean | No | - | Flag to use CsvNoSupValue for columns not in supplemental log during CDC CSV operations |
| - useTaskStartTimeForFullLoadTimestamp | No | boolean | No | - | Flag to use task start time for full load timestamp column instead of data arrival time |
3.4.1.16.1. Property root > dms > endpoints > additionalProperties > s3Settings > addColumnName
| Type | boolean |
| Required | No |
Description: Flag to add column name information to CSV output files for S3 data lake integration
3.4.1.16.2. Property root > dms > endpoints > additionalProperties > s3Settings > bucketFolder
| Type | string |
| Required | No |
Description: S3 bucket folder name for organizing migrated data with hierarchical structure
3.4.1.16.3. Property root > dms > endpoints > additionalProperties > s3Settings > bucketName
| Type | string |
| Required | Yes |
Description: S3 bucket name for DMS data migration destination in data lake architecture
3.4.1.16.4. Property root > dms > endpoints > additionalProperties > s3Settings > cannedAclForObjects
| Type | string |
| Required | No |
Description: Predefined access control list (ACL) for S3 objects created during data migration
3.4.1.16.5. Property root > dms > endpoints > additionalProperties > s3Settings > cdcInsertsAndUpdates
| Type | boolean |
| Required | No |
Description: Flag to enable CDC INSERT and UPDATE operations capture to S3 files for change tracking
3.4.1.16.6. Property root > dms > endpoints > additionalProperties > s3Settings > cdcInsertsOnly
| Type | boolean |
| Required | No |
Description: Flag to enable CDC INSERT-only operations capture to S3 files for insert-focused change tracking
3.4.1.16.7. Property root > dms > endpoints > additionalProperties > s3Settings > cdcMaxBatchInterval
| Type | number |
| Required | No |
Description: Maximum batch interval in seconds for CDC file output to S3 for time-based file creation
3.4.1.16.8. Property root > dms > endpoints > additionalProperties > s3Settings > cdcMinFileSize
| Type | number |
| Required | No |
Description: Minimum file size in kilobytes for CDC file output to S3 for size-based file creation
3.4.1.16.9. Property root > dms > endpoints > additionalProperties > s3Settings > cdcPath
| Type | string |
| Required | No |
Description: CDC folder path specification for change data capture file organization in S3
3.4.1.16.10. Property root > dms > endpoints > additionalProperties > s3Settings > compressionType
| Type | string |
| Required | No |
Description: Compression type for S3 target files to optimize storage and transfer performance
3.4.1.16.11. Property root > dms > endpoints > additionalProperties > s3Settings > csvDelimiter
| Type | string |
| Required | No |
Description: Column delimiter for CSV file format in S3 data lake integration
3.4.1.16.12. Property root > dms > endpoints > additionalProperties > s3Settings > csvNoSupValue
| Type | string |
| Required | No |
Description: String value for columns not included in supplemental log during CDC CSV operations
3.4.1.16.13. Property root > dms > endpoints > additionalProperties > s3Settings > csvNullValue
| Type | string |
| Required | No |
Description: Null value representation for CSV files in S3 data lake operations
3.4.1.16.14. Property root > dms > endpoints > additionalProperties > s3Settings > csvRowDelimiter
| Type | string |
| Required | No |
Description: Row delimiter for CSV files in S3 data lake integration
3.4.1.16.15. Property root > dms > endpoints > additionalProperties > s3Settings > dataFormat
| Type | string |
| Required | No |
Description: Data format specification for S3 output files in data lake architecture
3.4.1.16.16. Property root > dms > endpoints > additionalProperties > s3Settings > dataPageSize
| Type | number |
| Required | No |
Description: Data page size in bytes for Parquet file format optimization
3.4.1.16.17. Property root > dms > endpoints > additionalProperties > s3Settings > datePartitionDelimiter
| Type | string |
| Required | No |
Description: Date partition delimiter for S3 folder partitioning organization
3.4.1.16.18. Property root > dms > endpoints > additionalProperties > s3Settings > datePartitionEnabled
| Type | boolean |
| Required | No |
Description: Flag to enable date-based folder partitioning for S3 bucket organization
3.4.1.16.19. Property root > dms > endpoints > additionalProperties > s3Settings > datePartitionSequence
| Type | string |
| Required | No |
Description: Date format sequence for folder partitioning organization in S3 data lake
3.4.1.16.20. Property root > dms > endpoints > additionalProperties > s3Settings > datePartitionTimezone
| Type | string |
| Required | No |
Description: Time zone specification for date partition folder creation and CDC file naming
3.4.1.16.21. Property root > dms > endpoints > additionalProperties > s3Settings > dictPageSizeLimit
| Type | number |
| Required | No |
Description: Maximum dictionary page size limit for Parquet column encoding optimization
3.4.1.16.22. Property root > dms > endpoints > additionalProperties > s3Settings > enableStatistics
| Type | boolean |
| Required | No |
Description: Flag to enable statistics collection for Parquet pages and row groups for query optimization
3.4.1.16.23. Property root > dms > endpoints > additionalProperties > s3Settings > encodingType
| Type | string |
| Required | No |
Description: Encoding type specification for Parquet file compression and storage optimization
3.4.1.16.24. Property root > dms > endpoints > additionalProperties > s3Settings > externalTableDefinition
| Type | string |
| Required | No |
Description: External table definition for S3 source configuration in data lake integration
3.4.1.16.25. Property root > dms > endpoints > additionalProperties > s3Settings > ignoreHeaderRows
| Type | number |
| Required | No |
Description: Number of header rows to ignore in CSV files for S3 source processing
3.4.1.16.26. Property root > dms > endpoints > additionalProperties > s3Settings > includeOpForFullLoad
| Type | boolean |
| Required | No |
Description: Flag to include INSERT operation indicators in full load CSV output for consistency with CDC operations
3.4.1.16.27. Property root > dms > endpoints > additionalProperties > s3Settings > maxFileSize
| Type | number |
| Required | No |
Description: Maximum CSV file size in KB for S3 target during full load migration operations
3.4.1.16.28. Property root > dms > endpoints > additionalProperties > s3Settings > parquetTimestampInMillisecond
| Type | boolean |
| Required | No |
Description: Flag to set TIMESTAMP column precision to milliseconds in Parquet files for Athena and Glue compatibility
3.4.1.16.29. Property root > dms > endpoints > additionalProperties > s3Settings > parquetVersion
| Type | string |
| Required | No |
Description: Apache Parquet format version specification for S3 data lake columnar storage
3.4.1.16.30. Property root > dms > endpoints > additionalProperties > s3Settings > preserveTransactions
| Type | boolean |
| Required | No |
Description: Flag to preserve transaction order for CDC loads in S3 target for data consistency
3.4.1.16.31. Property root > dms > endpoints > additionalProperties > s3Settings > rfc4180
| Type | boolean |
| Required | No |
Description: Flag to enable RFC 4180 compliance for CSV quotation mark handling in S3 operations
3.4.1.16.32. Property root > dms > endpoints > additionalProperties > s3Settings > rowGroupLength
| Type | number |
| Required | No |
Description: Number of rows in Parquet row group for read/write performance optimization
3.4.1.16.33. Property root > dms > endpoints > additionalProperties > s3Settings > serverSideEncryptionKmsKeyId
| Type | string |
| Required | Yes |
Description: KMS key ID for server-side encryption when using SSE_KMS encryption mode for S3 data lake security
3.4.1.16.34. Property root > dms > endpoints > additionalProperties > s3Settings > serviceAccessRoleArn
| Type | string |
| Required | No |
Description: IAM role ARN for DMS service access to S3 bucket operations for data lake integration
3.4.1.16.35. Property root > dms > endpoints > additionalProperties > s3Settings > timestampColumnName
| Type | string |
| Required | No |
Description: Timestamp column name for adding migration timing information to S3 data lake files
3.4.1.16.36. Property root > dms > endpoints > additionalProperties > s3Settings > useCsvNoSupValue
| Type | boolean |
| Required | No |
Description: Flag to use CsvNoSupValue for columns not in supplemental log during CDC CSV operations
3.4.1.16.37. Property root > dms > endpoints > additionalProperties > s3Settings > useTaskStartTimeForFullLoadTimestamp
| Type | boolean |
| Required | No |
Description: Flag to use task start time for full load timestamp column instead of data arrival time
3.4.1.17. Property root > dms > endpoints > additionalProperties > sybaseSettings
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/SybaseSettingsProperty |
Description: Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see Extra connection attributes when using SAP ASE as a source for AWS DMS and Extra connection attributes when using SAP ASE as a target for AWS DMS in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-sybasesettings
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - secretsManagerAccessRoleArn | No | string | No | - | IAM role ARN for DMS to access Secrets Manager secret containing Sybase endpoint |
| + secretsManagerSecretArn | No | string | No | - | - |
| - secretsManagerSecretKMSArn | No | string | No | - | KMS key ARN for encrypting Secrets Manager secret containing Sybase credentials enabling |
3.4.1.17.1. Property root > dms > endpoints > additionalProperties > sybaseSettings > secretsManagerAccessRoleArn
| Type | string |
| Required | No |
Description: IAM role ARN for DMS to access Secrets Manager secret containing Sybase endpoint
3.4.1.17.2. Property root > dms > endpoints > additionalProperties > sybaseSettings > secretsManagerSecretArn
| Type | string |
| Required | Yes |
3.4.1.17.3. Property root > dms > endpoints > additionalProperties > sybaseSettings > secretsManagerSecretKMSArn
| Type | string |
| Required | No |
Description: KMS key ARN for encrypting Secrets Manager secret containing Sybase credentials enabling
3.5. Property root > dms > replicationInstances
| Type | object |
| Required | No |
| Additional properties | Each additional property must conform to the schema |
| Defined in | #/definitions/NamedReplicationInstanceProps |
Description: Named replication instance configurations.
3.5.1. Property root > dms > replicationInstances > ReplicationInstanceProps
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/ReplicationInstanceProps |
Description: Configuration for a DMS replication instance with compute, networking, and security settings.
Use cases: Database migration; Database replication; Data migration workflows; Database connectivity
AWS: AWS Database Migration Service configuration for database migration and replication
Validation: Configuration must be valid for deployment; properties must conform to AWS DMS and MDAA requirements
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - addSelfReferenceRule | No | boolean | No | - | If true, the SG will allow traffic to and from itself |
| - egressRules | No | object | No | In #/definitions/MdaaSecurityGroupRuleProps | List of egress rules to be added to the function SG |
| - ingressRules | No | object | No | Same as egressRules | List of ingress rules to be added to the function SG |
| + instanceClass | No | string | No | - | DMS replication instance class (e.g., 'dms.r5.large'). |
| + subnetIds | No | array of string | No | - | Subnet IDs for replication instance deployment, spanning at least two AZs. |
| + vpcId | No | string | No | - | VPC ID for replication instance deployment. |
3.5.1.1. Property root > dms > replicationInstances > additionalProperties > addSelfReferenceRule
| Type | boolean |
| Required | No |
Description: If true, the SG will allow traffic to and from itself
3.5.1.2. Property root > dms > replicationInstances > additionalProperties > egressRules
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/MdaaSecurityGroupRuleProps |
Description: List of egress rules to be added to the function SG
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - ipv4 | No | array | No | - | IPv4 CIDR block rules for security group traffic control defining IP address-based access restrictions |
| - prefixList | No | array | No | - | Prefix list rules for security group traffic control defining managed prefix list-based access restrictions |
| - sg | No | array | No | - | Security group rules for cross-security group traffic control defining security group-based access restrictions |
3.5.1.2.1. Property root > dms > replicationInstances > additionalProperties > egressRules > ipv4
| Type | array |
| Required | No |
Description: IPv4 CIDR block rules for security group traffic control defining IP address-based access restrictions
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| MdaaCidrPeer | - |
3.5.1.2.1.1. root > dms > replicationInstances > additionalProperties > egressRules > ipv4 > MdaaCidrPeer
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/MdaaCidrPeer |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + cidr | No | string | No | - | CIDR block specification for network access control in security group rules enabling IP |
| - description | No | string | No | - | - |
| - port | No | number | No | - | - |
| + protocol | No | string | No | - | - |
| - suppressions | No | array | No | - | - |
| - toPort | No | number | No | - | The ending port number for the security group rule defining the upper bound of the port range |
3.5.1.2.1.1.1. Property root > dms > replicationInstances > additionalProperties > egressRules > ipv4 > ipv4 items > cidr
| Type | string |
| Required | Yes |
Description: CIDR block specification for network access control in security group rules enabling IP
3.5.1.2.1.1.2. Property root > dms > replicationInstances > additionalProperties > egressRules > ipv4 > ipv4 items > description
| Type | string |
| Required | No |
3.5.1.2.1.1.3. Property root > dms > replicationInstances > additionalProperties > egressRules > ipv4 > ipv4 items > port
| Type | number |
| Required | No |
3.5.1.2.1.1.4. Property root > dms > replicationInstances > additionalProperties > egressRules > ipv4 > ipv4 items > protocol
| Type | string |
| Required | Yes |
3.5.1.2.1.1.5. Property root > dms > replicationInstances > additionalProperties > egressRules > ipv4 > ipv4 items > suppressions
| Type | array |
| Required | No |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| NagPackSuppression | Interface for creating a rule suppression |
3.5.1.2.1.1.5.1. root > dms > replicationInstances > additionalProperties > egressRules > ipv4 > ipv4 items > suppressions > NagPackSuppression
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/NagPackSuppression |
Description: Interface for creating a rule suppression
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - appliesTo | No | array | No | - | Rule specific granular suppressions |
| + id | No | string | No | - | The id of the rule to ignore |
| + reason | No | string | No | - | The reason to ignore the rule (minimum 10 characters) |
3.5.1.2.1.1.5.1.1. Property root > dms > replicationInstances > additionalProperties > egressRules > ipv4 > ipv4 items > suppressions > suppressions items > appliesTo
| Type | array |
| Required | No |
Description: Rule specific granular suppressions
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| NagPackSuppressionAppliesTo | A granular suppression |
3.5.1.2.1.1.5.1.1.1. root > dms > replicationInstances > additionalProperties > egressRules > ipv4 > ipv4 items > suppressions > suppressions items > appliesTo > NagPackSuppressionAppliesTo
| Type | combining |
| Required | No |
| Additional properties | Any type allowed |
| Defined in | #/definitions/NagPackSuppressionAppliesTo |
Description: A granular suppression
| Any of(Option) |
|---|
| RegexAppliesTo |
| item 1 |
3.5.1.2.1.1.5.1.1.1.1. Property root > dms > replicationInstances > additionalProperties > egressRules > ipv4 > ipv4 items > suppressions > suppressions items > appliesTo > appliesTo items > anyOf > RegexAppliesTo
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/RegexAppliesTo |
Description: A regular expression to apply to matching findings
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + regex | No | string | No | - | An ECMA-262 regex string |
3.5.1.2.1.1.5.1.1.1.1.1. Property root > dms > replicationInstances > additionalProperties > egressRules > ipv4 > ipv4 items > suppressions > suppressions items > appliesTo > appliesTo items > anyOf > item 0 > regex
| Type | string |
| Required | Yes |
Description: An ECMA-262 regex string
3.5.1.2.1.1.5.1.1.1.2. Property root > dms > replicationInstances > additionalProperties > egressRules > ipv4 > ipv4 items > suppressions > suppressions items > appliesTo > appliesTo items > anyOf > item 1
| Type | string |
| Required | No |
3.5.1.2.1.1.5.1.2. Property root > dms > replicationInstances > additionalProperties > egressRules > ipv4 > ipv4 items > suppressions > suppressions items > id
| Type | string |
| Required | Yes |
Description: The id of the rule to ignore
3.5.1.2.1.1.5.1.3. Property root > dms > replicationInstances > additionalProperties > egressRules > ipv4 > ipv4 items > suppressions > suppressions items > reason
| Type | string |
| Required | Yes |
Description: The reason to ignore the rule (minimum 10 characters)
3.5.1.2.1.1.6. Property root > dms > replicationInstances > additionalProperties > egressRules > ipv4 > ipv4 items > toPort
| Type | number |
| Required | No |
Description: The ending port number for the security group rule defining the upper bound of the port range
3.5.1.2.2. Property root > dms > replicationInstances > additionalProperties > egressRules > prefixList
| Type | array |
| Required | No |
Description: Prefix list rules for security group traffic control defining managed prefix list-based access restrictions
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| MdaaPrefixListPeer | - |
3.5.1.2.2.1. root > dms > replicationInstances > additionalProperties > egressRules > prefixList > MdaaPrefixListPeer
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/MdaaPrefixListPeer |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - description | No | string | No | - | - |
| - port | No | number | No | - | - |
| + prefixList | No | string | No | - | Prefix list identifier for managed IP range access control in security group rules enabling |
| + protocol | No | string | No | - | - |
| - suppressions | No | array | No | - | - |
| - toPort | No | number | No | - | The ending port number for the security group rule defining the upper bound of the port range |
3.5.1.2.2.1.1. Property root > dms > replicationInstances > additionalProperties > egressRules > prefixList > prefixList items > description
| Type | string |
| Required | No |
3.5.1.2.2.1.2. Property root > dms > replicationInstances > additionalProperties > egressRules > prefixList > prefixList items > port
| Type | number |
| Required | No |
3.5.1.2.2.1.3. Property root > dms > replicationInstances > additionalProperties > egressRules > prefixList > prefixList items > prefixList
| Type | string |
| Required | Yes |
Description: Prefix list identifier for managed IP range access control in security group rules enabling
3.5.1.2.2.1.4. Property root > dms > replicationInstances > additionalProperties > egressRules > prefixList > prefixList items > protocol
| Type | string |
| Required | Yes |
3.5.1.2.2.1.5. Property root > dms > replicationInstances > additionalProperties > egressRules > prefixList > prefixList items > suppressions
| Type | array |
| Required | No |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| NagPackSuppression | Interface for creating a rule suppression |
3.5.1.2.2.1.5.1. root > dms > replicationInstances > additionalProperties > egressRules > prefixList > prefixList items > suppressions > NagPackSuppression
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | dms_replicationInstances_additionalProperties_egressRules_ipv4_items_suppressions_items |
Description: Interface for creating a rule suppression
3.5.1.2.2.1.6. Property root > dms > replicationInstances > additionalProperties > egressRules > prefixList > prefixList items > toPort
| Type | number |
| Required | No |
Description: The ending port number for the security group rule defining the upper bound of the port range
3.5.1.2.3. Property root > dms > replicationInstances > additionalProperties > egressRules > sg
| Type | array |
| Required | No |
Description: Security group rules for cross-security group traffic control defining security group-based access restrictions
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| MdaaSecurityGroupPeer | - |
3.5.1.2.3.1. root > dms > replicationInstances > additionalProperties > egressRules > sg > MdaaSecurityGroupPeer
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/MdaaSecurityGroupPeer |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - description | No | string | No | - | - |
| - port | No | number | No | - | - |
| + protocol | No | string | No | - | - |
| + sgId | No | string | No | - | Security group identifier for security group-based access control in network rules enabling |
| - suppressions | No | array | No | - | - |
| - toPort | No | number | No | - | The ending port number for the security group rule defining the upper bound of the port range |
3.5.1.2.3.1.1. Property root > dms > replicationInstances > additionalProperties > egressRules > sg > sg items > description
| Type | string |
| Required | No |
3.5.1.2.3.1.2. Property root > dms > replicationInstances > additionalProperties > egressRules > sg > sg items > port
| Type | number |
| Required | No |
3.5.1.2.3.1.3. Property root > dms > replicationInstances > additionalProperties > egressRules > sg > sg items > protocol
| Type | string |
| Required | Yes |
3.5.1.2.3.1.4. Property root > dms > replicationInstances > additionalProperties > egressRules > sg > sg items > sgId
| Type | string |
| Required | Yes |
Description: Security group identifier for security group-based access control in network rules enabling
3.5.1.2.3.1.5. Property root > dms > replicationInstances > additionalProperties > egressRules > sg > sg items > suppressions
| Type | array |
| Required | No |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| NagPackSuppression | Interface for creating a rule suppression |
3.5.1.2.3.1.5.1. root > dms > replicationInstances > additionalProperties > egressRules > sg > sg items > suppressions > NagPackSuppression
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | dms_replicationInstances_additionalProperties_egressRules_ipv4_items_suppressions_items |
Description: Interface for creating a rule suppression
3.5.1.2.3.1.6. Property root > dms > replicationInstances > additionalProperties > egressRules > sg > sg items > toPort
| Type | number |
| Required | No |
Description: The ending port number for the security group rule defining the upper bound of the port range
3.5.1.3. Property root > dms > replicationInstances > additionalProperties > ingressRules
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | egressRules |
Description: List of ingress rules to be added to the function SG
3.5.1.4. Property root > dms > replicationInstances > additionalProperties > instanceClass
| Type | string |
| Required | Yes |
Description: DMS replication instance class (e.g., 'dms.r5.large').
3.5.1.5. Property root > dms > replicationInstances > additionalProperties > subnetIds
| Type | array of string |
| Required | Yes |
Description: Subnet IDs for replication instance deployment, spanning at least two AZs.
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| subnetIds items | - |
3.5.1.5.1. root > dms > replicationInstances > additionalProperties > subnetIds > subnetIds items
| Type | string |
| Required | No |
3.5.1.6. Property root > dms > replicationInstances > additionalProperties > vpcId
| Type | string |
| Required | Yes |
Description: VPC ID for replication instance deployment.
3.6. Property root > dms > replicationTasks
| Type | object |
| Required | No |
| Additional properties | Each additional property must conform to the schema |
| Defined in | #/definitions/NamedReplicationTaskProps |
Description: Named replication task configurations.
3.6.1. Property root > dms > replicationTasks > ReplicationTaskProps
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/ReplicationTaskProps |
Description: Configuration for a DMS replication task defining migration settings.
Use cases: Database migration; Database replication; Data migration workflows; Database connectivity
AWS: AWS Database Migration Service configuration for database migration and replication
Validation: Configuration must be valid for deployment; properties must conform to AWS DMS and MDAA requirements
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - cdcStartPosition | No | string | No | - | Indicates when you want a change data capture (CDC) operation to start. Use either `CdcStartPosition` or `CdcStartTime` to specify when you want a CDC operation to start. Specifying both values results in an error. The value can be in date, checkpoint, log sequence number (LSN), or system change number (SCN) format. Here is a date example: `--cdc-start-position "2018-03-08T12:12:12"` Here is a checkpoint example: `--cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0##0#93"` Here is an LSN example: `--cdc-start-position “mysql-bin-changelog.000024:373”` > When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the `slotName` extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS in the AWS Database Migration Service User Guide* . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstartposition |
| - cdcStartTime | No | number | No | - | Indicates the start time for a change data capture (CDC) operation. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstarttime |
| - cdcStopPosition | No | string | No | - | Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time. Here is a server time example: `--cdc-stop-position "server_time:2018-02-09T12:12:12"` Here is a commit time example: `--cdc-stop-position "commit_time: 2018-02-09T12:12:12"` See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstopposition |
| + migrationType | No | enum (of string) | No | In #/definitions/DmsMigrationType | The migration type. Valid values: `full-load` | `cdc` | `full-load-and-cdc` See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-migrationtype |
| + replicationInstance | No | string | No | - | Name of the replication instance from the replicationInstances section. |
| - replicationTaskSettings | No | object | No | - | Overall settings for the task, in JSON format. For more information, see Specifying Task Settings for AWS Database Migration Service Tasks in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationtasksettings |
| + sourceEndpoint | No | string | No | - | Name of the source endpoint from the endpoints section. |
| + tableMappings | No | object | No | - | The table mappings for the task, in JSON format. For more information, see Using Table Mapping to Specify Task Settings in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-tablemappings |
| + targetEndpoint | No | string | No | - | Name of the target endpoint from the endpoints section. |
| - taskData | No | object | No | - | Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the AWS Database Migration Service User Guide. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-taskdata |
3.6.1.1. Property root > dms > replicationTasks > additionalProperties > cdcStartPosition
| Type | string |
| Required | No |
Description: Indicates when you want a change data capture (CDC) operation to start.
Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.
The value can be in date, checkpoint, log sequence number (LSN), or system change number (SCN) format.
Here is a date example: --cdc-start-position "2018-03-08T12:12:12"
Here is a checkpoint example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"
Here is an LSN example: --cdc-start-position “mysql-bin-changelog.000024:373”
When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the
slotNameextra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstartposition
3.6.1.2. Property root > dms > replicationTasks > additionalProperties > cdcStartTime
| Type | number |
| Required | No |
Description: Indicates the start time for a change data capture (CDC) operation. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstarttime
3.6.1.3. Property root > dms > replicationTasks > additionalProperties > cdcStopPosition
| Type | string |
| Required | No |
Description: Indicates when you want a change data capture (CDC) operation to stop.
The value can be either server time or commit time.
Here is a server time example: --cdc-stop-position "server_time:2018-02-09T12:12:12"
Here is a commit time example: --cdc-stop-position "commit_time: 2018-02-09T12:12:12"
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstopposition
3.6.1.4. Property root > dms > replicationTasks > additionalProperties > migrationType
| Type | enum (of string) |
| Required | Yes |
| Defined in | #/definitions/DmsMigrationType |
Description: The migration type.
Valid values: full-load | cdc | full-load-and-cdc
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-migrationtype
Must be one of: * "cdc" * "full-load" * "full-load-and-cdc"
3.6.1.5. Property root > dms > replicationTasks > additionalProperties > replicationInstance
| Type | string |
| Required | Yes |
Description: Name of the replication instance from the replicationInstances section.
3.6.1.6. Property root > dms > replicationTasks > additionalProperties > replicationTaskSettings
| Type | object |
| Required | No |
| Additional properties | Each additional property must conform to the schema |
Description: Overall settings for the task, in JSON format. For more information, see Specifying Task Settings for AWS Database Migration Service Tasks in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationtasksettings
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | - | - |
3.6.1.6.1. Property root > dms > replicationTasks > additionalProperties > replicationTaskSettings > additionalProperties
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
3.6.1.7. Property root > dms > replicationTasks > additionalProperties > sourceEndpoint
| Type | string |
| Required | Yes |
Description: Name of the source endpoint from the endpoints section.
3.6.1.8. Property root > dms > replicationTasks > additionalProperties > tableMappings
| Type | object |
| Required | Yes |
| Additional properties | Each additional property must conform to the schema |
Description: The table mappings for the task, in JSON format. For more information, see Using Table Mapping to Specify Task Settings in the AWS Database Migration Service User Guide . See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-tablemappings
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | - | - |
3.6.1.8.1. Property root > dms > replicationTasks > additionalProperties > tableMappings > additionalProperties
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
3.6.1.9. Property root > dms > replicationTasks > additionalProperties > targetEndpoint
| Type | string |
| Required | Yes |
Description: Name of the target endpoint from the endpoints section.
3.6.1.10. Property root > dms > replicationTasks > additionalProperties > taskData
| Type | object |
| Required | No |
| Additional properties | Each additional property must conform to the schema |
Description: Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the AWS Database Migration Service User Guide. See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-taskdata
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | - | - |
3.6.1.10.1. Property root > dms > replicationTasks > additionalProperties > taskData > additionalProperties
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
4. Property root > kmsArn
| Type | string |
| Required | No |
Description: KMS key ARN for encrypting DataOps resources and data. Auto-resolved from project when projectName is set.
Use cases: Data encryption; Security compliance
AWS: KMS key
Validation: Optional; auto-wired from project if projectName provided
5. Property root > nag_suppressions
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/MdaaNagSuppressionConfigs |
Description: Q-ENHANCED-PROPERTY Optional CDK Nag suppression configurations for compliance rule management enabling controlled security rule exceptions and compliance documentation. Provides structured approach to managing security rule suppressions with proper justification and documentation for compliance auditing.
Use cases: Compliance management; Security rule exceptions; Audit documentation; Controlled suppressions
AWS: CDK Nag suppressions for compliance rule management and security exception documentation
Validation: Must be valid MdaaNagSuppressionConfigs if provided; enables structured compliance rule management
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + by_path | No | array | No | - | Array of CDK Nag suppressions organized by CloudFormation resource path, enabling targeted |
5.1. Property root > nag_suppressions > by_path
| Type | array |
| Required | Yes |
Description: Array of CDK Nag suppressions organized by CloudFormation resource path, enabling targeted
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| MdaaNagSuppressionByPath | - |
5.1.1. root > nag_suppressions > by_path > MdaaNagSuppressionByPath
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/MdaaNagSuppressionByPath |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + path | No | string | No | - | CloudFormation resource path identifying the specific resource for which CDK Nag rules should be suppressed |
| + suppressions | No | array of object | No | - | Array of specific CDK Nag rule suppressions with rule IDs and mandatory justifications for audit compliance |
5.1.1.1. Property root > nag_suppressions > by_path > by_path items > path
| Type | string |
| Required | Yes |
Description: CloudFormation resource path identifying the specific resource for which CDK Nag rules should be suppressed
5.1.1.2. Property root > nag_suppressions > by_path > by_path items > suppressions
| Type | array of object |
| Required | Yes |
Description: Array of specific CDK Nag rule suppressions with rule IDs and mandatory justifications for audit compliance
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| suppressions items | - |
5.1.1.2.1. root > nag_suppressions > by_path > by_path items > suppressions > suppressions items
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + id | No | string | No | - | - |
| + reason | No | string | No | - | - |
5.1.1.2.1.1. Property root > nag_suppressions > by_path > by_path items > suppressions > suppressions items > id
| Type | string |
| Required | Yes |
5.1.1.2.1.2. Property root > nag_suppressions > by_path > by_path items > suppressions > suppressions items > reason
| Type | string |
| Required | Yes |
6. Property root > notificationTopicArn
| Type | string |
| Required | No |
Description: SNS topic ARN for job notifications and workflow alerts. Auto-resolved from project when projectName is set.
Use cases: Job failure alerts; Workflow status notifications
AWS: SNS topic
Validation: Optional; auto-wired from project if projectName provided
7. Property root > projectName
| Type | string |
| Required | No |
Description: DataOps project name enabling auto-wiring of shared resources (bucket, KMS key, SNS topic, deployment role, security configuration) via SSM parameters.
Use cases: Project resource coordination; Shared infrastructure reuse
AWS: DataOps project SSM parameter references
Validation: Optional; must match an existing deployed project
8. Property root > sagemakerBlueprint
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/MdaaSageMakerCustomBluePrintConfig |
Description: Q-ENHANCED-PROPERTY Optional SageMaker blueprint configuration for governed self-service deployment enabling controlled infrastructure provisioning and governance. When specified, deploys the module as a SageMaker blueprint instead of direct deployment for governed access and compliance.
Use cases: Governed deployment; Self-service provisioning; SageMaker integration; Controlled access
AWS: SageMaker blueprint configuration for governed infrastructure deployment and self-service provisioning
Validation: Must be valid MdaaServiceCatalogProductConfig if provided; enables SageMaker deployment mode
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - additionalAccounts | No | object | No | - | Q-ENHANCED-PROPERTY Optional map of additional AWS accounts where the SageMaker blueprint should be enabled. Each entry maps a friendly account name to account-specific configuration including provisioning role ARN and optional parameters and authorized domain units. Use cases: Multi-account deployment; Cross-account provisioning; Account-specific configuration AWS: AWS SageMaker blueprint multi-account provisioning configuration Validation: Must be object with string keys and valid account configuration values if provided |
| - authorizedDomainUnits | No | array of string | No | - | - |
| - blueprintName | No | string | No | - | - |
| - description | No | string | No | - | Q-ENHANCED-PROPERTY Description for the SageMaker blueprint that will be visible to end users in the SageMaker console. Should be descriptive and user-friendly to facilitate blueprint discovery and selection. Use cases: Product identification; User-friendly naming; SageMaker console display AWS: AWS SageMaker blueprint name for user interface display Validation: Must be non-empty string suitable for SageMaker blueprint naming |
| - domainBucketName | No | string | No | - | - |
| - domainConfig | No | object | No | In #/definitions/DomainConfig | - |
| - domainConfigSSMParam | No | string | No | - | Q-ENHANCED-PROPERTY Optional SSM parameter reference for domain configuration enabling dynamic domain configuration management. Specifies the SSM parameter containing domain configuration data for flexible domain setup and configuration management. Use cases: Dynamic configuration; SSM parameter reference; Configuration management; Flexible setup AWS: AWS Systems Manager parameter for DataZone domain configuration reference Validation: Must be valid SSM parameter name if provided; parameter must contain valid domain configuration |
| - enabledRegions | No | array of string | No | - | - |
| - parameters | No | object | No | - | Q-ENHANCED-PROPERTY Optional object containing named parameter configurations for the SageMaker blueprint. Enables parameterized blueprint deployment with validation rules and user input constraints. Use cases: Product parameterization; User input collection; Deployment customization AWS: AWS SageMaker blueprint parameters for user-configurable deployment options Validation: Must be object with string keys and valid MdaaServiceCatalogParameterConfig values if provided * |
| + provisioningRole | No | object | No | Same as provisioningRole | - |
8.1. Property root > sagemakerBlueprint > additionalAccounts
| Type | object |
| Required | No |
| Additional properties | Each additional property must conform to the schema |
Description: Q-ENHANCED-PROPERTY Optional map of additional AWS accounts where the SageMaker blueprint should be enabled. Each entry maps a friendly account name to account-specific configuration including provisioning role ARN and optional parameters and authorized domain units.
Use cases: Multi-account deployment; Cross-account provisioning; Account-specific configuration
AWS: AWS SageMaker blueprint multi-account provisioning configuration
Validation: Must be object with string keys and valid account configuration values if provided
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | In #/definitions/AdditionalBlueprintAccount | - |
8.1.1. Property root > sagemakerBlueprint > additionalAccounts > AdditionalBlueprintAccount
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/AdditionalBlueprintAccount |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + account | No | string | No | - | - |
| - authorizedDomainUnits | No | array of string | No | - | - |
| - enabledRegions | No | array of string | No | - | - |
| - parameters | No | object | No | - | - |
| + provisioningRole | No | object | No | In #/definitions/MdaaRoleRef | - |
8.1.1.1. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > account
| Type | string |
| Required | Yes |
8.1.1.2. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > authorizedDomainUnits
| Type | array of string |
| Required | No |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| authorizedDomainUnits items | - |
8.1.1.2.1. root > sagemakerBlueprint > additionalAccounts > additionalProperties > authorizedDomainUnits > authorizedDomainUnits items
| Type | string |
| Required | No |
8.1.1.3. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > enabledRegions
| Type | array of string |
| Required | No |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| enabledRegions items | - |
8.1.1.3.1. root > sagemakerBlueprint > additionalAccounts > additionalProperties > enabledRegions > enabledRegions items
| Type | string |
| Required | No |
8.1.1.4. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > parameters
| Type | object |
| Required | No |
| Additional properties | Each additional property must conform to the schema |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | In #/definitions/MdaaSageMakerBluePrintParameterConfig | - |
8.1.1.4.1. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > parameters > MdaaSageMakerBluePrintParameterConfig
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/MdaaSageMakerBluePrintParameterConfig |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + blueprintParamProps | No | object | No | In #/definitions/MdaaSageMakerBluePrintParameterProps | - |
| - cfnParamProps | No | object | No | In #/definitions/CfnParameterProps | - |
8.1.1.4.1.1. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > parameters > additionalProperties > blueprintParamProps
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/MdaaSageMakerBluePrintParameterProps |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - defaultValue | No | string | No | - | - |
| - description | No | string | No | - | - |
| + fieldType | No | string | No | - | - |
| - isEditable | No | boolean | No | - | - |
| - isOptional | No | boolean | No | - | - |
| - isUpdateSupported | No | boolean | No | - | - |
8.1.1.4.1.1.1. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > parameters > additionalProperties > blueprintParamProps > defaultValue
| Type | string |
| Required | No |
8.1.1.4.1.1.2. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > parameters > additionalProperties > blueprintParamProps > description
| Type | string |
| Required | No |
8.1.1.4.1.1.3. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > parameters > additionalProperties > blueprintParamProps > fieldType
| Type | string |
| Required | Yes |
8.1.1.4.1.1.4. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > parameters > additionalProperties > blueprintParamProps > isEditable
| Type | boolean |
| Required | No |
8.1.1.4.1.1.5. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > parameters > additionalProperties > blueprintParamProps > isOptional
| Type | boolean |
| Required | No |
8.1.1.4.1.1.6. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > parameters > additionalProperties > blueprintParamProps > isUpdateSupported
| Type | boolean |
| Required | No |
8.1.1.4.1.2. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > parameters > additionalProperties > cfnParamProps
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/CfnParameterProps |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - allowedPattern | No | string | No | - | A regular expression that represents the patterns to allow for String types. |
| - allowedValues | No | array of string | No | - | An array containing the list of values allowed for the parameter. |
| - constraintDescription | No | string | No | - | A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error message when the user specifies an invalid value: |
| - default | No | object | No | - | A value of the appropriate type for the template to use if no value is specified when a stack is created. If you define constraints for the parameter, you must specify a value that adheres to those constraints. |
| - description | No | string | No | - | A string of up to 4000 characters that describes the parameter. |
| - maxLength | No | number | No | - | An integer value that determines the largest number of characters you want to allow for String types. |
| - maxValue | No | number | No | - | A numeric value that determines the largest numeric value you want to allow for Number types. |
| - minLength | No | number | No | - | An integer value that determines the smallest number of characters you want to allow for String types. |
| - minValue | No | number | No | - | A numeric value that determines the smallest numeric value you want to allow for Number types. |
| - noEcho | No | boolean | No | - | Whether to mask the parameter value when anyone makes a call that describes the stack. If you set the value to ``true``, the parameter value is masked with asterisks (``*``). |
| - type | No | string | No | - | The data type for the parameter (DataType). |
8.1.1.4.1.2.1. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > parameters > additionalProperties > cfnParamProps > allowedPattern
| Type | string |
| Required | No |
| Default | "- No constraints on patterns allowed for parameter." |
Description: A regular expression that represents the patterns to allow for String types.
8.1.1.4.1.2.2. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > parameters > additionalProperties > cfnParamProps > allowedValues
| Type | array of string |
| Required | No |
| Default | "- No constraints on values allowed for parameter." |
Description: An array containing the list of values allowed for the parameter.
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| allowedValues items | - |
8.1.1.4.1.2.2.1. root > sagemakerBlueprint > additionalAccounts > additionalProperties > parameters > additionalProperties > cfnParamProps > allowedValues > allowedValues items
| Type | string |
| Required | No |
8.1.1.4.1.2.3. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > parameters > additionalProperties > cfnParamProps > constraintDescription
| Type | string |
| Required | No |
| Default | "- No description with customized error message when user specifies invalid values." |
Description: A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error message when the user specifies an invalid value:
8.1.1.4.1.2.4. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > parameters > additionalProperties > cfnParamProps > default
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Default | "- No default value for parameter." |
Description: A value of the appropriate type for the template to use if no value is specified when a stack is created. If you define constraints for the parameter, you must specify a value that adheres to those constraints.
8.1.1.4.1.2.5. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > parameters > additionalProperties > cfnParamProps > description
| Type | string |
| Required | No |
| Default | "- No description for the parameter." |
Description: A string of up to 4000 characters that describes the parameter.
8.1.1.4.1.2.6. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > parameters > additionalProperties > cfnParamProps > maxLength
| Type | number |
| Required | No |
| Default | "- None." |
Description: An integer value that determines the largest number of characters you want to allow for String types.
8.1.1.4.1.2.7. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > parameters > additionalProperties > cfnParamProps > maxValue
| Type | number |
| Required | No |
| Default | "- None." |
Description: A numeric value that determines the largest numeric value you want to allow for Number types.
8.1.1.4.1.2.8. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > parameters > additionalProperties > cfnParamProps > minLength
| Type | number |
| Required | No |
| Default | "- None." |
Description: An integer value that determines the smallest number of characters you want to allow for String types.
8.1.1.4.1.2.9. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > parameters > additionalProperties > cfnParamProps > minValue
| Type | number |
| Required | No |
| Default | "- None." |
Description: A numeric value that determines the smallest numeric value you want to allow for Number types.
8.1.1.4.1.2.10. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > parameters > additionalProperties > cfnParamProps > noEcho
| Type | boolean |
| Required | No |
| Default | "- Parameter values are not masked." |
Description: Whether to mask the parameter value when anyone makes a call that describes the stack.
If you set the value to true, the parameter value is masked with asterisks (*****).
8.1.1.4.1.2.11. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > parameters > additionalProperties > cfnParamProps > type
| Type | string |
| Required | No |
| Default | "String" |
Description: The data type for the parameter (DataType).
8.1.1.5. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > provisioningRole
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/MdaaRoleRef |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - arn | No | string | No | - | Full IAM role ARN for cross-account role references and explicit role identification. Use cases: Cross-account role references; Explicit role binding; Multi-account deployments AWS: Full IAM role ARN (arn:aws:iam::ACCOUNT:role/ROLE-NAME) Validation: Optional; must be a valid IAM role ARN if provided |
| - id | No | string | No | - | IAM role unique identifier for role resolution using the role's AWS-generated ID. Use cases: Stable role references; Role resolution by unique ID; Immutable role binding AWS: IAM role unique ID (e.g., AROA...) Validation: Optional; must be a valid IAM role unique ID if provided |
| - immutable | No | boolean | No | - | Flag indicating whether the referenced role should be treated as immutable and not modified by MDAA operations. Use cases: Pre-existing role protection; Externally managed roles; Read-only role references AWS: Controls whether MDAA attaches policies or modifies the referenced IAM role Validation: Optional boolean; defaults to false |
| - name | No | string | No | - | IAM role name for role resolution within the same AWS account. Use cases: Same-account role references; Role name-based resolution; Local IAM role binding AWS: IAM role name resolved via GetRole within the deployment account Validation: Optional; must be a valid IAM role name; mutually preferred with arn/id for resolution |
| - refId | No | string | No | - | Unique identifier for the role reference within a configuration scope, enabling role lookup and deduplication. Use cases: Role reference identification; Configuration deduplication; Role lookup key AWS: Logical identifier for IAM role references within MDAA configuration Validation: Optional; must be unique within the configuration scope if provided |
| - sso | No | boolean | No | - | Flag indicating the role should be resolved as an AWS SSO auto-generated role. Use cases: AWS IAM Identity Center integration; SSO permission set role binding; Federated access AWS: Resolves role via AWS SSO/Identity Center auto-generated role naming convention Validation: Optional boolean; defaults to false |
8.1.1.5.1. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > provisioningRole > arn
| Type | string |
| Required | No |
Description: Full IAM role ARN for cross-account role references and explicit role identification.
Use cases: Cross-account role references; Explicit role binding; Multi-account deployments
AWS: Full IAM role ARN (arn:aws:iam::ACCOUNT:role/ROLE-NAME)
Validation: Optional; must be a valid IAM role ARN if provided
8.1.1.5.2. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > provisioningRole > id
| Type | string |
| Required | No |
Description: IAM role unique identifier for role resolution using the role's AWS-generated ID.
Use cases: Stable role references; Role resolution by unique ID; Immutable role binding
AWS: IAM role unique ID (e.g., AROA...)
Validation: Optional; must be a valid IAM role unique ID if provided
8.1.1.5.3. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > provisioningRole > immutable
| Type | boolean |
| Required | No |
Description: Flag indicating whether the referenced role should be treated as immutable and not modified by MDAA operations.
Use cases: Pre-existing role protection; Externally managed roles; Read-only role references
AWS: Controls whether MDAA attaches policies or modifies the referenced IAM role
Validation: Optional boolean; defaults to false
8.1.1.5.4. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > provisioningRole > name
| Type | string |
| Required | No |
Description: IAM role name for role resolution within the same AWS account.
Use cases: Same-account role references; Role name-based resolution; Local IAM role binding
AWS: IAM role name resolved via GetRole within the deployment account
Validation: Optional; must be a valid IAM role name; mutually preferred with arn/id for resolution
8.1.1.5.5. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > provisioningRole > refId
| Type | string |
| Required | No |
Description: Unique identifier for the role reference within a configuration scope, enabling role lookup and deduplication.
Use cases: Role reference identification; Configuration deduplication; Role lookup key
AWS: Logical identifier for IAM role references within MDAA configuration
Validation: Optional; must be unique within the configuration scope if provided
8.1.1.5.6. Property root > sagemakerBlueprint > additionalAccounts > additionalProperties > provisioningRole > sso
| Type | boolean |
| Required | No |
Description: Flag indicating the role should be resolved as an AWS SSO auto-generated role.
Use cases: AWS IAM Identity Center integration; SSO permission set role binding; Federated access
AWS: Resolves role via AWS SSO/Identity Center auto-generated role naming convention
Validation: Optional boolean; defaults to false
8.2. Property root > sagemakerBlueprint > authorizedDomainUnits
| Type | array of string |
| Required | No |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| authorizedDomainUnits items | - |
8.2.1. root > sagemakerBlueprint > authorizedDomainUnits > authorizedDomainUnits items
| Type | string |
| Required | No |
8.3. Property root > sagemakerBlueprint > blueprintName
| Type | string |
| Required | No |
8.4. Property root > sagemakerBlueprint > description
| Type | string |
| Required | No |
Description: Q-ENHANCED-PROPERTY Description for the SageMaker blueprint that will be visible to end users in the SageMaker console. Should be descriptive and user-friendly to facilitate blueprint discovery and selection.
Use cases: Product identification; User-friendly naming; SageMaker console display
AWS: AWS SageMaker blueprint name for user interface display
Validation: Must be non-empty string suitable for SageMaker blueprint naming
8.5. Property root > sagemakerBlueprint > domainBucketName
| Type | string |
| Required | No |
8.6. Property root > sagemakerBlueprint > domainConfig
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/DomainConfig |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + blueprintIds | No | object | No | - | - |
| + configParamArns | No | array of string | No | - | - |
| + customResourceRoleName | No | string | No | - | - |
| + domainArn | No | string | No | - | - |
| + domainBucketArn | No | string | No | - | - |
| + domainBucketUsagePolicyName | No | string | No | - | - |
| + domainConfigCr | No | object | No | In #/definitions/MdaaCustomResource | - |
| + domainId | No | string | No | - | - |
| + domainKmsKeyArn | No | string | No | - | - |
| + domainKmsUsagePolicyName | No | string | No | - | - |
| + domainName | No | string | No | - | - |
| + domainUnitIds | No | object | No | - | - |
| + domainVersion | No | string | No | - | - |
| + glueCatalogArns | No | array of string | No | - | - |
| + glueCatalogKmsKeyArns | No | array of string | No | - | - |
| + node | No | object | No | Same as node | The tree node. |
| + projectIds | No | object | No | - | - |
| + props | No | object | No | In #/definitions/DomainConfigProps | - |
| + ssmParamBase | No | string | No | - | - |
8.6.1. Property root > sagemakerBlueprint > domainConfig > blueprintIds
| Type | object |
| Required | Yes |
| Additional properties | Each additional property must conform to the schema |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | string | No | - | - |
8.6.1.1. Property root > sagemakerBlueprint > domainConfig > blueprintIds > additionalProperties
| Type | string |
| Required | No |
8.6.2. Property root > sagemakerBlueprint > domainConfig > configParamArns
| Type | array of string |
| Required | Yes |
| Default | [] |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| configParamArns items | - |
8.6.2.1. root > sagemakerBlueprint > domainConfig > configParamArns > configParamArns items
| Type | string |
| Required | No |
8.6.3. Property root > sagemakerBlueprint > domainConfig > customResourceRoleName
| Type | string |
| Required | Yes |
8.6.4. Property root > sagemakerBlueprint > domainConfig > domainArn
| Type | string |
| Required | Yes |
8.6.5. Property root > sagemakerBlueprint > domainConfig > domainBucketArn
| Type | string |
| Required | Yes |
8.6.6. Property root > sagemakerBlueprint > domainConfig > domainBucketUsagePolicyName
| Type | string |
| Required | Yes |
8.6.7. Property root > sagemakerBlueprint > domainConfig > domainConfigCr
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/MdaaCustomResource |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + _allowCrossEnvironment | No | object | No | - | - |
| + _physicalName | No | object | No | - | - |
| + env | No | object | No | In #/definitions/ResourceEnvironment | The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. |
| + handlerFunction | No | object | No | In #/definitions/MdaaLambdaFunction | Construct for creating a compliant Lambda Function |
| + node | No | object | No | Same as node | The tree node. |
| + physicalName | No | string | No | - | Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource. This value will resolve to one of the following: - a concrete value (e.g. `"my-awesome-bucket"`) - `undefined`, when a name should be generated by CloudFormation - a concrete name generated automatically during synthesis, in cross-environment scenarios. |
| + ref | No | string | No | - | The physical name of this custom resource. |
| + resource | No | object | No | - | - |
| + stack | No | object | No | Same as stack | The stack in which this resource is defined. |
8.6.7.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > _allowCrossEnvironment
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > _physicalName
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > env
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/ResourceEnvironment |
Description: The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + account | No | string | No | - | The AWS account ID that this resource belongs to. Since this can be a Token (for example, when the account is CloudFormation's AWS::AccountId intrinsic), make sure to use Token.compareStrings() instead of just comparing the values for equality. |
| + region | No | string | No | - | The AWS region that this resource belongs to. Since this can be a Token (for example, when the region is CloudFormation's AWS::Region intrinsic), make sure to use Token.compareStrings() instead of just comparing the values for equality. |
8.6.7.3.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > env > account
| Type | string |
| Required | Yes |
Description: The AWS account ID that this resource belongs to. Since this can be a Token (for example, when the account is CloudFormation's AWS::AccountId intrinsic), make sure to use Token.compareStrings() instead of just comparing the values for equality.
8.6.7.3.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > env > region
| Type | string |
| Required | Yes |
Description: The AWS region that this resource belongs to. Since this can be a Token (for example, when the region is CloudFormation's AWS::Region intrinsic), make sure to use Token.compareStrings() instead of just comparing the values for equality.
8.6.7.4. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/MdaaLambdaFunction |
Description: Construct for creating a compliant Lambda Function
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + _allowCrossEnvironment | No | object | No | - | - |
| - _architecture | No | object | No | - | - |
| - _connections | No | object | No | In #/definitions/Connections | Actual connections object for this Lambda May be unset, in which case this Lambda is not configured use in a VPC. |
| - _currentVersion | No | object | No | - | - |
| + _functionUrlInvocationGrants | No | object | No | In #/definitions/Record%3Cstring%2CGrant%3E | Mapping of function URL invocation principals to grants. Used to de-dupe `grantInvokeUrl()` calls. |
| + _hasAddedArrayTokenStatements | No | object | No | - | Track whether we've added statements with array token resources to the role's default policy |
| + _hasAddedLiteralStatements | No | object | No | - | Track whether we've added statements with literal resources to the role's default policy |
| + _invocationGrants | No | object | No | Same as _functionUrlInvocationGrants | Mapping of invocation principals to grants. Used to de-dupe `grantInvoke()` calls. |
| - _latestVersion | No | object | No | - | - |
| + _layers | No | array | No | - | - |
| - _logGroup | No | object | No | - | - |
| - _logRetention | No | object | No | In #/definitions/LogRetention | Creates a custom resource to control the retention policy of a CloudWatch Logs log group. The log group is created if it doesn't already exist. The policy is removed when `retentionDays` is `undefined` or equal to `Infinity`. Log group can be created in the region that is different from stack region by specifying `logGroupRegion` |
| + _physicalName | No | object | No | - | - |
| + _policyCounter | No | object | No | - | The number of permissions added to this function |
| - _skipPermissions | No | boolean | No | - | Whether the user decides to skip adding permissions. The only use case is for cross-account, imported lambdas where the user commits to modifying the permisssions on the imported lambda outside CDK. |
| + _warnIfCurrentVersionCalled | No | boolean | No | - | Flag to delay adding a warning message until current version is invoked. |
| + architecture | No | object | No | In #/definitions/Architecture | The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64). |
| + buildDeadLetterConfig | No | object | No | - | - |
| + buildDeadLetterQueue | No | object | No | - | - |
| + buildTracingConfig | No | object | No | - | - |
| + canCreatePermissions | No | const | No | - | Whether the addPermission() call adds any permissions True for new Lambdas, false for version $LATEST and imported Lambdas from different accounts. |
| + configureAdotInstrumentation | No | object | No | - | Add an AWS Distro for OpenTelemetry Lambda layer. |
| + configureLambdaInsights | No | object | No | - | Configured lambda insights on the function if specified. This is achieved by adding an imported layer which is added to the list of lambda layers on synthesis. https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights-extension-versions.html |
| + configureParamsAndSecretsExtension | No | object | No | - | Add a Parameters and Secrets Extension Lambda layer. |
| + configureSnapStart | No | object | No | - | - |
| + configureVpc | No | object | No | - | If configured, set up the VPC-related properties Returns the VpcConfig that should be added to the Lambda creation properties. |
| + connections | No | object | No | Same as _connections | Access the Connections object Will fail if not a VPC-enabled Lambda Function |
| + currentVersion | No | object | No | In #/definitions/Version | Returns a `lambda.Version` which represents the current version of this Lambda function. A new version will be created every time the function's configuration changes. You can specify options for this version using the `currentVersionOptions` prop when initializing the `lambda.Function`. |
| - currentVersionOptions | No | object | No | - | - |
| - deadLetterQueue | No | object | No | In #/definitions/IQueue | The DLQ (as queue) associated with this Lambda Function (this is an optional attribute). |
| - deadLetterTopic | No | object | No | In #/definitions/ITopic | The DLQ (as topic) associated with this Lambda Function (this is an optional attribute). |
| + env | No | object | No | Same as env | The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. |
| + environment | No | object | No | - | Environment variables for this function |
| + functionArn | No | string | No | - | ARN of this function |
| + functionName | No | string | No | - | Name of this function |
| + functionRef | No | object | No | Same as functionRef | A reference to a Function resource. |
| + getLoggingConfig | No | object | No | - | Get Logging Config property for the function. This method returns the function LoggingConfig Property if the property is set on the function and undefined if not. |
| + grant | No | object | No | - | - |
| + grantPrincipal | No | object | No | Same as grantPrincipal | The principal this Lambda Function is running as |
| + hashMixins | No | object | No | - | - |
| + isBoundToVpc | No | boolean | No | - | Whether or not this Lambda function was bound to a VPC If this is is `false`, trying to access the `connections` object will fail. |
| + isPrincipalWithConditions | No | object | No | - | - |
| + isQueue | No | object | No | - | - |
| + latestVersion | No | object | No | Same as latestVersion | The `$LATEST` version of this function. Note that this is reference to a non-specific AWS Lambda version, which means the function this version refers to can return different results in different invocations. To obtain a reference to an explicit version which references the current function configuration, use `lambdaFunction.currentVersion` instead. |
| + logGroup | No | object | No | In #/definitions/ILogGroup | The LogGroup where the Lambda function's logs are made available. If either `logRetention` is set or this property is called, a CloudFormation custom resource is added to the stack that pre-creates the log group as part of the stack deployment, if it already doesn't exist, and sets the correct log retention period (never expire, by default). Further, if the log group already exists and the `logRetention` is not set, the custom resource will reset the log retention to never expire even if it was configured with a different value. |
| + node | No | object | No | Same as node | The tree node. |
| + parsePermissionPrincipal | No | object | No | - | Translate IPrincipal to something we can pass to AWS::Lambda::Permissions Do some nasty things because `Permission` supports a subset of what the full IAM principal language supports, and we may not be able to parse strings outright because they may be tokens. Try to recognize some specific Principal classes first, then try a generic fallback. |
| + permissionsNode | No | object | No | Same as node | The construct node where permissions are attached. |
| + physicalName | No | string | No | - | Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource. This value will resolve to one of the following: - a concrete value (e.g. `"my-awesome-bucket"`) - `undefined`, when a name should be generated by CloudFormation - a concrete name generated automatically during synthesis, in cross-environment scenarios. |
| + renderEnvironment | No | object | No | - | - |
| + renderLayers | No | object | No | - | - |
| + resourceArnsForGrantInvoke | No | array of string | No | - | The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke() |
| - role | No | object | No | Same as role | Execution role associated with this function |
| + runtime | No | object | No | Same as sagemakerBlueprint_domainConfig_domainConfigCr_handlerFunction__layers_items_compatibleRuntimes_items | The runtime configured for this lambda. |
| + stack | No | object | No | Same as stack | The stack in which this resource is defined. |
| + statementHasArrayTokens | No | object | No | - | Check if a policy statement contains array tokens that would cause CloudFormation resolution conflicts when mixed with literal arrays in the same policy document. Array tokens are created by CloudFormation intrinsic functions that return arrays, such as Fn::Split, Fn::GetAZs, etc. These cannot be safely merged with literal resource arrays due to CloudFormation's token resolution limitations. Individual string tokens within literal arrays (e.g., `["arn:${token}:..."]`) are safe and do not cause conflicts, so they are not detected by this method. |
| - timeout | No | object | No | In #/definitions/Duration | The timeout configured for this lambda. |
| + validateConditionCombinations | No | object | No | - | - |
| + validateConditions | No | object | No | - | - |
| + validateProfiling | No | object | No | - | - |
8.6.7.4.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _allowCrossEnvironment
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _architecture
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
8.6.7.4.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/Connections |
Description: Actual connections object for this Lambda
May be unset, in which case this Lambda is not configured use in a VPC.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + _securityGroupRules | No | object | No | - | The rule that defines how to represent this peer in a security group |
| + _securityGroups | No | object | No | - | Underlying securityGroup for this Connections object, if present May be empty if this Connections object is not managing a SecurityGroup, but simply representing a Connectable peer. |
| + connections | No | object | No | Same as _connections | The network connections associated with this resource. |
| - defaultPort | No | object | No | In #/definitions/Port | The default port configured for this connection peer, if available |
| + remoteRule | No | object | No | - | When doing bidirectional grants between Security Groups in different stacks, put the rule on the other SG |
| + securityGroups | No | array | No | - | - |
| + skip | No | object | No | - | When doing bidirectional grants between Connections, make sure we don't recursive infinitely |
8.6.7.4.3.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > _securityGroupRules
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: The rule that defines how to represent this peer in a security group
8.6.7.4.3.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > _securityGroups
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Underlying securityGroup for this Connections object, if present
May be empty if this Connections object is not managing a SecurityGroup, but simply representing a Connectable peer.
8.6.7.4.3.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > connections
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | _connections |
Description: The network connections associated with this resource.
8.6.7.4.3.4. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > defaultPort
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/Port |
Description: The default port configured for this connection peer, if available
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + canInlineRule | No | boolean | No | - | Whether the rule containing this port range can be inlined into a securitygroup or not. |
| + props | No | object | No | - | - |
8.6.7.4.3.4.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > defaultPort > canInlineRule
| Type | boolean |
| Required | Yes |
Description: Whether the rule containing this port range can be inlined into a securitygroup or not.
8.6.7.4.3.4.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > defaultPort > props
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.3.5. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > remoteRule
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: When doing bidirectional grants between Security Groups in different stacks, put the rule on the other SG
8.6.7.4.3.6. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups
| Type | array |
| Required | Yes |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| ISecurityGroup | Interface for security group-like objects |
8.6.7.4.3.6.1. root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > ISecurityGroup
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/ISecurityGroup |
Description: Interface for security group-like objects
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + allowAllOutbound | No | boolean | No | - | Whether the SecurityGroup has been configured to allow all outbound traffic |
| + canInlineRule | No | boolean | No | - | Whether the rule can be inlined into a SecurityGroup or not |
| + connections | No | object | No | Same as _connections | The network connections associated with this resource. |
| + env | No | object | No | Same as env | The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. |
| + node | No | object | No | In #/definitions/Node | The tree node. |
| + securityGroupId | No | string | No | - | ID for the current security group |
| + securityGroupRef | No | object | No | In #/definitions/SecurityGroupReference | A reference to a SecurityGroup resource. |
| + stack | No | object | No | In #/definitions/Stack | The stack in which this resource is defined. |
| + uniqueId | No | string | No | - | A unique identifier for this connection peer |
8.6.7.4.3.6.1.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > allowAllOutbound
| Type | boolean |
| Required | Yes |
Description: Whether the SecurityGroup has been configured to allow all outbound traffic
8.6.7.4.3.6.1.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > canInlineRule
| Type | boolean |
| Required | Yes |
Description: Whether the rule can be inlined into a SecurityGroup or not
8.6.7.4.3.6.1.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > connections
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | _connections |
Description: The network connections associated with this resource.
8.6.7.4.3.6.1.4. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > env
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | env |
Description: The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
8.6.7.4.3.6.1.5. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/Node |
Description: The tree node.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - _addr | No | object | No | - | - |
| + _children | No | object | No | - | - |
| + _context | No | object | No | - | - |
| + _defaultChild | No | object | No | - | - |
| + _dependencies | No | object | No | - | - |
| + _locked | No | object | No | - | - |
| + _metadata | No | object | No | - | - |
| + _validations | No | object | No | - | - |
| + addChild | No | object | No | - | Adds a child construct to this node. |
| + addr | No | string | No | - | Returns an opaque tree-unique address for this construct. Addresses are 42 characters hexadecimal strings. They begin with "c8" followed by 40 lowercase hexadecimal characters (0-9a-f). Addresses are calculated using a SHA-1 of the components of the construct path. To enable refactorings of construct trees, constructs with the ID `Default` will be excluded from the calculation. In those cases constructs in the same tree may have the same addreess. |
| + children | No | array | No | - | All direct children of this construct. |
| - defaultChild | No | object | No | Same as sagemakerBlueprint_domainConfig_domainConfigCr_handlerFunction__connections_securityGroups_items_node_children_items | Returns the child construct that has the id `Default` or `Resource"`. This is usually the construct that provides the bulk of the underlying functionality. Useful for modifications of the underlying construct that are not available at the higher levels. Override the defaultChild property. This should only be used in the cases where the correct default child is not named 'Resource' or 'Default' as it should be. If you set this to undefined, the default behavior of finding the child named 'Resource' or 'Default' will be used. |
| + dependencies | No | array | No | - | Return all dependencies registered on this node (non-recursive). |
| + host | No | object | No | - | - |
| + id | No | string | No | - | The id of this construct within the current scope. This is a a scope-unique id. To obtain an app-unique id for this construct, use `addr`. |
| + locked | No | boolean | No | - | Returns true if this construct or the scopes in which it is defined are locked. |
| + metadata | No | array | No | - | An immutable array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc. |
| + path | No | string | No | - | The full, absolute path of this construct in the tree. Components are separated by '/'. |
| + root | No | object | No | Same as sagemakerBlueprint_domainConfig_domainConfigCr_handlerFunction__connections_securityGroups_items_node_children_items | Returns the root of the construct tree. |
| - scope | No | object | No | Same as sagemakerBlueprint_domainConfig_domainConfigCr_handlerFunction__connections_securityGroups_items_node_children_items | Returns the scope in which this construct is defined. The value is `undefined` at the root of the construct scope tree. |
| + scopes | No | array | No | - | All parent scopes of this construct. |
8.6.7.4.3.6.1.5.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > _addr
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
8.6.7.4.3.6.1.5.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > _children
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.3.6.1.5.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > _context
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.3.6.1.5.4. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > _defaultChild
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.3.6.1.5.5. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > _dependencies
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.3.6.1.5.6. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > _locked
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.3.6.1.5.7. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > _metadata
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.3.6.1.5.8. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > _validations
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.3.6.1.5.9. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > addChild
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Adds a child construct to this node.
8.6.7.4.3.6.1.5.10. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > addr
| Type | string |
| Required | Yes |
Description: Returns an opaque tree-unique address for this construct.
Addresses are 42 characters hexadecimal strings. They begin with "c8" followed by 40 lowercase hexadecimal characters (0-9a-f).
Addresses are calculated using a SHA-1 of the components of the construct path.
To enable refactorings of construct trees, constructs with the ID Default
will be excluded from the calculation. In those cases constructs in the
same tree may have the same addreess.
8.6.7.4.3.6.1.5.11. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > children
| Type | array |
| Required | Yes |
Description: All direct children of this construct.
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| IConstruct | Represents a construct. |
8.6.7.4.3.6.1.5.11.1. root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > children > IConstruct
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/IConstruct |
Description: Represents a construct.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + node | No | object | No | Same as node | The tree node. |
8.6.7.4.3.6.1.5.11.1.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > children > children items > node
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | node |
Description: The tree node.
8.6.7.4.3.6.1.5.12. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > defaultChild
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | sagemakerBlueprint_domainConfig_domainConfigCr_handlerFunction__connections_securityGroups_items_node_children_items |
Description: Returns the child construct that has the id Default or Resource".
This is usually the construct that provides the bulk of the underlying functionality.
Useful for modifications of the underlying construct that are not available at the higher levels.
Override the defaultChild property.
This should only be used in the cases where the correct default child is not named 'Resource' or 'Default' as it should be.
If you set this to undefined, the default behavior of finding the child named 'Resource' or 'Default' will be used.
8.6.7.4.3.6.1.5.13. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > dependencies
| Type | array |
| Required | Yes |
Description: Return all dependencies registered on this node (non-recursive).
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| IConstruct | Represents a construct. |
8.6.7.4.3.6.1.5.13.1. root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > dependencies > IConstruct
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | sagemakerBlueprint_domainConfig_domainConfigCr_handlerFunction__connections_securityGroups_items_node_children_items |
Description: Represents a construct.
8.6.7.4.3.6.1.5.14. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > host
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.3.6.1.5.15. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > id
| Type | string |
| Required | Yes |
Description: The id of this construct within the current scope.
This is a a scope-unique id. To obtain an app-unique id for this construct, use addr.
8.6.7.4.3.6.1.5.16. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > locked
| Type | boolean |
| Required | Yes |
Description: Returns true if this construct or the scopes in which it is defined are locked.
8.6.7.4.3.6.1.5.17. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > metadata
| Type | array |
| Required | Yes |
Description: An immutable array of metadata objects associated with this construct. This can be used, for example, to implement support for deprecation notices, source mapping, etc.
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| MetadataEntry | An entry in the construct metadata table. |
8.6.7.4.3.6.1.5.17.1. root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > metadata > MetadataEntry
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/MetadataEntry |
Description: An entry in the construct metadata table.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + data | No | object | No | - | The data. |
| - trace | No | array of string | No | - | Stack trace at the point of adding the metadata. Only available if `addMetadata()` is called with `stackTrace: true`. |
| + type | No | string | No | - | The metadata entry type. |
8.6.7.4.3.6.1.5.17.1.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > metadata > metadata items > data
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: The data.
8.6.7.4.3.6.1.5.17.1.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > metadata > metadata items > trace
| Type | array of string |
| Required | No |
| Default | "- no trace information" |
Description: Stack trace at the point of adding the metadata.
Only available if addMetadata() is called with stackTrace: true.
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| trace items | - |
8.6.7.4.3.6.1.5.17.1.2.1. root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > metadata > metadata items > trace > trace items
| Type | string |
| Required | No |
8.6.7.4.3.6.1.5.17.1.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > metadata > metadata items > type
| Type | string |
| Required | Yes |
Description: The metadata entry type.
8.6.7.4.3.6.1.5.18. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > path
| Type | string |
| Required | Yes |
Description: The full, absolute path of this construct in the tree.
Components are separated by '/'.
8.6.7.4.3.6.1.5.19. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > root
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | sagemakerBlueprint_domainConfig_domainConfigCr_handlerFunction__connections_securityGroups_items_node_children_items |
Description: Returns the root of the construct tree.
8.6.7.4.3.6.1.5.20. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > scope
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | sagemakerBlueprint_domainConfig_domainConfigCr_handlerFunction__connections_securityGroups_items_node_children_items |
Description: Returns the scope in which this construct is defined.
The value is undefined at the root of the construct scope tree.
8.6.7.4.3.6.1.5.21. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > scopes
| Type | array |
| Required | Yes |
Description: All parent scopes of this construct.
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| IConstruct | Represents a construct. |
8.6.7.4.3.6.1.5.21.1. root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > node > scopes > IConstruct
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | sagemakerBlueprint_domainConfig_domainConfigCr_handlerFunction__connections_securityGroups_items_node_children_items |
Description: Represents a construct.
8.6.7.4.3.6.1.6. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > securityGroupId
| Type | string |
| Required | Yes |
Description: ID for the current security group
8.6.7.4.3.6.1.7. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > securityGroupRef
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/SecurityGroupReference |
Description: A reference to a SecurityGroup resource.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + securityGroupId | No | string | No | - | The Id of the SecurityGroup resource. |
8.6.7.4.3.6.1.7.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > securityGroupRef > securityGroupId
| Type | string |
| Required | Yes |
Description: The Id of the SecurityGroup resource.
8.6.7.4.3.6.1.8. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/Stack |
Description: The stack in which this resource is defined.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + _crossRegionReferences | No | boolean | No | - | Whether cross region references are enabled for this stack |
| + _logicalIds | No | object | No | - | Logical ID generation strategy |
| + _missingContext | No | object | No | - | Lists all missing contextual information. This is returned when the stack is synthesized under the 'missing' attribute and allows tooling to obtain the context and re-synthesize. |
| - _notificationArns | No | array of string | No | - | SNS Notification ARNs to receive stack events. |
| + _stackDependencies | No | object | No | - | Other stacks this stack depends on |
| + _stackName | No | object | No | - | - |
| + _suppressTemplateIndentation | No | object | No | - | Enable this flag to suppress indentation in generated CloudFormation templates. If not specified, the value of the `@aws-cdk/core:suppressTemplateIndentation` context key will be used. If that is not specified, then the default value `false` will be used. |
| + _terminationProtection | No | object | No | - | - |
| + _versionReportingEnabled | No | boolean | No | - | Whether version reporting is enabled for this stack Controls whether the CDK Metadata resource is injected |
| + account | No | string | No | - | The AWS account into which this stack will be deployed. This value is resolved according to the following rules: 1. The value provided to `env.account` when the stack is defined. This can either be a concrete account (e.g. `585695031111`) or the `Aws.ACCOUNT_ID` token. 3. `Aws.ACCOUNT_ID`, which represents the CloudFormation intrinsic reference `{ "Ref": "AWS::AccountId" }` encoded as a string token. Preferably, you should use the return value as an opaque string and not attempt to parse it to implement your logic. If you do, you must first check that it is a concrete value an not an unresolved token. If this value is an unresolved token (`Token.isUnresolved(stack.account)` returns `true`), this implies that the user wishes that this stack will synthesize into an account-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using `Annotations.of(construct).addError()`) or implement some other account-agnostic behavior. |
| + addPermissionsBoundaryAspect | No | object | No | - | Adds an aspect to the stack that will apply the permissions boundary. This will only add the aspect if the permissions boundary has been set |
| + artifactId | No | string | No | - | The ID of the cloud assembly artifact for this stack. |
| + availabilityZones | No | array of string | No | - | Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack. If the stack is environment-agnostic (either account and/or region are tokens), this property will return an array with 2 tokens that will resolve at deploy-time to the first two availability zones returned from CloudFormation's `Fn::GetAZs` intrinsic function. If they are not available in the context, returns a set of dummy values and reports them as missing, and let the CLI resolve them by calling EC2 `DescribeAvailabilityZones` on the target environment. To specify a different strategy for selecting availability zones override this method. |
| + bundlingRequired | No | boolean | No | - | Indicates whether the stack requires bundling or not |
| + dependencies | No | array | No | - | Return the stacks this stack depends on |
| + environment | No | string | No | - | The environment coordinates in which this stack is deployed. In the form `aws://account/region`. Use `stack.account` and `stack.region` to obtain the specific values, no need to parse. You can use this value to determine if two stacks are targeting the same environment. If either `stack.account` or `stack.region` are not concrete values (e.g. `Aws.ACCOUNT_ID` or `Aws.REGION`) the special strings `unknown-account` and/or `unknown-region` will be used respectively to indicate this stack is region/account-agnostic. |
| + generateStackArtifactId | No | object | No | - | The artifact ID for this stack Stack artifact ID is unique within the App's Cloud Assembly. |
| + generateStackId | No | object | No | - | Generate an ID with respect to the given container construct. |
| + generateStackName | No | object | No | - | Calculate the stack name based on the construct path The stack name is the name under which we'll deploy the stack, and incorporates containing Stage names by default. Generally this looks a lot like how logical IDs are calculated. The stack name is calculated based on the construct root path, as follows: - Path is calculated with respect to containing App or Stage (if any) - If the path is one component long just use that component, otherwise combine them with a hash. Since the hash is quite ugly and we'd like to avoid it if possible -- but we can't anymore in the general case since it has been written into legacy stacks. The introduction of Stages makes it possible to make this nicer however. When a Stack is nested inside a Stage, we use the path components below the Stage, and prefix the path components of the Stage before it. |
| + maxResources | No | object | No | - | Maximum number of resources in the stack Set to 0 to mean "unlimited". |
| + nested | No | boolean | No | - | Indicates if this is a nested stack, in which case `parentStack` will include a reference to it's parent. |
| - nestedStackParent | No | object | No | Same as stack | If this is a nested stack, returns it's parent stack. |
| - nestedStackResource | No | object | No | In #/definitions/CfnResource | If this is a nested stack, this represents its `AWS::CloudFormation::Stack` resource. `undefined` for top-level (non-nested) stacks. |
| + node | No | object | No | Same as node | The tree node. |
| + notificationArns | No | array of string | No | - | Returns the list of notification Amazon Resource Names (ARNs) for the current stack. |
| + parseEnvironment | No | object | No | - | Determine the various stack environment attributes. |
| + partition | No | string | No | - | The partition in which this stack is defined |
| + permissionsBoundaryArn | No | object | No | - | If a permissions boundary has been applied on this scope or any parent scope then this will return the ARN of the permissions boundary. This will return the permissions boundary that has been applied to the most specific scope. For example: const stage = new Stage(app, 'stage', { permissionsBoundary: PermissionsBoundary.fromName('stage-pb'), }); const stack = new Stack(stage, 'Stack', { permissionsBoundary: PermissionsBoundary.fromName('some-other-pb'), }); Stack.permissionsBoundaryArn === 'arn:${AWS::Partition}:iam::${AWS::AccountId}:policy/some-other-pb'; |
| + region | No | string | No | - | The AWS region into which this stack will be deployed (e.g. `us-west-2`). This value is resolved according to the following rules: 1. The value provided to `env.region` when the stack is defined. This can either be a concrete region (e.g. `us-west-2`) or the `Aws.REGION` token. 3. `Aws.REGION`, which is represents the CloudFormation intrinsic reference `{ "Ref": "AWS::Region" }` encoded as a string token. Preferably, you should use the return value as an opaque string and not attempt to parse it to implement your logic. If you do, you must first check that it is a concrete value an not an unresolved token. If this value is an unresolved token (`Token.isUnresolved(stack.region)` returns `true`), this implies that the user wishes that this stack will synthesize into a region-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using `Annotations.of(construct).addError()`) or implement some other region-agnostic behavior. |
| + resolveExportedValue | No | object | No | - | - |
| + stackDependencyReasons | No | object | No | - | Check whether this stack has a (transitive) dependency on another stack Returns the list of reasons on the dependency path, or undefined if there is no dependency. |
| + stackId | No | string | No | - | The ID of the stack |
| + stackName | No | string | No | - | The concrete CloudFormation physical stack name. This is either the name defined explicitly in the `stackName` prop or allocated based on the stack's location in the construct tree. Stacks that are directly defined under the app use their construct `id` as their stack name. Stacks that are defined deeper within the tree will use a hashed naming scheme based on the construct path to ensure uniqueness. If you wish to obtain the deploy-time AWS::StackName intrinsic, you can use `Aws.STACK_NAME` directly. |
| + synthesizer | No | object | No | In #/definitions/IStackSynthesizer | Synthesis method for this stack |
| + tags | No | object | No | In #/definitions/TagManager | Tags to be applied to the stack. |
| + templateFile | No | string | No | - | The name of the CloudFormation template file emitted to the output directory during synthesis. Example value: `MyStack.template.json` |
| + templateOptions | No | object | No | In #/definitions/ITemplateOptions | Options for CloudFormation template (like version, transform, description). |
| + terminationProtection | No | boolean | No | - | Whether termination protection is enabled for this stack. |
| + urlSuffix | No | string | No | - | The Amazon domain suffix for the region in which this stack is defined |
8.6.7.4.3.6.1.8.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > _crossRegionReferences
| Type | boolean |
| Required | Yes |
Description: Whether cross region references are enabled for this stack
8.6.7.4.3.6.1.8.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > _logicalIds
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Logical ID generation strategy
8.6.7.4.3.6.1.8.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > _missingContext
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Lists all missing contextual information. This is returned when the stack is synthesized under the 'missing' attribute and allows tooling to obtain the context and re-synthesize.
8.6.7.4.3.6.1.8.4. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > _notificationArns
| Type | array of string |
| Required | No |
Description: SNS Notification ARNs to receive stack events.
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| _notificationArns items | - |
8.6.7.4.3.6.1.8.4.1. root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > _notificationArns > _notificationArns items
| Type | string |
| Required | No |
8.6.7.4.3.6.1.8.5. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > _stackDependencies
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Other stacks this stack depends on
8.6.7.4.3.6.1.8.6. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > _stackName
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.3.6.1.8.7. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > _suppressTemplateIndentation
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
| Default | "- the value of@aws-cdk/core:suppressTemplateIndentation, orfalseif that is not set." |
Description: Enable this flag to suppress indentation in generated CloudFormation templates.
If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation
context key will be used. If that is not specified, then the
default value false will be used.
8.6.7.4.3.6.1.8.8. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > _terminationProtection
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.3.6.1.8.9. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > _versionReportingEnabled
| Type | boolean |
| Required | Yes |
Description: Whether version reporting is enabled for this stack
Controls whether the CDK Metadata resource is injected
8.6.7.4.3.6.1.8.10. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > account
| Type | string |
| Required | Yes |
Description: The AWS account into which this stack will be deployed.
This value is resolved according to the following rules:
- The value provided to
env.accountwhen the stack is defined. This can either be a concrete account (e.g.585695031111) or theAws.ACCOUNT_IDtoken. Aws.ACCOUNT_ID, which represents the CloudFormation intrinsic reference{ "Ref": "AWS::AccountId" }encoded as a string token.
Preferably, you should use the return value as an opaque string and not
attempt to parse it to implement your logic. If you do, you must first
check that it is a concrete value an not an unresolved token. If this
value is an unresolved token (Token.isUnresolved(stack.account) returns
true), this implies that the user wishes that this stack will synthesize
into an account-agnostic template. In this case, your code should either
fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or
implement some other account-agnostic behavior.
8.6.7.4.3.6.1.8.11. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > addPermissionsBoundaryAspect
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Adds an aspect to the stack that will apply the permissions boundary. This will only add the aspect if the permissions boundary has been set
8.6.7.4.3.6.1.8.12. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > artifactId
| Type | string |
| Required | Yes |
Description: The ID of the cloud assembly artifact for this stack.
8.6.7.4.3.6.1.8.13. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > availabilityZones
| Type | array of string |
| Required | Yes |
Description: Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.
If the stack is environment-agnostic (either account and/or region are
tokens), this property will return an array with 2 tokens that will resolve
at deploy-time to the first two availability zones returned from CloudFormation's
Fn::GetAZs intrinsic function.
If they are not available in the context, returns a set of dummy values and
reports them as missing, and let the CLI resolve them by calling EC2
DescribeAvailabilityZones on the target environment.
To specify a different strategy for selecting availability zones override this method.
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| availabilityZones items | - |
8.6.7.4.3.6.1.8.13.1. root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > availabilityZones > availabilityZones items
| Type | string |
| Required | No |
8.6.7.4.3.6.1.8.14. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > bundlingRequired
| Type | boolean |
| Required | Yes |
Description: Indicates whether the stack requires bundling or not
8.6.7.4.3.6.1.8.15. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > dependencies
| Type | array |
| Required | Yes |
Description: Return the stacks this stack depends on
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| Stack | A root construct which represents a single CloudFormation stack. |
8.6.7.4.3.6.1.8.15.1. root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > dependencies > Stack
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | stack |
Description: A root construct which represents a single CloudFormation stack.
8.6.7.4.3.6.1.8.16. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > environment
| Type | string |
| Required | Yes |
Description: The environment coordinates in which this stack is deployed. In the form
aws://account/region. Use stack.account and stack.region to obtain
the specific values, no need to parse.
You can use this value to determine if two stacks are targeting the same environment.
If either stack.account or stack.region are not concrete values (e.g.
Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or
unknown-region will be used respectively to indicate this stack is
region/account-agnostic.
8.6.7.4.3.6.1.8.17. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > generateStackArtifactId
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: The artifact ID for this stack
Stack artifact ID is unique within the App's Cloud Assembly.
8.6.7.4.3.6.1.8.18. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > generateStackId
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Generate an ID with respect to the given container construct.
8.6.7.4.3.6.1.8.19. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > generateStackName
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Calculate the stack name based on the construct path
The stack name is the name under which we'll deploy the stack, and incorporates containing Stage names by default.
Generally this looks a lot like how logical IDs are calculated. The stack name is calculated based on the construct root path, as follows:
- Path is calculated with respect to containing App or Stage (if any)
- If the path is one component long just use that component, otherwise combine them with a hash.
Since the hash is quite ugly and we'd like to avoid it if possible -- but we can't anymore in the general case since it has been written into legacy stacks. The introduction of Stages makes it possible to make this nicer however. When a Stack is nested inside a Stage, we use the path components below the Stage, and prefix the path components of the Stage before it.
8.6.7.4.3.6.1.8.20. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > maxResources
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Maximum number of resources in the stack
Set to 0 to mean "unlimited".
8.6.7.4.3.6.1.8.21. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nested
| Type | boolean |
| Required | Yes |
Description: Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.
8.6.7.4.3.6.1.8.22. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackParent
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | stack |
Description: If this is a nested stack, returns it's parent stack.
8.6.7.4.3.6.1.8.23. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/CfnResource |
Description: If this is a nested stack, this represents its AWS::CloudFormation::Stack
resource. undefined for top-level (non-nested) stacks.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + _cfnProperties | No | object | No | - | AWS CloudFormation resource properties. This object is returned via cfnProperties |
| - _logicalIdLocked | No | object | No | - | If the logicalId is locked then it can no longer be overridden. This is needed for cases where the logicalId is consumed prior to synthesis (i.e. Stack.exportValue). |
| - _logicalIdOverride | No | object | No | - | An explicit logical ID provided by `overrideLogicalId`. |
| + cfnOptions | No | object | No | In #/definitions/ICfnResourceOptions | Options for this resource, such as condition, update policy etc. |
| + cfnProperties | No | object | No | - | - |
| + cfnResourceType | No | string | No | - | AWS resource type. |
| + creationStack | No | array of string | No | - | - |
| + dependsOn | No | object | No | - | Logical IDs of dependencies. Is filled during prepare(). |
| + logicalId | No | string | No | - | The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. |
| + node | No | object | No | Same as node | The tree node. |
| + rawOverrides | No | object | No | - | An object to be merged on top of the entire resource definition. |
| + ref | No | string | No | - | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. |
| + stack | No | object | No | Same as stack | The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). |
| + synthesizeLogicalId | No | object | No | - | Called during synthesize to render the logical ID of this element. If `overrideLogicalId` was it will be used, otherwise, we will allocate the logical ID through the stack. |
| + updatedProperites | No | object | No | - | Deprecated |
| + updatedProperties | No | object | No | - | Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource. |
8.6.7.4.3.6.1.8.23.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > _cfnProperties
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: AWS CloudFormation resource properties.
This object is returned via cfnProperties
8.6.7.4.3.6.1.8.23.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > _logicalIdLocked
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
Description: If the logicalId is locked then it can no longer be overridden. This is needed for cases where the logicalId is consumed prior to synthesis (i.e. Stack.exportValue).
8.6.7.4.3.6.1.8.23.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > _logicalIdOverride
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
Description: An explicit logical ID provided by overrideLogicalId.
8.6.7.4.3.6.1.8.23.4. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/ICfnResourceOptions |
Description: Options for this resource, such as condition, update policy etc.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - condition | No | object | No | In #/definitions/CfnCondition | A condition to associate with this resource. This means that only if the condition evaluates to 'true' when the stack is deployed, the resource will be included. This is provided to allow CDK projects to produce legacy templates, but normally there is no need to use it in CDK projects. |
| - creationPolicy | No | object | No | In #/definitions/CfnCreationPolicy | Associate the CreationPolicy attribute with a resource to prevent its status from reaching create complete until AWS CloudFormation receives a specified number of success signals or the timeout period is exceeded. To signal a resource, you can use the cfn-signal helper script or SignalResource API. AWS CloudFormation publishes valid signals to the stack events so that you track the number of signals sent. |
| - deletionPolicy | No | enum (of string) | No | - | With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. Note that this capability also applies to update operations that lead to resources being removed. |
| - description | No | string | No | - | The description of this resource. Used for informational purposes only, is not processed in any way (and stays with the CloudFormation template, is not passed to the underlying resource, even if it does have a 'description' property). |
| - metadata | No | object | No | - | Metadata associated with the CloudFormation resource. This is not the same as the construct metadata which can be added using construct.addMetadata(), but would not appear in the CloudFormation template automatically. |
| - updatePolicy | No | object | No | In #/definitions/CfnUpdatePolicy | Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AutoScaling::AutoScalingGroup resource. AWS CloudFormation invokes one of three update policies depending on the type of change you make or whether a scheduled action is associated with the Auto Scaling group. |
| - updateReplacePolicy | No | enum (of string) | No | - | Use the UpdateReplacePolicy attribute to retain or (in some cases) backup the existing physical instance of a resource when it is replaced during a stack update operation. |
| - version | No | string | No | - | The version of this resource. Used only for custom CloudFormation resources. |
8.6.7.4.3.6.1.8.23.4.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > condition
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/CfnCondition |
Description: A condition to associate with this resource. This means that only if the condition evaluates to 'true' when the stack is deployed, the resource will be included. This is provided to allow CDK projects to produce legacy templates, but normally there is no need to use it in CDK projects.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - _logicalIdLocked | No | object | No | - | If the logicalId is locked then it can no longer be overridden. This is needed for cases where the logicalId is consumed prior to synthesis (i.e. Stack.exportValue). |
| - _logicalIdOverride | No | object | No | - | An explicit logical ID provided by `overrideLogicalId`. |
| + creationStack | No | array of string | No | - | - |
| - expression | No | object | No | In #/definitions/ICfnConditionExpression | The condition statement. |
| + logicalId | No | string | No | - | The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. |
| + node | No | object | No | Same as node | The tree node. |
| + stack | No | object | No | Same as stack | The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). |
| + synthesizeLogicalId | No | object | No | - | Called during synthesize to render the logical ID of this element. If `overrideLogicalId` was it will be used, otherwise, we will allocate the logical ID through the stack. |
8.6.7.4.3.6.1.8.23.4.1.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > condition > _logicalIdLocked
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
Description: If the logicalId is locked then it can no longer be overridden. This is needed for cases where the logicalId is consumed prior to synthesis (i.e. Stack.exportValue).
8.6.7.4.3.6.1.8.23.4.1.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > condition > _logicalIdOverride
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
Description: An explicit logical ID provided by overrideLogicalId.
8.6.7.4.3.6.1.8.23.4.1.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > condition > creationStack
| Type | array of string |
| Required | Yes |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| creationStack items | - |
8.6.7.4.3.6.1.8.23.4.1.3.1. root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > condition > creationStack > creationStack items
| Type | string |
| Required | No |
8.6.7.4.3.6.1.8.23.4.1.4. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > condition > expression
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/ICfnConditionExpression |
Description: The condition statement.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + creationStack | No | array of string | No | - | The creation stack of this resolvable which will be appended to errors thrown during resolution. This may return an array with a single informational element indicating how to get this property populated, if it was skipped for performance reasons. |
| - typeHint | No | enum (of string) | No | - | The type that this token will likely resolve to. |
8.6.7.4.3.6.1.8.23.4.1.4.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > condition > expression > creationStack
| Type | array of string |
| Required | Yes |
Description: The creation stack of this resolvable which will be appended to errors thrown during resolution.
This may return an array with a single informational element indicating how to get this property populated, if it was skipped for performance reasons.
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| creationStack items | - |
8.6.7.4.3.6.1.8.23.4.1.4.1.1. root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > condition > expression > creationStack > creationStack items
| Type | string |
| Required | No |
8.6.7.4.3.6.1.8.23.4.1.4.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > condition > expression > typeHint
| Type | enum (of string) |
| Required | No |
Description: The type that this token will likely resolve to.
Must be one of: * "number" * "string" * "string-list"
8.6.7.4.3.6.1.8.23.4.1.5. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > condition > logicalId
| Type | string |
| Required | Yes |
Description: The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId).
8.6.7.4.3.6.1.8.23.4.1.6. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > condition > node
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | node |
Description: The tree node.
8.6.7.4.3.6.1.8.23.4.1.7. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > condition > stack
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | stack |
Description: The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly).
8.6.7.4.3.6.1.8.23.4.1.8. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > condition > synthesizeLogicalId
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Called during synthesize to render the logical ID of this element. If
overrideLogicalId was it will be used, otherwise, we will allocate the
logical ID through the stack.
8.6.7.4.3.6.1.8.23.4.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > creationPolicy
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/CfnCreationPolicy |
Description: Associate the CreationPolicy attribute with a resource to prevent its status from reaching create complete until AWS CloudFormation receives a specified number of success signals or the timeout period is exceeded. To signal a resource, you can use the cfn-signal helper script or SignalResource API. AWS CloudFormation publishes valid signals to the stack events so that you track the number of signals sent.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - autoScalingCreationPolicy | No | object | No | In #/definitions/CfnResourceAutoScalingCreationPolicy | For an Auto Scaling group replacement update, specifies how many instances must signal success for the update to succeed. |
| - resourceSignal | No | object | No | In #/definitions/CfnResourceSignal | When AWS CloudFormation creates the associated resource, configures the number of required success signals and the length of time that AWS CloudFormation waits for those signals. |
| - startFleet | No | boolean | No | - | For an AppStream Fleet creation, specifies that the fleet is started after creation. |
8.6.7.4.3.6.1.8.23.4.2.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > creationPolicy > autoScalingCreationPolicy
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/CfnResourceAutoScalingCreationPolicy |
Description: For an Auto Scaling group replacement update, specifies how many instances must signal success for the update to succeed.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - minSuccessfulInstancesPercent | No | number | No | - | Specifies the percentage of instances in an Auto Scaling replacement update that must signal success for the update to succeed. You can specify a value from 0 to 100. AWS CloudFormation rounds to the nearest tenth of a percent. For example, if you update five instances with a minimum successful percentage of 50, three instances must signal success. If an instance doesn't send a signal within the time specified by the Timeout property, AWS CloudFormation assumes that the instance wasn't created. |
8.6.7.4.3.6.1.8.23.4.2.1.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > creationPolicy > autoScalingCreationPolicy > minSuccessfulInstancesPercent
| Type | number |
| Required | No |
Description: Specifies the percentage of instances in an Auto Scaling replacement update that must signal success for the update to succeed. You can specify a value from 0 to 100. AWS CloudFormation rounds to the nearest tenth of a percent. For example, if you update five instances with a minimum successful percentage of 50, three instances must signal success. If an instance doesn't send a signal within the time specified by the Timeout property, AWS CloudFormation assumes that the instance wasn't created.
8.6.7.4.3.6.1.8.23.4.2.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > creationPolicy > resourceSignal
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/CfnResourceSignal |
Description: When AWS CloudFormation creates the associated resource, configures the number of required success signals and the length of time that AWS CloudFormation waits for those signals.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - count | No | number | No | - | The number of success signals AWS CloudFormation must receive before it sets the resource status as CREATE_COMPLETE. If the resource receives a failure signal or doesn't receive the specified number of signals before the timeout period expires, the resource creation fails and AWS CloudFormation rolls the stack back. |
| - timeout | No | string | No | - | The length of time that AWS CloudFormation waits for the number of signals that was specified in the Count property. The timeout period starts after AWS CloudFormation starts creating the resource, and the timeout expires no sooner than the time you specify but can occur shortly thereafter. The maximum time that you can specify is 12 hours. |
8.6.7.4.3.6.1.8.23.4.2.2.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > creationPolicy > resourceSignal > count
| Type | number |
| Required | No |
Description: The number of success signals AWS CloudFormation must receive before it sets the resource status as CREATE_COMPLETE. If the resource receives a failure signal or doesn't receive the specified number of signals before the timeout period expires, the resource creation fails and AWS CloudFormation rolls the stack back.
8.6.7.4.3.6.1.8.23.4.2.2.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > creationPolicy > resourceSignal > timeout
| Type | string |
| Required | No |
Description: The length of time that AWS CloudFormation waits for the number of signals that was specified in the Count property. The timeout period starts after AWS CloudFormation starts creating the resource, and the timeout expires no sooner than the time you specify but can occur shortly thereafter. The maximum time that you can specify is 12 hours.
8.6.7.4.3.6.1.8.23.4.2.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > creationPolicy > startFleet
| Type | boolean |
| Required | No |
Description: For an AppStream Fleet creation, specifies that the fleet is started after creation.
8.6.7.4.3.6.1.8.23.4.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > deletionPolicy
| Type | enum (of string) |
| Required | No |
Description: With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. Note that this capability also applies to update operations that lead to resources being removed.
Must be one of: * "Delete" * "Retain" * "RetainExceptOnCreate" * "Snapshot"
8.6.7.4.3.6.1.8.23.4.4. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > description
| Type | string |
| Required | No |
Description: The description of this resource. Used for informational purposes only, is not processed in any way (and stays with the CloudFormation template, is not passed to the underlying resource, even if it does have a 'description' property).
8.6.7.4.3.6.1.8.23.4.5. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > metadata
| Type | object |
| Required | No |
| Additional properties | Each additional property must conform to the schema |
Description: Metadata associated with the CloudFormation resource. This is not the same as the construct metadata which can be added using construct.addMetadata(), but would not appear in the CloudFormation template automatically.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | - | - |
8.6.7.4.3.6.1.8.23.4.5.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > metadata > additionalProperties
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
8.6.7.4.3.6.1.8.23.4.6. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > updatePolicy
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/CfnUpdatePolicy |
Description: Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AutoScaling::AutoScalingGroup resource. AWS CloudFormation invokes one of three update policies depending on the type of change you make or whether a scheduled action is associated with the Auto Scaling group.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - autoScalingReplacingUpdate | No | object | No | In #/definitions/CfnAutoScalingReplacingUpdate | Specifies whether an Auto Scaling group and the instances it contains are replaced during an update. During replacement, AWS CloudFormation retains the old group until it finishes creating the new one. If the update fails, AWS CloudFormation can roll back to the old Auto Scaling group and delete the new Auto Scaling group. |
| - autoScalingRollingUpdate | No | object | No | In #/definitions/CfnAutoScalingRollingUpdate | To specify how AWS CloudFormation handles rolling updates for an Auto Scaling group, use the AutoScalingRollingUpdate policy. Rolling updates enable you to specify whether AWS CloudFormation updates instances that are in an Auto Scaling group in batches or all at once. |
| - autoScalingScheduledAction | No | object | No | In #/definitions/CfnAutoScalingScheduledAction | To specify how AWS CloudFormation handles updates for the MinSize, MaxSize, and DesiredCapacity properties when the AWS::AutoScaling::AutoScalingGroup resource has an associated scheduled action, use the AutoScalingScheduledAction policy. |
| - codeDeployLambdaAliasUpdate | No | object | No | In #/definitions/CfnCodeDeployLambdaAliasUpdate | To perform an AWS CodeDeploy deployment when the version changes on an AWS::Lambda::Alias resource, use the CodeDeployLambdaAliasUpdate update policy. |
| - enableVersionUpgrade | No | boolean | No | - | To upgrade an Amazon ES domain to a new version of Elasticsearch rather than replacing the entire AWS::Elasticsearch::Domain resource, use the EnableVersionUpgrade update policy. |
| - useOnlineResharding | No | boolean | No | - | To modify a replication group's shards by adding or removing shards, rather than replacing the entire AWS::ElastiCache::ReplicationGroup resource, use the UseOnlineResharding update policy. |
8.6.7.4.3.6.1.8.23.4.6.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > updatePolicy > autoScalingReplacingUpdate
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/CfnAutoScalingReplacingUpdate |
Description: Specifies whether an Auto Scaling group and the instances it contains are replaced during an update. During replacement, AWS CloudFormation retains the old group until it finishes creating the new one. If the update fails, AWS CloudFormation can roll back to the old Auto Scaling group and delete the new Auto Scaling group.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - willReplace | No | boolean | No | - | - |
8.6.7.4.3.6.1.8.23.4.6.1.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > updatePolicy > autoScalingReplacingUpdate > willReplace
| Type | boolean |
| Required | No |
8.6.7.4.3.6.1.8.23.4.6.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > updatePolicy > autoScalingRollingUpdate
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/CfnAutoScalingRollingUpdate |
Description: To specify how AWS CloudFormation handles rolling updates for an Auto Scaling group, use the AutoScalingRollingUpdate policy. Rolling updates enable you to specify whether AWS CloudFormation updates instances that are in an Auto Scaling group in batches or all at once.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - maxBatchSize | No | number | No | - | Specifies the maximum number of instances that AWS CloudFormation updates. |
| - minActiveInstancesPercent | No | number | No | - | Specifies the percentage of instances in an Auto Scaling group that must remain in service while AWS CloudFormation updates old instances. You can specify a value from 0 to 100. AWS CloudFormation rounds to the nearest tenth of a percent. For example, if you update five instances with a minimum active percentage of 50, three instances must remain in service. |
| - minInstancesInService | No | number | No | - | Specifies the minimum number of instances that must be in service within the Auto Scaling group while AWS CloudFormation updates old instances. |
| - minSuccessfulInstancesPercent | No | number | No | - | Specifies the percentage of instances in an Auto Scaling rolling update that must signal success for an update to succeed. You can specify a value from 0 to 100. AWS CloudFormation rounds to the nearest tenth of a percent. For example, if you update five instances with a minimum successful percentage of 50, three instances must signal success. If an instance doesn't send a signal within the time specified in the PauseTime property, AWS CloudFormation assumes that the instance wasn't updated. If you specify this property, you must also enable the WaitOnResourceSignals and PauseTime properties. |
| - pauseTime | No | string | No | - | The amount of time that AWS CloudFormation pauses after making a change to a batch of instances to give those instances time to start software applications. For example, you might need to specify PauseTime when scaling up the number of instances in an Auto Scaling group. If you enable the WaitOnResourceSignals property, PauseTime is the amount of time that AWS CloudFormation should wait for the Auto Scaling group to receive the required number of valid signals from added or replaced instances. If the PauseTime is exceeded before the Auto Scaling group receives the required number of signals, the update fails. For best results, specify a time period that gives your applications sufficient time to get started. If the update needs to be rolled back, a short PauseTime can cause the rollback to fail. Specify PauseTime in the ISO8601 duration format (in the format PT#H#M#S, where each # is the number of hours, minutes, and seconds, respectively). The maximum PauseTime is one hour (PT1H). |
| - suspendProcesses | No | array of string | No | - | Specifies the Auto Scaling processes to suspend during a stack update. Suspending processes prevents Auto Scaling from interfering with a stack update. For example, you can suspend alarming so that Auto Scaling doesn't execute scaling policies associated with an alarm. For valid values, see the ScalingProcesses.member.N parameter for the SuspendProcesses action in the Auto Scaling API Reference. |
| - waitOnResourceSignals | No | boolean | No | - | Specifies whether the Auto Scaling group waits on signals from new instances during an update. Use this property to ensure that instances have completed installing and configuring applications before the Auto Scaling group update proceeds. AWS CloudFormation suspends the update of an Auto Scaling group after new EC2 instances are launched into the group. AWS CloudFormation must receive a signal from each new instance within the specified PauseTime before continuing the update. To signal the Auto Scaling group, use the cfn-signal helper script or SignalResource API. To have instances wait for an Elastic Load Balancing health check before they signal success, add a health-check verification by using the cfn-init helper script. For an example, see the verify_instance_health command in the Auto Scaling rolling updates sample template. |
8.6.7.4.3.6.1.8.23.4.6.2.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > updatePolicy > autoScalingRollingUpdate > maxBatchSize
| Type | number |
| Required | No |
Description: Specifies the maximum number of instances that AWS CloudFormation updates.
8.6.7.4.3.6.1.8.23.4.6.2.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > updatePolicy > autoScalingRollingUpdate > minActiveInstancesPercent
| Type | number |
| Required | No |
Description: Specifies the percentage of instances in an Auto Scaling group that must remain in service while AWS CloudFormation updates old instances. You can specify a value from 0 to 100. AWS CloudFormation rounds to the nearest tenth of a percent. For example, if you update five instances with a minimum active percentage of 50, three instances must remain in service.
8.6.7.4.3.6.1.8.23.4.6.2.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > updatePolicy > autoScalingRollingUpdate > minInstancesInService
| Type | number |
| Required | No |
Description: Specifies the minimum number of instances that must be in service within the Auto Scaling group while AWS CloudFormation updates old instances.
8.6.7.4.3.6.1.8.23.4.6.2.4. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > updatePolicy > autoScalingRollingUpdate > minSuccessfulInstancesPercent
| Type | number |
| Required | No |
Description: Specifies the percentage of instances in an Auto Scaling rolling update that must signal success for an update to succeed. You can specify a value from 0 to 100. AWS CloudFormation rounds to the nearest tenth of a percent. For example, if you update five instances with a minimum successful percentage of 50, three instances must signal success.
If an instance doesn't send a signal within the time specified in the PauseTime property, AWS CloudFormation assumes that the instance wasn't updated.
If you specify this property, you must also enable the WaitOnResourceSignals and PauseTime properties.
8.6.7.4.3.6.1.8.23.4.6.2.5. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > updatePolicy > autoScalingRollingUpdate > pauseTime
| Type | string |
| Required | No |
Description: The amount of time that AWS CloudFormation pauses after making a change to a batch of instances to give those instances time to start software applications. For example, you might need to specify PauseTime when scaling up the number of instances in an Auto Scaling group.
If you enable the WaitOnResourceSignals property, PauseTime is the amount of time that AWS CloudFormation should wait for the Auto Scaling group to receive the required number of valid signals from added or replaced instances. If the PauseTime is exceeded before the Auto Scaling group receives the required number of signals, the update fails. For best results, specify a time period that gives your applications sufficient time to get started. If the update needs to be rolled back, a short PauseTime can cause the rollback to fail.
Specify PauseTime in the ISO8601 duration format (in the format PT#H#M#S, where each # is the number of hours, minutes, and seconds, respectively). The maximum PauseTime is one hour (PT1H).
8.6.7.4.3.6.1.8.23.4.6.2.6. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > updatePolicy > autoScalingRollingUpdate > suspendProcesses
| Type | array of string |
| Required | No |
Description: Specifies the Auto Scaling processes to suspend during a stack update. Suspending processes prevents Auto Scaling from interfering with a stack update. For example, you can suspend alarming so that Auto Scaling doesn't execute scaling policies associated with an alarm. For valid values, see the ScalingProcesses.member.N parameter for the SuspendProcesses action in the Auto Scaling API Reference.
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| suspendProcesses items | - |
8.6.7.4.3.6.1.8.23.4.6.2.6.1. root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > updatePolicy > autoScalingRollingUpdate > suspendProcesses > suspendProcesses items
| Type | string |
| Required | No |
8.6.7.4.3.6.1.8.23.4.6.2.7. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > updatePolicy > autoScalingRollingUpdate > waitOnResourceSignals
| Type | boolean |
| Required | No |
Description: Specifies whether the Auto Scaling group waits on signals from new instances during an update. Use this property to ensure that instances have completed installing and configuring applications before the Auto Scaling group update proceeds. AWS CloudFormation suspends the update of an Auto Scaling group after new EC2 instances are launched into the group. AWS CloudFormation must receive a signal from each new instance within the specified PauseTime before continuing the update. To signal the Auto Scaling group, use the cfn-signal helper script or SignalResource API.
To have instances wait for an Elastic Load Balancing health check before they signal success, add a health-check verification by using the cfn-init helper script. For an example, see the verify_instance_health command in the Auto Scaling rolling updates sample template.
8.6.7.4.3.6.1.8.23.4.6.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > updatePolicy > autoScalingScheduledAction
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/CfnAutoScalingScheduledAction |
Description: To specify how AWS CloudFormation handles updates for the MinSize, MaxSize, and DesiredCapacity properties when the AWS::AutoScaling::AutoScalingGroup resource has an associated scheduled action, use the AutoScalingScheduledAction policy.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - ignoreUnmodifiedGroupSizeProperties | No | boolean | No | - | - |
8.6.7.4.3.6.1.8.23.4.6.3.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > updatePolicy > autoScalingScheduledAction > ignoreUnmodifiedGroupSizeProperties
| Type | boolean |
| Required | No |
8.6.7.4.3.6.1.8.23.4.6.4. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > updatePolicy > codeDeployLambdaAliasUpdate
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/CfnCodeDeployLambdaAliasUpdate |
Description: To perform an AWS CodeDeploy deployment when the version changes on an AWS::Lambda::Alias resource, use the CodeDeployLambdaAliasUpdate update policy.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - afterAllowTrafficHook | No | string | No | - | The name of the Lambda function to run after traffic routing completes. |
| + applicationName | No | string | No | - | The name of the AWS CodeDeploy application. |
| - beforeAllowTrafficHook | No | string | No | - | The name of the Lambda function to run before traffic routing starts. |
| + deploymentGroupName | No | string | No | - | The name of the AWS CodeDeploy deployment group. This is where the traffic-shifting policy is set. |
8.6.7.4.3.6.1.8.23.4.6.4.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > updatePolicy > codeDeployLambdaAliasUpdate > afterAllowTrafficHook
| Type | string |
| Required | No |
Description: The name of the Lambda function to run after traffic routing completes.
8.6.7.4.3.6.1.8.23.4.6.4.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > updatePolicy > codeDeployLambdaAliasUpdate > applicationName
| Type | string |
| Required | Yes |
Description: The name of the AWS CodeDeploy application.
8.6.7.4.3.6.1.8.23.4.6.4.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > updatePolicy > codeDeployLambdaAliasUpdate > beforeAllowTrafficHook
| Type | string |
| Required | No |
Description: The name of the Lambda function to run before traffic routing starts.
8.6.7.4.3.6.1.8.23.4.6.4.4. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > updatePolicy > codeDeployLambdaAliasUpdate > deploymentGroupName
| Type | string |
| Required | Yes |
Description: The name of the AWS CodeDeploy deployment group. This is where the traffic-shifting policy is set.
8.6.7.4.3.6.1.8.23.4.6.5. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > updatePolicy > enableVersionUpgrade
| Type | boolean |
| Required | No |
Description: To upgrade an Amazon ES domain to a new version of Elasticsearch rather than replacing the entire AWS::Elasticsearch::Domain resource, use the EnableVersionUpgrade update policy.
8.6.7.4.3.6.1.8.23.4.6.6. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > updatePolicy > useOnlineResharding
| Type | boolean |
| Required | No |
Description: To modify a replication group's shards by adding or removing shards, rather than replacing the entire AWS::ElastiCache::ReplicationGroup resource, use the UseOnlineResharding update policy.
8.6.7.4.3.6.1.8.23.4.7. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > updateReplacePolicy
| Type | enum (of string) |
| Required | No |
Description: Use the UpdateReplacePolicy attribute to retain or (in some cases) backup the existing physical instance of a resource when it is replaced during a stack update operation.
Must be one of: * "Delete" * "Retain" * "RetainExceptOnCreate" * "Snapshot"
8.6.7.4.3.6.1.8.23.4.8. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnOptions > version
| Type | string |
| Required | No |
Description: The version of this resource. Used only for custom CloudFormation resources.
8.6.7.4.3.6.1.8.23.5. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnProperties
| Type | object |
| Required | Yes |
| Additional properties | Each additional property must conform to the schema |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | - | - |
8.6.7.4.3.6.1.8.23.5.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnProperties > additionalProperties
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
8.6.7.4.3.6.1.8.23.6. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > cfnResourceType
| Type | string |
| Required | Yes |
Description: AWS resource type.
8.6.7.4.3.6.1.8.23.7. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > creationStack
| Type | array of string |
| Required | Yes |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| creationStack items | - |
8.6.7.4.3.6.1.8.23.7.1. root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > creationStack > creationStack items
| Type | string |
| Required | No |
8.6.7.4.3.6.1.8.23.8. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > dependsOn
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Logical IDs of dependencies.
Is filled during prepare().
8.6.7.4.3.6.1.8.23.9. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > logicalId
| Type | string |
| Required | Yes |
Description: The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId).
8.6.7.4.3.6.1.8.23.10. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > node
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | node |
Description: The tree node.
8.6.7.4.3.6.1.8.23.11. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > rawOverrides
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: An object to be merged on top of the entire resource definition.
8.6.7.4.3.6.1.8.23.12. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > ref
| Type | string |
| Required | Yes |
Description: Return a string that will be resolved to a CloudFormation { Ref } for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).
8.6.7.4.3.6.1.8.23.13. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > stack
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | stack |
Description: The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly).
8.6.7.4.3.6.1.8.23.14. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > synthesizeLogicalId
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Called during synthesize to render the logical ID of this element. If
overrideLogicalId was it will be used, otherwise, we will allocate the
logical ID through the stack.
8.6.7.4.3.6.1.8.23.15. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > updatedProperites
| Type | object |
| Required | Yes |
| Additional properties | Each additional property must conform to the schema |
Description: Deprecated
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | - | - |
8.6.7.4.3.6.1.8.23.15.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > updatedProperites > additionalProperties
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
8.6.7.4.3.6.1.8.23.16. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > updatedProperties
| Type | object |
| Required | Yes |
| Additional properties | Each additional property must conform to the schema |
Description: Return properties modified after initiation
Resources that expose mutable properties should override this function to collect and return the properties object for this resource.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | - | - |
8.6.7.4.3.6.1.8.23.16.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > nestedStackResource > updatedProperties > additionalProperties
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
8.6.7.4.3.6.1.8.24. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > node
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | node |
Description: The tree node.
8.6.7.4.3.6.1.8.25. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > notificationArns
| Type | array of string |
| Required | Yes |
Description: Returns the list of notification Amazon Resource Names (ARNs) for the current stack.
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| notificationArns items | - |
8.6.7.4.3.6.1.8.25.1. root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > notificationArns > notificationArns items
| Type | string |
| Required | No |
8.6.7.4.3.6.1.8.26. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > parseEnvironment
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Determine the various stack environment attributes.
8.6.7.4.3.6.1.8.27. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > partition
| Type | string |
| Required | Yes |
Description: The partition in which this stack is defined
8.6.7.4.3.6.1.8.28. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > permissionsBoundaryArn
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: If a permissions boundary has been applied on this scope or any parent scope then this will return the ARN of the permissions boundary.
This will return the permissions boundary that has been applied to the most specific scope.
For example:
const stage = new Stage(app, 'stage', { permissionsBoundary: PermissionsBoundary.fromName('stage-pb'), });
const stack = new Stack(stage, 'Stack', { permissionsBoundary: PermissionsBoundary.fromName('some-other-pb'), });
Stack.permissionsBoundaryArn === 'arn:${AWS::Partition}:iam::${AWS::AccountId}:policy/some-other-pb';
8.6.7.4.3.6.1.8.29. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > region
| Type | string |
| Required | Yes |
Description: The AWS region into which this stack will be deployed (e.g. us-west-2).
This value is resolved according to the following rules:
- The value provided to
env.regionwhen the stack is defined. This can either be a concrete region (e.g.us-west-2) or theAws.REGIONtoken. Aws.REGION, which is represents the CloudFormation intrinsic reference{ "Ref": "AWS::Region" }encoded as a string token.
Preferably, you should use the return value as an opaque string and not
attempt to parse it to implement your logic. If you do, you must first
check that it is a concrete value an not an unresolved token. If this
value is an unresolved token (Token.isUnresolved(stack.region) returns
true), this implies that the user wishes that this stack will synthesize
into a region-agnostic template. In this case, your code should either
fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or
implement some other region-agnostic behavior.
8.6.7.4.3.6.1.8.30. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > resolveExportedValue
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.3.6.1.8.31. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > stackDependencyReasons
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Check whether this stack has a (transitive) dependency on another stack
Returns the list of reasons on the dependency path, or undefined if there is no dependency.
8.6.7.4.3.6.1.8.32. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > stackId
| Type | string |
| Required | Yes |
Description: The ID of the stack
8.6.7.4.3.6.1.8.33. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > stackName
| Type | string |
| Required | Yes |
Description: The concrete CloudFormation physical stack name.
This is either the name defined explicitly in the stackName prop or
allocated based on the stack's location in the construct tree. Stacks that
are directly defined under the app use their construct id as their stack
name. Stacks that are defined deeper within the tree will use a hashed naming
scheme based on the construct path to ensure uniqueness.
If you wish to obtain the deploy-time AWS::StackName intrinsic,
you can use Aws.STACK_NAME directly.
8.6.7.4.3.6.1.8.34. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > synthesizer
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/IStackSynthesizer |
Description: Synthesis method for this stack
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - bootstrapQualifier | No | string | No | - | The qualifier used to bootstrap this stack |
| - lookupRole | No | string | No | - | The role used to lookup for this stack |
8.6.7.4.3.6.1.8.34.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > synthesizer > bootstrapQualifier
| Type | string |
| Required | No |
| Default | "- no qualifier" |
Description: The qualifier used to bootstrap this stack
8.6.7.4.3.6.1.8.34.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > synthesizer > lookupRole
| Type | string |
| Required | No |
| Default | "- no role" |
Description: The role used to lookup for this stack
8.6.7.4.3.6.1.8.35. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > tags
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/TagManager |
Description: Tags to be applied to the stack.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + _setTag | No | object | No | - | - |
| + didHaveInitialTags | No | object | No | - | - |
| - dynamicTags | No | object | No | - | - |
| + externalTagPriority | No | object | No | - | - |
| + parseExternalTags | No | object | No | - | Parse external tags. Set the parseable ones into this tag manager. Save the rest (tokens, lazies) in `this.dynamicTags`. |
| + priorities | No | object | No | - | - |
| + renderedTags | No | object | No | In #/definitions/IResolvable | A lazy value that represents the rendered tags at synthesis time If you need to make a custom construct taggable, use the value of this property to pass to the `tags` property of the underlying construct. |
| + resourceTypeName | No | object | No | - | - |
| + sortedTags | No | object | No | - | - |
| + tagFormatter | No | object | No | - | - |
| + tagPropertyName | No | string | No | - | The property name for tag values Normally this is `tags` but some resources choose a different name. Cognito UserPool uses UserPoolTags |
| + tags | No | object | No | - | - |
8.6.7.4.3.6.1.8.35.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > tags > _setTag
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.3.6.1.8.35.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > tags > didHaveInitialTags
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.3.6.1.8.35.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > tags > dynamicTags
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
8.6.7.4.3.6.1.8.35.4. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > tags > externalTagPriority
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.3.6.1.8.35.5. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > tags > parseExternalTags
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Parse external tags.
Set the parseable ones into this tag manager. Save the rest (tokens, lazies) in this.dynamicTags.
8.6.7.4.3.6.1.8.35.6. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > tags > priorities
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.3.6.1.8.35.7. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > tags > renderedTags
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/IResolvable |
Description: A lazy value that represents the rendered tags at synthesis time
If you need to make a custom construct taggable, use the value of this
property to pass to the tags property of the underlying construct.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + creationStack | No | array of string | No | - | The creation stack of this resolvable which will be appended to errors thrown during resolution. This may return an array with a single informational element indicating how to get this property populated, if it was skipped for performance reasons. |
| - typeHint | No | enum (of string) | No | - | The type that this token will likely resolve to. |
8.6.7.4.3.6.1.8.35.7.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > tags > renderedTags > creationStack
| Type | array of string |
| Required | Yes |
Description: The creation stack of this resolvable which will be appended to errors thrown during resolution.
This may return an array with a single informational element indicating how to get this property populated, if it was skipped for performance reasons.
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| creationStack items | - |
8.6.7.4.3.6.1.8.35.7.1.1. root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > tags > renderedTags > creationStack > creationStack items
| Type | string |
| Required | No |
8.6.7.4.3.6.1.8.35.7.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > tags > renderedTags > typeHint
| Type | enum (of string) |
| Required | No |
Description: The type that this token will likely resolve to.
Must be one of: * "number" * "string" * "string-list"
8.6.7.4.3.6.1.8.35.8. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > tags > resourceTypeName
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.3.6.1.8.35.9. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > tags > sortedTags
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.3.6.1.8.35.10. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > tags > tagFormatter
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.3.6.1.8.35.11. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > tags > tagPropertyName
| Type | string |
| Required | Yes |
Description: The property name for tag values
Normally this is tags but some resources choose a different name. Cognito
UserPool uses UserPoolTags
8.6.7.4.3.6.1.8.35.12. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > tags > tags
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.3.6.1.8.36. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > templateFile
| Type | string |
| Required | Yes |
Description: The name of the CloudFormation template file emitted to the output directory during synthesis.
Example value: MyStack.template.json
8.6.7.4.3.6.1.8.37. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > templateOptions
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/ITemplateOptions |
Description: Options for CloudFormation template (like version, transform, description).
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - description | No | string | No | - | Gets or sets the description of this stack. If provided, it will be included in the CloudFormation template's "Description" attribute. |
| - metadata | No | object | No | - | Metadata associated with the CloudFormation template. |
| - templateFormatVersion | No | string | No | - | Gets or sets the AWSTemplateFormatVersion field of the CloudFormation template. |
| - transforms | No | array of string | No | - | Gets or sets the top-level template transform(s) for this stack (e.g. `["AWS::Serverless-2016-10-31"]`). |
8.6.7.4.3.6.1.8.37.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > templateOptions > description
| Type | string |
| Required | No |
Description: Gets or sets the description of this stack. If provided, it will be included in the CloudFormation template's "Description" attribute.
8.6.7.4.3.6.1.8.37.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > templateOptions > metadata
| Type | object |
| Required | No |
| Additional properties | Each additional property must conform to the schema |
Description: Metadata associated with the CloudFormation template.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | - | - |
8.6.7.4.3.6.1.8.37.2.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > templateOptions > metadata > additionalProperties
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
8.6.7.4.3.6.1.8.37.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > templateOptions > templateFormatVersion
| Type | string |
| Required | No |
Description: Gets or sets the AWSTemplateFormatVersion field of the CloudFormation template.
8.6.7.4.3.6.1.8.37.4. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > templateOptions > transforms
| Type | array of string |
| Required | No |
Description: Gets or sets the top-level template transform(s) for this stack (e.g. ["AWS::Serverless-2016-10-31"]).
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| transforms items | - |
8.6.7.4.3.6.1.8.37.4.1. root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > templateOptions > transforms > transforms items
| Type | string |
| Required | No |
8.6.7.4.3.6.1.8.38. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > terminationProtection
| Type | boolean |
| Required | Yes |
Description: Whether termination protection is enabled for this stack.
8.6.7.4.3.6.1.8.39. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > stack > urlSuffix
| Type | string |
| Required | Yes |
Description: The Amazon domain suffix for the region in which this stack is defined
8.6.7.4.3.6.1.9. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > securityGroups > securityGroups items > uniqueId
| Type | string |
| Required | Yes |
Description: A unique identifier for this connection peer
8.6.7.4.3.7. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _connections > skip
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: When doing bidirectional grants between Connections, make sure we don't recursive infinitely
8.6.7.4.4. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _currentVersion
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
8.6.7.4.5. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _functionUrlInvocationGrants
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
| Defined in | #/definitions/Record%3Cstring%2CGrant%3E |
Description: Mapping of function URL invocation principals to grants. Used to de-dupe grantInvokeUrl() calls.
8.6.7.4.6. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _hasAddedArrayTokenStatements
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Track whether we've added statements with array token resources to the role's default policy
8.6.7.4.7. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _hasAddedLiteralStatements
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Track whether we've added statements with literal resources to the role's default policy
8.6.7.4.8. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _invocationGrants
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
| Same definition as | _functionUrlInvocationGrants |
Description: Mapping of invocation principals to grants. Used to de-dupe grantInvoke() calls.
8.6.7.4.9. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _latestVersion
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
8.6.7.4.10. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _layers
| Type | array |
| Required | Yes |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| ILayerVersion | - |
8.6.7.4.10.1. root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _layers > ILayerVersion
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/ILayerVersion |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - compatibleRuntimes | No | array | No | - | The runtimes compatible with this Layer. |
| + env | No | object | No | Same as env | The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. |
| + layerVersionArn | No | string | No | - | The ARN of the Lambda Layer version that this Layer defines. |
| + layerVersionRef | No | object | No | In #/definitions/LayerVersionReference | A reference to a LayerVersion resource. |
| + node | No | object | No | Same as node | The tree node. |
| + stack | No | object | No | Same as stack | The stack in which this resource is defined. |
8.6.7.4.10.1.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _layers > _layers items > compatibleRuntimes
| Type | array |
| Required | No |
| Default | "- All supported runtimes. Setting this to Runtime.ALL is equivalent to leaving it undefined." |
Description: The runtimes compatible with this Layer.
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| Runtime | Lambda function runtime environment. ... |
8.6.7.4.10.1.1.1. root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _layers > _layers items > compatibleRuntimes > Runtime
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/Runtime |
Description: Lambda function runtime environment.
If you need to use a runtime name that doesn't exist as a static member, you
can instantiate a Runtime object, e.g: new Runtime('nodejs99.99').
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + bundlingImage | No | object | No | In #/definitions/DockerImage | The bundling Docker image for this runtime. |
| - family | No | enum (of integer) | No | - | The runtime family. |
| + isVariable | No | boolean | No | - | Enabled for runtime enums that always target the latest available. |
| + name | No | string | No | - | The name of this runtime, as expected by the Lambda resource. |
| + supportsCodeGuruProfiling | No | boolean | No | - | Whether this runtime is integrated with and supported for profiling using Amazon CodeGuru Profiler. |
| + supportsInlineCode | No | boolean | No | - | Whether the ``ZipFile`` (aka inline code) property can be used with this runtime. |
| + supportsSnapStart | No | boolean | No | - | Whether this runtime supports snapstart. |
8.6.7.4.10.1.1.1.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _layers > _layers items > compatibleRuntimes > compatibleRuntimes items > bundlingImage
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/DockerImage |
Description: The bundling Docker image for this runtime.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + image | No | string | No | - | The Docker image |
8.6.7.4.10.1.1.1.1.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _layers > _layers items > compatibleRuntimes > compatibleRuntimes items > bundlingImage > image
| Type | string |
| Required | Yes |
Description: The Docker image
8.6.7.4.10.1.1.1.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _layers > _layers items > compatibleRuntimes > compatibleRuntimes items > family
| Type | enum (of integer) |
| Required | No |
Description: The runtime family.
Must be one of: * 0 * 1 * 2 * 3 * 4 * 5 * 6
8.6.7.4.10.1.1.1.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _layers > _layers items > compatibleRuntimes > compatibleRuntimes items > isVariable
| Type | boolean |
| Required | Yes |
Description: Enabled for runtime enums that always target the latest available.
8.6.7.4.10.1.1.1.4. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _layers > _layers items > compatibleRuntimes > compatibleRuntimes items > name
| Type | string |
| Required | Yes |
Description: The name of this runtime, as expected by the Lambda resource.
8.6.7.4.10.1.1.1.5. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _layers > _layers items > compatibleRuntimes > compatibleRuntimes items > supportsCodeGuruProfiling
| Type | boolean |
| Required | Yes |
Description: Whether this runtime is integrated with and supported for profiling using Amazon CodeGuru Profiler.
8.6.7.4.10.1.1.1.6. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _layers > _layers items > compatibleRuntimes > compatibleRuntimes items > supportsInlineCode
| Type | boolean |
| Required | Yes |
Description: Whether the ZipFile (aka inline code) property can be used with this
runtime.
8.6.7.4.10.1.1.1.7. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _layers > _layers items > compatibleRuntimes > compatibleRuntimes items > supportsSnapStart
| Type | boolean |
| Required | Yes |
Description: Whether this runtime supports snapstart.
8.6.7.4.10.1.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _layers > _layers items > env
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | env |
Description: The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
8.6.7.4.10.1.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _layers > _layers items > layerVersionArn
| Type | string |
| Required | Yes |
Description: The ARN of the Lambda Layer version that this Layer defines.
8.6.7.4.10.1.4. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _layers > _layers items > layerVersionRef
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/LayerVersionReference |
Description: A reference to a LayerVersion resource.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + layerVersionArn | No | string | No | - | The LayerVersionArn of the LayerVersion resource. |
8.6.7.4.10.1.4.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _layers > _layers items > layerVersionRef > layerVersionArn
| Type | string |
| Required | Yes |
Description: The LayerVersionArn of the LayerVersion resource.
8.6.7.4.10.1.5. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _layers > _layers items > node
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | node |
Description: The tree node.
8.6.7.4.10.1.6. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _layers > _layers items > stack
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | stack |
Description: The stack in which this resource is defined.
8.6.7.4.11. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _logGroup
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
8.6.7.4.12. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _logRetention
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/LogRetention |
Description: Creates a custom resource to control the retention policy of a CloudWatch Logs
log group. The log group is created if it doesn't already exist. The policy
is removed when retentionDays is undefined or equal to Infinity.
Log group can be created in the region that is different from stack region by
specifying logGroupRegion
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + ensureSingletonLogRetentionFunction | No | object | No | - | Helper method to ensure that only one instance of LogRetentionFunction resources are in the stack mimicking the behaviour of aws-cdk-lib/aws-lambda's SingletonFunction to prevent circular dependencies |
| + logGroupArn | No | string | No | - | The ARN of the LogGroup. |
| + node | No | object | No | Same as node | The tree node. |
8.6.7.4.12.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _logRetention > ensureSingletonLogRetentionFunction
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Helper method to ensure that only one instance of LogRetentionFunction resources are in the stack mimicking the behaviour of aws-cdk-lib/aws-lambda's SingletonFunction to prevent circular dependencies
8.6.7.4.12.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _logRetention > logGroupArn
| Type | string |
| Required | Yes |
Description: The ARN of the LogGroup.
8.6.7.4.12.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _logRetention > node
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | node |
Description: The tree node.
8.6.7.4.13. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _physicalName
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.14. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _policyCounter
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: The number of permissions added to this function
8.6.7.4.15. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _skipPermissions
| Type | boolean |
| Required | No |
Description: Whether the user decides to skip adding permissions. The only use case is for cross-account, imported lambdas where the user commits to modifying the permisssions on the imported lambda outside CDK.
8.6.7.4.16. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > _warnIfCurrentVersionCalled
| Type | boolean |
| Required | Yes |
Description: Flag to delay adding a warning message until current version is invoked.
8.6.7.4.17. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > architecture
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/Architecture |
Description: The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64).
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + dockerPlatform | No | string | No | - | The platform to use for this architecture when building with Docker. |
| + name | No | string | No | - | The name of the architecture as recognized by the AWS Lambda service APIs. |
8.6.7.4.17.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > architecture > dockerPlatform
| Type | string |
| Required | Yes |
Description: The platform to use for this architecture when building with Docker.
8.6.7.4.17.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > architecture > name
| Type | string |
| Required | Yes |
Description: The name of the architecture as recognized by the AWS Lambda service APIs.
8.6.7.4.18. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > buildDeadLetterConfig
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.19. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > buildDeadLetterQueue
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.20. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > buildTracingConfig
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.21. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > canCreatePermissions
| Type | const |
| Required | Yes |
| Default | true |
Description: Whether the addPermission() call adds any permissions
True for new Lambdas, false for version $LATEST and imported Lambdas from different accounts.
Specific value: true
8.6.7.4.22. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > configureAdotInstrumentation
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Add an AWS Distro for OpenTelemetry Lambda layer.
8.6.7.4.23. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > configureLambdaInsights
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Configured lambda insights on the function if specified. This is achieved by adding an imported layer which is added to the list of lambda layers on synthesis.
https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights-extension-versions.html
8.6.7.4.24. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > configureParamsAndSecretsExtension
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Add a Parameters and Secrets Extension Lambda layer.
8.6.7.4.25. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > configureSnapStart
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.26. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > configureVpc
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: If configured, set up the VPC-related properties
Returns the VpcConfig that should be added to the Lambda creation properties.
8.6.7.4.27. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > connections
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | _connections |
Description: Access the Connections object
Will fail if not a VPC-enabled Lambda Function
8.6.7.4.28. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/Version |
Description: Returns a lambda.Version which represents the current version of this
Lambda function. A new version will be created every time the function's
configuration changes.
You can specify options for this version using the currentVersionOptions
prop when initializing the lambda.Function.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + _allowCrossEnvironment | No | object | No | - | - |
| - _connections | No | object | No | Same as _connections | Actual connections object for this Lambda May be unset, in which case this Lambda is not configured use in a VPC. |
| + _functionUrlInvocationGrants | No | object | No | Same as _functionUrlInvocationGrants | Mapping of function URL invocation principals to grants. Used to de-dupe `grantInvokeUrl()` calls. |
| + _hasAddedArrayTokenStatements | No | object | No | - | Track whether we've added statements with array token resources to the role's default policy |
| + _hasAddedLiteralStatements | No | object | No | - | Track whether we've added statements with literal resources to the role's default policy |
| + _invocationGrants | No | object | No | Same as _functionUrlInvocationGrants | Mapping of invocation principals to grants. Used to de-dupe `grantInvoke()` calls. |
| - _latestVersion | No | object | No | - | - |
| + _physicalName | No | object | No | - | - |
| + _policyCounter | No | object | No | - | The number of permissions added to this function |
| - _skipPermissions | No | boolean | No | - | Whether the user decides to skip adding permissions. The only use case is for cross-account, imported lambdas where the user commits to modifying the permisssions on the imported lambda outside CDK. |
| + _warnIfCurrentVersionCalled | No | boolean | No | - | Flag to delay adding a warning message until current version is invoked. |
| + architecture | No | object | No | Same as architecture | The architecture of this Lambda Function. |
| + canCreatePermissions | No | const | No | - | Whether the addPermission() call adds any permissions True for new Lambdas, false for version $LATEST and imported Lambdas from different accounts. |
| + connections | No | object | No | Same as _connections | Access the Connections object Will fail if not a VPC-enabled Lambda Function |
| + determineProvisionedConcurrency | No | object | No | - | Validate that the provisionedConcurrentExecutions makes sense Member must have value greater than or equal to 1 |
| + edgeArn | No | string | No | - | The ARN of the version for Lambda@Edge. |
| + env | No | object | No | Same as env | The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. |
| + functionArn | No | string | No | - | The ARN fo the function. |
| + functionName | No | string | No | - | The name of the function. |
| + functionRef | No | object | No | In #/definitions/FunctionReference | A reference to a Function resource. |
| + grant | No | object | No | - | - |
| + grantPrincipal | No | object | No | In #/definitions/IPrincipal | The principal this Lambda Function is running as |
| + isBoundToVpc | No | boolean | No | - | Whether or not this Lambda function was bound to a VPC If this is is `false`, trying to access the `connections` object will fail. |
| + isPrincipalWithConditions | No | object | No | - | - |
| + lambda | No | object | No | In #/definitions/IFunction | The underlying `IFunction` |
| + latestVersion | No | object | No | Same as latestVersion | The `$LATEST` version of this function. Note that this is reference to a non-specific AWS Lambda version, which means the function this version refers to can return different results in different invocations. To obtain a reference to an explicit version which references the current function configuration, use `lambdaFunction.currentVersion` instead. |
| + node | No | object | No | Same as node | The tree node. |
| + parsePermissionPrincipal | No | object | No | - | Translate IPrincipal to something we can pass to AWS::Lambda::Permissions Do some nasty things because `Permission` supports a subset of what the full IAM principal language supports, and we may not be able to parse strings outright because they may be tokens. Try to recognize some specific Principal classes first, then try a generic fallback. |
| + permissionsNode | No | object | No | Same as node | The construct node where permissions are attached. |
| + physicalName | No | string | No | - | Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource. This value will resolve to one of the following: - a concrete value (e.g. `"my-awesome-bucket"`) - `undefined`, when a name should be generated by CloudFormation - a concrete name generated automatically during synthesis, in cross-environment scenarios. |
| + qualifier | No | string | No | - | The qualifier of the version or alias of this function. A qualifier is the identifier that's appended to a version or alias ARN. |
| + resourceArnsForGrantInvoke | No | array of string | No | - | The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke() |
| - role | No | object | No | Same as role | The IAM role associated with this function. Undefined if the function was imported without a role. |
| + stack | No | object | No | Same as stack | The stack in which this resource is defined. |
| + statementHasArrayTokens | No | object | No | - | Check if a policy statement contains array tokens that would cause CloudFormation resolution conflicts when mixed with literal arrays in the same policy document. Array tokens are created by CloudFormation intrinsic functions that return arrays, such as Fn::Split, Fn::GetAZs, etc. These cannot be safely merged with literal resource arrays due to CloudFormation's token resolution limitations. Individual string tokens within literal arrays (e.g., `["arn:${token}:..."]`) are safe and do not cause conflicts, so they are not detected by this method. |
| + validateConditionCombinations | No | object | No | - | - |
| + validateConditions | No | object | No | - | - |
| + version | No | string | No | - | The most recently deployed version of this function. |
| + versionRef | No | object | No | Same as versionRef | A reference to a Version resource. |
8.6.7.4.28.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > _allowCrossEnvironment
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.28.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > _connections
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | _connections |
Description: Actual connections object for this Lambda
May be unset, in which case this Lambda is not configured use in a VPC.
8.6.7.4.28.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > _functionUrlInvocationGrants
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
| Same definition as | _functionUrlInvocationGrants |
Description: Mapping of function URL invocation principals to grants. Used to de-dupe grantInvokeUrl() calls.
8.6.7.4.28.4. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > _hasAddedArrayTokenStatements
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Track whether we've added statements with array token resources to the role's default policy
8.6.7.4.28.5. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > _hasAddedLiteralStatements
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Track whether we've added statements with literal resources to the role's default policy
8.6.7.4.28.6. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > _invocationGrants
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
| Same definition as | _functionUrlInvocationGrants |
Description: Mapping of invocation principals to grants. Used to de-dupe grantInvoke() calls.
8.6.7.4.28.7. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > _latestVersion
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
8.6.7.4.28.8. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > _physicalName
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.28.9. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > _policyCounter
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: The number of permissions added to this function
8.6.7.4.28.10. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > _skipPermissions
| Type | boolean |
| Required | No |
Description: Whether the user decides to skip adding permissions. The only use case is for cross-account, imported lambdas where the user commits to modifying the permisssions on the imported lambda outside CDK.
8.6.7.4.28.11. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > _warnIfCurrentVersionCalled
| Type | boolean |
| Required | Yes |
Description: Flag to delay adding a warning message until current version is invoked.
8.6.7.4.28.12. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > architecture
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | architecture |
Description: The architecture of this Lambda Function.
8.6.7.4.28.13. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > canCreatePermissions
| Type | const |
| Required | Yes |
| Default | true |
Description: Whether the addPermission() call adds any permissions
True for new Lambdas, false for version $LATEST and imported Lambdas from different accounts.
Specific value: true
8.6.7.4.28.14. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > connections
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | _connections |
Description: Access the Connections object
Will fail if not a VPC-enabled Lambda Function
8.6.7.4.28.15. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > determineProvisionedConcurrency
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Validate that the provisionedConcurrentExecutions makes sense
Member must have value greater than or equal to 1
8.6.7.4.28.16. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > edgeArn
| Type | string |
| Required | Yes |
Description: The ARN of the version for Lambda@Edge.
8.6.7.4.28.17. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > env
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | env |
Description: The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
8.6.7.4.28.18. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > functionArn
| Type | string |
| Required | Yes |
Description: The ARN fo the function.
8.6.7.4.28.19. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > functionName
| Type | string |
| Required | Yes |
Description: The name of the function.
8.6.7.4.28.20. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > functionRef
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/FunctionReference |
Description: A reference to a Function resource.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + functionArn | No | string | No | - | The ARN of the Function resource. |
| + functionName | No | string | No | - | The FunctionName of the Function resource. |
8.6.7.4.28.20.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > functionRef > functionArn
| Type | string |
| Required | Yes |
Description: The ARN of the Function resource.
8.6.7.4.28.20.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > functionRef > functionName
| Type | string |
| Required | Yes |
Description: The FunctionName of the Function resource.
8.6.7.4.28.21. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > grant
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.28.22. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > grantPrincipal
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/IPrincipal |
Description: The principal this Lambda Function is running as
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + assumeRoleAction | No | string | No | - | When this Principal is used in an AssumeRole policy, the action to use. |
| + grantPrincipal | No | object | No | Same as grantPrincipal | The principal to grant permissions to |
| + policyFragment | No | object | No | In #/definitions/PrincipalPolicyFragment | Return the policy fragment that identifies this principal in a Policy. |
| - principalAccount | No | string | No | - | The AWS account ID of this principal. Can be undefined when the account is not known (for example, for service principals). Can be a Token - in that case, it's assumed to be AWS::AccountId. |
8.6.7.4.28.22.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > grantPrincipal > assumeRoleAction
| Type | string |
| Required | Yes |
Description: When this Principal is used in an AssumeRole policy, the action to use.
8.6.7.4.28.22.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > grantPrincipal > grantPrincipal
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | grantPrincipal |
Description: The principal to grant permissions to
8.6.7.4.28.22.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > grantPrincipal > policyFragment
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/PrincipalPolicyFragment |
Description: Return the policy fragment that identifies this principal in a Policy.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + conditions | No | object | No | In #/definitions/Conditions | The conditions under which the policy is in effect. See the IAM documentation. |
| + principalJson | No | object | No | - | - |
8.6.7.4.28.22.3.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > grantPrincipal > policyFragment > conditions
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
| Defined in | #/definitions/Conditions |
Description: The conditions under which the policy is in effect. See the IAM documentation.
8.6.7.4.28.22.3.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > grantPrincipal > policyFragment > principalJson
| Type | object |
| Required | Yes |
| Additional properties | Each additional property must conform to the schema |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | array of string | No | - | - |
8.6.7.4.28.22.3.2.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > grantPrincipal > policyFragment > principalJson > additionalProperties
| Type | array of string |
| Required | No |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| additionalProperties items | - |
8.6.7.4.28.22.3.2.1.1. root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > grantPrincipal > policyFragment > principalJson > additionalProperties > additionalProperties items
| Type | string |
| Required | No |
8.6.7.4.28.22.4. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > grantPrincipal > principalAccount
| Type | string |
| Required | No |
Description: The AWS account ID of this principal. Can be undefined when the account is not known (for example, for service principals). Can be a Token - in that case, it's assumed to be AWS::AccountId.
8.6.7.4.28.23. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > isBoundToVpc
| Type | boolean |
| Required | Yes |
Description: Whether or not this Lambda function was bound to a VPC
If this is is false, trying to access the connections object will fail.
8.6.7.4.28.24. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > isPrincipalWithConditions
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.28.25. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/IFunction |
Description: The underlying IFunction
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + architecture | No | object | No | Same as architecture | The system architectures compatible with this lambda function. |
| + connections | No | object | No | Same as _connections | The network connections associated with this resource. |
| + env | No | object | No | Same as env | The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. |
| + functionArn | No | string | No | - | The ARN of the function. |
| + functionName | No | string | No | - | The name of the function. |
| + functionRef | No | object | No | Same as functionRef | A reference to a Function resource. |
| + grantPrincipal | No | object | No | Same as grantPrincipal | The principal to grant permissions to |
| + isBoundToVpc | No | boolean | No | - | Whether or not this Lambda function was bound to a VPC If this is is `false`, trying to access the `connections` object will fail. |
| + latestVersion | No | object | No | In #/definitions/IVersion | The `$LATEST` version of this function. Note that this is reference to a non-specific AWS Lambda version, which means the function this version refers to can return different results in different invocations. To obtain a reference to an explicit version which references the current function configuration, use `lambdaFunction.currentVersion` instead. |
| + node | No | object | No | Same as node | The tree node. |
| + permissionsNode | No | object | No | Same as node | The construct node where permissions are attached. |
| + resourceArnsForGrantInvoke | No | array of string | No | - | The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke(). This property is for cdk modules to consume only. You should not need to use this property. Instead, use grantInvoke() directly. |
| - role | No | object | No | Same as role | The IAM role associated with this function. |
| + stack | No | object | No | Same as stack | The stack in which this resource is defined. |
8.6.7.4.28.25.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > architecture
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | architecture |
Description: The system architectures compatible with this lambda function.
8.6.7.4.28.25.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > connections
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | _connections |
Description: The network connections associated with this resource.
8.6.7.4.28.25.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > env
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | env |
Description: The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
8.6.7.4.28.25.4. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > functionArn
| Type | string |
| Required | Yes |
Description: The ARN of the function.
8.6.7.4.28.25.5. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > functionName
| Type | string |
| Required | Yes |
Description: The name of the function.
8.6.7.4.28.25.6. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > functionRef
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | functionRef |
Description: A reference to a Function resource.
8.6.7.4.28.25.7. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > grantPrincipal
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | grantPrincipal |
Description: The principal to grant permissions to
8.6.7.4.28.25.8. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > isBoundToVpc
| Type | boolean |
| Required | Yes |
Description: Whether or not this Lambda function was bound to a VPC
If this is is false, trying to access the connections object will fail.
8.6.7.4.28.25.9. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/IVersion |
Description: The $LATEST version of this function.
Note that this is reference to a non-specific AWS Lambda version, which means the function this version refers to can return different results in different invocations.
To obtain a reference to an explicit version which references the current
function configuration, use lambdaFunction.currentVersion instead.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + architecture | No | object | No | Same as architecture | The system architectures compatible with this lambda function. |
| + connections | No | object | No | Same as _connections | The network connections associated with this resource. |
| + edgeArn | No | string | No | - | The ARN of the version for Lambda@Edge. |
| + env | No | object | No | Same as env | The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. |
| + functionArn | No | string | No | - | The ARN of the function. |
| + functionName | No | string | No | - | The name of the function. |
| + functionRef | No | object | No | Same as functionRef | A reference to a Function resource. |
| + grantPrincipal | No | object | No | Same as grantPrincipal | The principal to grant permissions to |
| + isBoundToVpc | No | boolean | No | - | Whether or not this Lambda function was bound to a VPC If this is is `false`, trying to access the `connections` object will fail. |
| + lambda | No | object | No | Same as lambda | The underlying AWS Lambda function. |
| + latestVersion | No | object | No | Same as latestVersion | The `$LATEST` version of this function. Note that this is reference to a non-specific AWS Lambda version, which means the function this version refers to can return different results in different invocations. To obtain a reference to an explicit version which references the current function configuration, use `lambdaFunction.currentVersion` instead. |
| + node | No | object | No | Same as node | The tree node. |
| + permissionsNode | No | object | No | Same as node | The construct node where permissions are attached. |
| + resourceArnsForGrantInvoke | No | array of string | No | - | The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke(). This property is for cdk modules to consume only. You should not need to use this property. Instead, use grantInvoke() directly. |
| - role | No | object | No | In #/definitions/IRole | The IAM role associated with this function. |
| + stack | No | object | No | Same as stack | The stack in which this resource is defined. |
| + version | No | string | No | - | The most recently deployed version of this function. |
| + versionRef | No | object | No | In #/definitions/VersionReference | A reference to a Version resource. |
8.6.7.4.28.25.9.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > architecture
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | architecture |
Description: The system architectures compatible with this lambda function.
8.6.7.4.28.25.9.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > connections
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | _connections |
Description: The network connections associated with this resource.
8.6.7.4.28.25.9.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > edgeArn
| Type | string |
| Required | Yes |
Description: The ARN of the version for Lambda@Edge.
8.6.7.4.28.25.9.4. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > env
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | env |
Description: The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
8.6.7.4.28.25.9.5. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > functionArn
| Type | string |
| Required | Yes |
Description: The ARN of the function.
8.6.7.4.28.25.9.6. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > functionName
| Type | string |
| Required | Yes |
Description: The name of the function.
8.6.7.4.28.25.9.7. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > functionRef
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | functionRef |
Description: A reference to a Function resource.
8.6.7.4.28.25.9.8. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > grantPrincipal
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | grantPrincipal |
Description: The principal to grant permissions to
8.6.7.4.28.25.9.9. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > isBoundToVpc
| Type | boolean |
| Required | Yes |
Description: Whether or not this Lambda function was bound to a VPC
If this is is false, trying to access the connections object will fail.
8.6.7.4.28.25.9.10. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > lambda
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | lambda |
Description: The underlying AWS Lambda function.
8.6.7.4.28.25.9.11. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > latestVersion
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | latestVersion |
Description: The $LATEST version of this function.
Note that this is reference to a non-specific AWS Lambda version, which means the function this version refers to can return different results in different invocations.
To obtain a reference to an explicit version which references the current
function configuration, use lambdaFunction.currentVersion instead.
8.6.7.4.28.25.9.12. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > node
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | node |
Description: The tree node.
8.6.7.4.28.25.9.13. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > permissionsNode
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | node |
Description: The construct node where permissions are attached.
8.6.7.4.28.25.9.14. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > resourceArnsForGrantInvoke
| Type | array of string |
| Required | Yes |
Description: The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke().
This property is for cdk modules to consume only. You should not need to use this property. Instead, use grantInvoke() directly.
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| resourceArnsForGrantInvoke items | - |
8.6.7.4.28.25.9.14.1. root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > resourceArnsForGrantInvoke > resourceArnsForGrantInvoke items
| Type | string |
| Required | No |
8.6.7.4.28.25.9.15. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > role
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/IRole |
Description: The IAM role associated with this function.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + assumeRoleAction | No | string | No | - | When this Principal is used in an AssumeRole policy, the action to use. |
| + env | No | object | No | Same as env | The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. |
| + grantPrincipal | No | object | No | Same as grantPrincipal | The principal to grant permissions to |
| + node | No | object | No | Same as node | The tree node. |
| + policyFragment | No | object | No | Same as policyFragment | Return the policy fragment that identifies this principal in a Policy. |
| - principalAccount | No | string | No | - | The AWS account ID of this principal. Can be undefined when the account is not known (for example, for service principals). Can be a Token - in that case, it's assumed to be AWS::AccountId. |
| + roleArn | No | string | No | - | Returns the ARN of this role. |
| + roleName | No | string | No | - | Returns the name of this role. |
| + roleRef | No | object | No | In #/definitions/RoleReference | A reference to a Role resource. |
| + stack | No | object | No | Same as stack | The stack in which this resource is defined. |
8.6.7.4.28.25.9.15.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > role > assumeRoleAction
| Type | string |
| Required | Yes |
Description: When this Principal is used in an AssumeRole policy, the action to use.
8.6.7.4.28.25.9.15.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > role > env
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | env |
Description: The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
8.6.7.4.28.25.9.15.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > role > grantPrincipal
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | grantPrincipal |
Description: The principal to grant permissions to
8.6.7.4.28.25.9.15.4. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > role > node
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | node |
Description: The tree node.
8.6.7.4.28.25.9.15.5. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > role > policyFragment
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | policyFragment |
Description: Return the policy fragment that identifies this principal in a Policy.
8.6.7.4.28.25.9.15.6. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > role > principalAccount
| Type | string |
| Required | No |
Description: The AWS account ID of this principal. Can be undefined when the account is not known (for example, for service principals). Can be a Token - in that case, it's assumed to be AWS::AccountId.
8.6.7.4.28.25.9.15.7. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > role > roleArn
| Type | string |
| Required | Yes |
Description: Returns the ARN of this role.
8.6.7.4.28.25.9.15.8. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > role > roleName
| Type | string |
| Required | Yes |
Description: Returns the name of this role.
8.6.7.4.28.25.9.15.9. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > role > roleRef
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/RoleReference |
Description: A reference to a Role resource.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + roleArn | No | string | No | - | The ARN of the Role resource. |
| + roleName | No | string | No | - | The RoleName of the Role resource. |
8.6.7.4.28.25.9.15.9.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > role > roleRef > roleArn
| Type | string |
| Required | Yes |
Description: The ARN of the Role resource.
8.6.7.4.28.25.9.15.9.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > role > roleRef > roleName
| Type | string |
| Required | Yes |
Description: The RoleName of the Role resource.
8.6.7.4.28.25.9.15.10. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > role > stack
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | stack |
Description: The stack in which this resource is defined.
8.6.7.4.28.25.9.16. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > stack
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | stack |
Description: The stack in which this resource is defined.
8.6.7.4.28.25.9.17. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > version
| Type | string |
| Required | Yes |
Description: The most recently deployed version of this function.
8.6.7.4.28.25.9.18. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > versionRef
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/VersionReference |
Description: A reference to a Version resource.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + functionArn | No | string | No | - | The FunctionArn of the Version resource. |
8.6.7.4.28.25.9.18.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > latestVersion > versionRef > functionArn
| Type | string |
| Required | Yes |
Description: The FunctionArn of the Version resource.
8.6.7.4.28.25.10. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > node
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | node |
Description: The tree node.
8.6.7.4.28.25.11. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > permissionsNode
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | node |
Description: The construct node where permissions are attached.
8.6.7.4.28.25.12. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > resourceArnsForGrantInvoke
| Type | array of string |
| Required | Yes |
Description: The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke().
This property is for cdk modules to consume only. You should not need to use this property. Instead, use grantInvoke() directly.
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| resourceArnsForGrantInvoke items | - |
8.6.7.4.28.25.12.1. root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > resourceArnsForGrantInvoke > resourceArnsForGrantInvoke items
| Type | string |
| Required | No |
8.6.7.4.28.25.13. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > role
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | role |
Description: The IAM role associated with this function.
8.6.7.4.28.25.14. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > lambda > stack
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | stack |
Description: The stack in which this resource is defined.
8.6.7.4.28.26. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > latestVersion
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | latestVersion |
Description: The $LATEST version of this function.
Note that this is reference to a non-specific AWS Lambda version, which means the function this version refers to can return different results in different invocations.
To obtain a reference to an explicit version which references the current
function configuration, use lambdaFunction.currentVersion instead.
8.6.7.4.28.27. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > node
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | node |
Description: The tree node.
8.6.7.4.28.28. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > parsePermissionPrincipal
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Translate IPrincipal to something we can pass to AWS::Lambda::Permissions
Do some nasty things because Permission supports a subset of what the
full IAM principal language supports, and we may not be able to parse strings
outright because they may be tokens.
Try to recognize some specific Principal classes first, then try a generic fallback.
8.6.7.4.28.29. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > permissionsNode
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | node |
Description: The construct node where permissions are attached.
8.6.7.4.28.30. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > physicalName
| Type | string |
| Required | Yes |
Description: Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
This value will resolve to one of the following:
- a concrete value (e.g. "my-awesome-bucket")
- undefined, when a name should be generated by CloudFormation
- a concrete name generated automatically during synthesis, in
cross-environment scenarios.
8.6.7.4.28.31. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > qualifier
| Type | string |
| Required | Yes |
Description: The qualifier of the version or alias of this function. A qualifier is the identifier that's appended to a version or alias ARN.
8.6.7.4.28.32. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > resourceArnsForGrantInvoke
| Type | array of string |
| Required | Yes |
Description: The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke()
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| resourceArnsForGrantInvoke items | - |
8.6.7.4.28.32.1. root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > resourceArnsForGrantInvoke > resourceArnsForGrantInvoke items
| Type | string |
| Required | No |
8.6.7.4.28.33. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > role
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | role |
Description: The IAM role associated with this function.
Undefined if the function was imported without a role.
8.6.7.4.28.34. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > stack
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | stack |
Description: The stack in which this resource is defined.
8.6.7.4.28.35. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > statementHasArrayTokens
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Check if a policy statement contains array tokens that would cause CloudFormation resolution conflicts when mixed with literal arrays in the same policy document.
Array tokens are created by CloudFormation intrinsic functions that return arrays, such as Fn::Split, Fn::GetAZs, etc. These cannot be safely merged with literal resource arrays due to CloudFormation's token resolution limitations.
Individual string tokens within literal arrays (e.g., ["arn:${token}:..."]) are
safe and do not cause conflicts, so they are not detected by this method.
8.6.7.4.28.36. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > validateConditionCombinations
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.28.37. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > validateConditions
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.28.38. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > version
| Type | string |
| Required | Yes |
Description: The most recently deployed version of this function.
8.6.7.4.28.39. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersion > versionRef
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | versionRef |
Description: A reference to a Version resource.
8.6.7.4.29. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > currentVersionOptions
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
8.6.7.4.30. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterQueue
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/IQueue |
Description: The DLQ (as queue) associated with this Lambda Function (this is an optional attribute).
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - encryptionMasterKey | No | object | No | In #/definitions/IKey | If this queue is server-side encrypted, this is the KMS encryption key. |
| - encryptionType | No | enum (of string) | No | - | Whether the contents of the queue are encrypted, and by what type of key. |
| + env | No | object | No | Same as env | The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. |
| + fifo | No | boolean | No | - | Whether this queue is an Amazon SQS FIFO queue. If false, this is a standard queue. |
| + node | No | object | No | Same as node | The tree node. |
| + queueArn | No | string | No | - | The ARN of this queue |
| + queueName | No | string | No | - | The name of this queue |
| + queueUrl | No | string | No | - | The URL of this queue |
| + stack | No | object | No | Same as stack | The stack in which this resource is defined. |
8.6.7.4.30.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterQueue > encryptionMasterKey
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/IKey |
Description: If this queue is server-side encrypted, this is the KMS encryption key.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + env | No | object | No | Same as env | The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. |
| + keyArn | No | string | No | - | The ARN of the key. |
| + keyId | No | string | No | - | The ID of the key (the part that looks something like: 1234abcd-12ab-34cd-56ef-1234567890ab). |
| + keyRef | No | object | No | In #/definitions/KeyReference | A reference to a Key resource. |
| + node | No | object | No | Same as node | The tree node. |
| + stack | No | object | No | Same as stack | The stack in which this resource is defined. |
8.6.7.4.30.1.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterQueue > encryptionMasterKey > env
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | env |
Description: The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
8.6.7.4.30.1.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterQueue > encryptionMasterKey > keyArn
| Type | string |
| Required | Yes |
Description: The ARN of the key.
8.6.7.4.30.1.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterQueue > encryptionMasterKey > keyId
| Type | string |
| Required | Yes |
Description: The ID of the key (the part that looks something like: 1234abcd-12ab-34cd-56ef-1234567890ab).
8.6.7.4.30.1.4. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterQueue > encryptionMasterKey > keyRef
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/KeyReference |
Description: A reference to a Key resource.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + keyArn | No | string | No | - | The ARN of the Key resource. |
| + keyId | No | string | No | - | The KeyId of the Key resource. |
8.6.7.4.30.1.4.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterQueue > encryptionMasterKey > keyRef > keyArn
| Type | string |
| Required | Yes |
Description: The ARN of the Key resource.
8.6.7.4.30.1.4.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterQueue > encryptionMasterKey > keyRef > keyId
| Type | string |
| Required | Yes |
Description: The KeyId of the Key resource.
8.6.7.4.30.1.5. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterQueue > encryptionMasterKey > node
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | node |
Description: The tree node.
8.6.7.4.30.1.6. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterQueue > encryptionMasterKey > stack
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | stack |
Description: The stack in which this resource is defined.
8.6.7.4.30.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterQueue > encryptionType
| Type | enum (of string) |
| Required | No |
Description: Whether the contents of the queue are encrypted, and by what type of key.
Must be one of: * "KMS" * "KMS_MANAGED" * "NONE" * "SQS_MANAGED"
8.6.7.4.30.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterQueue > env
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | env |
Description: The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
8.6.7.4.30.4. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterQueue > fifo
| Type | boolean |
| Required | Yes |
Description: Whether this queue is an Amazon SQS FIFO queue. If false, this is a standard queue.
8.6.7.4.30.5. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterQueue > node
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | node |
Description: The tree node.
8.6.7.4.30.6. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterQueue > queueArn
| Type | string |
| Required | Yes |
Description: The ARN of this queue
8.6.7.4.30.7. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterQueue > queueName
| Type | string |
| Required | Yes |
Description: The name of this queue
8.6.7.4.30.8. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterQueue > queueUrl
| Type | string |
| Required | Yes |
Description: The URL of this queue
8.6.7.4.30.9. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterQueue > stack
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | stack |
Description: The stack in which this resource is defined.
8.6.7.4.31. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterTopic
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/ITopic |
Description: The DLQ (as topic) associated with this Lambda Function (this is an optional attribute).
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + contentBasedDeduplication | No | boolean | No | - | Enables content-based deduplication for FIFO topics. |
| + env | No | object | No | Same as env | The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. |
| + fifo | No | boolean | No | - | Whether this topic is an Amazon SNS FIFO queue. If false, this is a standard topic. |
| - masterKey | No | object | No | In #/definitions/IKey | A KMS Key, either managed by this CDK app, or imported. This property applies only to server-side encryption. |
| + node | No | object | No | Same as node | The tree node. |
| + stack | No | object | No | Same as stack | The stack in which this resource is defined. |
| + topicArn | No | string | No | - | The ARN of the topic |
| + topicName | No | string | No | - | The name of the topic |
8.6.7.4.31.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterTopic > contentBasedDeduplication
| Type | boolean |
| Required | Yes |
Description: Enables content-based deduplication for FIFO topics.
8.6.7.4.31.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterTopic > env
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | env |
Description: The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
8.6.7.4.31.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterTopic > fifo
| Type | boolean |
| Required | Yes |
Description: Whether this topic is an Amazon SNS FIFO queue. If false, this is a standard topic.
8.6.7.4.31.4. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterTopic > masterKey
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Default | "None" |
| Defined in | #/definitions/IKey |
Description: A KMS Key, either managed by this CDK app, or imported.
This property applies only to server-side encryption.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + env | No | object | No | Same as env | The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. |
| + keyArn | No | string | No | - | The ARN of the key. |
| + keyId | No | string | No | - | The ID of the key (the part that looks something like: 1234abcd-12ab-34cd-56ef-1234567890ab). |
| + keyRef | No | object | No | In #/definitions/KeyReference | A reference to a Key resource. |
| + node | No | object | No | Same as node | The tree node. |
| + stack | No | object | No | Same as stack | The stack in which this resource is defined. |
8.6.7.4.31.4.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterQueue > encryptionMasterKey > env
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | env |
Description: The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
8.6.7.4.31.4.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterQueue > encryptionMasterKey > keyArn
| Type | string |
| Required | Yes |
Description: The ARN of the key.
8.6.7.4.31.4.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterQueue > encryptionMasterKey > keyId
| Type | string |
| Required | Yes |
Description: The ID of the key (the part that looks something like: 1234abcd-12ab-34cd-56ef-1234567890ab).
8.6.7.4.31.4.4. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterQueue > encryptionMasterKey > keyRef
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/KeyReference |
Description: A reference to a Key resource.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + keyArn | No | string | No | - | The ARN of the Key resource. |
| + keyId | No | string | No | - | The KeyId of the Key resource. |
8.6.7.4.31.4.4.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterQueue > encryptionMasterKey > keyRef > keyArn
| Type | string |
| Required | Yes |
Description: The ARN of the Key resource.
8.6.7.4.31.4.4.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterQueue > encryptionMasterKey > keyRef > keyId
| Type | string |
| Required | Yes |
Description: The KeyId of the Key resource.
8.6.7.4.31.4.5. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterQueue > encryptionMasterKey > node
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | node |
Description: The tree node.
8.6.7.4.31.4.6. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterQueue > encryptionMasterKey > stack
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | stack |
Description: The stack in which this resource is defined.
8.6.7.4.31.5. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterTopic > node
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | node |
Description: The tree node.
8.6.7.4.31.6. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterTopic > stack
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | stack |
Description: The stack in which this resource is defined.
8.6.7.4.31.7. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterTopic > topicArn
| Type | string |
| Required | Yes |
Description: The ARN of the topic
8.6.7.4.31.8. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > deadLetterTopic > topicName
| Type | string |
| Required | Yes |
Description: The name of the topic
8.6.7.4.32. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > env
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | env |
Description: The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
8.6.7.4.33. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > environment
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Environment variables for this function
8.6.7.4.34. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > functionArn
| Type | string |
| Required | Yes |
Description: ARN of this function
8.6.7.4.35. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > functionName
| Type | string |
| Required | Yes |
Description: Name of this function
8.6.7.4.36. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > functionRef
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | functionRef |
Description: A reference to a Function resource.
8.6.7.4.37. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > getLoggingConfig
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Get Logging Config property for the function. This method returns the function LoggingConfig Property if the property is set on the function and undefined if not.
8.6.7.4.38. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > grant
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.39. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > grantPrincipal
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | grantPrincipal |
Description: The principal this Lambda Function is running as
8.6.7.4.40. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > hashMixins
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.41. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > isBoundToVpc
| Type | boolean |
| Required | Yes |
Description: Whether or not this Lambda function was bound to a VPC
If this is is false, trying to access the connections object will fail.
8.6.7.4.42. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > isPrincipalWithConditions
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.43. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > isQueue
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.44. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > latestVersion
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | latestVersion |
Description: The $LATEST version of this function.
Note that this is reference to a non-specific AWS Lambda version, which means the function this version refers to can return different results in different invocations.
To obtain a reference to an explicit version which references the current
function configuration, use lambdaFunction.currentVersion instead.
8.6.7.4.45. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > logGroup
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/ILogGroup |
Description: The LogGroup where the Lambda function's logs are made available.
If either logRetention is set or this property is called, a CloudFormation custom resource is added to the stack that
pre-creates the log group as part of the stack deployment, if it already doesn't exist, and sets the correct log retention
period (never expire, by default).
Further, if the log group already exists and the logRetention is not set, the custom resource will reset the log retention
to never expire even if it was configured with a different value.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + env | No | object | No | Same as env | The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. |
| + logGroupArn | No | string | No | - | The ARN of this log group, with ':*' appended |
| + logGroupName | No | string | No | - | The name of this log group |
| + node | No | object | No | Same as node | The tree node. |
| + stack | No | object | No | Same as stack | The stack in which this resource is defined. |
8.6.7.4.45.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > logGroup > env
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | env |
Description: The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
8.6.7.4.45.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > logGroup > logGroupArn
| Type | string |
| Required | Yes |
Description: The ARN of this log group, with ':*' appended
8.6.7.4.45.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > logGroup > logGroupName
| Type | string |
| Required | Yes |
Description: The name of this log group
8.6.7.4.45.4. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > logGroup > node
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | node |
Description: The tree node.
8.6.7.4.45.5. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > logGroup > stack
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | stack |
Description: The stack in which this resource is defined.
8.6.7.4.46. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > node
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | node |
Description: The tree node.
8.6.7.4.47. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > parsePermissionPrincipal
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Translate IPrincipal to something we can pass to AWS::Lambda::Permissions
Do some nasty things because Permission supports a subset of what the
full IAM principal language supports, and we may not be able to parse strings
outright because they may be tokens.
Try to recognize some specific Principal classes first, then try a generic fallback.
8.6.7.4.48. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > permissionsNode
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | node |
Description: The construct node where permissions are attached.
8.6.7.4.49. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > physicalName
| Type | string |
| Required | Yes |
Description: Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
This value will resolve to one of the following:
- a concrete value (e.g. "my-awesome-bucket")
- undefined, when a name should be generated by CloudFormation
- a concrete name generated automatically during synthesis, in
cross-environment scenarios.
8.6.7.4.50. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > renderEnvironment
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.51. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > renderLayers
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.52. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > resourceArnsForGrantInvoke
| Type | array of string |
| Required | Yes |
Description: The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke()
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| resourceArnsForGrantInvoke items | - |
8.6.7.4.52.1. root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > resourceArnsForGrantInvoke > resourceArnsForGrantInvoke items
| Type | string |
| Required | No |
8.6.7.4.53. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > role
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | role |
Description: Execution role associated with this function
8.6.7.4.54. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > runtime
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | sagemakerBlueprint_domainConfig_domainConfigCr_handlerFunction__layers_items_compatibleRuntimes_items |
Description: The runtime configured for this lambda.
8.6.7.4.55. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > stack
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | stack |
Description: The stack in which this resource is defined.
8.6.7.4.56. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > statementHasArrayTokens
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Check if a policy statement contains array tokens that would cause CloudFormation resolution conflicts when mixed with literal arrays in the same policy document.
Array tokens are created by CloudFormation intrinsic functions that return arrays, such as Fn::Split, Fn::GetAZs, etc. These cannot be safely merged with literal resource arrays due to CloudFormation's token resolution limitations.
Individual string tokens within literal arrays (e.g., ["arn:${token}:..."]) are
safe and do not cause conflicts, so they are not detected by this method.
8.6.7.4.57. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > timeout
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/Duration |
Description: The timeout configured for this lambda.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + amount | No | object | No | - | - |
| + components | No | object | No | - | Return the duration in a set of whole numbered time components, ordered from largest to smallest Only components != 0 will be returned. Can combine millis and seconds together for the benefit of toIsoString, makes the logic in there simpler. |
| + unit | No | object | No | - | - |
8.6.7.4.57.1. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > timeout > amount
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.57.2. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > timeout > components
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
Description: Return the duration in a set of whole numbered time components, ordered from largest to smallest
Only components != 0 will be returned.
Can combine millis and seconds together for the benefit of toIsoString, makes the logic in there simpler.
8.6.7.4.57.3. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > timeout > unit
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.58. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > validateConditionCombinations
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.59. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > validateConditions
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.4.60. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > handlerFunction > validateProfiling
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.5. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > node
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | node |
Description: The tree node.
8.6.7.6. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > physicalName
| Type | string |
| Required | Yes |
Description: Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
This value will resolve to one of the following:
- a concrete value (e.g. "my-awesome-bucket")
- undefined, when a name should be generated by CloudFormation
- a concrete name generated automatically during synthesis, in
cross-environment scenarios.
8.6.7.7. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > ref
| Type | string |
| Required | Yes |
Description: The physical name of this custom resource.
8.6.7.8. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > resource
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
8.6.7.9. Property root > sagemakerBlueprint > domainConfig > domainConfigCr > stack
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | stack |
Description: The stack in which this resource is defined.
8.6.8. Property root > sagemakerBlueprint > domainConfig > domainId
| Type | string |
| Required | Yes |
8.6.9. Property root > sagemakerBlueprint > domainConfig > domainKmsKeyArn
| Type | string |
| Required | Yes |
8.6.10. Property root > sagemakerBlueprint > domainConfig > domainKmsUsagePolicyName
| Type | string |
| Required | Yes |
8.6.11. Property root > sagemakerBlueprint > domainConfig > domainName
| Type | string |
| Required | Yes |
8.6.12. Property root > sagemakerBlueprint > domainConfig > domainUnitIds
| Type | object |
| Required | Yes |
| Additional properties | Each additional property must conform to the schema |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | string | No | - | - |
8.6.12.1. Property root > sagemakerBlueprint > domainConfig > domainUnitIds > additionalProperties
| Type | string |
| Required | No |
8.6.13. Property root > sagemakerBlueprint > domainConfig > domainVersion
| Type | string |
| Required | Yes |
8.6.14. Property root > sagemakerBlueprint > domainConfig > glueCatalogArns
| Type | array of string |
| Required | Yes |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| glueCatalogArns items | - |
8.6.14.1. root > sagemakerBlueprint > domainConfig > glueCatalogArns > glueCatalogArns items
| Type | string |
| Required | No |
8.6.15. Property root > sagemakerBlueprint > domainConfig > glueCatalogKmsKeyArns
| Type | array of string |
| Required | Yes |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| glueCatalogKmsKeyArns items | - |
8.6.15.1. root > sagemakerBlueprint > domainConfig > glueCatalogKmsKeyArns > glueCatalogKmsKeyArns items
| Type | string |
| Required | No |
8.6.16. Property root > sagemakerBlueprint > domainConfig > node
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | node |
Description: The tree node.
8.6.17. Property root > sagemakerBlueprint > domainConfig > projectIds
| Type | object |
| Required | Yes |
| Additional properties | Each additional property must conform to the schema |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | string | No | - | - |
8.6.17.1. Property root > sagemakerBlueprint > domainConfig > projectIds > additionalProperties
| Type | string |
| Required | No |
8.6.18. Property root > sagemakerBlueprint > domainConfig > props
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/DomainConfigProps |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - blueprintIds | No | object | No | - | - |
| - createConfigParams | No | boolean | No | - | - |
| - createOutputs | No | boolean | No | - | Flag controlling CloudFormation output and stack export creation for construct resources |
| - createParams | No | boolean | No | - | Flag controlling SSM parameter creation for construct resource references enabling |
| - customResourceRoleName | No | string | No | - | - |
| - domainArn | No | string | No | - | DataZone domain ARN for AWS resource identification and IAM policy integration enabling |
| - domainBucketArn | No | string | No | - | - |
| - domainBucketUsagePolicyName | No | string | No | - | Domain Bucket usage policy name |
| - domainId | No | string | No | - | DataZone domain ID for unique domain identification within AWS enabling cross-service |
| - domainKmsKeyArn | No | string | No | - | KMS key ARN for domain encryption ensuring data protection compliance and secure domain operations |
| - domainKmsUsagePolicyName | No | string | No | - | Domain KMS usage policy name for key access management enabling controlled encryption key |
| - domainName | No | string | No | - | DataZone domain name for domain identification and management enabling unique domain naming |
| - domainUnitIds | No | object | No | - | Map of domain unit names to identifiers for hierarchical domain organization enabling |
| - domainVersion | No | string | No | - | Domain version for domain lifecycle management and versioning control enabling domain evolution tracking |
| - glueCatalogArns | No | array of string | No | - | Array of Glue catalog ARNs for catalog integration enabling data catalog connectivity with DataZone |
| - glueCatalogKmsKeyArns | No | array of string | No | - | Array of Glue catalog KMS key ARNs for catalog encryption enabling secure catalog integration with DataZone |
| + naming | No | object | No | In #/definitions/IMdaaResourceNaming | MDAA naming implementation for consistent resource naming across all MDAA constructs |
| - projectIds | No | object | No | - | - |
| - refresh | No | boolean | No | - | - |
| + ssmParamBase | No | string | No | - | SSM parameter base path for domain configuration storage enabling centralized configuration management |
8.6.18.1. Property root > sagemakerBlueprint > domainConfig > props > blueprintIds
| Type | object |
| Required | No |
| Additional properties | Each additional property must conform to the schema |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | string | No | - | - |
8.6.18.1.1. Property root > sagemakerBlueprint > domainConfig > props > blueprintIds > additionalProperties
| Type | string |
| Required | No |
8.6.18.2. Property root > sagemakerBlueprint > domainConfig > props > createConfigParams
| Type | boolean |
| Required | No |
8.6.18.3. Property root > sagemakerBlueprint > domainConfig > props > createOutputs
| Type | boolean |
| Required | No |
Description: Flag controlling CloudFormation output and stack export creation for construct resources
8.6.18.4. Property root > sagemakerBlueprint > domainConfig > props > createParams
| Type | boolean |
| Required | No |
Description: Flag controlling SSM parameter creation for construct resource references enabling
8.6.18.5. Property root > sagemakerBlueprint > domainConfig > props > customResourceRoleName
| Type | string |
| Required | No |
8.6.18.6. Property root > sagemakerBlueprint > domainConfig > props > domainArn
| Type | string |
| Required | No |
Description: DataZone domain ARN for AWS resource identification and IAM policy integration enabling
8.6.18.7. Property root > sagemakerBlueprint > domainConfig > props > domainBucketArn
| Type | string |
| Required | No |
8.6.18.8. Property root > sagemakerBlueprint > domainConfig > props > domainBucketUsagePolicyName
| Type | string |
| Required | No |
Description: Domain Bucket usage policy name
8.6.18.9. Property root > sagemakerBlueprint > domainConfig > props > domainId
| Type | string |
| Required | No |
Description: DataZone domain ID for unique domain identification within AWS enabling cross-service
8.6.18.10. Property root > sagemakerBlueprint > domainConfig > props > domainKmsKeyArn
| Type | string |
| Required | No |
Description: KMS key ARN for domain encryption ensuring data protection compliance and secure domain operations
8.6.18.11. Property root > sagemakerBlueprint > domainConfig > props > domainKmsUsagePolicyName
| Type | string |
| Required | No |
Description: Domain KMS usage policy name for key access management enabling controlled encryption key
8.6.18.12. Property root > sagemakerBlueprint > domainConfig > props > domainName
| Type | string |
| Required | No |
Description: DataZone domain name for domain identification and management enabling unique domain naming
8.6.18.13. Property root > sagemakerBlueprint > domainConfig > props > domainUnitIds
| Type | object |
| Required | No |
| Additional properties | Each additional property must conform to the schema |
Description: Map of domain unit names to identifiers for hierarchical domain organization enabling
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | string | No | - | - |
8.6.18.13.1. Property root > sagemakerBlueprint > domainConfig > props > domainUnitIds > additionalProperties
| Type | string |
| Required | No |
8.6.18.14. Property root > sagemakerBlueprint > domainConfig > props > domainVersion
| Type | string |
| Required | No |
Description: Domain version for domain lifecycle management and versioning control enabling domain evolution tracking
8.6.18.15. Property root > sagemakerBlueprint > domainConfig > props > glueCatalogArns
| Type | array of string |
| Required | No |
Description: Array of Glue catalog ARNs for catalog integration enabling data catalog connectivity with DataZone
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| glueCatalogArns items | - |
8.6.18.15.1. root > sagemakerBlueprint > domainConfig > props > glueCatalogArns > glueCatalogArns items
| Type | string |
| Required | No |
8.6.18.16. Property root > sagemakerBlueprint > domainConfig > props > glueCatalogKmsKeyArns
| Type | array of string |
| Required | No |
Description: Array of Glue catalog KMS key ARNs for catalog encryption enabling secure catalog integration with DataZone
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| glueCatalogKmsKeyArns items | - |
8.6.18.16.1. root > sagemakerBlueprint > domainConfig > props > glueCatalogKmsKeyArns > glueCatalogKmsKeyArns items
| Type | string |
| Required | No |
8.6.18.17. Property root > sagemakerBlueprint > domainConfig > props > naming
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/IMdaaResourceNaming |
Description: MDAA naming implementation for consistent resource naming across all MDAA constructs
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + props | No | object | No | In #/definitions/MdaaResourceNamingConfig | Configuration properties containing organizational context and CDK node access for the naming implementation |
8.6.18.17.1. Property root > sagemakerBlueprint > domainConfig > props > naming > props
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | #/definitions/MdaaResourceNamingConfig |
Description: Configuration properties containing organizational context and CDK node access for the naming implementation
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + cdkNode | No | object | No | Same as node | CDK construct node providing access to context values for custom naming implementations |
| + domain | No | string | No | - | Domain identifier from MDAA configuration representing logical business or organizational boundaries |
| + env | No | string | No | - | Environment identifier from MDAA configuration that distinguishes deployment stages within the same domain |
| + moduleName | No | string | No | - | Module name from MDAA configuration identifying the specific MDAA module deployment within a domain/environment |
| + org | No | string | No | - | Organization identifier from MDAA configuration that serves as the top-level namespace for all AWS resource names |
8.6.18.17.1.1. Property root > sagemakerBlueprint > domainConfig > props > naming > props > cdkNode
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | node |
Description: CDK construct node providing access to context values for custom naming implementations
8.6.18.17.1.2. Property root > sagemakerBlueprint > domainConfig > props > naming > props > domain
| Type | string |
| Required | Yes |
Description: Domain identifier from MDAA configuration representing logical business or organizational boundaries
8.6.18.17.1.3. Property root > sagemakerBlueprint > domainConfig > props > naming > props > env
| Type | string |
| Required | Yes |
Description: Environment identifier from MDAA configuration that distinguishes deployment stages within the same domain
8.6.18.17.1.4. Property root > sagemakerBlueprint > domainConfig > props > naming > props > moduleName
| Type | string |
| Required | Yes |
Description: Module name from MDAA configuration identifying the specific MDAA module deployment within a domain/environment
8.6.18.17.1.5. Property root > sagemakerBlueprint > domainConfig > props > naming > props > org
| Type | string |
| Required | Yes |
Description: Organization identifier from MDAA configuration that serves as the top-level namespace for all AWS resource names
8.6.18.18. Property root > sagemakerBlueprint > domainConfig > props > projectIds
| Type | object |
| Required | No |
| Additional properties | Each additional property must conform to the schema |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | string | No | - | - |
8.6.18.18.1. Property root > sagemakerBlueprint > domainConfig > props > projectIds > additionalProperties
| Type | string |
| Required | No |
8.6.18.19. Property root > sagemakerBlueprint > domainConfig > props > refresh
| Type | boolean |
| Required | No |
8.6.18.20. Property root > sagemakerBlueprint > domainConfig > props > ssmParamBase
| Type | string |
| Required | Yes |
Description: SSM parameter base path for domain configuration storage enabling centralized configuration management
8.6.19. Property root > sagemakerBlueprint > domainConfig > ssmParamBase
| Type | string |
| Required | Yes |
8.7. Property root > sagemakerBlueprint > domainConfigSSMParam
| Type | string |
| Required | No |
Description: Q-ENHANCED-PROPERTY Optional SSM parameter reference for domain configuration enabling dynamic domain configuration management. Specifies the SSM parameter containing domain configuration data for flexible domain setup and configuration management.
Use cases: Dynamic configuration; SSM parameter reference; Configuration management; Flexible setup
AWS: AWS Systems Manager parameter for DataZone domain configuration reference
Validation: Must be valid SSM parameter name if provided; parameter must contain valid domain configuration
8.8. Property root > sagemakerBlueprint > enabledRegions
| Type | array of string |
| Required | No |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| enabledRegions items | - |
8.8.1. root > sagemakerBlueprint > enabledRegions > enabledRegions items
| Type | string |
| Required | No |
8.9. Property root > sagemakerBlueprint > parameters
| Type | object |
| Required | No |
| Additional properties | Each additional property must conform to the schema |
Description: Q-ENHANCED-PROPERTY Optional object containing named parameter configurations for the SageMaker blueprint. Enables parameterized blueprint deployment with validation rules and user input constraints.
Use cases: Product parameterization; User input collection; Deployment customization
AWS: AWS SageMaker blueprint parameters for user-configurable deployment options
Validation: Must be object with string keys and valid MdaaServiceCatalogParameterConfig values if provided *
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | Same as sagemakerBlueprint_additionalAccounts_additionalProperties_parameters_additionalProperties | - |
8.9.1. Property root > sagemakerBlueprint > parameters > MdaaSageMakerBluePrintParameterConfig
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | sagemakerBlueprint_additionalAccounts_additionalProperties_parameters_additionalProperties |
8.10. Property root > sagemakerBlueprint > provisioningRole
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | provisioningRole |
9. Property root > securityConfigurationName
| Type | string |
| Required | No |
Description: Glue security configuration name for job encryption (at rest, in transit, CloudWatch logs). Auto-resolved from project when projectName is set.
Use cases: Job encryption; Security compliance
AWS: Glue security configuration
Validation: Optional; auto-wired from project if projectName provided
10. Property root > service_catalog_product_config
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/MdaaServiceCatalogProductConfig |
Description: Q-ENHANCED-PROPERTY Optional Service Catalog product configuration for governed self-service deployment enabling controlled infrastructure provisioning and governance. When specified, deploys the module as a Service Catalog product instead of direct deployment for governed access and compliance.
Use cases: Governed deployment; Self-service provisioning; Service Catalog integration; Controlled access
AWS: Service Catalog product configuration for governed infrastructure deployment and self-service provisioning
Validation: Must be valid MdaaServiceCatalogProductConfig if provided; enables Service Catalog deployment mode
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - launch_role_name | No | string | No | - | IAM role name that will be used to launch the Service Catalog product |
| + name | No | string | No | - | Display name for the Service Catalog product that will be visible to end users in the Service Catalog console |
| + owner | No | string | No | - | Owner identifier for the Service Catalog product, typically representing the team or organization |
| - parameters | No | object | No | - | Object containing named parameter configurations for the Service Catalog product |
| + portfolio_arn | No | string | No | - | ARN of the AWS Service Catalog portfolio where the product will be associated |
| + portfolio_bucket_name | No | string | No | - | - |
10.1. Property root > service_catalog_product_config > launch_role_name
| Type | string |
| Required | No |
Description: IAM role name that will be used to launch the Service Catalog product
10.2. Property root > service_catalog_product_config > name
| Type | string |
| Required | Yes |
Description: Display name for the Service Catalog product that will be visible to end users in the Service Catalog console
10.3. Property root > service_catalog_product_config > owner
| Type | string |
| Required | Yes |
Description: Owner identifier for the Service Catalog product, typically representing the team or organization
10.4. Property root > service_catalog_product_config > parameters
| Type | object |
| Required | No |
| Additional properties | Each additional property must conform to the schema |
Description: Object containing named parameter configurations for the Service Catalog product
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | In #/definitions/MdaaServiceCatalogParameterConfig | - |
10.4.1. Property root > service_catalog_product_config > parameters > MdaaServiceCatalogParameterConfig
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/MdaaServiceCatalogParameterConfig |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - constraints | No | object | No | In #/definitions/MdaaServiceCatalogConstraintConfig | Constraint configuration that defines additional validation rules for the Service Catalog product parameter |
| + props | No | object | No | Same as cfnParamProps | CloudFormation parameter properties that define the parameter characteristics including type, |
10.4.1.1. Property root > service_catalog_product_config > parameters > additionalProperties > constraints
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/MdaaServiceCatalogConstraintConfig |
Description: Constraint configuration that defines additional validation rules for the Service Catalog product parameter
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + description | No | string | No | - | Human-readable description explaining the purpose and scope of the Service Catalog constraint |
| + rules | No | object | No | - | Object containing named constraint rules that define the validation logic for Service Catalog product parameters |
10.4.1.1.1. Property root > service_catalog_product_config > parameters > additionalProperties > constraints > description
| Type | string |
| Required | Yes |
Description: Human-readable description explaining the purpose and scope of the Service Catalog constraint
10.4.1.1.2. Property root > service_catalog_product_config > parameters > additionalProperties > constraints > rules
| Type | object |
| Required | Yes |
| Additional properties | Each additional property must conform to the schema |
Description: Object containing named constraint rules that define the validation logic for Service Catalog product parameters
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | In #/definitions/MdaaServiceCatalogConstraintRuleConfig | - |
10.4.1.1.2.1. Property root > service_catalog_product_config > parameters > additionalProperties > constraints > rules > MdaaServiceCatalogConstraintRuleConfig
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/MdaaServiceCatalogConstraintRuleConfig |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + assertions | No | array | No | - | Array of constraint assertions that define the validation logic to be applied when the condition is met |
| + condition | No | object | No | In #/definitions/MdaaServiceCatalogConstraintRuleCondititionConfig | Condition configuration that determines when the constraint rule assertions should be evaluated |
10.4.1.1.2.1.1. Property root > service_catalog_product_config > parameters > additionalProperties > constraints > rules > additionalProperties > assertions
| Type | array |
| Required | Yes |
Description: Array of constraint assertions that define the validation logic to be applied when the condition is met
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| MdaaServiceCatalogConstraintRuleAssertionConfig | - |
10.4.1.1.2.1.1.1. root > service_catalog_product_config > parameters > additionalProperties > constraints > rules > additionalProperties > assertions > MdaaServiceCatalogConstraintRuleAssertionConfig
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/definitions/MdaaServiceCatalogConstraintRuleAssertionConfig |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + assert | No | string | No | - | Constraint assertion expression that defines the validation logic for Service Catalog product parameters |
| + description | No | string | No | - | Human-readable description explaining the purpose and requirements of the constraint assertion |
10.4.1.1.2.1.1.1.1. Property root > service_catalog_product_config > parameters > additionalProperties > constraints > rules > additionalProperties > assertions > assertions items > assert
| Type | string |
| Required | Yes |
Description: Constraint assertion expression that defines the validation logic for Service Catalog product parameters
10.4.1.1.2.1.1.1.2. Property root > service_catalog_product_config > parameters > additionalProperties > constraints > rules > additionalProperties > assertions > assertions items > description
| Type | string |
| Required | Yes |
Description: Human-readable description explaining the purpose and requirements of the constraint assertion
10.4.1.1.2.1.2. Property root > service_catalog_product_config > parameters > additionalProperties > constraints > rules > additionalProperties > condition
| Type | object |
| Required | Yes |
| Additional properties | Any type allowed |
| Defined in | #/definitions/MdaaServiceCatalogConstraintRuleCondititionConfig |
Description: Condition configuration that determines when the constraint rule assertions should be evaluated
10.4.1.2. Property root > service_catalog_product_config > parameters > additionalProperties > props
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Same definition as | cfnParamProps |
Description: CloudFormation parameter properties that define the parameter characteristics including type,
10.5. Property root > service_catalog_product_config > portfolio_arn
| Type | string |
| Required | Yes |
Description: ARN of the AWS Service Catalog portfolio where the product will be associated
10.6. Property root > service_catalog_product_config > portfolio_bucket_name
| Type | string |
| Required | Yes |