software.amazon.awssdk.services.serverlessapplicationrepository.model

Interface Version.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Version.Builder,Version>, SdkBuilder<Version.Builder,Version>, SdkPojo

Enclosing class:

Version

public static interface Version.Builder
extends SdkPojo, CopyableBuilder<Version.Builder,Version>

Method Summary

Modifier and Type	Method and Description
Version.Builder	applicationId(String applicationId) The application Amazon Resource Name (ARN).
Version.Builder	creationTime(String creationTime) The date and time this resource was created.
Version.Builder	parameterDefinitions(Collection<ParameterDefinition> parameterDefinitions) An array of parameter types supported by the application.
Version.Builder	parameterDefinitions(Consumer<ParameterDefinition.Builder>... parameterDefinitions) An array of parameter types supported by the application.
Version.Builder	parameterDefinitions(ParameterDefinition... parameterDefinitions) An array of parameter types supported by the application.
Version.Builder	requiredCapabilities(Capability... requiredCapabilities) A list of values that you must specify before you can deploy certain applications.
Version.Builder	requiredCapabilities(Collection<Capability> requiredCapabilities) A list of values that you must specify before you can deploy certain applications.
Version.Builder	requiredCapabilitiesWithStrings(Collection<String> requiredCapabilities) A list of values that you must specify before you can deploy certain applications.
Version.Builder	requiredCapabilitiesWithStrings(String... requiredCapabilities) A list of values that you must specify before you can deploy certain applications.
Version.Builder	resourcesSupported(Boolean resourcesSupported) Whether all of the AWS resources contained in this application are supported in the region in which it is being retrieved.
Version.Builder	semanticVersion(String semanticVersion) The semantic version of the application:
Version.Builder	sourceCodeUrl(String sourceCodeUrl) A link to a public repository for the source code of your application.
Version.Builder	templateUrl(String templateUrl) A link to the packaged AWS SAM template of your application.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

applicationId

Version.Builder applicationId(String applicationId)

The application Amazon Resource Name (ARN).

Parameters:

applicationId - The application Amazon Resource Name (ARN).

Returns:

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

creationTime

Version.Builder creationTime(String creationTime)

The date and time this resource was created.

Parameters:

creationTime - The date and time this resource was created.

Returns:

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

parameterDefinitions

Version.Builder parameterDefinitions(Collection<ParameterDefinition> parameterDefinitions)

An array of parameter types supported by the application.

Parameters:

parameterDefinitions - An array of parameter types supported by the application.

Returns:

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

parameterDefinitions

Version.Builder parameterDefinitions(ParameterDefinition... parameterDefinitions)

An array of parameter types supported by the application.

Parameters:

parameterDefinitions - An array of parameter types supported by the application.

Returns:

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

parameterDefinitions

Version.Builder parameterDefinitions(Consumer<ParameterDefinition.Builder>... parameterDefinitions)

An array of parameter types supported by the application.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #parameterDefinitions(List).

Parameters:

parameterDefinitions - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#parameterDefinitions(List)

requiredCapabilitiesWithStrings

Version.Builder requiredCapabilitiesWithStrings(Collection<String> requiredCapabilities)

A list of values that you must specify before you can deploy certain applications. Some applications might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those applications, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, and CAPABILITY_RESOURCE_POLICY.

The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, and AWS::IAM::Role. If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS::IAM:Policy, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicy, AWS::SQS::QueuePolicy, and AWS::SNS::TopicPolicy.

If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don't specify this parameter for an application that requires capabilities, the call will fail.

Valid values: CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_RESOURCE_POLICY

Parameters:

requiredCapabilities - A list of values that you must specify before you can deploy certain applications. Some applications might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those applications, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, and CAPABILITY_RESOURCE_POLICY.

The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, and AWS::IAM::Role. If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS::IAM:Policy, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicy, AWS::SQS::QueuePolicy, and AWS::SNS::TopicPolicy.

If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don't specify this parameter for an application that requires capabilities, the call will fail.

Valid values: CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_RESOURCE_POLICY

