libZSservicesZSamazonka-serverlessrepoZSamazonka-serverlessrepo
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ServerlessApplicationRepository.Lens

Description

 
Synopsis

Operations

GetApplicationPolicy

getApplicationPolicy_applicationId :: Lens' GetApplicationPolicy Text Source #

The Amazon Resource Name (ARN) of the application.

CreateApplicationVersion

createApplicationVersion_sourceCodeUrl :: Lens' CreateApplicationVersion (Maybe Text) Source #

A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.

createApplicationVersion_templateBody :: Lens' CreateApplicationVersion (Maybe Text) Source #

The raw packaged AWS SAM template of your application.

createApplicationVersion_templateUrl :: Lens' CreateApplicationVersion (Maybe Text) Source #

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

createApplicationVersion_sourceCodeArchiveUrl :: Lens' CreateApplicationVersion (Maybe Text) Source #

A link to the S3 object that contains the ZIP archive of the source code for this version of your application.

Maximum size 50 MB

createApplicationVersion_applicationId :: Lens' CreateApplicationVersion Text Source #

The Amazon Resource Name (ARN) of the application.

createApplicationVersionResponse_resourcesSupported :: Lens' CreateApplicationVersionResponse (Maybe Bool) Source #

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

createApplicationVersionResponse_requiredCapabilities :: Lens' CreateApplicationVersionResponse (Maybe [Capability]) Source #

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, CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.

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.

Applications that contain one or more nested applications require you to specify CAPABILITY_AUTO_EXPAND.

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.

createApplicationVersionResponse_sourceCodeUrl :: Lens' CreateApplicationVersionResponse (Maybe Text) Source #

A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.

createApplicationVersionResponse_templateUrl :: Lens' CreateApplicationVersionResponse (Maybe Text) Source #

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

createApplicationVersionResponse_sourceCodeArchiveUrl :: Lens' CreateApplicationVersionResponse (Maybe Text) Source #

A link to the S3 object that contains the ZIP archive of the source code for this version of your application.

Maximum size 50 MB

UnshareApplication

unshareApplication_applicationId :: Lens' UnshareApplication Text Source #

The Amazon Resource Name (ARN) of the application.

unshareApplication_organizationId :: Lens' UnshareApplication Text Source #

The AWS Organization ID to unshare the application from.

DeleteApplication

deleteApplication_applicationId :: Lens' DeleteApplication Text Source #

The Amazon Resource Name (ARN) of the application.

UpdateApplication

updateApplication_homePageUrl :: Lens' UpdateApplication (Maybe Text) Source #

A URL with more information about the application, for example the location of your GitHub repository for the application.

updateApplication_readmeBody :: Lens' UpdateApplication (Maybe Text) Source #

A text readme file in Markdown language that contains a more detailed description of the application and how it works.

Maximum size 5 MB

updateApplication_readmeUrl :: Lens' UpdateApplication (Maybe Text) Source #

A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.

Maximum size 5 MB

updateApplication_author :: Lens' UpdateApplication (Maybe Text) Source #

The name of the author publishing the app.

Minimum length=1. Maximum length=127.

Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";

updateApplication_labels :: Lens' UpdateApplication (Maybe [Text]) Source #

Labels to improve discovery of apps in search results.

Minimum length=1. Maximum length=127. Maximum number of labels: 10

Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";

updateApplication_description :: Lens' UpdateApplication (Maybe Text) Source #

The description of the application.

Minimum length=1. Maximum length=256

updateApplication_applicationId :: Lens' UpdateApplication Text Source #

The Amazon Resource Name (ARN) of the application.

updateApplicationResponse_homePageUrl :: Lens' UpdateApplicationResponse (Maybe Text) Source #

A URL with more information about the application, for example the location of your GitHub repository for the application.

updateApplicationResponse_licenseUrl :: Lens' UpdateApplicationResponse (Maybe Text) Source #

A link to a license file of the app that matches the spdxLicenseID value of your application.

Maximum size 5 MB

updateApplicationResponse_readmeUrl :: Lens' UpdateApplicationResponse (Maybe Text) Source #

A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.

Maximum size 5 MB

updateApplicationResponse_name :: Lens' UpdateApplicationResponse (Maybe Text) Source #

The name of the application.

Minimum length=1. Maximum length=140

Pattern: "[a-zA-Z0-9\\-]+";

updateApplicationResponse_author :: Lens' UpdateApplicationResponse (Maybe Text) Source #

The name of the author publishing the app.

Minimum length=1. Maximum length=127.

Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";

updateApplicationResponse_labels :: Lens' UpdateApplicationResponse (Maybe [Text]) Source #

Labels to improve discovery of apps in search results.

Minimum length=1. Maximum length=127. Maximum number of labels: 10

Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";

updateApplicationResponse_verifiedAuthorUrl :: Lens' UpdateApplicationResponse (Maybe Text) Source #

The URL to the public profile of a verified author. This URL is submitted by the author.

updateApplicationResponse_description :: Lens' UpdateApplicationResponse (Maybe Text) Source #

The description of the application.

Minimum length=1. Maximum length=256

updateApplicationResponse_spdxLicenseId :: Lens' UpdateApplicationResponse (Maybe Text) Source #

A valid identifier from https://spdx.org/licenses/.

updateApplicationResponse_isVerifiedAuthor :: Lens' UpdateApplicationResponse (Maybe Bool) Source #

Whether the author of this application has been verified. This means means that AWS has made a good faith review, as a reasonable and prudent service provider, of the information provided by the requester and has confirmed that the requester's identity is as claimed.

CreateCloudFormationTemplate

createCloudFormationTemplate_applicationId :: Lens' CreateCloudFormationTemplate Text Source #

The Amazon Resource Name (ARN) of the application.

createCloudFormationTemplateResponse_status :: Lens' CreateCloudFormationTemplateResponse (Maybe Status) Source #

Status of the template creation workflow.

Possible values: PREPARING | ACTIVE | EXPIRED

createCloudFormationTemplateResponse_templateId :: Lens' CreateCloudFormationTemplateResponse (Maybe Text) Source #

The UUID returned by CreateCloudFormationTemplate.

Pattern: [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}

createCloudFormationTemplateResponse_templateUrl :: Lens' CreateCloudFormationTemplateResponse (Maybe Text) Source #

A link to the template that can be used to deploy the application using AWS CloudFormation.

createCloudFormationTemplateResponse_expirationTime :: Lens' CreateCloudFormationTemplateResponse (Maybe Text) Source #

The date and time this template expires. Templates expire 1 hour after creation.

CreateApplication

createApplication_homePageUrl :: Lens' CreateApplication (Maybe Text) Source #

A URL with more information about the application, for example the location of your GitHub repository for the application.

createApplication_readmeBody :: Lens' CreateApplication (Maybe Text) Source #

A local text readme file in Markdown language that contains a more detailed description of the application and how it works. The file has the format file://<path>/<filename>.

Maximum size 5 MB

You can specify only one of readmeBody and readmeUrl; otherwise, an error results.

createApplication_licenseUrl :: Lens' CreateApplication (Maybe Text) Source #

A link to the S3 object that contains the license of the app that matches the spdxLicenseID value of your application.

Maximum size 5 MB

You can specify only one of licenseBody and licenseUrl; otherwise, an error results.

createApplication_sourceCodeUrl :: Lens' CreateApplication (Maybe Text) Source #

A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.

createApplication_readmeUrl :: Lens' CreateApplication (Maybe Text) Source #

A link to the S3 object in Markdown language that contains a more detailed description of the application and how it works.

Maximum size 5 MB

You can specify only one of readmeBody and readmeUrl; otherwise, an error results.

createApplication_labels :: Lens' CreateApplication (Maybe [Text]) Source #

Labels to improve discovery of apps in search results.

Minimum length=1. Maximum length=127. Maximum number of labels: 10

Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";

createApplication_templateBody :: Lens' CreateApplication (Maybe Text) Source #

The local raw packaged AWS SAM template file of your application. The file has the format file://<path>/<filename>.

You can specify only one of templateBody and templateUrl; otherwise an error results.

createApplication_templateUrl :: Lens' CreateApplication (Maybe Text) Source #

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

You can specify only one of templateBody and templateUrl; otherwise an error results.

createApplication_licenseBody :: Lens' CreateApplication (Maybe Text) Source #

A local text file that contains the license of the app that matches the spdxLicenseID value of your application. The file has the format file://<path>/<filename>.

Maximum size 5 MB

