com.amazonaws.services.amplify.model

Class CreateAppRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.amplify.model.CreateAppRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateAppRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Request structure used to create Apps in Amplify.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateAppRequest()

Method Summary

Modifier and Type	Method and Description
CreateAppRequest	addEnvironmentVariablesEntry(String key, String value) Add a single EnvironmentVariables entry
CreateAppRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateAppRequest	clearEnvironmentVariablesEntries() Removes all the entries added into EnvironmentVariables.
CreateAppRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateAppRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAccessToken() Personal Access token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key.
AutoBranchCreationConfig	getAutoBranchCreationConfig() Automated branch creation config for the Amplify App.
List<String>	getAutoBranchCreationPatterns() Automated branch creation glob patterns for the Amplify App.
String	getBasicAuthCredentials() Credentials for Basic Authorization for an Amplify App.
String	getBuildSpec() BuildSpec for an Amplify App
List<CustomRule>	getCustomRules() Custom rewrite / redirect rules for an Amplify App.
String	getDescription() Description for an Amplify App
Boolean	getEnableAutoBranchCreation() Enables automated branch creation for the Amplify App.
Boolean	getEnableBasicAuth() Enable Basic Authorization for an Amplify App, this will apply to all branches part of this App.
Boolean	getEnableBranchAutoBuild() Enable the auto building of branches for an Amplify App.
Map<String,String>	getEnvironmentVariables() Environment variables map for an Amplify App.
String	getIamServiceRoleArn() AWS IAM service role for an Amplify App
String	getName() Name for the Amplify App
String	getOauthToken() OAuth token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key.
String	getPlatform() Platform / framework for an Amplify App
String	getRepository() Repository for an Amplify App
Map<String,String>	getTags() Tag for an Amplify App
int	hashCode()
Boolean	isEnableAutoBranchCreation() Enables automated branch creation for the Amplify App.
Boolean	isEnableBasicAuth() Enable Basic Authorization for an Amplify App, this will apply to all branches part of this App.
Boolean	isEnableBranchAutoBuild() Enable the auto building of branches for an Amplify App.
void	setAccessToken(String accessToken) Personal Access token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key.
void	setAutoBranchCreationConfig(AutoBranchCreationConfig autoBranchCreationConfig) Automated branch creation config for the Amplify App.
void	setAutoBranchCreationPatterns(Collection<String> autoBranchCreationPatterns) Automated branch creation glob patterns for the Amplify App.
void	setBasicAuthCredentials(String basicAuthCredentials) Credentials for Basic Authorization for an Amplify App.
void	setBuildSpec(String buildSpec) BuildSpec for an Amplify App
void	setCustomRules(Collection<CustomRule> customRules) Custom rewrite / redirect rules for an Amplify App.
void	setDescription(String description) Description for an Amplify App
void	setEnableAutoBranchCreation(Boolean enableAutoBranchCreation) Enables automated branch creation for the Amplify App.
void	setEnableBasicAuth(Boolean enableBasicAuth) Enable Basic Authorization for an Amplify App, this will apply to all branches part of this App.
void	setEnableBranchAutoBuild(Boolean enableBranchAutoBuild) Enable the auto building of branches for an Amplify App.
void	setEnvironmentVariables(Map<String,String> environmentVariables) Environment variables map for an Amplify App.
void	setIamServiceRoleArn(String iamServiceRoleArn) AWS IAM service role for an Amplify App
void	setName(String name) Name for the Amplify App
void	setOauthToken(String oauthToken) OAuth token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key.
void	setPlatform(String platform) Platform / framework for an Amplify App
void	setRepository(String repository) Repository for an Amplify App
void	setTags(Map<String,String> tags) Tag for an Amplify App
String	toString() Returns a string representation of this object.
CreateAppRequest	withAccessToken(String accessToken) Personal Access token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key.
CreateAppRequest	withAutoBranchCreationConfig(AutoBranchCreationConfig autoBranchCreationConfig) Automated branch creation config for the Amplify App.
CreateAppRequest	withAutoBranchCreationPatterns(Collection<String> autoBranchCreationPatterns) Automated branch creation glob patterns for the Amplify App.
CreateAppRequest	withAutoBranchCreationPatterns(String... autoBranchCreationPatterns) Automated branch creation glob patterns for the Amplify App.
CreateAppRequest	withBasicAuthCredentials(String basicAuthCredentials) Credentials for Basic Authorization for an Amplify App.
CreateAppRequest	withBuildSpec(String buildSpec) BuildSpec for an Amplify App
CreateAppRequest	withCustomRules(Collection<CustomRule> customRules) Custom rewrite / redirect rules for an Amplify App.
CreateAppRequest	withCustomRules(CustomRule... customRules) Custom rewrite / redirect rules for an Amplify App.
CreateAppRequest	withDescription(String description) Description for an Amplify App
CreateAppRequest	withEnableAutoBranchCreation(Boolean enableAutoBranchCreation) Enables automated branch creation for the Amplify App.
CreateAppRequest	withEnableBasicAuth(Boolean enableBasicAuth) Enable Basic Authorization for an Amplify App, this will apply to all branches part of this App.
CreateAppRequest	withEnableBranchAutoBuild(Boolean enableBranchAutoBuild) Enable the auto building of branches for an Amplify App.
CreateAppRequest	withEnvironmentVariables(Map<String,String> environmentVariables) Environment variables map for an Amplify App.
CreateAppRequest	withIamServiceRoleArn(String iamServiceRoleArn) AWS IAM service role for an Amplify App
CreateAppRequest	withName(String name) Name for the Amplify App
CreateAppRequest	withOauthToken(String oauthToken) OAuth token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key.
CreateAppRequest	withPlatform(Platform platform) Platform / framework for an Amplify App
CreateAppRequest	withPlatform(String platform) Platform / framework for an Amplify App
CreateAppRequest	withRepository(String repository) Repository for an Amplify App
CreateAppRequest	withTags(Map<String,String> tags) Tag for an Amplify App

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateAppRequest

public CreateAppRequest()

Method Detail

setName

public void setName(String name)

Name for the Amplify App

Parameters:

name - Name for the Amplify App

getName

public String getName()

Name for the Amplify App

Returns:

Name for the Amplify App

withName

public CreateAppRequest withName(String name)

Name for the Amplify App

Parameters:

name - Name for the Amplify App

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

Description for an Amplify App

Parameters:

description - Description for an Amplify App

getDescription

public String getDescription()

Description for an Amplify App

Returns:

Description for an Amplify App

withDescription

public CreateAppRequest withDescription(String description)

Description for an Amplify App

Parameters:

description - Description for an Amplify App

Returns:

Returns a reference to this object so that method calls can be chained together.

setRepository

public void setRepository(String repository)

Repository for an Amplify App

Parameters:

repository - Repository for an Amplify App

getRepository

public String getRepository()

Repository for an Amplify App

Returns:

Repository for an Amplify App

withRepository

public CreateAppRequest withRepository(String repository)

Repository for an Amplify App

Parameters:

repository - Repository for an Amplify App

Returns:

Returns a reference to this object so that method calls can be chained together.

setPlatform

public void setPlatform(String platform)

Platform / framework for an Amplify App

Parameters:

platform - Platform / framework for an Amplify App

See Also:

Platform

getPlatform

public String getPlatform()

Platform / framework for an Amplify App

Returns:

Platform / framework for an Amplify App

See Also:

Platform

withPlatform

public CreateAppRequest withPlatform(String platform)

Platform / framework for an Amplify App

Parameters:

platform - Platform / framework for an Amplify App

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Platform

withPlatform

public CreateAppRequest withPlatform(Platform platform)

Platform / framework for an Amplify App

Parameters:

platform - Platform / framework for an Amplify App

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Platform

setIamServiceRoleArn

public void setIamServiceRoleArn(String iamServiceRoleArn)

AWS IAM service role for an Amplify App

Parameters:

iamServiceRoleArn - AWS IAM service role for an Amplify App

getIamServiceRoleArn

public String getIamServiceRoleArn()

AWS IAM service role for an Amplify App

Returns:

AWS IAM service role for an Amplify App

withIamServiceRoleArn

public CreateAppRequest withIamServiceRoleArn(String iamServiceRoleArn)

AWS IAM service role for an Amplify App

Parameters:

iamServiceRoleArn - AWS IAM service role for an Amplify App

Returns:

Returns a reference to this object so that method calls can be chained together.

setOauthToken

public void setOauthToken(String oauthToken)

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.

Parameters:

oauthToken - 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.

getOauthToken

public String getOauthToken()

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:

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.

withOauthToken

public CreateAppRequest withOauthToken(String oauthToken)

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.

Parameters:

oauthToken - 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:

Returns a reference to this object so that method calls can be chained together.

setAccessToken

public void setAccessToken(String accessToken)

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.

Parameters:

accessToken - 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.

getAccessToken

public String getAccessToken()

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:

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.

withAccessToken

public CreateAppRequest withAccessToken(String accessToken)

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.

Parameters:

accessToken - 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:

Returns a reference to this object so that method calls can be chained together.

getEnvironmentVariables

public Map<String,String> getEnvironmentVariables()

Environment variables map for an Amplify App.

Returns:

Environment variables map for an Amplify App.

setEnvironmentVariables

public void setEnvironmentVariables(Map<String,String> environmentVariables)

Environment variables map for an Amplify App.

Parameters:

environmentVariables - Environment variables map for an Amplify App.

withEnvironmentVariables

public CreateAppRequest withEnvironmentVariables(Map<String,String> environmentVariables)

Environment variables map for an Amplify App.

Parameters:

environmentVariables - Environment variables map for an Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.

addEnvironmentVariablesEntry

public CreateAppRequest addEnvironmentVariablesEntry(String key,
                                                     String value)

Add a single EnvironmentVariables entry

See Also:

withEnvironmentVariables(java.util.Map<java.lang.String, java.lang.String>)

clearEnvironmentVariablesEntries

public CreateAppRequest clearEnvironmentVariablesEntries()

Removes all the entries added into EnvironmentVariables.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEnableBranchAutoBuild

public void setEnableBranchAutoBuild(Boolean enableBranchAutoBuild)

Enable the auto building of branches for an Amplify App.

Parameters:

enableBranchAutoBuild - Enable the auto building of branches for an Amplify App.

getEnableBranchAutoBuild

public Boolean getEnableBranchAutoBuild()

Enable the auto building of branches for an Amplify App.

Returns:

Enable the auto building of branches for an Amplify App.

withEnableBranchAutoBuild

public CreateAppRequest withEnableBranchAutoBuild(Boolean enableBranchAutoBuild)

Enable the auto building of branches for an Amplify App.

Parameters:

enableBranchAutoBuild - Enable the auto building of branches for an Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.

isEnableBranchAutoBuild

public Boolean isEnableBranchAutoBuild()

Enable the auto building of branches for an Amplify App.

Returns:

Enable the auto building of branches for an Amplify App.

setEnableBasicAuth

public void setEnableBasicAuth(Boolean enableBasicAuth)

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

Parameters:

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

getEnableBasicAuth

public Boolean getEnableBasicAuth()

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

Returns:

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

withEnableBasicAuth

public CreateAppRequest withEnableBasicAuth(Boolean enableBasicAuth)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

isEnableBasicAuth

public Boolean isEnableBasicAuth()

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

Returns:

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

setBasicAuthCredentials

public void setBasicAuthCredentials(String basicAuthCredentials)

Credentials for Basic Authorization for an Amplify App.

Parameters:

basicAuthCredentials - Credentials for Basic Authorization for an Amplify App.

getBasicAuthCredentials

public String getBasicAuthCredentials()

Credentials for Basic Authorization for an Amplify App.

Returns:

Credentials for Basic Authorization for an Amplify App.

withBasicAuthCredentials

public CreateAppRequest withBasicAuthCredentials(String basicAuthCredentials)

Credentials for Basic Authorization for an Amplify App.

Parameters:

basicAuthCredentials - Credentials for Basic Authorization for an Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.

getCustomRules

public List<CustomRule> getCustomRules()

Custom rewrite / redirect rules for an Amplify App.

Returns:

Custom rewrite / redirect rules for an Amplify App.

setCustomRules

public void setCustomRules(Collection<CustomRule> customRules)

Custom rewrite / redirect rules for an Amplify App.

Parameters:

customRules - Custom rewrite / redirect rules for an Amplify App.

withCustomRules

public CreateAppRequest withCustomRules(CustomRule... customRules)

Custom rewrite / redirect rules for an Amplify App.

NOTE: This method appends the values to the existing list (if any). Use setCustomRules(java.util.Collection) or withCustomRules(java.util.Collection) if you want to override the existing values.

Parameters:

customRules - Custom rewrite / redirect rules for an Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.