Returns:

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

requiredCapabilitiesWithStrings

Version.Builder requiredCapabilitiesWithStrings(String... requiredCapabilities)

A list of values that you must specify before you can deploy certain applications. Some applications might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those applications, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, and CAPABILITY_RESOURCE_POLICY.

The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, and AWS::IAM::Role. If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS::IAM:Policy, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicy, AWS::SQS::QueuePolicy, and AWS::SNS::TopicPolicy.

If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don't specify this parameter for an application that requires capabilities, the call will fail.

Valid values: CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_RESOURCE_POLICY

Parameters:

requiredCapabilities - A list of values that you must specify before you can deploy certain applications. Some applications might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those applications, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, and CAPABILITY_RESOURCE_POLICY.

The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, and AWS::IAM::Role. If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS::IAM:Policy, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicy, AWS::SQS::QueuePolicy, and AWS::SNS::TopicPolicy.

If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don't specify this parameter for an application that requires capabilities, the call will fail.

Valid values: CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_RESOURCE_POLICY

Returns:

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

requiredCapabilities

Version.Builder requiredCapabilities(Collection<Capability> requiredCapabilities)

A list of values that you must specify before you can deploy certain applications. Some applications might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those applications, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, and CAPABILITY_RESOURCE_POLICY.

The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, and AWS::IAM::Role. If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS::IAM:Policy, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicy, AWS::SQS::QueuePolicy, and AWS::SNS::TopicPolicy.

If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don't specify this parameter for an application that requires capabilities, the call will fail.

Valid values: CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_RESOURCE_POLICY

Parameters:

requiredCapabilities - A list of values that you must specify before you can deploy certain applications. Some applications might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those applications, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, and CAPABILITY_RESOURCE_POLICY.

The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, and AWS::IAM::Role. If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS::IAM:Policy, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicy, AWS::SQS::QueuePolicy, and AWS::SNS::TopicPolicy.

If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don't specify this parameter for an application that requires capabilities, the call will fail.

Valid values: CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_RESOURCE_POLICY

Returns:

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

requiredCapabilities

Version.Builder requiredCapabilities(Capability... requiredCapabilities)

A list of values that you must specify before you can deploy certain applications. Some applications might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those applications, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, and CAPABILITY_RESOURCE_POLICY.

The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, and AWS::IAM::Role. If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS::IAM:Policy, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicy, AWS::SQS::QueuePolicy, and AWS::SNS::TopicPolicy.

If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don't specify this parameter for an application that requires capabilities, the call will fail.

Valid values: CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_RESOURCE_POLICY

Parameters:

requiredCapabilities - A list of values that you must specify before you can deploy certain applications. Some applications might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those applications, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, and CAPABILITY_RESOURCE_POLICY.

The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, and AWS::IAM::Role. If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS::IAM:Policy, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicy, AWS::SQS::QueuePolicy, and AWS::SNS::TopicPolicy.

If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don't specify this parameter for an application that requires capabilities, the call will fail.

Valid values: CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_RESOURCE_POLICY

Returns:

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

resourcesSupported

Version.Builder resourcesSupported(Boolean resourcesSupported)

Whether all of the AWS resources contained in this application are supported in the region in which it is being retrieved.

Parameters:

resourcesSupported - Whether all of the AWS resources contained in this application are supported in the region in which it is being retrieved.

Returns:

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

semanticVersion

Version.Builder semanticVersion(String semanticVersion)

The semantic version of the application:

https://semver.org/

Parameters:

semanticVersion - The semantic version of the application:

https://semver.org/

Returns:

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

sourceCodeUrl

Version.Builder sourceCodeUrl(String sourceCodeUrl)

A link to a public repository for the source code of your application.

Parameters:

sourceCodeUrl - A link to a public repository for the source code of your application.

Returns:

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

templateUrl

Version.Builder templateUrl(String templateUrl)

A link to the packaged AWS SAM template of your application.

Parameters:

templateUrl - A link to the packaged AWS SAM template of your application.

Returns:

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