You can specify only one of licenseBody and licenseUrl; otherwise, an error results.

createApplication_sourceCodeArchiveUrl :: Lens' CreateApplication (Maybe Text) Source #

A link to the S3 object that contains the ZIP archive of the source code for this version of your application.

Maximum size 50 MB

createApplication_description :: Lens' CreateApplication Text Source #

The description of the application.

Minimum length=1. Maximum length=256

createApplication_name :: Lens' CreateApplication Text Source #

The name of the application that you want to publish.

Minimum length=1. Maximum length=140

Pattern: "[a-zA-Z0-9\\-]+";

createApplication_author :: Lens' CreateApplication Text Source #

The name of the author publishing the app.

Minimum length=1. Maximum length=127.

Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";

createApplicationResponse_homePageUrl :: Lens' CreateApplicationResponse (Maybe Text) Source #

A URL with more information about the application, for example the location of your GitHub repository for the application.

createApplicationResponse_licenseUrl :: Lens' CreateApplicationResponse (Maybe Text) Source #

A link to a license file of the app that matches the spdxLicenseID value of your application.

Maximum size 5 MB

createApplicationResponse_readmeUrl :: Lens' CreateApplicationResponse (Maybe Text) Source #

A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.

Maximum size 5 MB

createApplicationResponse_name :: Lens' CreateApplicationResponse (Maybe Text) Source #

The name of the application.

Minimum length=1. Maximum length=140

Pattern: "[a-zA-Z0-9\\-]+";

createApplicationResponse_author :: Lens' CreateApplicationResponse (Maybe Text) Source #

The name of the author publishing the app.

Minimum length=1. Maximum length=127.

Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";

createApplicationResponse_labels :: Lens' CreateApplicationResponse (Maybe [Text]) Source #

Labels to improve discovery of apps in search results.

Minimum length=1. Maximum length=127. Maximum number of labels: 10

Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";

createApplicationResponse_verifiedAuthorUrl :: Lens' CreateApplicationResponse (Maybe Text) Source #

The URL to the public profile of a verified author. This URL is submitted by the author.

createApplicationResponse_description :: Lens' CreateApplicationResponse (Maybe Text) Source #

The description of the application.

Minimum length=1. Maximum length=256

createApplicationResponse_spdxLicenseId :: Lens' CreateApplicationResponse (Maybe Text) Source #

A valid identifier from https://spdx.org/licenses/.

createApplicationResponse_isVerifiedAuthor :: Lens' CreateApplicationResponse (Maybe Bool) Source #

Whether the author of this application has been verified. This means means that AWS has made a good faith review, as a reasonable and prudent service provider, of the information provided by the requester and has confirmed that the requester's identity is as claimed.

ListApplicationDependencies

listApplicationDependencies_applicationId :: Lens' ListApplicationDependencies Text Source #

The Amazon Resource Name (ARN) of the application.

ListApplicationVersions

listApplicationVersions_nextToken :: Lens' ListApplicationVersions (Maybe Text) Source #

A token to specify where to start paginating.

listApplicationVersions_applicationId :: Lens' ListApplicationVersions Text Source #

The Amazon Resource Name (ARN) of the application.

GetApplication

getApplication_semanticVersion :: Lens' GetApplication (Maybe Text) Source #

The semantic version of the application to get.

getApplication_applicationId :: Lens' GetApplication Text Source #

The Amazon Resource Name (ARN) of the application.

getApplicationResponse_creationTime :: Lens' GetApplicationResponse (Maybe Text) Source #

The date and time this resource was created.

getApplicationResponse_homePageUrl :: Lens' GetApplicationResponse (Maybe Text) Source #

A URL with more information about the application, for example the location of your GitHub repository for the application.

getApplicationResponse_licenseUrl :: Lens' GetApplicationResponse (Maybe Text) Source #

A link to a license file of the app that matches the spdxLicenseID value of your application.

Maximum size 5 MB

getApplicationResponse_readmeUrl :: Lens' GetApplicationResponse (Maybe Text) Source #

A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.

Maximum size 5 MB

getApplicationResponse_applicationId :: Lens' GetApplicationResponse (Maybe Text) Source #

The application Amazon Resource Name (ARN).

getApplicationResponse_name :: Lens' GetApplicationResponse (Maybe Text) Source #

The name of the application.

Minimum length=1. Maximum length=140

Pattern: "[a-zA-Z0-9\\-]+";

getApplicationResponse_version :: Lens' GetApplicationResponse (Maybe Version) Source #

Version information about the application.

getApplicationResponse_author :: Lens' GetApplicationResponse (Maybe Text) Source #

The name of the author publishing the app.

Minimum length=1. Maximum length=127.

Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";

getApplicationResponse_labels :: Lens' GetApplicationResponse (Maybe [Text]) Source #

Labels to improve discovery of apps in search results.

Minimum length=1. Maximum length=127. Maximum number of labels: 10

Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";

getApplicationResponse_verifiedAuthorUrl :: Lens' GetApplicationResponse (Maybe Text) Source #

The URL to the public profile of a verified author. This URL is submitted by the author.

getApplicationResponse_description :: Lens' GetApplicationResponse (Maybe Text) Source #

The description of the application.

Minimum length=1. Maximum length=256

getApplicationResponse_spdxLicenseId :: Lens' GetApplicationResponse (Maybe Text) Source #

A valid identifier from https://spdx.org/licenses/.

getApplicationResponse_isVerifiedAuthor :: Lens' GetApplicationResponse (Maybe Bool) Source #

Whether the author of this application has been verified. This means means that AWS has made a good faith review, as a reasonable and prudent service provider, of the information provided by the requester and has confirmed that the requester's identity is as claimed.

GetCloudFormationTemplate

getCloudFormationTemplate_applicationId :: Lens' GetCloudFormationTemplate Text Source #

The Amazon Resource Name (ARN) of the application.

getCloudFormationTemplate_templateId :: Lens' GetCloudFormationTemplate Text Source #

The UUID returned by CreateCloudFormationTemplate.

Pattern: [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}

getCloudFormationTemplateResponse_status :: Lens' GetCloudFormationTemplateResponse (Maybe Status) Source #

Status of the template creation workflow.

Possible values: PREPARING | ACTIVE | EXPIRED

getCloudFormationTemplateResponse_templateId :: Lens' GetCloudFormationTemplateResponse (Maybe Text) Source #

The UUID returned by CreateCloudFormationTemplate.

Pattern: [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}

getCloudFormationTemplateResponse_templateUrl :: Lens' GetCloudFormationTemplateResponse (Maybe Text) Source #

A link to the template that can be used to deploy the application using AWS CloudFormation.

getCloudFormationTemplateResponse_expirationTime :: Lens' GetCloudFormationTemplateResponse (Maybe Text) Source #

The date and time this template expires. Templates expire 1 hour after creation.

CreateCloudFormationChangeSet

createCloudFormationChangeSet_clientToken :: Lens' CreateCloudFormationChangeSet (Maybe Text) Source #

This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.

createCloudFormationChangeSet_templateId :: Lens' CreateCloudFormationChangeSet (Maybe Text) Source #

The UUID returned by CreateCloudFormationTemplate.

Pattern: [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}

createCloudFormationChangeSet_notificationArns :: Lens' CreateCloudFormationChangeSet (Maybe [Text]) Source #

This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.

createCloudFormationChangeSet_changeSetName :: Lens' CreateCloudFormationChangeSet (Maybe Text) Source #

This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.

createCloudFormationChangeSet_description :: Lens' CreateCloudFormationChangeSet (Maybe Text) Source #

This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.

createCloudFormationChangeSet_capabilities :: Lens' CreateCloudFormationChangeSet (Maybe [Text]) Source #

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, CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.

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.

Applications that contain one or more nested applications require you to specify CAPABILITY_AUTO_EXPAND.

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.

createCloudFormationChangeSet_parameterOverrides :: Lens' CreateCloudFormationChangeSet (Maybe [ParameterValue]) Source #

A list of parameter values for the parameters of the application.

createCloudFormationChangeSet_rollbackConfiguration :: Lens' CreateCloudFormationChangeSet (Maybe RollbackConfiguration) Source #

This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.

createCloudFormationChangeSet_resourceTypes :: Lens' CreateCloudFormationChangeSet (Maybe [Text]) Source #

This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.

createCloudFormationChangeSet_tags :: Lens' CreateCloudFormationChangeSet (Maybe [Tag]) Source #

This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.

