software.amazon.awssdk.services.amplify.model

Class CreateAppRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.amplify.model.AmplifyRequest

software.amazon.awssdk.services.amplify.model.CreateAppRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAppRequest.Builder,CreateAppRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateAppRequest
extends AmplifyRequest
implements ToCopyableBuilder<CreateAppRequest.Builder,CreateAppRequest>

Request structure used to create Apps in Amplify.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateAppRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	accessToken() Personal Access token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key.
AutoBranchCreationConfig	autoBranchCreationConfig() Automated branch creation config for the Amplify App.
List<String>	autoBranchCreationPatterns() Automated branch creation glob patterns for the Amplify App.
String	basicAuthCredentials() Credentials for Basic Authorization for an Amplify App.
static CreateAppRequest.Builder	builder()
String	buildSpec() BuildSpec for an Amplify App
List<CustomRule>	customRules() Custom rewrite / redirect rules for an Amplify App.
String	description() Description for an Amplify App
Boolean	enableAutoBranchCreation() Enables automated branch creation for the Amplify App.
Boolean	enableBasicAuth() Enable Basic Authorization for an Amplify App, this will apply to all branches part of this App.
Boolean	enableBranchAutoBuild() Enable the auto building of branches for an Amplify App.
Map<String,String>	environmentVariables() Environment variables map for an Amplify App.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAutoBranchCreationPatterns() Returns true if the AutoBranchCreationPatterns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasCustomRules() Returns true if the CustomRules property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasEnvironmentVariables() Returns true if the EnvironmentVariables property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	iamServiceRoleArn() AWS IAM service role for an Amplify App
String	name() Name for the Amplify App
String	oauthToken() OAuth token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key.
Platform	platform() Platform / framework for an Amplify App
String	platformAsString() Platform / framework for an Amplify App
String	repository() Repository for an Amplify App
List<SdkField<?>>	sdkFields()
static Class<? extends CreateAppRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() Tag for an Amplify App
CreateAppRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public String name()

Name for the Amplify App

Returns:

Name for the Amplify App

description

public String description()

Description for an Amplify App

Returns:

Description for an Amplify App

repository

public String repository()

Repository for an Amplify App

Returns:

Repository for an Amplify App

platform

public Platform platform()

Platform / framework for an Amplify App

If the service returns an enum value that is not available in the current SDK version, platform will return Platform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().

Returns:

Platform / framework for an Amplify App

See Also:

Platform

platformAsString

public String platformAsString()

Platform / framework for an Amplify App

If the service returns an enum value that is not available in the current SDK version, platform will return Platform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().

Returns:

Platform / framework for an Amplify App

See Also:

Platform

iamServiceRoleArn

public String iamServiceRoleArn()

AWS IAM service role for an Amplify App

Returns:

AWS IAM service role for an Amplify App

oauthToken

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

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.

accessToken

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

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.

hasEnvironmentVariables

public boolean hasEnvironmentVariables()

Returns true if the EnvironmentVariables property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

environmentVariables

public Map<String,String> environmentVariables()

Environment variables map for an Amplify App.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasEnvironmentVariables() to see if a value was sent in this field.

Returns:

Environment variables map for an Amplify App.

enableBranchAutoBuild

public Boolean enableBranchAutoBuild()

Enable the auto building of branches for an Amplify App.

Returns:

Enable the auto building of branches for an Amplify App.

enableBasicAuth

public Boolean enableBasicAuth()

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.

basicAuthCredentials

public String basicAuthCredentials()

Credentials for Basic Authorization for an Amplify App.

Returns:

Credentials for Basic Authorization for an Amplify App.

hasCustomRules

public boolean hasCustomRules()

Returns true if the CustomRules property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

customRules

public List<CustomRule> customRules()

Custom rewrite / redirect rules for an Amplify App.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasCustomRules() to see if a value was sent in this field.

Returns:

Custom rewrite / redirect rules for an Amplify App.

hasTags

public boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public Map<String,String> tags()

Tag for an Amplify App

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

Tag for an Amplify App

buildSpec

public String buildSpec()

BuildSpec for an Amplify App

Returns:

BuildSpec for an Amplify App

enableAutoBranchCreation

public Boolean enableAutoBranchCreation()

Enables automated branch creation for the Amplify App.

Returns:

Enables automated branch creation for the Amplify App.

hasAutoBranchCreationPatterns

public boolean hasAutoBranchCreationPatterns()

Returns true if the AutoBranchCreationPatterns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

autoBranchCreationPatterns

public List<String> autoBranchCreationPatterns()

Automated branch creation glob patterns for the Amplify App.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasAutoBranchCreationPatterns() to see if a value was sent in this field.

Returns:

Automated branch creation glob patterns for the Amplify App.

autoBranchCreationConfig

public AutoBranchCreationConfig autoBranchCreationConfig()

Automated branch creation config for the Amplify App.

Returns:

Automated branch creation config for the Amplify App.

toBuilder

public CreateAppRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAppRequest.Builder,CreateAppRequest>

Specified by:

toBuilder in class AmplifyRequest

builder

public static CreateAppRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateAppRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo