owners

Creates, updates, deletes or gets an owner resource or lists owners in a region

Overview

Name	owners
Type	Resource
Description	A owner can set up authorization permissions on their resources.
Id	awscc.datazone.owners

Fields

get (all properties)

Name	Datatype	Description
entity_type	string	The type of an entity.
owner	object	The owner that you want to add to the entity.
entity_identifier	string	The ID of the entity to which you want to add an owner.
domain_identifier	string	The ID of the domain in which you want to add the entity owner.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
entity_type	string	The type of an entity.
owner	object	The owner that you want to add to the entity.
entity_identifier	string	The ID of the entity to which you want to add an owner.
domain_identifier	string	The ID of the domain in which you want to add the entity owner.
region	string	AWS region.

For more information, see AWS::DataZone::Owner.

Methods

Name	Resource	Accessible by	Required Params
create_resource	owners	INSERT	DomainIdentifier, EntityIdentifier, EntityType, Owner, region
delete_resource	owners	DELETE	Identifier, region
list_resources	owners_list_only	SELECT	region
get_resource	owners	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual owner.

SELECT
  region,
  entity_type,
  owner,
  entity_identifier,
  domain_identifier
FROM awscc.datazone.owners
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ domain_identifier }}|{{ entity_type }}|{{ entity_identifier }}|{{ owner_type }}|{{ owner_identifier }}';

list (identifiers only)

Lists all owners in a region.

SELECT
  region,
  domain_identifier,
  entity_type,
  entity_identifier,
  owner_type,
  owner_identifier
FROM awscc.datazone.owners_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new owner resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.datazone.owners (
  EntityType,
  Owner,
  EntityIdentifier,
  DomainIdentifier,
  region
)
SELECT
  '{{ entity_type }}',
  '{{ owner }}',
  '{{ entity_identifier }}',
  '{{ domain_identifier }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.datazone.owners (
  EntityType,
  Owner,
  EntityIdentifier,
  DomainIdentifier,
  region
)
SELECT
  '{{ entity_type }}',
  '{{ owner }}',
  '{{ entity_identifier }}',
  '{{ domain_identifier }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: owner
  props:
    - name: entity_type
      value: '{{ entity_type }}'
    - name: owner
      value: {}
    - name: entity_identifier
      value: '{{ entity_identifier }}'
    - name: domain_identifier
      value: '{{ domain_identifier }}'

DELETE example

/*+ delete */
DELETE FROM awscc.datazone.owners
WHERE
  Identifier = '{{ domain_identifier }}|{{ entity_type }}|{{ entity_identifier }}|{{ owner_type }}|{{ owner_identifier }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the owners resource, the following permissions are required:

Read

datazone:ListEntityOwners,
iam:GetRole

Create

datazone:AddEntityOwner,
datazone:ListEntityOwners,
datazone:GetGroupProfile,
datazone:GetUserProfile,
iam:GetRole

List

datazone:ListEntityOwners,
iam:GetRole

Delete

datazone:RemoveEntityOwner,
datazone:GetUserProfile,
iam:GetRole