aws-native.amplify.App
The AWS::Amplify::App resource creates Apps in the Amplify Console. An App is a collection of branches.
Create App Resource
new App(name: string, args?: AppArgs, opts?: CustomResourceOptions);
@overload
def App(resource_name: str,
opts: Optional[ResourceOptions] = None,
access_token: Optional[str] = None,
auto_branch_creation_config: Optional[AppAutoBranchCreationConfigArgs] = None,
basic_auth_config: Optional[AppBasicAuthConfigArgs] = None,
build_spec: Optional[str] = None,
custom_headers: Optional[str] = None,
custom_rules: Optional[Sequence[AppCustomRuleArgs]] = None,
description: Optional[str] = None,
enable_branch_auto_deletion: Optional[bool] = None,
environment_variables: Optional[Sequence[AppEnvironmentVariableArgs]] = None,
i_am_service_role: Optional[str] = None,
name: Optional[str] = None,
oauth_token: Optional[str] = None,
platform: Optional[AppPlatform] = None,
repository: Optional[str] = None,
tags: Optional[Sequence[AppTagArgs]] = None)
@overload
def App(resource_name: str,
args: Optional[AppArgs] = None,
opts: Optional[ResourceOptions] = None)
func NewApp(ctx *Context, name string, args *AppArgs, opts ...ResourceOption) (*App, error)
public App(string name, AppArgs? args = null, CustomResourceOptions? opts = null)
type: aws-native:amplify:App
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AppArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args AppArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AppArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AppArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AppArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
App Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The App resource accepts the following input properties:
- Access
Token string - Auto
Branch Pulumi.Creation Config Aws Native. Amplify. Inputs. App Auto Branch Creation Config Args - Basic
Auth Pulumi.Config Aws Native. Amplify. Inputs. App Basic Auth Config Args - Build
Spec string - Custom
Headers string - Custom
Rules List<Pulumi.Aws Native. Amplify. Inputs. App Custom Rule Args> - Description string
- Enable
Branch boolAuto Deletion - Environment
Variables List<Pulumi.Aws Native. Amplify. Inputs. App Environment Variable Args> - IAMService
Role string - Name string
- Oauth
Token string - Platform
Pulumi.
Aws Native. Amplify. App Platform - Repository string
- List<Pulumi.
Aws Native. Amplify. Inputs. App Tag Args>
- Access
Token string - Auto
Branch AppCreation Config Auto Branch Creation Config Args - Basic
Auth AppConfig Basic Auth Config Args - Build
Spec string - Custom
Headers string - Custom
Rules []AppCustom Rule Args - Description string
- Enable
Branch boolAuto Deletion - Environment
Variables []AppEnvironment Variable Args - IAMService
Role string - Name string
- Oauth
Token string - Platform
App
Platform - Repository string
- []App
Tag Args
- access
Token String - auto
Branch AppCreation Config Auto Branch Creation Config Args - basic
Auth AppConfig Basic Auth Config Args - build
Spec String - custom
Headers String - custom
Rules List<AppCustom Rule Args> - description String
- enable
Branch BooleanAuto Deletion - environment
Variables List<AppEnvironment Variable Args> - i
AMService StringRole - name String
- oauth
Token String - platform
App
Platform - repository String
- List<App
Tag Args>
- access
Token string - auto
Branch AppCreation Config Auto Branch Creation Config Args - basic
Auth AppConfig Basic Auth Config Args - build
Spec string - custom
Headers string - custom
Rules AppCustom Rule Args[] - description string
- enable
Branch booleanAuto Deletion - environment
Variables AppEnvironment Variable Args[] - i
AMService stringRole - name string
- oauth
Token string - platform
App
Platform - repository string
- App
Tag Args[]
- access_
token str - auto_
branch_ Appcreation_ config Auto Branch Creation Config Args - basic_
auth_ Appconfig Basic Auth Config Args - build_
spec str - custom_
headers str - custom_
rules Sequence[AppCustom Rule Args] - description str
- enable_
branch_ boolauto_ deletion - environment_
variables Sequence[AppEnvironment Variable Args] - i_
am_ strservice_ role - name str
- oauth_
token str - platform
App
Platform - repository str
- Sequence[App
Tag Args]
- access
Token String - auto
Branch Property MapCreation Config - basic
Auth Property MapConfig - build
Spec String - custom
Headers String - custom
Rules List<Property Map> - description String
- enable
Branch BooleanAuto Deletion - environment
Variables List<Property Map> - i
AMService StringRole - name String
- oauth
Token String - platform "WEB" | "WEB_DYNAMIC" | "WEB_COMPUTE"
- repository String
- List<Property Map>
Outputs
All input properties are implicitly available as output properties. Additionally, the App resource produces the following output properties:
- App
Id string - App
Name string - Arn string
- Default
Domain string - Id string
The provider-assigned unique ID for this managed resource.
- App
Id string - App
Name string - Arn string
- Default
Domain string - Id string
The provider-assigned unique ID for this managed resource.
- app
Id String - app
Name String - arn String
- default
Domain String - id String
The provider-assigned unique ID for this managed resource.
- app
Id string - app
Name string - arn string
- default
Domain string - id string
The provider-assigned unique ID for this managed resource.
- app_
id str - app_
name str - arn str
- default_
domain str - id str
The provider-assigned unique ID for this managed resource.
- app
Id String - app
Name String - arn String
- default
Domain String - id String
The provider-assigned unique ID for this managed resource.
Supporting Types
AppAutoBranchCreationConfig
- Auto
Branch List<string>Creation Patterns - Basic
Auth Pulumi.Config Aws Native. Amplify. Inputs. App Basic Auth Config - Build
Spec string - Enable
Auto boolBranch Creation - Enable
Auto boolBuild - Enable
Performance boolMode - Enable
Pull boolRequest Preview - Environment
Variables List<Pulumi.Aws Native. Amplify. Inputs. App Environment Variable> - Framework string
- Pull
Request stringEnvironment Name - Stage
Pulumi.
Aws Native. Amplify. App Auto Branch Creation Config Stage
- Auto
Branch []stringCreation Patterns - Basic
Auth AppConfig Basic Auth Config - Build
Spec string - Enable
Auto boolBranch Creation - Enable
Auto boolBuild - Enable
Performance boolMode - Enable
Pull boolRequest Preview - Environment
Variables []AppEnvironment Variable - Framework string
- Pull
Request stringEnvironment Name - Stage
App
Auto Branch Creation Config Stage
- auto
Branch List<String>Creation Patterns - basic
Auth AppConfig Basic Auth Config - build
Spec String - enable
Auto BooleanBranch Creation - enable
Auto BooleanBuild - enable
Performance BooleanMode - enable
Pull BooleanRequest Preview - environment
Variables List<AppEnvironment Variable> - framework String
- pull
Request StringEnvironment Name - stage
App
Auto Branch Creation Config Stage
- auto
Branch string[]Creation Patterns - basic
Auth AppConfig Basic Auth Config - build
Spec string - enable
Auto booleanBranch Creation - enable
Auto booleanBuild - enable
Performance booleanMode - enable
Pull booleanRequest Preview - environment
Variables AppEnvironment Variable[] - framework string
- pull
Request stringEnvironment Name - stage
App
Auto Branch Creation Config Stage
- auto_
branch_ Sequence[str]creation_ patterns - basic_
auth_ Appconfig Basic Auth Config - build_
spec str - enable_
auto_ boolbranch_ creation - enable_
auto_ boolbuild - enable_
performance_ boolmode - enable_
pull_ boolrequest_ preview - environment_
variables Sequence[AppEnvironment Variable] - framework str
- pull_
request_ strenvironment_ name - stage
App
Auto Branch Creation Config Stage
- auto
Branch List<String>Creation Patterns - basic
Auth Property MapConfig - build
Spec String - enable
Auto BooleanBranch Creation - enable
Auto BooleanBuild - enable
Performance BooleanMode - enable
Pull BooleanRequest Preview - environment
Variables List<Property Map> - framework String
- pull
Request StringEnvironment Name - stage "EXPERIMENTAL" | "BETA" | "PULL_REQUEST" | "PRODUCTION" | "DEVELOPMENT"
AppAutoBranchCreationConfigStage
- Experimental
- EXPERIMENTAL
- Beta
- BETA
- Pull
Request - PULL_REQUEST
- Production
- PRODUCTION
- Development
- DEVELOPMENT
- App
Auto Branch Creation Config Stage Experimental - EXPERIMENTAL
- App
Auto Branch Creation Config Stage Beta - BETA
- App
Auto Branch Creation Config Stage Pull Request - PULL_REQUEST
- App
Auto Branch Creation Config Stage Production - PRODUCTION
- App
Auto Branch Creation Config Stage Development - DEVELOPMENT
- Experimental
- EXPERIMENTAL
- Beta
- BETA
- Pull
Request - PULL_REQUEST
- Production
- PRODUCTION
- Development
- DEVELOPMENT
- Experimental
- EXPERIMENTAL
- Beta
- BETA
- Pull
Request - PULL_REQUEST
- Production
- PRODUCTION
- Development
- DEVELOPMENT
- EXPERIMENTAL
- EXPERIMENTAL
- BETA
- BETA
- PULL_REQUEST
- PULL_REQUEST
- PRODUCTION
- PRODUCTION
- DEVELOPMENT
- DEVELOPMENT
- "EXPERIMENTAL"
- EXPERIMENTAL
- "BETA"
- BETA
- "PULL_REQUEST"
- PULL_REQUEST
- "PRODUCTION"
- PRODUCTION
- "DEVELOPMENT"
- DEVELOPMENT
AppBasicAuthConfig
- Enable
Basic boolAuth - Password string
- Username string
- Enable
Basic boolAuth - Password string
- Username string
- enable
Basic BooleanAuth - password String
- username String
- enable
Basic booleanAuth - password string
- username string
- enable_
basic_ boolauth - password str
- username str
- enable
Basic BooleanAuth - password String
- username String
AppCustomRule
AppEnvironmentVariable
AppPlatform
- Web
- WEB
- Web
Dynamic - WEB_DYNAMIC
- Web
Compute - WEB_COMPUTE
- App
Platform Web - WEB
- App
Platform Web Dynamic - WEB_DYNAMIC
- App
Platform Web Compute - WEB_COMPUTE
- Web
- WEB
- Web
Dynamic - WEB_DYNAMIC
- Web
Compute - WEB_COMPUTE
- Web
- WEB
- Web
Dynamic - WEB_DYNAMIC
- Web
Compute - WEB_COMPUTE
- WEB
- WEB
- WEB_DYNAMIC
- WEB_DYNAMIC
- WEB_COMPUTE
- WEB_COMPUTE
- "WEB"
- WEB
- "WEB_DYNAMIC"
- WEB_DYNAMIC
- "WEB_COMPUTE"
- WEB_COMPUTE
AppTag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0