AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Amplify::Types::CreateAppRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateAppRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "Name", # required
  description: "Description",
  repository: "Repository",
  platform: "WEB", # accepts WEB
  iam_service_role_arn: "ServiceRoleArn",
  oauth_token: "OauthToken",
  access_token: "AccessToken",
  environment_variables: {
    "EnvKey" => "EnvValue",
  },
  enable_branch_auto_build: false,
  enable_branch_auto_deletion: false,
  enable_basic_auth: false,
  basic_auth_credentials: "BasicAuthCredentials",
  custom_rules: [
    {
      source: "Source", # required
      target: "Target", # required
      status: "Status",
      condition: "Condition",
    },
  ],
  tags: {
    "TagKey" => "TagValue",
  },
  build_spec: "BuildSpec",
  custom_headers: "CustomHeaders",
  enable_auto_branch_creation: false,
  auto_branch_creation_patterns: ["AutoBranchCreationPattern"],
  auto_branch_creation_config: {
    stage: "PRODUCTION", # accepts PRODUCTION, BETA, DEVELOPMENT, EXPERIMENTAL, PULL_REQUEST
    framework: "Framework",
    enable_auto_build: false,
    environment_variables: {
      "EnvKey" => "EnvValue",
    },
    basic_auth_credentials: "BasicAuthCredentials",
    enable_basic_auth: false,
    enable_performance_mode: false,
    build_spec: "BuildSpec",
    enable_pull_request_preview: false,
    pull_request_environment_name: "PullRequestEnvironmentName",
  },
}

The request structure used to create apps in Amplify.

Instance Attribute Summary collapse

Instance Attribute Details

#access_tokenString

The personal access token for a third-party source control system for an Amplify app. The personal access token is used to create a webhook and a read-only deploy key. The token is not stored.

Returns:

  • (String)

    The personal access token for a third-party source control system for an Amplify app.

#auto_branch_creation_configTypes::AutoBranchCreationConfig

The automated branch creation configuration for an Amplify app.

Returns:

#auto_branch_creation_patternsArray<String>

The automated branch creation glob patterns for an Amplify app.

Returns:

  • (Array<String>)

    The automated branch creation glob patterns for an Amplify app.

#basic_auth_credentialsString

The credentials for basic authorization for an Amplify app.

Returns:

  • (String)

    The credentials for basic authorization for an Amplify app.

#build_specString

The build specification (build spec) for an Amplify app.

Returns:

  • (String)

    The build specification (build spec) for an Amplify app.

#custom_headersString

The custom HTTP headers for an Amplify app.

Returns:

  • (String)

    The custom HTTP headers for an Amplify app.

#custom_rulesArray<Types::CustomRule>

The custom rewrite and redirect rules for an Amplify app.

Returns:

  • (Array<Types::CustomRule>)

    The custom rewrite and redirect rules for an Amplify app.

#descriptionString

The description for an Amplify app.

Returns:

  • (String)

    The description for an Amplify app.

#enable_auto_branch_creationBoolean

Enables automated branch creation for an Amplify app.

Returns:

  • (Boolean)

    Enables automated branch creation for an Amplify app.

#enable_basic_authBoolean

Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.

Returns:

  • (Boolean)

    Enables basic authorization for an Amplify app.

#enable_branch_auto_buildBoolean

Enables the auto building of branches for an Amplify app.

Returns:

  • (Boolean)

    Enables the auto building of branches for an Amplify app.

#enable_branch_auto_deletionBoolean

Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.

Returns:

  • (Boolean)

    Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.

#environment_variablesHash<String,String>

The environment variables map for an Amplify app.

Returns:

  • (Hash<String,String>)

    The environment variables map for an Amplify app.

#iam_service_role_arnString

The AWS Identity and Access Management (IAM) service role for an Amplify app.

Returns:

  • (String)

    The AWS Identity and Access Management (IAM) service role for an Amplify app.

#nameString

The name for an Amplify app.

Returns:

  • (String)

    The name for an Amplify app.

#oauth_tokenString

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.

Returns:

  • (String)

    The OAuth token for a third-party source control system for an Amplify app.

#platformString

The platform or framework for an Amplify app.

Possible values:

  • WEB

Returns:

  • (String)

    The platform or framework for an Amplify app.

#repositoryString

The repository for an Amplify app.

Returns:

  • (String)

    The repository for an Amplify app.

#tagsHash<String,String>

The tag for an Amplify app.

Returns:

  • (Hash<String,String>)

    The tag for an Amplify app.