createCloudFormationChangeSet_stackName :: Lens' CreateCloudFormationChangeSet Text Source #

This property corresponds to the parameter of the same name for the /AWS CloudFormation CreateChangeSet/ API.

createCloudFormationChangeSetResponse_changeSetId :: Lens' CreateCloudFormationChangeSetResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the change set.

Length constraints: Minimum length of 1.

Pattern: ARN:[-a-zA-Z0-9:/]*

PutApplicationPolicy

putApplicationPolicy_applicationId :: Lens' PutApplicationPolicy Text Source #

The Amazon Resource Name (ARN) of the application.

putApplicationPolicy_statements :: Lens' PutApplicationPolicy [ApplicationPolicyStatement] Source #

An array of policy statements applied to the application.

ListApplications

listApplications_nextToken :: Lens' ListApplications (Maybe Text) Source #

A token to specify where to start paginating.

listApplications_maxItems :: Lens' ListApplications (Maybe Natural) Source #

The total number of items to return.

listApplicationsResponse_nextToken :: Lens' ListApplicationsResponse (Maybe Text) Source #

The token to request the next page of results.

Types

ApplicationDependencySummary

applicationDependencySummary_applicationId :: Lens' ApplicationDependencySummary Text Source #

The Amazon Resource Name (ARN) of the nested application.

ApplicationPolicyStatement

applicationPolicyStatement_principalOrgIDs :: Lens' ApplicationPolicyStatement (Maybe [Text]) Source #

An array of PrinciplalOrgIDs, which corresponds to AWS IAM aws:PrincipalOrgID global condition key.

applicationPolicyStatement_principals :: Lens' ApplicationPolicyStatement [Text] Source #

An array of AWS account IDs, or * to make the application public.

applicationPolicyStatement_actions :: Lens' ApplicationPolicyStatement [Text] Source #

For the list of actions supported for this operation, see Application Permissions.

ApplicationSummary

applicationSummary_creationTime :: Lens' ApplicationSummary (Maybe Text) Source #

The date and time this resource was created.

applicationSummary_homePageUrl :: Lens' ApplicationSummary (Maybe Text) Source #

A URL with more information about the application, for example the location of your GitHub repository for the application.

applicationSummary_labels :: Lens' ApplicationSummary (Maybe [Text]) Source #

Labels to improve discovery of apps in search results.

Minimum length=1. Maximum length=127. Maximum number of labels: 10

Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";

applicationSummary_description :: Lens' ApplicationSummary Text Source #

The description of the application.

Minimum length=1. Maximum length=256

applicationSummary_author :: Lens' ApplicationSummary Text Source #

The name of the author publishing the app.

Minimum length=1. Maximum length=127.

Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";

applicationSummary_applicationId :: Lens' ApplicationSummary Text Source #

The application Amazon Resource Name (ARN).

applicationSummary_name :: Lens' ApplicationSummary Text Source #

The name of the application.

Minimum length=1. Maximum length=140

Pattern: "[a-zA-Z0-9\\-]+";

ParameterDefinition

parameterDefinition_maxValue :: Lens' ParameterDefinition (Maybe Int) Source #

A numeric value that determines the largest numeric value that you want to allow for Number types.

parameterDefinition_maxLength :: Lens' ParameterDefinition (Maybe Int) Source #

An integer value that determines the largest number of characters that you want to allow for String types.

parameterDefinition_constraintDescription :: Lens' ParameterDefinition (Maybe Text) Source #

A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error message when the user specifies an invalid value:

Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+

By adding a constraint description, such as "must contain only uppercase and lowercase letters and numbers," you can display the following customized error message:

Malformed input-Parameter MyParameter must contain only uppercase and lowercase letters and numbers.

parameterDefinition_minLength :: Lens' ParameterDefinition (Maybe Int) Source #

An integer value that determines the smallest number of characters that you want to allow for String types.

parameterDefinition_defaultValue :: Lens' ParameterDefinition (Maybe Text) Source #

A value of the appropriate type for the template to use if no value is specified when a stack is created. If you define constraints for the parameter, you must specify a value that adheres to those constraints.

parameterDefinition_allowedPattern :: Lens' ParameterDefinition (Maybe Text) Source #

A regular expression that represents the patterns to allow for String types.

