software.amazon.awssdk.services.proton.model

Class CreateEnvironmentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.proton.model.ProtonRequest

software.amazon.awssdk.services.proton.model.CreateEnvironmentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateEnvironmentRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateEnvironmentRequest.Builder	builder()
String	codebuildRoleArn() The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
String	componentRoleArn() The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment.
String	description() A description of the environment that's being created and deployed.
String	environmentAccountConnectionId() The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	name() The name of the environment.
String	protonServiceRoleArn() The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
RepositoryBranchInput	provisioningRepository() The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateEnvironmentRequest.Builder>	serializableBuilderClass()
String	spec() A YAML formatted string that provides inputs as defined in the environment template bundle schema file.
List<Tag>	tags() An optional list of metadata items that you can associate with the Proton environment.
String	templateMajorVersion() The major version of the environment template.
String	templateMinorVersion() The minor version of the environment template.
String	templateName() The name of the environment template.
CreateEnvironmentRequest.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

codebuildRoleArn

public final String codebuildRoleArn()

The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.

To use CodeBuild-based provisioning for the environment or for any service instance running in the environment, specify either the environmentAccountConnectionId or codebuildRoleArn parameter.

Returns:

The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.

To use CodeBuild-based provisioning for the environment or for any service instance running in the environment, specify either the environmentAccountConnectionId or codebuildRoleArn parameter.

componentRoleArn

public final String componentRoleArn()

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

You must specify componentRoleArn to allow directly defined components to be associated with this environment.

For more information about components, see Proton components in the Proton User Guide.

Returns:

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

You must specify componentRoleArn to allow directly defined components to be associated with this environment.

For more information about components, see Proton components in the Proton User Guide.

description

public final String description()

A description of the environment that's being created and deployed.

Returns:

A description of the environment that's being created and deployed.

environmentAccountConnectionId

public final String environmentAccountConnectionId()

The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account. For more information, see Environment account connections in the Proton User guide.

To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.

Returns:

The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account. For more information, see Environment account connections in the Proton User guide.

To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.

name

public final String name()

The name of the environment.

Returns:

The name of the environment.

protonServiceRoleArn

public final String protonServiceRoleArn()

The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.

To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.

Returns:

The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.

To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.

provisioningRepository

public final RepositoryBranchInput provisioningRepository()

The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

To use self-managed provisioning for the environment, specify this parameter and omit the environmentAccountConnectionId and protonServiceRoleArn parameters.

Returns:

The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

To use self-managed provisioning for the environment, specify this parameter and omit the environmentAccountConnectionId and protonServiceRoleArn parameters.

spec

public final String spec()

A YAML formatted string that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the Proton User Guide.

Returns:

A YAML formatted string that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the Proton User Guide.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

An optional list of metadata items that you can associate with the Proton environment. A tag is a key-value pair.

For more information, see Proton resources and tagging in the Proton User Guide.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

An optional list of metadata items that you can associate with the Proton environment. A tag is a key-value pair.

For more information, see Proton resources and tagging in the Proton User Guide.

templateMajorVersion

public final String templateMajorVersion()

The major version of the environment template.

Returns:

The major version of the environment template.

templateMinorVersion

public final String templateMinorVersion()

The minor version of the environment template.

Returns:

The minor version of the environment template.

templateName

public final String templateName()

The name of the environment template. For more information, see Environment Templates in the Proton User Guide.

Returns:

The name of the environment template. For more information, see Environment Templates in the Proton User Guide.

toBuilder

public CreateEnvironmentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateEnvironmentRequest.Builder,CreateEnvironmentRequest>

Specified by:

toBuilder in class ProtonRequest

builder

public static CreateEnvironmentRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo