Skip to content

Latest commit

 

History

History
138 lines (121 loc) · 4.02 KB

types.md

File metadata and controls

138 lines (121 loc) · 4.02 KB
Raw

AWS.Amplify @ default

Resource AWS.Amplify/App@default

  • Valid Scope(s): Unknown

Properties

  • alias: string (Required): the resource alias
  • name: string: the resource name
  • properties: AWS.Amplify/AppProperties (Required): properties of the resource

Resource AWS.Amplify/Branch@default

  • Valid Scope(s): Unknown

Properties

  • alias: string (Required): the resource alias
  • name: string: the resource name
  • properties: AWS.Amplify/BranchProperties (Required): properties of the resource

Resource AWS.Amplify/Domain@default

  • Valid Scope(s): Unknown

Properties

  • alias: string (Required): the resource alias
  • name: string: the resource name
  • properties: AWS.Amplify/DomainProperties (Required): properties of the resource

AWS.Amplify/AppProperties

Properties

  • AccessToken: string (WriteOnly)
  • AppId: string (ReadOnly)
  • AppName: string (ReadOnly)
  • Arn: string (ReadOnly, Identifier)
  • AutoBranchCreationConfig: AutoBranchCreationConfig (WriteOnly)
  • BasicAuthConfig: BasicAuthConfig (WriteOnly)
  • BuildSpec: string
  • CustomHeaders: string
  • CustomRules: CustomRule[]
  • DefaultDomain: string (ReadOnly)
  • Description: string
  • EnableBranchAutoDeletion: bool
  • EnvironmentVariables: EnvironmentVariable[]
  • IAMServiceRole: string
  • Name: string (Required)
  • OauthToken: string (WriteOnly)
  • Platform: string
  • Repository: string
  • Tags: Tag[]

AutoBranchCreationConfig

Properties

  • AutoBranchCreationPatterns: string[]
  • BasicAuthConfig: BasicAuthConfig
  • BuildSpec: string
  • EnableAutoBranchCreation: bool
  • EnableAutoBuild: bool
  • EnablePerformanceMode: bool
  • EnablePullRequestPreview: bool
  • EnvironmentVariables: EnvironmentVariable[]
  • Framework: string
  • PullRequestEnvironmentName: string
  • Stage: string

BasicAuthConfig

Properties

  • EnableBasicAuth: bool
  • Password: string
  • Username: string

EnvironmentVariable

Properties

  • Name: string (Required)
  • Value: string (Required)

CustomRule

Properties

  • Condition: string
  • Source: string (Required)
  • Status: string
  • Target: string (Required)

Tag

Properties

  • Key: string (Required)
  • Value: string (Required)

AWS.Amplify/BranchProperties

Properties

  • AppId: string (Required)
  • Arn: string (ReadOnly, Identifier)
  • Backend: Backend
  • BasicAuthConfig: BasicAuthConfig (WriteOnly)
  • BranchName: string (Required)
  • BuildSpec: string
  • Description: string
  • EnableAutoBuild: bool
  • EnablePerformanceMode: bool
  • EnablePullRequestPreview: bool
  • EnvironmentVariables: EnvironmentVariable[]
  • Framework: string
  • PullRequestEnvironmentName: string
  • Stage: string
  • Tags: Tag[]

Backend

Properties

  • StackArn: string

BasicAuthConfig

Properties

  • EnableBasicAuth: bool
  • Password: string (Required)
  • Username: string (Required)

EnvironmentVariable

Properties

  • Name: string (Required)
  • Value: string (Required)

Tag

Properties

  • Key: string (Required)
  • Value: string (Required)

AWS.Amplify/DomainProperties

Properties

  • AppId: string (Required)
  • Arn: string (ReadOnly, Identifier)
  • AutoSubDomainCreationPatterns: string[]
  • AutoSubDomainIAMRole: string
  • CertificateRecord: string (ReadOnly)
  • DomainName: string (Required)
  • DomainStatus: string (ReadOnly)
  • EnableAutoSubDomain: bool
  • StatusReason: string (ReadOnly)
  • SubDomainSettings: SubDomainSetting[] (Required)

SubDomainSetting

Properties

  • BranchName: string (Required)
  • Prefix: string (Required)