Documentation ¶
Index ¶
- func CfnApp_CFN_RESOURCE_TYPE_NAME() *string
- func CfnApp_IsCfnElement(x interface{}) *bool
- func CfnApp_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnApp_IsConstruct(x interface{}) *bool
- func CfnBranch_CFN_RESOURCE_TYPE_NAME() *string
- func CfnBranch_IsCfnElement(x interface{}) *bool
- func CfnBranch_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnBranch_IsConstruct(x interface{}) *bool
- func CfnDomain_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDomain_IsCfnElement(x interface{}) *bool
- func CfnDomain_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDomain_IsConstruct(x interface{}) *bool
- func NewCfnApp_Override(c CfnApp, scope constructs.Construct, id *string, props *CfnAppProps)
- func NewCfnBranch_Override(c CfnBranch, scope constructs.Construct, id *string, props *CfnBranchProps)
- func NewCfnDomain_Override(c CfnDomain, scope constructs.Construct, id *string, props *CfnDomainProps)
- type CfnApp
- type CfnAppProps
- type CfnApp_AutoBranchCreationConfigProperty
- type CfnApp_BasicAuthConfigProperty
- type CfnApp_CustomRuleProperty
- type CfnApp_EnvironmentVariableProperty
- type CfnBranch
- type CfnBranchProps
- type CfnBranch_BasicAuthConfigProperty
- type CfnBranch_EnvironmentVariableProperty
- type CfnDomain
- type CfnDomainProps
- type CfnDomain_SubDomainSettingProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
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.
func CfnApp_IsCfnResource ¶
func CfnApp_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnApp_IsConstruct ¶
func CfnApp_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
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.
func CfnBranch_IsCfnResource ¶
func CfnBranch_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnBranch_IsConstruct ¶
func CfnBranch_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
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.
func CfnDomain_IsCfnResource ¶
func CfnDomain_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnDomain_IsConstruct ¶
func CfnDomain_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func NewCfnApp_Override ¶
func NewCfnApp_Override(c CfnApp, scope constructs.Construct, id *string, props *CfnAppProps)
Create a new `AWS::Amplify::App`.
func NewCfnBranch_Override ¶
func NewCfnBranch_Override(c CfnBranch, scope constructs.Construct, id *string, props *CfnBranchProps)
Create a new `AWS::Amplify::Branch`.
func NewCfnDomain_Override ¶
func NewCfnDomain_Override(c CfnDomain, scope constructs.Construct, id *string, props *CfnDomainProps)
Create a new `AWS::Amplify::Domain`.
Types ¶
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() constructs.Node 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) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::Amplify::App`.
The AWS::Amplify::App resource creates Apps in the Amplify Console. An App is a collection of branches.
TODO: EXAMPLE
func NewCfnApp ¶
func NewCfnApp(scope constructs.Construct, id *string, props *CfnAppProps) CfnApp
Create a new `AWS::Amplify::App`.
type CfnAppProps ¶
type CfnAppProps struct { // The name for an Amplify app. // // *Length Constraints:* Minimum length of 1. Maximum length of 255. // // *Pattern:* (?s).+ Name *string `json:"name" yaml:"name"` // 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. // // *Length Constraints:* Minimum length of 1. Maximum length of 255. AccessToken *string `json:"accessToken" yaml:"accessToken"` // Sets the configuration for your automatic branch creation. AutoBranchCreationConfig interface{} `json:"autoBranchCreationConfig" yaml:"autoBranchCreationConfig"` // The credentials for basic authorization for an Amplify app. // // You must base64-encode the authorization credentials and provide them in the format `user:password` . BasicAuthConfig interface{} `json:"basicAuthConfig" yaml:"basicAuthConfig"` // The build specification (build spec) for an Amplify app. // // *Length Constraints:* Minimum length of 1. Maximum length of 25000. // // *Pattern:* (?s).+ BuildSpec *string `json:"buildSpec" yaml:"buildSpec"` // The custom HTTP headers for an Amplify app. // // *Length Constraints:* Minimum length of 0. Maximum length of 25000. // // *Pattern:* (?s).* CustomHeaders *string `json:"customHeaders" yaml:"customHeaders"` // The custom rewrite and redirect rules for an Amplify app. CustomRules interface{} `json:"customRules" yaml:"customRules"` // The description for an Amplify app. // // *Length Constraints:* Maximum length of 1000. // // *Pattern:* (?s).* Description *string `json:"description" yaml:"description"` // Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository. EnableBranchAutoDeletion interface{} `json:"enableBranchAutoDeletion" yaml:"enableBranchAutoDeletion"` // The environment variables map for an Amplify app. EnvironmentVariables interface{} `json:"environmentVariables" yaml:"environmentVariables"` // The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app. // // *Length Constraints:* Minimum length of 0. Maximum length of 1000. // // *Pattern:* (?s).* IamServiceRole *string `json:"iamServiceRole" yaml:"iamServiceRole"` // The OAuth token for a third-party source control system for an Amplify app. // // The OAuth token is used to create a webhook and a read-only deploy key. The OAuth token is not stored. // // *Length Constraints:* Maximum length of 1000. // // *Pattern:* (?s).* OauthToken *string `json:"oauthToken" yaml:"oauthToken"` // The repository for an Amplify app. // // *Pattern:* (?s).* Repository *string `json:"repository" yaml:"repository"` // The tag for an Amplify app. Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"` }
Properties for defining a `CfnApp`.
TODO: EXAMPLE
type CfnApp_AutoBranchCreationConfigProperty ¶
type CfnApp_AutoBranchCreationConfigProperty struct { // Automated branch creation glob patterns for the Amplify app. AutoBranchCreationPatterns *[]*string `json:"autoBranchCreationPatterns" yaml:"autoBranchCreationPatterns"` // Sets password protection for your auto created branch. BasicAuthConfig interface{} `json:"basicAuthConfig" yaml:"basicAuthConfig"` // The build specification (build spec) for the autocreated branch. // // *Length Constraints:* Minimum length of 1. Maximum length of 25000. BuildSpec *string `json:"buildSpec" yaml:"buildSpec"` // Enables automated branch creation for the Amplify app. EnableAutoBranchCreation interface{} `json:"enableAutoBranchCreation" yaml:"enableAutoBranchCreation"` // Enables auto building for the auto created branch. EnableAutoBuild interface{} `json:"enableAutoBuild" yaml:"enableAutoBuild"` // Enables performance mode for the branch. // // Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out. EnablePerformanceMode interface{} `json:"enablePerformanceMode" yaml:"enablePerformanceMode"` // Sets whether pull request previews are enabled for each branch that Amplify Console automatically creates for your app. // // Amplify Console creates previews by deploying your app to a unique URL whenever a pull request is opened for the branch. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch. // // To provide backend support for your preview, the Amplify Console automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the `PullRequestEnvironmentName` property. // // For more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the *AWS Amplify Console User Guide* . EnablePullRequestPreview interface{} `json:"enablePullRequestPreview" yaml:"enablePullRequestPreview"` // Environment variables for the auto created branch. EnvironmentVariables interface{} `json:"environmentVariables" yaml:"environmentVariables"` // If pull request previews are enabled, you can use this property to specify a dedicated backend environment for your previews. // // For example, you could specify an environment named `prod` , `test` , or `dev` that you initialized with the Amplify CLI. // // To enable pull request previews, set the `EnablePullRequestPreview` property to `true` . // // If you don't specify an environment, the Amplify Console provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Console deletes this environment when the pull request is closed. // // For more information about creating backend environments, see [Feature Branch Deployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Console User Guide* . // // *Length Constraints:* Maximum length of 20. // // *Pattern:* (?s).* PullRequestEnvironmentName *string `json:"pullRequestEnvironmentName" yaml:"pullRequestEnvironmentName"` // Stage for the auto created branch. Stage *string `json:"stage" yaml:"stage"` }
Use the AutoBranchCreationConfig property type to automatically create branches that match a certain pattern.
TODO: EXAMPLE
type CfnApp_BasicAuthConfigProperty ¶
type CfnApp_BasicAuthConfigProperty struct { // Enables basic authorization for the Amplify app's branches. EnableBasicAuth interface{} `json:"enableBasicAuth" yaml:"enableBasicAuth"` // The password for basic authorization. // // *Length Constraints:* Minimum length of 1. Maximum length of 255. Password *string `json:"password" yaml:"password"` // The user name for basic authorization. // // *Length Constraints:* Minimum length of 1. Maximum length of 255. Username *string `json:"username" yaml:"username"` }
Use the BasicAuthConfig property type to set password protection at an app level to all your branches.
TODO: EXAMPLE
type CfnApp_CustomRuleProperty ¶
type CfnApp_CustomRuleProperty struct { // The source pattern for a URL rewrite or redirect rule. // // *Length Constraints:* Minimum length of 1. Maximum length of 2048. // // *Pattern:* (?s).+ Source *string `json:"source" yaml:"source"` // The target pattern for a URL rewrite or redirect rule. // // *Length Constraints:* Minimum length of 1. Maximum length of 2048. // // *Pattern:* (?s).+ Target *string `json:"target" yaml:"target"` // The condition for a URL rewrite or redirect rule, such as a country code. // // *Length Constraints:* Minimum length of 0. Maximum length of 2048. // // *Pattern:* (?s).* Condition *string `json:"condition" yaml:"condition"` // The status code for a URL rewrite or redirect rule. // // - **200** - Represents a 200 rewrite rule. // - **301** - Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL. // - **302** - Represents a 302 temporary redirect rule. // - **404** - Represents a 404 redirect rule. // - **404-200** - Represents a 404 rewrite rule. // // *Length Constraints:* Minimum length of 3. Maximum length of 7. // // *Pattern:* .{3,7} Status *string `json:"status" yaml:"status"` }
The CustomRule property type allows you to specify redirects, rewrites, and reverse proxies.
Redirects enable a web app to reroute navigation from one URL to another.
TODO: EXAMPLE
type CfnApp_EnvironmentVariableProperty ¶
type CfnApp_EnvironmentVariableProperty struct { // The environment variable name. // // *Length Constraints:* Maximum length of 255. // // *Pattern:* (?s).* Name *string `json:"name" yaml:"name"` // The environment variable value. // // *Length Constraints:* Maximum length of 5500. // // *Pattern:* (?s).* Value *string `json:"value" yaml:"value"` }
Environment variables are key-value pairs that are available at build time.
Set environment variables for all branches in your app.
TODO: EXAMPLE
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() constructs.Node 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) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::Amplify::Branch`.
The AWS::Amplify::Branch resource creates a new branch within an app.
TODO: EXAMPLE
func NewCfnBranch ¶
func NewCfnBranch(scope constructs.Construct, id *string, props *CfnBranchProps) CfnBranch
Create a new `AWS::Amplify::Branch`.
type CfnBranchProps ¶
type CfnBranchProps struct { // The unique ID for an Amplify app. // // *Length Constraints:* Minimum length of 1. Maximum length of 20. // // *Pattern:* d[a-z0-9]+ AppId *string `json:"appId" yaml:"appId"` // The name for the branch. // // *Length Constraints:* Minimum length of 1. Maximum length of 255. // // *Pattern:* (?s).+ BranchName *string `json:"branchName" yaml:"branchName"` // The basic authorization credentials for a branch of an Amplify app. // // You must base64-encode the authorization credentials and provide them in the format `user:password` . BasicAuthConfig interface{} `json:"basicAuthConfig" yaml:"basicAuthConfig"` // The build specification (build spec) for the branch. // // *Length Constraints:* Minimum length of 1. Maximum length of 25000. // // *Pattern:* (?s).+ BuildSpec *string `json:"buildSpec" yaml:"buildSpec"` // The description for the branch that is part of an Amplify app. // // *Length Constraints:* Maximum length of 1000. // // *Pattern:* (?s).* Description *string `json:"description" yaml:"description"` // Enables auto building for the branch. EnableAutoBuild interface{} `json:"enableAutoBuild" yaml:"enableAutoBuild"` // Enables performance mode for the branch. // // Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out. EnablePerformanceMode interface{} `json:"enablePerformanceMode" yaml:"enablePerformanceMode"` // Sets whether the Amplify Console creates a preview for each pull request that is made for this branch. // // If this property is enabled, the Amplify Console deploys your app to a unique preview URL after each pull request is opened. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch. // // To provide backend support for your preview, the Amplify Console automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the `PullRequestEnvironmentName` property. // // For more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the *AWS Amplify Console User Guide* . EnablePullRequestPreview interface{} `json:"enablePullRequestPreview" yaml:"enablePullRequestPreview"` // The environment variables for the branch. EnvironmentVariables interface{} `json:"environmentVariables" yaml:"environmentVariables"` // If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews. // // For example, you could specify an environment named `prod` , `test` , or `dev` that you initialized with the Amplify CLI and mapped to this branch. // // To enable pull request previews, set the `EnablePullRequestPreview` property to `true` . // // If you don't specify an environment, the Amplify Console provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Console deletes this environment when the pull request is closed. // // For more information about creating backend environments, see [Feature Branch Deployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Console User Guide* . // // *Length Constraints:* Maximum length of 20. // // *Pattern:* (?s).* PullRequestEnvironmentName *string `json:"pullRequestEnvironmentName" yaml:"pullRequestEnvironmentName"` // Describes the current stage for the branch. // // *Valid Values:* PRODUCTION | BETA | DEVELOPMENT | EXPERIMENTAL | PULL_REQUEST Stage *string `json:"stage" yaml:"stage"` // The tag for the branch. Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"` }
Properties for defining a `CfnBranch`.
TODO: EXAMPLE
type CfnBranch_BasicAuthConfigProperty ¶
type CfnBranch_BasicAuthConfigProperty struct { // The password for basic authorization. // // *Length Constraints:* Minimum length of 1. Maximum length of 255. Password *string `json:"password" yaml:"password"` // The user name for basic authorization. // // *Length Constraints:* Minimum length of 1. Maximum length of 255. Username *string `json:"username" yaml:"username"` // Enables basic authorization for the branch. EnableBasicAuth interface{} `json:"enableBasicAuth" yaml:"enableBasicAuth"` }
Use the BasicAuthConfig property type to set password protection for a specific branch.
TODO: EXAMPLE
type CfnBranch_EnvironmentVariableProperty ¶
type CfnBranch_EnvironmentVariableProperty struct { // The environment variable name. // // *Length Constraints:* Maximum length of 255. // // *Pattern:* (?s).* Name *string `json:"name" yaml:"name"` // The environment variable value. // // *Length Constraints:* Maximum length of 5500. // // *Pattern:* (?s).* Value *string `json:"value" yaml:"value"` }
The EnvironmentVariable property type sets environment variables for a specific branch.
Environment variables are key-value pairs that are available at build time.
TODO: EXAMPLE
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() constructs.Node 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) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::Amplify::Domain`.
The AWS::Amplify::Domain resource allows you to connect a custom domain to your app.
TODO: EXAMPLE
func NewCfnDomain ¶
func NewCfnDomain(scope constructs.Construct, id *string, props *CfnDomainProps) CfnDomain
Create a new `AWS::Amplify::Domain`.
type CfnDomainProps ¶
type CfnDomainProps struct { // The unique ID for an Amplify app. // // *Length Constraints:* Minimum length of 1. Maximum length of 20. // // *Pattern:* d[a-z0-9]+ AppId *string `json:"appId" yaml:"appId"` // The domain name for the domain association. // // *Length Constraints:* Maximum length of 255. // // *Pattern:* ^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])(\.)?$ DomainName *string `json:"domainName" yaml:"domainName"` // The setting for the subdomain. SubDomainSettings interface{} `json:"subDomainSettings" yaml:"subDomainSettings"` // Sets the branch patterns for automatic subdomain creation. AutoSubDomainCreationPatterns *[]*string `json:"autoSubDomainCreationPatterns" yaml:"autoSubDomainCreationPatterns"` // The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. // // *Length Constraints:* Maximum length of 1000. // // *Pattern:* ^$|^arn:aws:iam::\d{12}:role.+ AutoSubDomainIamRole *string `json:"autoSubDomainIamRole" yaml:"autoSubDomainIamRole"` // Enables the automated creation of subdomains for branches. EnableAutoSubDomain interface{} `json:"enableAutoSubDomain" yaml:"enableAutoSubDomain"` }
Properties for defining a `CfnDomain`.
TODO: EXAMPLE
type CfnDomain_SubDomainSettingProperty ¶
type CfnDomain_SubDomainSettingProperty struct { // The branch name setting for the subdomain. // // *Length Constraints:* Minimum length of 1. Maximum length of 255. // // *Pattern:* (?s).+ BranchName *string `json:"branchName" yaml:"branchName"` // The prefix setting for the subdomain. // // *Length Constraints:* Maximum length of 255. // // *Pattern:* (?s).* Prefix *string `json:"prefix" yaml:"prefix"` }
The SubDomainSetting property type enables you to connect a subdomain (for example, example.exampledomain.com) to a specific branch.
TODO: EXAMPLE