1. Packages
  2. AWS Native
  3. API Docs
  4. amplify
  5. App

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

aws-native.amplify.App

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

    The AWS::Amplify::App resource creates Apps in the Amplify Console. An App is a collection of branches.

    Create App Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new App(name: string, args?: AppArgs, opts?: CustomResourceOptions);
    @overload
    def App(resource_name: str,
            args: Optional[AppArgs] = None,
            opts: Optional[ResourceOptions] = None)
    
    @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,
            iam_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[_root_inputs.TagArgs]] = None)
    func NewApp(ctx *Context, name string, args *AppArgs, opts ...ResourceOption) (*App, error)
    public App(string name, AppArgs? args = null, CustomResourceOptions? opts = null)
    public App(String name, AppArgs args)
    public App(String name, AppArgs args, CustomResourceOptions options)
    
    type: aws-native:amplify:App
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    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.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const appResource = new aws_native.amplify.App("appResource", {
        accessToken: "string",
        autoBranchCreationConfig: {
            autoBranchCreationPatterns: ["string"],
            basicAuthConfig: {
                enableBasicAuth: false,
                password: "string",
                username: "string",
            },
            buildSpec: "string",
            enableAutoBranchCreation: false,
            enableAutoBuild: false,
            enablePerformanceMode: false,
            enablePullRequestPreview: false,
            environmentVariables: [{
                name: "string",
                value: "string",
            }],
            framework: "string",
            pullRequestEnvironmentName: "string",
            stage: aws_native.amplify.AppAutoBranchCreationConfigStage.Experimental,
        },
        basicAuthConfig: {
            enableBasicAuth: false,
            password: "string",
            username: "string",
        },
        buildSpec: "string",
        customHeaders: "string",
        customRules: [{
            source: "string",
            target: "string",
            condition: "string",
            status: "string",
        }],
        description: "string",
        enableBranchAutoDeletion: false,
        environmentVariables: [{
            name: "string",
            value: "string",
        }],
        iamServiceRole: "string",
        name: "string",
        oauthToken: "string",
        platform: aws_native.amplify.AppPlatform.Web,
        repository: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    Coming soon!
    

    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:

    Outputs

    All input properties are implicitly available as output properties. Additionally, the App resource produces the following output properties:

    AppId string
    AppName string
    Arn string
    DefaultDomain string
    Id string
    The provider-assigned unique ID for this managed resource.
    AppId string
    AppName string
    Arn string
    DefaultDomain string
    Id string
    The provider-assigned unique ID for this managed resource.
    appId String
    appName String
    arn String
    defaultDomain String
    id String
    The provider-assigned unique ID for this managed resource.
    appId string
    appName string
    arn string
    defaultDomain 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.
    appId String
    appName String
    arn String
    defaultDomain String
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    AppAutoBranchCreationConfig, AppAutoBranchCreationConfigArgs

    AppAutoBranchCreationConfigStage, AppAutoBranchCreationConfigStageArgs

    Experimental
    EXPERIMENTAL
    Beta
    BETA
    PullRequest
    PULL_REQUEST
    Production
    PRODUCTION
    Development
    DEVELOPMENT
    AppAutoBranchCreationConfigStageExperimental
    EXPERIMENTAL
    AppAutoBranchCreationConfigStageBeta
    BETA
    AppAutoBranchCreationConfigStagePullRequest
    PULL_REQUEST
    AppAutoBranchCreationConfigStageProduction
    PRODUCTION
    AppAutoBranchCreationConfigStageDevelopment
    DEVELOPMENT
    Experimental
    EXPERIMENTAL
    Beta
    BETA
    PullRequest
    PULL_REQUEST
    Production
    PRODUCTION
    Development
    DEVELOPMENT
    Experimental
    EXPERIMENTAL
    Beta
    BETA
    PullRequest
    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, AppBasicAuthConfigArgs

    enableBasicAuth Boolean
    password String
    username String
    enableBasicAuth boolean
    password string
    username string
    enableBasicAuth Boolean
    password String
    username String

    AppCustomRule, AppCustomRuleArgs

    Source string
    Target string
    Condition string
    Status string
    Source string
    Target string
    Condition string
    Status string
    source String
    target String
    condition String
    status String
    source string
    target string
    condition string
    status string
    source String
    target String
    condition String
    status String

    AppEnvironmentVariable, AppEnvironmentVariableArgs

    Name string
    Value string
    Name string
    Value string
    name String
    value String
    name string
    value string
    name str
    value str
    name String
    value String

    AppPlatform, AppPlatformArgs

    Web
    WEB
    WebDynamic
    WEB_DYNAMIC
    WebCompute
    WEB_COMPUTE
    AppPlatformWeb
    WEB
    AppPlatformWebDynamic
    WEB_DYNAMIC
    AppPlatformWebCompute
    WEB_COMPUTE
    Web
    WEB
    WebDynamic
    WEB_DYNAMIC
    WebCompute
    WEB_COMPUTE
    Web
    WEB
    WebDynamic
    WEB_DYNAMIC
    WebCompute
    WEB_COMPUTE
    WEB
    WEB
    WEB_DYNAMIC
    WEB_DYNAMIC
    WEB_COMPUTE
    WEB_COMPUTE
    "WEB"
    WEB
    "WEB_DYNAMIC"
    WEB_DYNAMIC
    "WEB_COMPUTE"
    WEB_COMPUTE

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi