Struct aws_sdk_amplify::operation::create_app::CreateAppInput

#[non_exhaustive]
pub struct CreateAppInput {

    pub name: Option<String>,
    pub description: Option<String>,
    pub repository: Option<String>,
    pub platform: Option<Platform>,
    pub iam_service_role_arn: Option<String>,
    pub oauth_token: Option<String>,
    pub access_token: Option<String>,
    pub environment_variables: Option<HashMap<String, String>>,
    pub enable_branch_auto_build: Option<bool>,
    pub enable_branch_auto_deletion: Option<bool>,
    pub enable_basic_auth: Option<bool>,
    pub basic_auth_credentials: Option<String>,
    pub custom_rules: Option<Vec<CustomRule>>,
    pub tags: Option<HashMap<String, String>>,
    pub build_spec: Option<String>,
    pub custom_headers: Option<String>,
    pub enable_auto_branch_creation: Option<bool>,
    pub auto_branch_creation_patterns: Option<Vec<String>>,
    pub auto_branch_creation_config: Option<AutoBranchCreationConfig>,
}

The request structure used to create apps in Amplify.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name for an Amplify app.

description: Option<String>

The description for an Amplify app.

repository: Option<String>

The repository for an Amplify app.

platform: Option<Platform>

The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.

iam_service_role_arn: Option<String>

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

oauth_token: Option<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 .

access_token: Option<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 .

environment_variables: Option<HashMap<String, String>>

The environment variables map for an Amplify app.

enable_branch_auto_build: Option<bool>

Enables the auto building of branches for an Amplify app.

enable_branch_auto_deletion: Option<bool>

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

enable_basic_auth: Option<bool>

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

basic_auth_credentials: Option<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.

custom_rules: Option<Vec<CustomRule>>

The custom rewrite and redirect rules for an Amplify app.

tags: Option<HashMap<String, String>>

The tag for an Amplify app.

build_spec: Option<String>

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

custom_headers: Option<String>

The custom HTTP headers for an Amplify app.

enable_auto_branch_creation: Option<bool>

Enables automated branch creation for an Amplify app.

auto_branch_creation_patterns: Option<Vec<String>>

The automated branch creation glob patterns for an Amplify app.

auto_branch_creation_config: Option<AutoBranchCreationConfig>

The automated branch creation configuration for an Amplify app.

Implementations

impl CreateAppInput

pub fn name(&self) -> Option<&str>

The name for an Amplify app.

pub fn description(&self) -> Option<&str>

The description for an Amplify app.

pub fn repository(&self) -> Option<&str>

The repository for an Amplify app.

pub fn platform(&self) -> Option<&Platform>

The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.

pub fn iam_service_role_arn(&self) -> Option<&str>

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

pub fn oauth_token(&self) -> Option<&str>

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 .

pub fn access_token(&self) -> Option<&str>

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 .

pub fn environment_variables(&self) -> Option<&HashMap<String, String>>

The environment variables map for an Amplify app.

pub fn enable_branch_auto_build(&self) -> Option<bool>

Enables the auto building of branches for an Amplify app.

pub fn enable_branch_auto_deletion(&self) -> Option<bool>

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

pub fn enable_basic_auth(&self) -> Option<bool>

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

pub fn basic_auth_credentials(&self) -> Option<&str>

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

pub fn custom_rules(&self) -> Option<&[CustomRule]>

The custom rewrite and redirect rules for an Amplify app.

pub fn tags(&self) -> Option<&HashMap<String, String>>

The tag for an Amplify app.

pub fn build_spec(&self) -> Option<&str>

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

pub fn custom_headers(&self) -> Option<&str>

The custom HTTP headers for an Amplify app.

pub fn enable_auto_branch_creation(&self) -> Option<bool>

Enables automated branch creation for an Amplify app.

pub fn auto_branch_creation_patterns(&self) -> Option<&[String]>

The automated branch creation glob patterns for an Amplify app.

pub fn auto_branch_creation_config(&self) -> Option<&AutoBranchCreationConfig>

The automated branch creation configuration for an Amplify app.

impl CreateAppInput

pub fn builder() -> CreateAppInputBuilder

Creates a new builder-style object to manufacture CreateAppInput.

Trait Implementations

impl Clone for CreateAppInput

fn clone(&self) -> CreateAppInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateAppInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateAppInput

fn eq(&self, other: &CreateAppInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateAppInput