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	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	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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

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.

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.

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.

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.

Returns:

Custom rewrite / redirect rules for an Amplify App.

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.

Returns:

Tag for an Amplify App

buildSpec

public String buildSpec()

BuildSpec for an Amplify App

Returns:

BuildSpec for an Amplify App

toBuilder

public CreateAppRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAppRequest.Builder,CreateAppRequest>

Specified by:

toBuilder in class AmplifyRequest

Returns:

a builder for type T

builder

public static CreateAppRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.