Package-level declarations

Types

Link copied to clipboard
class Connection : KotlinCustomResource

Connections enables users to connect their DataZone resources (domains, projects, and environments) to external resources/services (data, compute, etc)

Link copied to clipboard
data class ConnectionArgs(val awsLocation: Output<ConnectionAwsLocationArgs>? = null, val description: Output<String>? = null, val domainIdentifier: Output<String>? = null, val environmentIdentifier: Output<String>? = null, val name: Output<String>? = null, val props: Output<Any>? = null) : ConvertibleToJava<ConnectionArgs>

Connections enables users to connect their DataZone resources (domains, projects, and environments) to external resources/services (data, compute, etc)

Link copied to clipboard
Link copied to clipboard
object ConnectionMapper : ResourceMapper<Connection>
Link copied to clipboard
Link copied to clipboard
class DataSource : KotlinCustomResource

A data source is used to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone.

Link copied to clipboard
data class DataSourceArgs(val assetFormsInput: Output<List<DataSourceFormInputArgs>>? = null, val configuration: Output<Any>? = null, val connectionIdentifier: Output<String>? = null, val description: Output<String>? = null, val domainIdentifier: Output<String>? = null, val enableSetting: Output<DataSourceEnableSetting>? = null, val environmentIdentifier: Output<String>? = null, val name: Output<String>? = null, val projectIdentifier: Output<String>? = null, val publishOnImport: Output<Boolean>? = null, val recommendation: Output<DataSourceRecommendationConfigurationArgs>? = null, val schedule: Output<DataSourceScheduleConfigurationArgs>? = null, val type: Output<String>? = null) : ConvertibleToJava<DataSourceArgs>

A data source is used to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone.

Link copied to clipboard
Link copied to clipboard
object DataSourceMapper : ResourceMapper<DataSource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class Domain : KotlinCustomResource

A domain is an organizing entity for connecting together assets, users, and their projects

Link copied to clipboard
data class DomainArgs(val description: Output<String>? = null, val domainExecutionRole: Output<String>? = null, val domainVersion: Output<DomainVersion>? = null, val kmsKeyIdentifier: Output<String>? = null, val name: Output<String>? = null, val serviceRole: Output<String>? = null, val singleSignOn: Output<DomainSingleSignOnArgs>? = null, val tags: Output<List<TagArgs>>? = null) : ConvertibleToJava<DomainArgs>

A domain is an organizing entity for connecting together assets, users, and their projects

Link copied to clipboard

Builder for DomainArgs.

Link copied to clipboard
object DomainMapper : ResourceMapper<Domain>
Link copied to clipboard

Builder for Domain.

Link copied to clipboard
class DomainUnit : KotlinCustomResource

A domain unit enables you to easily organize your assets and other domain entities under specific business units and teams.

Link copied to clipboard
data class DomainUnitArgs(val description: Output<String>? = null, val domainIdentifier: Output<String>? = null, val name: Output<String>? = null, val parentDomainUnitIdentifier: Output<String>? = null) : ConvertibleToJava<DomainUnitArgs>

A domain unit enables you to easily organize your assets and other domain entities under specific business units and teams.

Link copied to clipboard
Link copied to clipboard
object DomainUnitMapper : ResourceMapper<DomainUnit>
Link copied to clipboard
Link copied to clipboard
class Environment : KotlinCustomResource

Definition of AWS::DataZone::Environment Resource Type

Link copied to clipboard
class EnvironmentActions : KotlinCustomResource

Definition of AWS::DataZone::EnvironmentActions Resource Type

Link copied to clipboard
data class EnvironmentActionsArgs(val description: Output<String>? = null, val domainIdentifier: Output<String>? = null, val environmentIdentifier: Output<String>? = null, val identifier: Output<String>? = null, val name: Output<String>? = null, val parameters: Output<EnvironmentActionsAwsConsoleLinkParametersArgs>? = null) : ConvertibleToJava<EnvironmentActionsArgs>

Definition of AWS::DataZone::EnvironmentActions Resource Type

Link copied to clipboard
Link copied to clipboard
data class EnvironmentArgs(val description: Output<String>? = null, val domainIdentifier: Output<String>? = null, val environmentAccountIdentifier: Output<String>? = null, val environmentAccountRegion: Output<String>? = null, val environmentProfileIdentifier: Output<String>? = null, val environmentRoleArn: Output<String>? = null, val glossaryTerms: Output<List<String>>? = null, val name: Output<String>? = null, val projectIdentifier: Output<String>? = null, val userParameters: Output<List<EnvironmentParameterArgs>>? = null) : ConvertibleToJava<EnvironmentArgs>

Definition of AWS::DataZone::Environment Resource Type

Link copied to clipboard
Link copied to clipboard
class EnvironmentBlueprintConfiguration : KotlinCustomResource

Definition of AWS::DataZone::EnvironmentBlueprintConfiguration Resource Type

Link copied to clipboard
data class EnvironmentBlueprintConfigurationArgs(val domainIdentifier: Output<String>? = null, val enabledRegions: Output<List<String>>? = null, val environmentBlueprintIdentifier: Output<String>? = null, val manageAccessRoleArn: Output<String>? = null, val provisioningRoleArn: Output<String>? = null, val regionalParameters: Output<List<EnvironmentBlueprintConfigurationRegionalParameterArgs>>? = null) : ConvertibleToJava<EnvironmentBlueprintConfigurationArgs>

Definition of AWS::DataZone::EnvironmentBlueprintConfiguration Resource Type

Link copied to clipboard
object EnvironmentMapper : ResourceMapper<Environment>
Link copied to clipboard
class EnvironmentProfile : KotlinCustomResource

AWS Datazone Environment Profile is pre-configured set of resources and blueprints that provide reusable templates for creating environments.

Link copied to clipboard
data class EnvironmentProfileArgs(val awsAccountId: Output<String>? = null, val awsAccountRegion: Output<String>? = null, val description: Output<String>? = null, val domainIdentifier: Output<String>? = null, val environmentBlueprintIdentifier: Output<String>? = null, val name: Output<String>? = null, val projectIdentifier: Output<String>? = null, val userParameters: Output<List<EnvironmentProfileEnvironmentParameterArgs>>? = null) : ConvertibleToJava<EnvironmentProfileArgs>

AWS Datazone Environment Profile is pre-configured set of resources and blueprints that provide reusable templates for creating environments.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class GroupProfile : KotlinCustomResource

Group profiles represent groups of Amazon DataZone users. Groups can be manually created, or mapped to Active Directory groups of enterprise customers. In Amazon DataZone, groups serve two purposes. First, a group can map to a team of users in the organizational chart, and thus reduce the administrative work of a Amazon DataZone project owner when there are new employees joining or leaving a team. Second, corporate administrators use Active Directory groups to manage and update user statuses and so Amazon DataZone domain administrators can use these group memberships to implement Amazon DataZone domain policies.

Link copied to clipboard
data class GroupProfileArgs(val domainIdentifier: Output<String>? = null, val groupIdentifier: Output<String>? = null, val status: Output<GroupProfileStatus>? = null) : ConvertibleToJava<GroupProfileArgs>

Group profiles represent groups of Amazon DataZone users. Groups can be manually created, or mapped to Active Directory groups of enterprise customers. In Amazon DataZone, groups serve two purposes. First, a group can map to a team of users in the organizational chart, and thus reduce the administrative work of a Amazon DataZone project owner when there are new employees joining or leaving a team. Second, corporate administrators use Active Directory groups to manage and update user statuses and so Amazon DataZone domain administrators can use these group memberships to implement Amazon DataZone domain policies.

Link copied to clipboard
Link copied to clipboard
object GroupProfileMapper : ResourceMapper<GroupProfile>
Link copied to clipboard
Link copied to clipboard
class Owner : KotlinCustomResource

A owner can set up authorization permissions on their resources.

Link copied to clipboard
data class OwnerArgs(val domainIdentifier: Output<String>? = null, val entityIdentifier: Output<String>? = null, val entityType: Output<OwnerEntityType>? = null, val owner: Output<OwnerPropertiesArgs>? = null) : ConvertibleToJava<OwnerArgs>

A owner can set up authorization permissions on their resources.

Link copied to clipboard

Builder for OwnerArgs.

Link copied to clipboard
object OwnerMapper : ResourceMapper<Owner>
Link copied to clipboard

Builder for Owner.

Link copied to clipboard
class Project : KotlinCustomResource

Amazon DataZone projects are business use case–based groupings of people, assets (data), and tools used to simplify access to the AWS analytics.

Link copied to clipboard
data class ProjectArgs(val description: Output<String>? = null, val domainIdentifier: Output<String>? = null, val glossaryTerms: Output<List<String>>? = null, val name: Output<String>? = null) : ConvertibleToJava<ProjectArgs>

Amazon DataZone projects are business use case–based groupings of people, assets (data), and tools used to simplify access to the AWS analytics.

Link copied to clipboard
Link copied to clipboard
object ProjectMapper : ResourceMapper<Project>
Link copied to clipboard
class ProjectMembership : KotlinCustomResource

Definition of AWS::DataZone::ProjectMembership Resource Type

Link copied to clipboard
data class ProjectMembershipArgs(val designation: Output<ProjectMembershipUserDesignation>? = null, val domainIdentifier: Output<String>? = null, val member: Output<Either<ProjectMembershipMember0PropertiesArgs, ProjectMembershipMember1PropertiesArgs>>? = null, val projectIdentifier: Output<String>? = null) : ConvertibleToJava<ProjectMembershipArgs>

Definition of AWS::DataZone::ProjectMembership Resource Type

Link copied to clipboard
object ProjectMembershipMapper : ResourceMapper<ProjectMembership>
Link copied to clipboard
Link copied to clipboard
class SubscriptionTarget : KotlinCustomResource

Subscription targets enables one to access the data to which you have subscribed in your projects.

Link copied to clipboard
data class SubscriptionTargetArgs(val applicableAssetTypes: Output<List<String>>? = null, val authorizedPrincipals: Output<List<String>>? = null, val domainIdentifier: Output<String>? = null, val environmentIdentifier: Output<String>? = null, val manageAccessRole: Output<String>? = null, val name: Output<String>? = null, val provider: Output<String>? = null, val subscriptionTargetConfig: Output<List<SubscriptionTargetFormArgs>>? = null, val type: Output<String>? = null) : ConvertibleToJava<SubscriptionTargetArgs>

Subscription targets enables one to access the data to which you have subscribed in your projects.

Link copied to clipboard
Link copied to clipboard
class UserProfile : KotlinCustomResource

A user profile represents Amazon DataZone users. Amazon DataZone supports both IAM roles and SSO identities to interact with the Amazon DataZone Management Console and the data portal for different purposes. Domain administrators use IAM roles to perform the initial administrative domain-related work in the Amazon DataZone Management Console, including creating new Amazon DataZone domains, configuring metadata form types, and implementing policies. Data workers use their SSO corporate identities via Identity Center to log into the Amazon DataZone Data Portal and access projects where they have memberships.

Link copied to clipboard
data class UserProfileArgs(val domainIdentifier: Output<String>? = null, val status: Output<UserProfileStatus>? = null, val userIdentifier: Output<String>? = null, val userType: Output<UserProfileUserType>? = null) : ConvertibleToJava<UserProfileArgs>

A user profile represents Amazon DataZone users. Amazon DataZone supports both IAM roles and SSO identities to interact with the Amazon DataZone Management Console and the data portal for different purposes. Domain administrators use IAM roles to perform the initial administrative domain-related work in the Amazon DataZone Management Console, including creating new Amazon DataZone domains, configuring metadata form types, and implementing policies. Data workers use their SSO corporate identities via Identity Center to log into the Amazon DataZone Data Portal and access projects where they have memberships.

Link copied to clipboard
Link copied to clipboard
object UserProfileMapper : ResourceMapper<UserProfile>
Link copied to clipboard

Functions

Link copied to clipboard
suspend fun connection(name: String, block: suspend ConnectionResourceBuilder.() -> Unit): Connection
Link copied to clipboard
suspend fun dataSource(name: String, block: suspend DataSourceResourceBuilder.() -> Unit): DataSource
Link copied to clipboard
fun domain(name: String): Domain
suspend fun domain(name: String, block: suspend DomainResourceBuilder.() -> Unit): Domain
Link copied to clipboard
suspend fun domainUnit(name: String, block: suspend DomainUnitResourceBuilder.() -> Unit): DomainUnit
Link copied to clipboard
suspend fun environment(name: String, block: suspend EnvironmentResourceBuilder.() -> Unit): Environment
Link copied to clipboard
Link copied to clipboard
fun owner(name: String): Owner
suspend fun owner(name: String, block: suspend OwnerResourceBuilder.() -> Unit): Owner
Link copied to clipboard
fun project(name: String): Project
suspend fun project(name: String, block: suspend ProjectResourceBuilder.() -> Unit): Project
Link copied to clipboard
suspend fun userProfile(name: String, block: suspend UserProfileResourceBuilder.() -> Unit): UserProfile