service_principal_names

Creates, updates, deletes or gets a service_principal_name resource or lists service_principal_names in a region

Overview

Name	service_principal_names
Type	Resource
Description	Definition of AWS::PCAConnectorAD::ServicePrincipalName Resource Type
Id	awscc.pcaconnectorad.service_principal_names

Fields

get (all properties)

Name	Datatype	Description
connector_arn	string
directory_registration_arn	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
connector_arn	string
directory_registration_arn	string
region	string	AWS region.

For more information, see AWS::PCAConnectorAD::ServicePrincipalName.

Methods

Name	Resource	Accessible by	Required Params
create_resource	service_principal_names	INSERT	region
delete_resource	service_principal_names	DELETE	Identifier, region
list_resources	service_principal_names_list_only	SELECT	region
get_resource	service_principal_names	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual service_principal_name.

SELECT
  region,
  connector_arn,
  directory_registration_arn
FROM awscc.pcaconnectorad.service_principal_names
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ connector_arn }}|{{ directory_registration_arn }}';

list (identifiers only)

Lists all service_principal_names in a region.

SELECT
  region,
  connector_arn,
  directory_registration_arn
FROM awscc.pcaconnectorad.service_principal_names_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.pcaconnectorad.service_principal_names (
  ConnectorArn,
  DirectoryRegistrationArn,
  region
)
SELECT
  '{{ connector_arn }}',
  '{{ directory_registration_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.pcaconnectorad.service_principal_names (
  ConnectorArn,
  DirectoryRegistrationArn,
  region
)
SELECT
  '{{ connector_arn }}',
  '{{ directory_registration_arn }}',
  '{{ 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: service_principal_name
  props:
    - name: connector_arn
      value: '{{ connector_arn }}'
    - name: directory_registration_arn
      value: '{{ directory_registration_arn }}'

DELETE example

/*+ delete */
DELETE FROM awscc.pcaconnectorad.service_principal_names
WHERE
  Identifier = '{{ connector_arn }}|{{ directory_registration_arn }}' 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 service_principal_names resource, the following permissions are required:

Create

ds:UpdateAuthorizedApplication,
pca-connector-ad:GetServicePrincipalName,
pca-connector-ad:CreateServicePrincipalName

Read

pca-connector-ad:GetServicePrincipalName

Delete

ds:UpdateAuthorizedApplication,
pca-connector-ad:GetServicePrincipalName,
pca-connector-ad:DeleteServicePrincipalName

List

pca-connector-ad:ListServicePrincipalNames