withCustomRules

public CreateAppRequest withCustomRules(Collection<CustomRule> customRules)

Custom rewrite / redirect rules for an Amplify App.

Parameters:

customRules - Custom rewrite / redirect rules for an Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public Map<String,String> getTags()

Tag for an Amplify App

Returns:

Tag for an Amplify App

setTags

public void setTags(Map<String,String> tags)

Tag for an Amplify App

Parameters:

tags - Tag for an Amplify App

withTags

public CreateAppRequest withTags(Map<String,String> tags)

Tag for an Amplify App

Parameters:

tags - Tag for an Amplify App

Returns:

Returns a reference to this object so that method calls can be chained together.

addTagsEntry

public CreateAppRequest addTagsEntry(String key,
                                     String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateAppRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

Returns a reference to this object so that method calls can be chained together.

setBuildSpec

public void setBuildSpec(String buildSpec)

BuildSpec for an Amplify App

Parameters:

buildSpec - BuildSpec for an Amplify App

getBuildSpec

public String getBuildSpec()

BuildSpec for an Amplify App

Returns:

BuildSpec for an Amplify App

withBuildSpec

public CreateAppRequest withBuildSpec(String buildSpec)

BuildSpec for an Amplify App

Parameters:

buildSpec - BuildSpec for an Amplify App

Returns:

Returns a reference to this object so that method calls can be chained together.

setEnableAutoBranchCreation

public void setEnableAutoBranchCreation(Boolean enableAutoBranchCreation)

Enables automated branch creation for the Amplify App.

Parameters:

enableAutoBranchCreation - Enables automated branch creation for the Amplify App.

getEnableAutoBranchCreation

public Boolean getEnableAutoBranchCreation()

Enables automated branch creation for the Amplify App.

Returns:

Enables automated branch creation for the Amplify App.

withEnableAutoBranchCreation

public CreateAppRequest withEnableAutoBranchCreation(Boolean enableAutoBranchCreation)

Enables automated branch creation for the Amplify App.

Parameters:

enableAutoBranchCreation - Enables automated branch creation for the Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.

isEnableAutoBranchCreation

public Boolean isEnableAutoBranchCreation()

Enables automated branch creation for the Amplify App.

Returns:

Enables automated branch creation for the Amplify App.

getAutoBranchCreationPatterns

public List<String> getAutoBranchCreationPatterns()

Automated branch creation glob patterns for the Amplify App.

Returns:

Automated branch creation glob patterns for the Amplify App.

setAutoBranchCreationPatterns

public void setAutoBranchCreationPatterns(Collection<String> autoBranchCreationPatterns)

Automated branch creation glob patterns for the Amplify App.

Parameters:

autoBranchCreationPatterns - Automated branch creation glob patterns for the Amplify App.

withAutoBranchCreationPatterns

public CreateAppRequest withAutoBranchCreationPatterns(String... autoBranchCreationPatterns)

Automated branch creation glob patterns for the Amplify App.

NOTE: This method appends the values to the existing list (if any). Use setAutoBranchCreationPatterns(java.util.Collection) or withAutoBranchCreationPatterns(java.util.Collection) if you want to override the existing values.

Parameters:

autoBranchCreationPatterns - Automated branch creation glob patterns for the Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.

withAutoBranchCreationPatterns

public CreateAppRequest withAutoBranchCreationPatterns(Collection<String> autoBranchCreationPatterns)

Automated branch creation glob patterns for the Amplify App.

Parameters:

autoBranchCreationPatterns - Automated branch creation glob patterns for the Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAutoBranchCreationConfig

public void setAutoBranchCreationConfig(AutoBranchCreationConfig autoBranchCreationConfig)

Automated branch creation config for the Amplify App.

Parameters:

autoBranchCreationConfig - Automated branch creation config for the Amplify App.

getAutoBranchCreationConfig

public AutoBranchCreationConfig getAutoBranchCreationConfig()

Automated branch creation config for the Amplify App.

Returns:

Automated branch creation config for the Amplify App.

withAutoBranchCreationConfig

public CreateAppRequest withAutoBranchCreationConfig(AutoBranchCreationConfig autoBranchCreationConfig)

Automated branch creation config for the Amplify App.

Parameters:

autoBranchCreationConfig - Automated branch creation config for the Amplify App.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateAppRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()