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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb

Overview

Note:

When making an API call, you may pass CreateAppRequest data as a hash:

{
  name: "Name", # required
  description: "Description",
  repository: "Repository",
  platform: "WEB", # accepts WEB, WEB_DYNAMIC
  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.

See Also:

Constant Summary collapse

SENSITIVE = 
[:oauth_token, :access_token, :basic_auth_credentials, :build_spec]

Instance Attribute Summary collapse

Instance Attribute Details

#access_token ⇒ String

The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.

Use accessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use oauthToken.

You must specify either accessToken or oauthToken when you create a new app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

Returns:

  • (String) 


649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 649

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#auto_branch_creation_config ⇒ Types::AutoBranchCreationConfig

The automated branch creation configuration for an Amplify app.

Returns:



649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 649

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#auto_branch_creation_patterns ⇒ Array<String>

The automated branch creation glob patterns for an Amplify app.

Returns:

  • (Array<String>) 


649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 649

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#basic_auth_credentials ⇒ String

The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.

Returns:

  • (String) 


649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 649

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#build_spec ⇒ String

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

Returns:

  • (String) 


649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 649

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#custom_headers ⇒ String

The custom HTTP headers for an Amplify app.

Returns:

  • (String) 


649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 649

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#custom_rules ⇒ Array<Types::CustomRule>

The custom rewrite and redirect rules for an Amplify app.

Returns:



649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 649

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#description ⇒ String

The description for an Amplify app.

Returns:

  • (String) 


649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 649

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_auto_branch_creation ⇒ Boolean

Enables automated branch creation for an Amplify app.

Returns:

  • (Boolean) 


649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 649

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_basic_auth ⇒ Boolean

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

Returns:

  • (Boolean) 


649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 649

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_branch_auto_build ⇒ Boolean

Enables the auto building of branches for an Amplify app.

Returns:

  • (Boolean) 


649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 649

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_branch_auto_deletion ⇒ Boolean

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

Returns:

  • (Boolean) 


649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 649

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#environment_variables ⇒ Hash<String,String>

The environment variables map for an Amplify app.

Returns:

  • (Hash<String,String>) 


649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 649

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#iam_service_role_arn ⇒ String

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

Returns:

  • (String) 


649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 649

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#name ⇒ String

The name for an Amplify app.

Returns:

  • (String) 


649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 649

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#oauth_token ⇒ String

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 using SSH cloning. The OAuth token is not stored.

Use oauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use accessToken.

You must specify either oauthToken or accessToken when you create a new app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

Returns:

  • (String) 


649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 649

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#platform ⇒ String

The platform or framework for an Amplify app.

Returns:

  • (String) 


649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 649

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#repository ⇒ String

The repository for an Amplify app.

Returns:

  • (String) 


649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 649

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tag for an Amplify app.

Returns:

  • (Hash<String,String>) 


649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 649

class CreateAppRequest < Struct.new(
  :name,
  :description,
  :repository,
  :platform,
  :iam_service_role_arn,
  :oauth_token,
  :access_token,
  :environment_variables,
  :enable_branch_auto_build,
  :enable_branch_auto_deletion,
  :enable_basic_auth,
  :basic_auth_credentials,
  :custom_rules,
  :tags,
  :build_spec,
  :custom_headers,
  :enable_auto_branch_creation,
  :auto_branch_creation_patterns,
  :auto_branch_creation_config)
  SENSITIVE = [:oauth_token, :access_token, :basic_auth_credentials, :build_spec]
  include Aws::Structure
end