awsamplify

package
v1.120.0-devpreview Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 26, 2021 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func App_IsConstruct 

func App_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func App_IsResource 

func App_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func Branch_IsConstruct 

func Branch_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func Branch_IsResource 

func Branch_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func CfnApp_CFN_RESOURCE_TYPE_NAME 

func CfnApp_CFN_RESOURCE_TYPE_NAME() *string

func CfnApp_IsCfnElement 

func CfnApp_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnApp_IsCfnResource 

func CfnApp_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnApp_IsConstruct 

func CfnApp_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnBranch_CFN_RESOURCE_TYPE_NAME 

func CfnBranch_CFN_RESOURCE_TYPE_NAME() *string

func CfnBranch_IsCfnElement 

func CfnBranch_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnBranch_IsCfnResource 

func CfnBranch_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnBranch_IsConstruct 

func CfnBranch_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func CfnDomain_CFN_RESOURCE_TYPE_NAME 

func CfnDomain_CFN_RESOURCE_TYPE_NAME() *string

func CfnDomain_IsCfnElement 

func CfnDomain_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnDomain_IsCfnResource 

func CfnDomain_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnDomain_IsConstruct 

func CfnDomain_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func Domain_IsConstruct 

func Domain_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func Domain_IsResource 

func Domain_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func NewApp_Override 

func NewApp_Override(a App, scope constructs.Construct, id *string, props *AppProps)

Experimental.

func NewBasicAuth_Override 

func NewBasicAuth_Override(b BasicAuth, props *BasicAuthProps)

Experimental.

func NewBranch_Override 

func NewBranch_Override(b Branch, scope constructs.Construct, id *string, props *BranchProps)

Experimental.

func NewCfnApp_Override 

func NewCfnApp_Override(c CfnApp, scope awscdk.Construct, id *string, props *CfnAppProps)

Create a new `AWS::Amplify::App`.

func NewCfnBranch_Override 

func NewCfnBranch_Override(c CfnBranch, scope awscdk.Construct, id *string, props *CfnBranchProps)

Create a new `AWS::Amplify::Branch`.

func NewCfnDomain_Override 

func NewCfnDomain_Override(c CfnDomain, scope awscdk.Construct, id *string, props *CfnDomainProps)

Create a new `AWS::Amplify::Domain`.

func NewCodeCommitSourceCodeProvider_Override 

func NewCodeCommitSourceCodeProvider_Override(c CodeCommitSourceCodeProvider, props *CodeCommitSourceCodeProviderProps)

Experimental.

func NewCustomRule_Override 

func NewCustomRule_Override(c CustomRule, options *CustomRuleOptions)

Experimental.

func NewDomain_Override 

func NewDomain_Override(d Domain, scope constructs.Construct, id *string, props *DomainProps)

Experimental.

func NewGitHubSourceCodeProvider_Override 

func NewGitHubSourceCodeProvider_Override(g GitHubSourceCodeProvider, props *GitHubSourceCodeProviderProps)

Experimental.

func NewGitLabSourceCodeProvider_Override 

func NewGitLabSourceCodeProvider_Override(g GitLabSourceCodeProvider, props *GitLabSourceCodeProviderProps)

Experimental.

Types

type App 

type App interface {
	awscdk.Resource
	IApp
	awsiam.IGrantable
	AppId() *string
	AppName() *string
	Arn() *string
	DefaultDomain() *string
	Env() *awscdk.ResourceEnvironment
	GrantPrincipal() awsiam.IPrincipal
	Node() awscdk.ConstructNode
	PhysicalName() *string
	Stack() awscdk.Stack
	AddAutoBranchEnvironment(name *string, value *string) App
	AddBranch(id *string, options *BranchOptions) Branch
	AddCustomRule(rule CustomRule) App
	AddDomain(id *string, options *DomainOptions) Domain
	AddEnvironment(name *string, value *string) App
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

An Amplify Console application. Experimental.

func NewApp 

func NewApp(scope constructs.Construct, id *string, props *AppProps) App

Experimental.

type AppProps 

type AppProps struct {
	// The name for the application.
	// Experimental.
	AppName *string `json:"appName"`
	// The auto branch creation configuration.
	//
	// Use this to automatically create
	// branches that match a certain pattern.
	// Experimental.
	AutoBranchCreation *AutoBranchCreation `json:"autoBranchCreation"`
	// Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
	// Experimental.
	AutoBranchDeletion *bool `json:"autoBranchDeletion"`
	// The Basic Auth configuration.
	//
	// Use this to set password protection at an
	// app level to all your branches.
	// Experimental.
	BasicAuth BasicAuth `json:"basicAuth"`
	// BuildSpec for the application.
	//
	// Alternatively, add a `amplify.yml`
	// file to the repository.
	// See: https://docs.aws.amazon.com/amplify/latest/userguide/build-settings.html
	//
	// Experimental.
	BuildSpec awscodebuild.BuildSpec `json:"buildSpec"`
	// Custom rewrite/redirect rules for the application.
	// Experimental.
	CustomRules *[]CustomRule `json:"customRules"`
	// A description for the application.
	// Experimental.
	Description *string `json:"description"`
	// Environment variables for the application.
	//
	// All environment variables that you add are encrypted to prevent rogue
	// access so you can use them to store secret information.
	// Experimental.
	EnvironmentVariables *map[string]*string `json:"environmentVariables"`
	// The IAM service role to associate with the application.
	//
	// The App
	// implements IGrantable.
	// Experimental.
	Role awsiam.IRole `json:"role"`
	// The source code provider for this application.
	// Experimental.
	SourceCodeProvider ISourceCodeProvider `json:"sourceCodeProvider"`
}

Properties for an App. Experimental.

type AutoBranchCreation 

type AutoBranchCreation struct {
	// Whether to enable auto building for the auto created branch.
	// Experimental.
	AutoBuild *bool `json:"autoBuild"`
	// The Basic Auth configuration.
	//
	// Use this to set password protection for
	// the auto created branch.
	// Experimental.
	BasicAuth BasicAuth `json:"basicAuth"`
	// Build spec for the auto created branch.
	// Experimental.
	BuildSpec awscodebuild.BuildSpec `json:"buildSpec"`
	// Environment variables for the auto created branch.
	//
	// All environment variables that you add are encrypted to prevent rogue
	// access so you can use them to store secret information.
	// Experimental.
	EnvironmentVariables *map[string]*string `json:"environmentVariables"`
	// Automated branch creation glob patterns.
	// Experimental.
	Patterns *[]*string `json:"patterns"`
	// The dedicated backend environment for the pull request previews of the auto created branch.
	// Experimental.
	PullRequestEnvironmentName *string `json:"pullRequestEnvironmentName"`
	// Whether to enable pull request preview for the auto created branch.
	// Experimental.
	PullRequestPreview *bool `json:"pullRequestPreview"`
	// Stage for the auto created branch.
	// Experimental.
	Stage *string `json:"stage"`
}

Auto branch creation configuration. Experimental.

type BasicAuth 

type BasicAuth interface {
	Bind(scope awscdk.Construct, id *string) *BasicAuthConfig
}

Basic Auth configuration. Experimental.

func BasicAuth_FromCredentials 

func BasicAuth_FromCredentials(username *string, password awscdk.SecretValue) BasicAuth

Creates a Basic Auth configuration from a username and a password. Experimental.

func BasicAuth_FromGeneratedPassword 

func BasicAuth_FromGeneratedPassword(username *string, encryptionKey awskms.IKey) BasicAuth

Creates a Basic Auth configuration with a password generated in Secrets Manager. Experimental.

func NewBasicAuth 

func NewBasicAuth(props *BasicAuthProps) BasicAuth

Experimental.

type BasicAuthConfig 

type BasicAuthConfig struct {
	// Whether to enable Basic Auth.
	// Experimental.
	EnableBasicAuth *bool `json:"enableBasicAuth"`
	// The password.
	// Experimental.
	Password *string `json:"password"`
	// The username.
	// Experimental.
	Username *string `json:"username"`
}

A Basic Auth configuration. Experimental.

type BasicAuthProps 

type BasicAuthProps struct {
	// The username.
	// Experimental.
	Username *string `json:"username"`
	// The encryption key to use to encrypt the password when it's generated in Secrets Manager.
	// Experimental.
	EncryptionKey awskms.IKey `json:"encryptionKey"`
	// The password.
	// Experimental.
	Password awscdk.SecretValue `json:"password"`
}

Properties for a BasicAuth. Experimental.

type Branch 

type Branch interface {
	awscdk.Resource
	IBranch
	Arn() *string
	BranchName() *string
	Env() *awscdk.ResourceEnvironment
	Node() awscdk.ConstructNode
	PhysicalName() *string
	Stack() awscdk.Stack
	AddEnvironment(name *string, value *string) Branch
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

An Amplify Console branch. Experimental.

func NewBranch 

func NewBranch(scope constructs.Construct, id *string, props *BranchProps) Branch

Experimental.

type BranchOptions 

type BranchOptions struct {
	// Whether to enable auto building for the branch.
	// Experimental.
	AutoBuild *bool `json:"autoBuild"`
	// The Basic Auth configuration.
	//
	// Use this to set password protection for
	// the branch
	// Experimental.
	BasicAuth BasicAuth `json:"basicAuth"`
	// The name of the branch.
	// Experimental.
	BranchName *string `json:"branchName"`
	// BuildSpec for the branch.
	// See: https://docs.aws.amazon.com/amplify/latest/userguide/build-settings.html
	//
	// Experimental.
	BuildSpec awscodebuild.BuildSpec `json:"buildSpec"`
	// A description for the branch.
	// Experimental.
	Description *string `json:"description"`
	// Environment variables for the branch.
	//
	// All environment variables that you add are encrypted to prevent rogue
	// access so you can use them to store secret information.
	// Experimental.
	EnvironmentVariables *map[string]*string `json:"environmentVariables"`
	// The dedicated backend environment for the pull request previews.
	// Experimental.
	PullRequestEnvironmentName *string `json:"pullRequestEnvironmentName"`
	// Whether to enable pull request preview for the branch.
	// Experimental.
	PullRequestPreview *bool `json:"pullRequestPreview"`
	// Stage for the branch.
	// Experimental.
	Stage *string `json:"stage"`
}

Options to add a branch to an application. Experimental.

type BranchProps 

type BranchProps struct {
	// Whether to enable auto building for the branch.
	// Experimental.
	AutoBuild *bool `json:"autoBuild"`
	// The Basic Auth configuration.
	//
	// Use this to set password protection for
	// the branch
	// Experimental.
	BasicAuth BasicAuth `json:"basicAuth"`
	// The name of the branch.
	// Experimental.
	BranchName *string `json:"branchName"`
	// BuildSpec for the branch.
	// See: https://docs.aws.amazon.com/amplify/latest/userguide/build-settings.html
	//
	// Experimental.
	BuildSpec awscodebuild.BuildSpec `json:"buildSpec"`
	// A description for the branch.
	// Experimental.
	Description *string `json:"description"`
	// Environment variables for the branch.
	//
	// All environment variables that you add are encrypted to prevent rogue
	// access so you can use them to store secret information.
	// Experimental.
	EnvironmentVariables *map[string]*string `json:"environmentVariables"`
	// The dedicated backend environment for the pull request previews.
	// Experimental.
	PullRequestEnvironmentName *string `json:"pullRequestEnvironmentName"`
	// Whether to enable pull request preview for the branch.
	// Experimental.
	PullRequestPreview *bool `json:"pullRequestPreview"`
	// Stage for the branch.
	// Experimental.
	Stage *string `json:"stage"`
	// The application within which the branch must be created.
	// Experimental.
	App IApp `json:"app"`
}

Properties for a Branch. Experimental.

type CfnApp 

type CfnApp interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AccessToken() *string
	SetAccessToken(val *string)
	AttrAppId() *string
	AttrAppName() *string
	AttrArn() *string
	AttrDefaultDomain() *string
	AutoBranchCreationConfig() interface{}
	SetAutoBranchCreationConfig(val interface{})
	BasicAuthConfig() interface{}
	SetBasicAuthConfig(val interface{})
	BuildSpec() *string
	SetBuildSpec(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	CustomHeaders() *string
	SetCustomHeaders(val *string)
	CustomRules() interface{}
	SetCustomRules(val interface{})
	Description() *string
	SetDescription(val *string)
	EnableBranchAutoDeletion() interface{}
	SetEnableBranchAutoDeletion(val interface{})
	EnvironmentVariables() interface{}
	SetEnvironmentVariables(val interface{})
	IamServiceRole() *string
	SetIamServiceRole(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() awscdk.ConstructNode
	OauthToken() *string
	SetOauthToken(val *string)
	Ref() *string
	Repository() *string
	SetRepository(val *string)
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Amplify::App`.

func NewCfnApp 

func NewCfnApp(scope awscdk.Construct, id *string, props *CfnAppProps) CfnApp

Create a new `AWS::Amplify::App`.

type CfnAppProps 

type CfnAppProps struct {
	// `AWS::Amplify::App.Name`.
	Name *string `json:"name"`
	// `AWS::Amplify::App.AccessToken`.
	AccessToken *string `json:"accessToken"`
	// `AWS::Amplify::App.AutoBranchCreationConfig`.
	AutoBranchCreationConfig interface{} `json:"autoBranchCreationConfig"`
	// `AWS::Amplify::App.BasicAuthConfig`.
	BasicAuthConfig interface{} `json:"basicAuthConfig"`
	// `AWS::Amplify::App.BuildSpec`.
	BuildSpec *string `json:"buildSpec"`
	// `AWS::Amplify::App.CustomHeaders`.
	CustomHeaders *string `json:"customHeaders"`
	// `AWS::Amplify::App.CustomRules`.
	CustomRules interface{} `json:"customRules"`
	// `AWS::Amplify::App.Description`.
	Description *string `json:"description"`
	// `AWS::Amplify::App.EnableBranchAutoDeletion`.
	EnableBranchAutoDeletion interface{} `json:"enableBranchAutoDeletion"`
	// `AWS::Amplify::App.EnvironmentVariables`.
	EnvironmentVariables interface{} `json:"environmentVariables"`
	// `AWS::Amplify::App.IAMServiceRole`.
	IamServiceRole *string `json:"iamServiceRole"`
	// `AWS::Amplify::App.OauthToken`.
	OauthToken *string `json:"oauthToken"`
	// `AWS::Amplify::App.Repository`.
	Repository *string `json:"repository"`
	// `AWS::Amplify::App.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `AWS::Amplify::App`.

type CfnApp_AutoBranchCreationConfigProperty 

type CfnApp_AutoBranchCreationConfigProperty struct {
	// `CfnApp.AutoBranchCreationConfigProperty.AutoBranchCreationPatterns`.
	AutoBranchCreationPatterns *[]*string `json:"autoBranchCreationPatterns"`
	// `CfnApp.AutoBranchCreationConfigProperty.BasicAuthConfig`.
	BasicAuthConfig interface{} `json:"basicAuthConfig"`
	// `CfnApp.AutoBranchCreationConfigProperty.BuildSpec`.
	BuildSpec *string `json:"buildSpec"`
	// `CfnApp.AutoBranchCreationConfigProperty.EnableAutoBranchCreation`.
	EnableAutoBranchCreation interface{} `json:"enableAutoBranchCreation"`
	// `CfnApp.AutoBranchCreationConfigProperty.EnableAutoBuild`.
	EnableAutoBuild interface{} `json:"enableAutoBuild"`
	// `CfnApp.AutoBranchCreationConfigProperty.EnablePerformanceMode`.
	EnablePerformanceMode interface{} `json:"enablePerformanceMode"`
	// `CfnApp.AutoBranchCreationConfigProperty.EnablePullRequestPreview`.
	EnablePullRequestPreview interface{} `json:"enablePullRequestPreview"`
	// `CfnApp.AutoBranchCreationConfigProperty.EnvironmentVariables`.
	EnvironmentVariables interface{} `json:"environmentVariables"`
	// `CfnApp.AutoBranchCreationConfigProperty.PullRequestEnvironmentName`.
	PullRequestEnvironmentName *string `json:"pullRequestEnvironmentName"`
	// `CfnApp.AutoBranchCreationConfigProperty.Stage`.
	Stage *string `json:"stage"`
}

type CfnApp_BasicAuthConfigProperty 

type CfnApp_BasicAuthConfigProperty struct {
	// `CfnApp.BasicAuthConfigProperty.EnableBasicAuth`.
	EnableBasicAuth interface{} `json:"enableBasicAuth"`
	// `CfnApp.BasicAuthConfigProperty.Password`.
	Password *string `json:"password"`
	// `CfnApp.BasicAuthConfigProperty.Username`.
	Username *string `json:"username"`
}

type CfnApp_CustomRuleProperty 

type CfnApp_CustomRuleProperty struct {
	// `CfnApp.CustomRuleProperty.Source`.
	Source *string `json:"source"`
	// `CfnApp.CustomRuleProperty.Target`.
	Target *string `json:"target"`
	// `CfnApp.CustomRuleProperty.Condition`.
	Condition *string `json:"condition"`
	// `CfnApp.CustomRuleProperty.Status`.
	Status *string `json:"status"`
}

type CfnApp_EnvironmentVariableProperty 

type CfnApp_EnvironmentVariableProperty struct {
	// `CfnApp.EnvironmentVariableProperty.Name`.
	Name *string `json:"name"`
	// `CfnApp.EnvironmentVariableProperty.Value`.
	Value *string `json:"value"`
}

type CfnBranch 

type CfnBranch interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AppId() *string
	SetAppId(val *string)
	AttrArn() *string
	AttrBranchName() *string
	BasicAuthConfig() interface{}
	SetBasicAuthConfig(val interface{})
	BranchName() *string
	SetBranchName(val *string)
	BuildSpec() *string
	SetBuildSpec(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	EnableAutoBuild() interface{}
	SetEnableAutoBuild(val interface{})
	EnablePerformanceMode() interface{}
	SetEnablePerformanceMode(val interface{})
	EnablePullRequestPreview() interface{}
	SetEnablePullRequestPreview(val interface{})
	EnvironmentVariables() interface{}
	SetEnvironmentVariables(val interface{})
	LogicalId() *string
	Node() awscdk.ConstructNode
	PullRequestEnvironmentName() *string
	SetPullRequestEnvironmentName(val *string)
	Ref() *string
	Stack() awscdk.Stack
	Stage() *string
	SetStage(val *string)
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Amplify::Branch`.

func NewCfnBranch 

func NewCfnBranch(scope awscdk.Construct, id *string, props *CfnBranchProps) CfnBranch

Create a new `AWS::Amplify::Branch`.

type CfnBranchProps 

type CfnBranchProps struct {
	// `AWS::Amplify::Branch.AppId`.
	AppId *string `json:"appId"`
	// `AWS::Amplify::Branch.BranchName`.
	BranchName *string `json:"branchName"`
	// `AWS::Amplify::Branch.BasicAuthConfig`.
	BasicAuthConfig interface{} `json:"basicAuthConfig"`
	// `AWS::Amplify::Branch.BuildSpec`.
	BuildSpec *string `json:"buildSpec"`
	// `AWS::Amplify::Branch.Description`.
	Description *string `json:"description"`
	// `AWS::Amplify::Branch.EnableAutoBuild`.
	EnableAutoBuild interface{} `json:"enableAutoBuild"`
	// `AWS::Amplify::Branch.EnablePerformanceMode`.
	EnablePerformanceMode interface{} `json:"enablePerformanceMode"`
	// `AWS::Amplify::Branch.EnablePullRequestPreview`.
	EnablePullRequestPreview interface{} `json:"enablePullRequestPreview"`
	// `AWS::Amplify::Branch.EnvironmentVariables`.
	EnvironmentVariables interface{} `json:"environmentVariables"`
	// `AWS::Amplify::Branch.PullRequestEnvironmentName`.
	PullRequestEnvironmentName *string `json:"pullRequestEnvironmentName"`
	// `AWS::Amplify::Branch.Stage`.
	Stage *string `json:"stage"`
	// `AWS::Amplify::Branch.Tags`.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `AWS::Amplify::Branch`.

type CfnBranch_BasicAuthConfigProperty 

type CfnBranch_BasicAuthConfigProperty struct {
	// `CfnBranch.BasicAuthConfigProperty.Password`.
	Password *string `json:"password"`
	// `CfnBranch.BasicAuthConfigProperty.Username`.
	Username *string `json:"username"`
	// `CfnBranch.BasicAuthConfigProperty.EnableBasicAuth`.
	EnableBasicAuth interface{} `json:"enableBasicAuth"`
}

type CfnBranch_EnvironmentVariableProperty 

type CfnBranch_EnvironmentVariableProperty struct {
	// `CfnBranch.EnvironmentVariableProperty.Name`.
	Name *string `json:"name"`
	// `CfnBranch.EnvironmentVariableProperty.Value`.
	Value *string `json:"value"`
}

type CfnDomain 

type CfnDomain interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AppId() *string
	SetAppId(val *string)
	AttrArn() *string
	AttrAutoSubDomainCreationPatterns() *[]*string
	AttrAutoSubDomainIamRole() *string
	AttrCertificateRecord() *string
	AttrDomainName() *string
	AttrDomainStatus() *string
	AttrEnableAutoSubDomain() awscdk.IResolvable
	AttrStatusReason() *string
	AutoSubDomainCreationPatterns() *[]*string
	SetAutoSubDomainCreationPatterns(val *[]*string)
	AutoSubDomainIamRole() *string
	SetAutoSubDomainIamRole(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DomainName() *string
	SetDomainName(val *string)
	EnableAutoSubDomain() interface{}
	SetEnableAutoSubDomain(val interface{})
	LogicalId() *string
	Node() awscdk.ConstructNode
	Ref() *string
	Stack() awscdk.Stack
	SubDomainSettings() interface{}
	SetSubDomainSettings(val interface{})
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Amplify::Domain`.

func NewCfnDomain 

func NewCfnDomain(scope awscdk.Construct, id *string, props *CfnDomainProps) CfnDomain

Create a new `AWS::Amplify::Domain`.

type CfnDomainProps 

type CfnDomainProps struct {
	// `AWS::Amplify::Domain.AppId`.
	AppId *string `json:"appId"`
	// `AWS::Amplify::Domain.DomainName`.
	DomainName *string `json:"domainName"`
	// `AWS::Amplify::Domain.SubDomainSettings`.
	SubDomainSettings interface{} `json:"subDomainSettings"`
	// `AWS::Amplify::Domain.AutoSubDomainCreationPatterns`.
	AutoSubDomainCreationPatterns *[]*string `json:"autoSubDomainCreationPatterns"`
	// `AWS::Amplify::Domain.AutoSubDomainIAMRole`.
	AutoSubDomainIamRole *string `json:"autoSubDomainIamRole"`
	// `AWS::Amplify::Domain.EnableAutoSubDomain`.
	EnableAutoSubDomain interface{} `json:"enableAutoSubDomain"`
}

Properties for defining a `AWS::Amplify::Domain`.

type CfnDomain_SubDomainSettingProperty 

type CfnDomain_SubDomainSettingProperty struct {
	// `CfnDomain.SubDomainSettingProperty.BranchName`.
	BranchName *string `json:"branchName"`
	// `CfnDomain.SubDomainSettingProperty.Prefix`.
	Prefix *string `json:"prefix"`
}

type CodeCommitSourceCodeProvider 

type CodeCommitSourceCodeProvider interface {
	ISourceCodeProvider
	Bind(app App) *SourceCodeProviderConfig
}

CodeCommit source code provider. Experimental.

func NewCodeCommitSourceCodeProvider 

func NewCodeCommitSourceCodeProvider(props *CodeCommitSourceCodeProviderProps) CodeCommitSourceCodeProvider

Experimental.

type CodeCommitSourceCodeProviderProps 

type CodeCommitSourceCodeProviderProps struct {
	// The CodeCommit repository.
	// Experimental.
	Repository awscodecommit.IRepository `json:"repository"`
}

Properties for a CodeCommit source code provider. Experimental.

type CustomRule 

type CustomRule interface {
	Condition() *string
	Source() *string
	Status() RedirectStatus
	Target() *string
}

Custom rewrite/redirect rule for an Amplify App. See: https://docs.aws.amazon.com/amplify/latest/userguide/redirects.html

Experimental.

func CustomRule_SINGLE_PAGE_APPLICATION_REDIRECT 

func CustomRule_SINGLE_PAGE_APPLICATION_REDIRECT() CustomRule

func NewCustomRule 

func NewCustomRule(options *CustomRuleOptions) CustomRule

Experimental.

type CustomRuleOptions 

type CustomRuleOptions struct {
	// The source pattern for a URL rewrite or redirect rule.
	// See: https://docs.aws.amazon.com/amplify/latest/userguide/redirects.html
	//
	// Experimental.
	Source *string `json:"source"`
	// The target pattern for a URL rewrite or redirect rule.
	// See: https://docs.aws.amazon.com/amplify/latest/userguide/redirects.html
	//
	// Experimental.
	Target *string `json:"target"`
	// The condition for a URL rewrite or redirect rule, e.g. country code.
	// See: https://docs.aws.amazon.com/amplify/latest/userguide/redirects.html
	//
	// Experimental.
	Condition *string `json:"condition"`
	// The status code for a URL rewrite or redirect rule.
	// See: https://docs.aws.amazon.com/amplify/latest/userguide/redirects.html
	//
	// Experimental.
	Status RedirectStatus `json:"status"`
}

Options for a custom rewrite/redirect rule for an Amplify App. Experimental.

type Domain 

type Domain interface {
	awscdk.Resource
	Arn() *string
	CertificateRecord() *string
	DomainAutoSubDomainCreationPatterns() *[]*string
	DomainAutoSubDomainIamRole() *string
	DomainEnableAutoSubDomain() awscdk.IResolvable
	DomainName() *string
	DomainStatus() *string
	Env() *awscdk.ResourceEnvironment
	Node() awscdk.ConstructNode
	PhysicalName() *string
	Stack() awscdk.Stack
	StatusReason() *string
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	MapRoot(branch IBranch) Domain
	MapSubDomain(branch IBranch, prefix *string) Domain
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

An Amplify Console domain. Experimental.

func NewDomain 

func NewDomain(scope constructs.Construct, id *string, props *DomainProps) Domain

Experimental.

type DomainOptions 

type DomainOptions struct {
	// Branches which should automatically create subdomains.
	// Experimental.
	AutoSubdomainCreationPatterns *[]*string `json:"autoSubdomainCreationPatterns"`
	// The name of the domain.
	// Experimental.
	DomainName *string `json:"domainName"`
	// Automatically create subdomains for connected branches.
	// Experimental.
	EnableAutoSubdomain *bool `json:"enableAutoSubdomain"`
	// Subdomains.
	// Experimental.
	SubDomains *[]*SubDomain `json:"subDomains"`
}

Options to add a domain to an application. Experimental.

type DomainProps 

type DomainProps struct {
	// Branches which should automatically create subdomains.
	// Experimental.
	AutoSubdomainCreationPatterns *[]*string `json:"autoSubdomainCreationPatterns"`
	// The name of the domain.
	// Experimental.
	DomainName *string `json:"domainName"`
	// Automatically create subdomains for connected branches.
	// Experimental.
	EnableAutoSubdomain *bool `json:"enableAutoSubdomain"`
	// Subdomains.
	// Experimental.
	SubDomains *[]*SubDomain `json:"subDomains"`
	// The application to which the domain must be connected.
	// Experimental.
	App IApp `json:"app"`
	// The IAM role with access to Route53 when using enableAutoSubdomain.
	// Experimental.
	AutoSubDomainIamRole awsiam.IRole `json:"autoSubDomainIamRole"`
}

Properties for a Domain. Experimental.

type GitHubSourceCodeProvider 

type GitHubSourceCodeProvider interface {
	ISourceCodeProvider
	Bind(_app App) *SourceCodeProviderConfig
}

GitHub source code provider. Experimental.

func NewGitHubSourceCodeProvider 

func NewGitHubSourceCodeProvider(props *GitHubSourceCodeProviderProps) GitHubSourceCodeProvider

Experimental.

type GitHubSourceCodeProviderProps 

type GitHubSourceCodeProviderProps struct {
	// A personal access token with the `repo` scope.
	// Experimental.
	OauthToken awscdk.SecretValue `json:"oauthToken"`
	// The user or organization owning the repository.
	// Experimental.
	Owner *string `json:"owner"`
	// The name of the repository.
	// Experimental.
	Repository *string `json:"repository"`
}

Properties for a GitHub source code provider. Experimental.

type GitLabSourceCodeProvider 

type GitLabSourceCodeProvider interface {
	ISourceCodeProvider
	Bind(_app App) *SourceCodeProviderConfig
}

GitLab source code provider. Experimental.

func NewGitLabSourceCodeProvider 

func NewGitLabSourceCodeProvider(props *GitLabSourceCodeProviderProps) GitLabSourceCodeProvider

Experimental.

type GitLabSourceCodeProviderProps 

type GitLabSourceCodeProviderProps struct {
	// A personal access token with the `repo` scope.
	// Experimental.
	OauthToken awscdk.SecretValue `json:"oauthToken"`
	// The user or organization owning the repository.
	// Experimental.
	Owner *string `json:"owner"`
	// The name of the repository.
	// Experimental.
	Repository *string `json:"repository"`
}

Properties for a GitLab source code provider. Experimental.

type IApp 

type IApp interface {
	awscdk.IResource
	// The application id.
	// Experimental.
	AppId() *string
}

An Amplify Console application. Experimental.

func App_FromAppId 

func App_FromAppId(scope constructs.Construct, id *string, appId *string) IApp

Import an existing application. Experimental.

type IBranch 

type IBranch interface {
	awscdk.IResource
	// The name of the branch.
	// Experimental.
	BranchName() *string
}

A branch. Experimental.

func Branch_FromBranchName 

func Branch_FromBranchName(scope constructs.Construct, id *string, branchName *string) IBranch

Import an existing branch. Experimental.

type ISourceCodeProvider 

type ISourceCodeProvider interface {
	// Binds the source code provider to an app.
	// Experimental.
	Bind(app App) *SourceCodeProviderConfig
}

A source code provider. Experimental.

type RedirectStatus 

type RedirectStatus string

The status code for a URL rewrite or redirect rule. Experimental. 

const (
	RedirectStatus_REWRITE            RedirectStatus = "REWRITE"
	RedirectStatus_PERMANENT_REDIRECT RedirectStatus = "PERMANENT_REDIRECT"
	RedirectStatus_TEMPORARY_REDIRECT RedirectStatus = "TEMPORARY_REDIRECT"
	RedirectStatus_NOT_FOUND          RedirectStatus = "NOT_FOUND"
	RedirectStatus_NOT_FOUND_REWRITE  RedirectStatus = "NOT_FOUND_REWRITE"
)

type SourceCodeProviderConfig 

type SourceCodeProviderConfig struct {
	// The repository for the application.
	//
	// Must use the `HTTPS` protocol.
	//
	// TODO: EXAMPLE
	//
	// Experimental.
	Repository *string `json:"repository"`
	// Personal Access token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key.
	//
	// Token is not stored.
	//
	// Either `accessToken` or `oauthToken` must be specified if `repository`
	// is sepcified.
	// Experimental.
	AccessToken awscdk.SecretValue `json:"accessToken"`
	// OAuth token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key.
	//
	// OAuth token is not stored.
	//
	// Either `accessToken` or `oauthToken` must be specified if `repository`
	// is sepcified.
	// Experimental.
	OauthToken awscdk.SecretValue `json:"oauthToken"`
}

Configuration for the source code provider. Experimental.

type SubDomain 

type SubDomain struct {
	// The branch.
	// Experimental.
	Branch IBranch `json:"branch"`
	// The prefix.
	//
	// Use ” to map to the root of the domain
	// Experimental.
	Prefix *string `json:"prefix"`
}

Sub domain settings. Experimental.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.