Aws/datazone
@swamp/aws/datazonev2026.10.25.1
01README
AWS DATAZONE infrastructure models
02Behaviors
@swamp/aws/datazone/connectionv2026.10.23.1connection.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| AwsLocation? | object | AWS Location of project |
| Configurations? | array | The configurations of the connection. |
| Description? | string | The description of the connection. |
| DomainIdentifier | string | The identifier of the domain in which the connection is created. |
| EnableTrustedIdentityPropagation? | boolean | Specifies whether the trusted identity propagation is enabled |
| EnvironmentIdentifier? | string | The identifier of the environment in which the connection is created. |
| ProjectIdentifier? | string | The identifier of the project in which the connection should be created. If |
| Name | string | The name of the connection. |
| Props? | object | |
| Scope? | enum | The scope of the connection. |
fn create()
Create a DataZone Connection
fn get(identifier: string)
Get a DataZone Connection
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone Connection |
fn update()
Update a DataZone Connection
fn delete(identifier: string)
Delete a DataZone Connection
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone Connection |
fn sync()
Sync DataZone Connection state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DataZone Connection resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DataZone Connection resource state
@swamp/aws/datazone/data-sourcev2026.10.23.1data_source.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| AssetFormsInput? | array | The metadata forms that are to be attached to the assets that this data source works with. |
| ConnectionIdentifier? | string | The unique identifier of a connection used to fetch relevant parameters from connection during Datasource run |
| Description? | string | The description of the data source. |
| DomainIdentifier | string | The ID of the Amazon DataZone domain where the data source is created. |
| EnableSetting? | enum | Specifies whether the data source is enabled. |
| EnvironmentIdentifier? | string | The unique identifier of the Amazon DataZone environment to which the data source publishes assets. |
| Configuration? | object | Configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration. |
| Name | string | The name of the data source. |
| ProjectIdentifier | string | The identifier of the Amazon DataZone project in which you want to add the data source. |
| PublishOnImport? | boolean | Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog. |
| Recommendation? | object | Specifies whether the business name generation is to be enabled for this data source. |
| Schedule? | object | The schedule of the data source runs. |
| Type | string | The type of the data source. |
fn create()
Create a DataZone DataSource
fn get(identifier: string)
Get a DataZone DataSource
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone DataSource |
fn update()
Update a DataZone DataSource
fn delete(identifier: string)
Delete a DataZone DataSource
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone DataSource |
fn sync()
Sync DataZone DataSource state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DataZone DataSource resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DataZone DataSource resource state
@swamp/aws/datazone/domainv2026.10.23.1domain.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Description? | string | The description of the Amazon DataZone domain. |
| DomainExecutionRole? | string | The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the AWS account that houses the Amazon DataZone domain. |
| ServiceRole? | string | The service role of the domain that is created. |
| DomainVersion? | enum | The version of the domain. |
| KmsKeyIdentifier? | string | The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data. |
| Name | string | The name of the Amazon DataZone domain. |
| SingleSignOn? | object | The single-sign on configuration of the Amazon DataZone domain. |
| Tags? | array | The tags specified for the Amazon DataZone domain. |
fn create()
Create a DataZone Domain
fn get(identifier: string)
Get a DataZone Domain
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone Domain |
fn update()
Update a DataZone Domain
fn delete(identifier: string)
Delete a DataZone Domain
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone Domain |
fn sync()
Sync DataZone Domain state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DataZone Domain resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DataZone Domain resource state
@swamp/aws/datazone/domain-unitv2026.10.23.1domain_unit.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| DomainIdentifier | string | The ID of the domain where you want to create a domain unit. |
| Description? | string | The description of the domain unit. |
| Name | string | The name of the domain unit. |
| ParentDomainUnitIdentifier | string | The ID of the parent domain unit. |
fn create()
Create a DataZone DomainUnit
fn get(identifier: string)
Get a DataZone DomainUnit
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone DomainUnit |
fn update()
Update a DataZone DomainUnit
fn delete(identifier: string)
Delete a DataZone DomainUnit
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone DomainUnit |
fn sync()
Sync DataZone DomainUnit state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DataZone DomainUnit resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DataZone DomainUnit resource state
@swamp/aws/datazone/environmentv2026.10.23.1environment.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| EnvironmentAccountIdentifier? | string | The AWS account in which the Amazon DataZone environment is created. |
| EnvironmentAccountRegion? | string | The AWS region in which the Amazon DataZone environment is created. |
| Description? | string | The description of the Amazon DataZone environment. |
| DomainIdentifier | string | The identifier of the Amazon DataZone domain in which the environment would be created. |
| EnvironmentBlueprintIdentifier? | string | The identifier of the environment blueprint. |
| DeploymentOrder? | number | The deployment order for the environment. |
| EnvironmentConfigurationId? | string | The identifier of the environment configuration. |
| EnvironmentProfileIdentifier? | string | The ID of the environment profile with which the Amazon DataZone environment would be created. |
| GlossaryTerms? | array | The glossary terms that can be used in the Amazon DataZone environment. |
| EnvironmentRoleArn? | string | Environment role arn for custom aws environment permissions |
| Name | string | The name of the environment. |
| ProjectIdentifier | string | The ID of the Amazon DataZone project in which the environment would be created. |
| UserParameters? | array | The user parameters of the Amazon DataZone environment. |
fn create()
Create a DataZone Environment
fn get(identifier: string)
Get a DataZone Environment
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone Environment |
fn update()
Update a DataZone Environment
fn delete(identifier: string)
Delete a DataZone Environment
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone Environment |
fn sync()
Sync DataZone Environment state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DataZone Environment resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DataZone Environment resource state
@swamp/aws/datazone/environment-actionsv2026.10.23.1environment_actions.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Description? | string | The description of the Amazon DataZone environment action. |
| DomainIdentifier? | string | The identifier of the Amazon DataZone domain in which the environment would be created. |
| EnvironmentIdentifier? | string | The identifier of the Amazon DataZone environment in which the action is taking place |
| Identifier? | string | The ID of the Amazon DataZone environment action. |
| Name | string | The name of the environment action. |
| Parameters? | object | The parameters of the environment action. |
fn create()
Create a DataZone EnvironmentActions
fn get(identifier: string)
Get a DataZone EnvironmentActions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone EnvironmentActions |
fn update()
Update a DataZone EnvironmentActions
fn delete(identifier: string)
Delete a DataZone EnvironmentActions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone EnvironmentActions |
fn sync()
Sync DataZone EnvironmentActions state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DataZone EnvironmentActions resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DataZone EnvironmentActions resource state
@swamp/aws/datazone/environment-blueprint-configurationv2026.10.23.1environment_blueprint_configuration.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| GlobalParameters? | record | Region-agnostic environment blueprint parameters. |
| EnabledRegions | array | |
| EnvironmentBlueprintIdentifier | string | |
| RegionalParameters? | array | |
| ProvisioningRoleArn? | string | |
| ProvisioningConfigurations? | array | |
| DomainIdentifier | string | |
| EnvironmentRolePermissionBoundary? | string | |
| ManageAccessRoleArn? | string |
fn create()
Create a DataZone EnvironmentBlueprintConfiguration
fn get(identifier: string)
Get a DataZone EnvironmentBlueprintConfiguration
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone EnvironmentBlueprintConfiguration |
fn update()
Update a DataZone EnvironmentBlueprintConfiguration
fn delete(identifier: string)
Delete a DataZone EnvironmentBlueprintConfiguration
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone EnvironmentBlueprintConfiguration |
fn sync()
Sync DataZone EnvironmentBlueprintConfiguration state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DataZone EnvironmentBlueprintConfiguration resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DataZone EnvironmentBlueprintConfiguration resource state
@swamp/aws/datazone/environment-profilev2026.10.23.1environment_profile.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| AwsAccountId | string | The AWS account in which the Amazon DataZone environment is created. |
| AwsAccountRegion | string | The AWS region in which this environment profile is created. |
| Description? | string | The description of this Amazon DataZone environment profile. |
| DomainIdentifier | string | The ID of the Amazon DataZone domain in which this environment profile is created. |
| EnvironmentBlueprintIdentifier | string | The ID of the blueprint with which this environment profile is created. |
| Name | string | The name of this Amazon DataZone environment profile. |
| ProjectIdentifier | string | The identifier of the project in which to create the environment profile. |
| UserParameters? | array | The user parameters of this Amazon DataZone environment profile. |
fn create()
Create a DataZone EnvironmentProfile
fn get(identifier: string)
Get a DataZone EnvironmentProfile
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone EnvironmentProfile |
fn update()
Update a DataZone EnvironmentProfile
fn delete(identifier: string)
Delete a DataZone EnvironmentProfile
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone EnvironmentProfile |
fn sync()
Sync DataZone EnvironmentProfile state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DataZone EnvironmentProfile resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DataZone EnvironmentProfile resource state
@swamp/aws/datazone/form-typev2026.10.23.1form_type.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| DomainIdentifier | string | The ID of the Amazon DataZone domain in which this metadata form type is created. |
| Model | object | The model of this Amazon DataZone metadata form type. |
| Description? | string | The description of this Amazon DataZone metadata form type. |
| Name | string | The name of this Amazon DataZone metadata form type. |
| OwningProjectIdentifier | string | The ID of the Amazon DataZone project that owns this metadata form type. |
| Status? | enum | The status of this Amazon DataZone metadata form type. |
fn create()
Create a DataZone FormType
fn get(identifier: string)
Get a DataZone FormType
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone FormType |
fn update()
Update a DataZone FormType
fn delete(identifier: string)
Delete a DataZone FormType
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone FormType |
fn sync()
Sync DataZone FormType state from AWS
Resources
state(infinite)— DataZone FormType resource state
@swamp/aws/datazone/group-profilev2026.10.23.1group_profile.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| DomainIdentifier | string | The identifier of the Amazon DataZone domain in which the group profile would be created. |
| GroupIdentifier? | string | The ID of the group. |
| GroupType? | enum | The type of the group. |
| Status? | enum | The status of the group profile. |
| RolePrincipalArn? | string | The ARN of the role principal for the group profile. |
fn create()
Create a DataZone GroupProfile
fn get(identifier: string)
Get a DataZone GroupProfile
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone GroupProfile |
fn update()
Update a DataZone GroupProfile
fn delete(identifier: string)
Delete a DataZone GroupProfile
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone GroupProfile |
fn sync()
Sync DataZone GroupProfile state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DataZone GroupProfile resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DataZone GroupProfile resource state
@swamp/aws/datazone/ownerv2026.10.23.1owner.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| DomainIdentifier | string | The ID of the domain in which you want to add the entity owner. |
| EntityIdentifier | string | The ID of the entity to which you want to add an owner. |
| EntityType | enum | The type of an entity. |
| Owner | record | The owner that you want to add to the entity. |
fn create()
Create a DataZone Owner
fn get(identifier: string)
Get a DataZone Owner
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone Owner |
fn delete(identifier: string)
Delete a DataZone Owner
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone Owner |
fn sync()
Sync DataZone Owner state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DataZone Owner resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DataZone Owner resource state
@swamp/aws/datazone/policy-grantv2026.10.23.1policy_grant.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Detail | record | |
| DomainIdentifier | string | |
| EntityIdentifier | string | |
| EntityType | enum | |
| PolicyType | enum | |
| Principal | record |
fn create()
Create a DataZone PolicyGrant
fn get(identifier: string)
Get a DataZone PolicyGrant
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone PolicyGrant |
fn delete(identifier: string)
Delete a DataZone PolicyGrant
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone PolicyGrant |
fn sync()
Sync DataZone PolicyGrant state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DataZone PolicyGrant resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DataZone PolicyGrant resource state
@swamp/aws/datazone/projectv2026.10.23.1project.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Description? | string | The description of the Amazon DataZone project. |
| DomainIdentifier | string | The ID of the Amazon DataZone domain in which this project is created. |
| DomainUnitId? | string | The ID of the domain unit. |
| GlossaryTerms? | array | The glossary terms that can be used in this Amazon DataZone project. |
| Name | string | The name of the Amazon DataZone project. |
| ProjectProfileId? | string | The project profile ID. |
| ProjectProfileVersion? | string | The project profile version to which the project should be updated. You can only specify the following string for this parameter: latest. |
| UserParameters? | array | The user parameters of the project. |
| ResourceTags? | array | The resource tags of the project. |
| MembershipAssignments? | array | The project membership assignments. |
| ProjectCategory? | string | The project category. |
| ProjectExecutionRole? | string | The project execution role ARN. |
fn create()
Create a DataZone Project
fn get(identifier: string)
Get a DataZone Project
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone Project |
fn update()
Update a DataZone Project
fn delete(identifier: string)
Delete a DataZone Project
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone Project |
fn sync()
Sync DataZone Project state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DataZone Project resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DataZone Project resource state
@swamp/aws/datazone/project-membershipv2026.10.23.1project_membership.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Designation | string | |
| DomainIdentifier | string | |
| Member | object | |
| ProjectIdentifier | string |
fn create()
Create a DataZone ProjectMembership
fn get(identifier: string)
Get a DataZone ProjectMembership
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone ProjectMembership |
fn update()
Update a DataZone ProjectMembership
fn delete(identifier: string)
Delete a DataZone ProjectMembership
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone ProjectMembership |
fn sync()
Sync DataZone ProjectMembership state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DataZone ProjectMembership resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DataZone ProjectMembership resource state
@swamp/aws/datazone/project-profilev2026.10.23.1project_profile.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Description? | string | |
| DomainIdentifier? | string | |
| DomainUnitIdentifier? | string | |
| EnvironmentConfigurations? | array | |
| Name | string | |
| Status? | enum | |
| UseDefaultConfigurations? | boolean | |
| ProjectResourceTags? | array | |
| AllowCustomProjectResourceTags? | boolean | |
| ProjectResourceTagsDescription? | string |
fn create()
Create a DataZone ProjectProfile
fn get(identifier: string)
Get a DataZone ProjectProfile
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone ProjectProfile |
fn update()
Update a DataZone ProjectProfile
fn delete(identifier: string)
Delete a DataZone ProjectProfile
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone ProjectProfile |
fn sync()
Sync DataZone ProjectProfile state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DataZone ProjectProfile resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DataZone ProjectProfile resource state
@swamp/aws/datazone/subscription-targetv2026.10.23.1subscription_target.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ApplicableAssetTypes | array | The asset types that can be included in the subscription target. |
| AuthorizedPrincipals | array | The authorized principals of the subscription target. |
| DomainIdentifier | string | The ID of the Amazon DataZone domain in which subscription target would be created. |
| EnvironmentIdentifier | string | The ID of the environment in which subscription target would be created. |
| ManageAccessRole? | string | The manage access role that is used to create the subscription target. |
| Name | string | The name of the subscription target. |
| Provider? | string | The provider of the subscription target. |
| SubscriptionTargetConfig | array | The configuration of the subscription target. |
| Type | string | The type of the subscription target. |
fn create()
Create a DataZone SubscriptionTarget
fn get(identifier: string)
Get a DataZone SubscriptionTarget
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone SubscriptionTarget |
fn update()
Update a DataZone SubscriptionTarget
fn delete(identifier: string)
Delete a DataZone SubscriptionTarget
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone SubscriptionTarget |
fn sync()
Sync DataZone SubscriptionTarget state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DataZone SubscriptionTarget resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DataZone SubscriptionTarget resource state
@swamp/aws/datazone/user-profilev2026.10.23.1user_profile.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| DomainIdentifier | string | The identifier of the Amazon DataZone domain in which the user profile would be created. |
| Status? | enum | The status of the user profile. |
| UserIdentifier | string | The ID of the user. |
| UserType? | enum | The type of the user. |
| SessionName? | string | The session name of the user profile. |
fn create()
Create a DataZone UserProfile
fn get(identifier: string)
Get a DataZone UserProfile
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone UserProfile |
fn update()
Update a DataZone UserProfile
fn delete(identifier: string)
Delete a DataZone UserProfile
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DataZone UserProfile |
fn sync()
Sync DataZone UserProfile state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DataZone UserProfile resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DataZone UserProfile resource state
03Previous Versions
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later(was none)
- Updated: connection, data_source, domain, domain_unit, environment, environment_actions, environment_blueprint_configuration, environment_profile, form_type, group_profile, owner, policy_grant, project, project_membership, project_profile, subscription_target, user_profile
2026.10.13.1
- Updated: connection, data_source, domain, domain_unit, environment, environment_actions, environment_blueprint_configuration, environment_profile, form_type, group_profile, owner, policy_grant, project, project_membership, project_profile, subscription_target, user_profile
2026.10.08.1
2026.10.06.1
2026.10.04.1
2026.10.03.1
2026.10.02.1
2026.10.01.1
2026.09.30.1
2026.09.29.1
- Updated: connection, policy_grant, project, project_membership
2026.09.28.1
2026.09.27.1
2026.09.26.1
2026.09.25.1
2026.09.24.1
2026.09.23.1
2026.09.22.1
2026.09.21.1
04Stats
A
100 / 100
Downloads
37
Archive size
3.4 MB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
05Platforms
06Labels