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

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
  iam_service_role_arn: "ServiceRoleArn",
  oauth_token: "OauthToken",
  access_token: "AccessToken",
  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",
  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,
    build_spec: "BuildSpec",
    enable_pull_request_preview: false,
    pull_request_environment_name: "PullRequestEnvironmentName",
  },
}

Request structure used to create Apps in Amplify.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#access_token ⇒ String

Personal Access token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. Token is not stored.

Returns:

  • (String) 


528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 528

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

#auto_branch_creation_config ⇒ Types::AutoBranchCreationConfig

Automated branch creation config for the Amplify App.

Returns:



528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 528

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

#auto_branch_creation_patterns ⇒ Array<String>

Automated branch creation glob patterns for the Amplify App.

Returns:

  • (Array<String>) 


528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 528

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

#basic_auth_credentials ⇒ String

Credentials for Basic Authorization for an Amplify App.

Returns:

  • (String) 


528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 528

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

#build_spec ⇒ String

BuildSpec for an Amplify App

Returns:

  • (String) 


528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 528

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

#custom_rules ⇒ Array<Types::CustomRule>

Custom rewrite / redirect rules for an Amplify App.

Returns:



528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 528

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

#description ⇒ String

Description for an Amplify App

Returns:

  • (String) 


528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 528

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

#enable_auto_branch_creation ⇒ Boolean

Enables automated branch creation for the Amplify App.

Returns:

  • (Boolean) 


528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 528

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

#enable_basic_auth ⇒ Boolean

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

Returns:

  • (Boolean) 


528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 528

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

#enable_branch_auto_build ⇒ Boolean

Enable the auto building of branches for an Amplify App.

Returns:

  • (Boolean) 


528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 528

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

#environment_variables ⇒ Hash<String,String>

Environment variables map for an Amplify App.

Returns:

  • (Hash<String,String>) 


528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 528

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

#iam_service_role_arn ⇒ String

AWS IAM service role for an Amplify App

Returns:

  • (String) 


528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 528

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

#name ⇒ String

Name for the Amplify App

Returns:

  • (String) 


528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 528

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

#oauth_token ⇒ String

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) 


528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 528

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

#platform ⇒ String

Platform / framework for an Amplify App

Returns:

  • (String) 


528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 528

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

#repository ⇒ String

Repository for an Amplify App

Returns:

  • (String) 


528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 528

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

#tags ⇒ Hash<String,String>

Tag for an Amplify App

Returns:

  • (Hash<String,String>) 


528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 528

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