parameterDefinition_noEcho :: Lens' ParameterDefinition (Maybe Bool) Source #

Whether to mask the parameter value whenever anyone makes a call that describes the stack. If you set the value to true, the parameter value is masked with asterisks (*****).

parameterDefinition_type :: Lens' ParameterDefinition (Maybe Text) Source #

The type of the parameter.

Valid values: String | Number | List<Number> | CommaDelimitedList

String: A literal string.

For example, users can specify "MyUserName".

Number: An integer or float. AWS CloudFormation validates the parameter value as a number. However, when you use the parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a string.

For example, users might specify "8888".

List<Number>: An array of integers or floats that are separated by commas. AWS CloudFormation validates the parameter value as numbers. However, when you use the parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a list of strings.

For example, users might specify "80,20", and then Ref results in ["80","20"].

CommaDelimitedList: An array of literal strings that are separated by commas. The total number of strings should be one more than the total number of commas. Also, each member string is space-trimmed.

For example, users might specify "test,dev,prod", and then Ref results in ["test","dev","prod"].

parameterDefinition_allowedValues :: Lens' ParameterDefinition (Maybe [Text]) Source #

An array containing the list of values allowed for the parameter.

parameterDefinition_description :: Lens' ParameterDefinition (Maybe Text) Source #

A string of up to 4,000 characters that describes the parameter.

parameterDefinition_minValue :: Lens' ParameterDefinition (Maybe Int) Source #

A numeric value that determines the smallest numeric value that you want to allow for Number types.

parameterDefinition_referencedByResources :: Lens' ParameterDefinition [Text] Source #

A list of AWS SAM resources that use this parameter.

ParameterValue

parameterValue_value :: Lens' ParameterValue Text Source #

The input value associated with the parameter.

parameterValue_name :: Lens' ParameterValue Text Source #

The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.

RollbackConfiguration

rollbackConfiguration_rollbackTriggers :: Lens' RollbackConfiguration (Maybe [RollbackTrigger]) Source #

This property corresponds to the content of the same name for the /AWS CloudFormation RollbackConfiguration/ Data Type.

rollbackConfiguration_monitoringTimeInMinutes :: Lens' RollbackConfiguration (Maybe Int) Source #

This property corresponds to the content of the same name for the /AWS CloudFormation RollbackConfiguration/ Data Type.

RollbackTrigger

rollbackTrigger_type :: Lens' RollbackTrigger Text Source #

This property corresponds to the content of the same name for the /AWS CloudFormation RollbackTrigger/ Data Type.

rollbackTrigger_arn :: Lens' RollbackTrigger Text Source #

This property corresponds to the content of the same name for the /AWS CloudFormation RollbackTrigger/ Data Type.

Tag

tag_value :: Lens' Tag Text Source #

This property corresponds to the content of the same name for the /AWS CloudFormation Tag/ Data Type.

tag_key :: Lens' Tag Text Source #

This property corresponds to the content of the same name for the /AWS CloudFormation Tag/ Data Type.

Version

version_sourceCodeUrl :: Lens' Version (Maybe Text) Source #

A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.

version_sourceCodeArchiveUrl :: Lens' Version (Maybe Text) Source #

A link to the S3 object that contains the ZIP archive of the source code for this version of your application.

Maximum size 50 MB

version_templateUrl :: Lens' Version Text Source #

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

version_parameterDefinitions :: Lens' Version [ParameterDefinition] Source #

An array of parameter types supported by the application.

version_resourcesSupported :: Lens' Version Bool Source #

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

version_creationTime :: Lens' Version Text Source #

The date and time this resource was created.

version_requiredCapabilities :: Lens' Version [Capability] Source #

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, CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.

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.

Applications that contain one or more nested applications require you to specify CAPABILITY_AUTO_EXPAND.

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.

version_applicationId :: Lens' Version Text Source #

The application Amazon Resource Name (ARN).

version_semanticVersion :: Lens' Version Text Source #

The semantic version of the application:

https://semver.org/

VersionSummary

versionSummary_sourceCodeUrl :: Lens' VersionSummary (Maybe Text) Source #

A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.

versionSummary_creationTime :: Lens' VersionSummary Text Source #

The date and time this resource was created.

versionSummary_applicationId :: Lens' VersionSummary Text Source #

The application Amazon Resource Name (ARN).