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", # required
  platform: "IOS", # required, accepts IOS, ANDROID, WEB, REACT_NATIVE
  iam_service_role_arn: "ServiceRoleArn",
  oauth_token: "OauthToken", # required
  environment_variables: {
    "EnvKey" => "EnvValue",
  },
  enable_branch_auto_build: 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",
}

Request structure used to create Apps in Amplify.

Instance Attribute Summary collapse

Instance Attribute Details

#basic_auth_credentialsString

Credentials for Basic Authorization for an Amplify App.

Returns:

  • (String)

    Credentials for Basic Authorization for an Amplify App.

#build_specString

BuildSpec for an Amplify App

Returns:

  • (String)

    BuildSpec for an Amplify App.

#custom_rulesArray<Types::CustomRule>

Custom rewrite / redirect rules for an Amplify App.

Returns:

#descriptionString

Description for an Amplify App

Returns:

  • (String)

    Description for an Amplify App.

#enable_basic_authBoolean

Enable Basic Authorization for an Amplify App, this will apply to all branches part of this App.

Returns:

  • (Boolean)

    Enable Basic Authorization for an Amplify App, this will apply to all branches part of this App.

#enable_branch_auto_buildBoolean

Enable the auto building of branches for an Amplify App.

Returns:

  • (Boolean)

    Enable the auto building of branches for an Amplify App.

#environment_variablesHash<String,String>

Environment variables map for an Amplify App.

Returns:

  • (Hash<String,String>)

    Environment variables map for an Amplify App.

#iam_service_role_arnString

AWS IAM service role for an Amplify App

Returns:

  • (String)

    AWS IAM service role for an Amplify App.

#nameString

Name for the Amplify App

Returns:

  • (String)

    Name for the Amplify App.

#oauth_tokenString

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.

Returns:

  • (String)

    OAuth token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key.

#platformString

Platform / framework for an Amplify App

Possible values:

  • IOS
  • ANDROID
  • WEB
  • REACT_NATIVE

Returns:

  • (String)

    Platform / framework for an Amplify App.

#repositoryString

Repository for an Amplify App

Returns:

  • (String)

    Repository for an Amplify App.

#tagsHash<String,String>

Tag for an Amplify App

Returns:

  • (Hash<String,String>)

    Tag for an Amplify App.