Merge pull request #8 from gammarers/feature/change-provider-type-to-enum

feat: change provider type to enum

Author: yicr

API.md

@@ -28,12 +28,12 @@ yarn add @gammarers/aws-codeconnections-host-custom-resource
 ## Example
 
 ```typescript
-import { RDSDatabaseAutoRunningStopStack } from '@gammarers/aws-codeconnections-host-custom-resource';
+import { RDSDatabaseAutoRunningStopStack, CodeConnectionsHostProviderType } from '@gammarers/aws-codeconnections-host-custom-resource';
 
 const codeConnectionsHostCustomResource = new CodeConnectionsHostCustomResource(this, 'CodeConnectionsHost', {
   name: 'gitlab.example.com', // required, connection host name (Minimum length of 1. Maximum length of 64.)
   providerEndpoint: 'https://gitlab.example.com', // required, your provider endpoint (Minimum length of 1. Maximum length of 512.)
-  providerType: 'GitLabSelfManaged', // required, Bitbucket | GitHub | GitHubEnterpriseServer | GitLab | GitLabSelfManaged
+  providerType: CodeConnectionsHostProviderType.GIT_LAB_SELF_MANAGED,
 });
 
 // get host arn

README.md

@@ -4,10 +4,19 @@ import * as iam from 'aws-cdk-lib/aws-iam';
 import * as cr from 'aws-cdk-lib/custom-resources';
 import { Construct } from 'constructs';
 
+// Bitbucket | GitHub | GitHubEnterpriseServer | GitLab | GitLabSelfManaged
+export enum CodeConnectionsHostProviderType {
+  BIT_BUCKET = 'Bitbucket',
+  GIT_HUB = 'GitHub',
+  GIT_HUB_ENTERPRISE_SERVER = 'GitHubEnterpriseServer',
+  GIT_LAB = 'GitLab',
+  GIT_LAB_SELF_MANAGED = 'GitLabSelfManaged',
+}
+
 export interface CodeConnectionsHostCustomResourceProps {
   readonly name: string;
   readonly providerEndpoint: string;
-  readonly providerType: string;
+  readonly providerType: CodeConnectionsHostProviderType;
 }
 
 export class CodeConnectionsHostCustomResource extends cr.AwsCustomResource {