Skip to content

Commit 8efa34a

Browse files
committed
Extract service identity info as a nested object
1 parent f02f3a7 commit 8efa34a

File tree

1 file changed

+45
-4
lines changed

1 file changed

+45
-4
lines changed

spec/polaris-management-service.yml

+45-4
Original file line numberDiff line numberDiff line change
@@ -966,10 +966,8 @@ components:
966966
type: string
967967
description: The service name to be used by the SigV4 protocol for signing requests, the default signing name is "execute-api" is if not provided
968968
example: "glue"
969-
userArn:
970-
type: string
971-
description: The aws user arn used to assume the aws role, this represents the polaris service itself
972-
example: "arn:aws:iam::123456789001:user/polaris-service-user"
969+
serviceIdentity:
970+
$ref: '#/components/schemas/ServiceIdentityInfo'
973971
required:
974972
- roleArn
975973
- signingRegion
@@ -1059,6 +1057,49 @@ components:
10591057
allOf:
10601058
- $ref: '#/components/schemas/StorageConfigInfo'
10611059

1060+
ServiceIdentityInfo:
1061+
type: object
1062+
description: Identity metadata for the Polaris service used to access external resources.
1063+
readOnly: true
1064+
properties:
1065+
identityType:
1066+
type: string
1067+
enum:
1068+
- AWS_IAM_USER
1069+
- AWS_IAM_ROLE
1070+
description: The type of identity used to access external resources
1071+
required:
1072+
- identityType
1073+
discriminator:
1074+
propertyName: identityType
1075+
mapping:
1076+
AWS_IAM_USER: "#/components/schemas/AwsIamUserServiceIdentityInfo"
1077+
AWS_IAM_ROLE: "#/components/schemas/AwsIamRoleServiceIdentityInfo"
1078+
1079+
AwsIamUserServiceIdentityInfo:
1080+
type: object
1081+
allOf:
1082+
- $ref: '#/components/schemas/ServiceIdentityInfo'
1083+
properties:
1084+
userArn:
1085+
type: string
1086+
description: The ARN of the IAM user Polaris uses to assume roles and then access external resources.
1087+
example: "arn:aws:iam::111122223333:user/polaris-service-user"
1088+
required:
1089+
- userArn
1090+
1091+
AwsIamRoleServiceIdentityInfo:
1092+
type: object
1093+
allOf:
1094+
- $ref: '#/components/schemas/ServiceIdentityInfo'
1095+
properties:
1096+
roleArn:
1097+
type: string
1098+
description: The ARN of the IAM role Polaris uses to access external resources.
1099+
example: "arn:aws:iam::111122223333:role/polaris-service-role"
1100+
required:
1101+
- roleArn
1102+
10621103
UpdateCatalogRequest:
10631104
description: Updates to apply to a Catalog. Any fields which are required in the Catalog
10641105
will remain unaltered if omitted from the contents of this Update request.

0 commit comments

Comments
 (0)