AWS.Tools.ServerlessApplicationRepository.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.ServerlessApplicationRepository</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationCmdlet"> <summary> Gets the specified application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationCmdlet.ApplicationId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationCmdlet.SemanticVersion"> <summary> <para> <para>The semantic version of the application to get.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServerlessApplicationRepository.Model.GetApplicationResponse). Specifying the name of a property of type Amazon.ServerlessApplicationRepository.Model.GetApplicationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SemanticVersion parameter. The -PassThru parameter is deprecated, use -Select '^SemanticVersion' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationDependencyListCmdlet"> <summary> Retrieves the list of applications nested in the containing application.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationDependencyListCmdlet.ApplicationId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationDependencyListCmdlet.SemanticVersion"> <summary> <para> <para>The semantic version of the application to get.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationDependencyListCmdlet.MaxItem"> <summary> <para> <para>The total number of items to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationDependencyListCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start paginating.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationDependencyListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Dependencies'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServerlessApplicationRepository.Model.ListApplicationDependenciesResponse). Specifying the name of a property of type Amazon.ServerlessApplicationRepository.Model.ListApplicationDependenciesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationDependencyListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApplicationId parameter. The -PassThru parameter is deprecated, use -Select '^ApplicationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationDependencyListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationListCmdlet"> <summary> Lists applications owned by the requester.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationListCmdlet.MaxItem"> <summary> <para> <para>The total number of items to return.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationListCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start paginating.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Applications'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServerlessApplicationRepository.Model.ListApplicationsResponse). Specifying the name of a property of type Amazon.ServerlessApplicationRepository.Model.ListApplicationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MaxItem parameter. The -PassThru parameter is deprecated, use -Select '^MaxItem' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationPolicyCmdlet"> <summary> Retrieves the policy for the application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationPolicyCmdlet.ApplicationId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Statements'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServerlessApplicationRepository.Model.GetApplicationPolicyResponse). Specifying the name of a property of type Amazon.ServerlessApplicationRepository.Model.GetApplicationPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApplicationId parameter. The -PassThru parameter is deprecated, use -Select '^ApplicationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationVersionListCmdlet"> <summary> Lists versions for the specified application.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationVersionListCmdlet.ApplicationId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationVersionListCmdlet.MaxItem"> <summary> <para> <para>The total number of items to return.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationVersionListCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start paginating.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Versions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServerlessApplicationRepository.Model.ListApplicationVersionsResponse). Specifying the name of a property of type Amazon.ServerlessApplicationRepository.Model.ListApplicationVersionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationVersionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApplicationId parameter. The -PassThru parameter is deprecated, use -Select '^ApplicationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARApplicationVersionListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SAR.GetSARCloudFormationTemplateCmdlet"> <summary> Gets the specified AWS CloudFormation template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARCloudFormationTemplateCmdlet.ApplicationId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARCloudFormationTemplateCmdlet.TemplateId"> <summary> <para> <para>The UUID returned by CreateCloudFormationTemplate.</para><para>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}</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARCloudFormationTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServerlessApplicationRepository.Model.GetCloudFormationTemplateResponse). Specifying the name of a property of type Amazon.ServerlessApplicationRepository.Model.GetCloudFormationTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.GetSARCloudFormationTemplateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TemplateId parameter. The -PassThru parameter is deprecated, use -Select '^TemplateId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationCmdlet"> <summary> Creates an application, optionally including an AWS SAM file to create the first application version in the same call. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationCmdlet.Author"> <summary> <para> <para>The name of the author publishing the app.</para><para>Minimum length=1. Maximum length=127.</para><para>Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationCmdlet.Description"> <summary> <para> <para>The description of the application.</para><para>Minimum length=1. Maximum length=256</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationCmdlet.HomePageUrl"> <summary> <para> <para>A URL with more information about the application, for example the location of your GitHub repository for the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationCmdlet.Label"> <summary> <para> <para>Labels to improve discovery of apps in search results.</para><para>Minimum length=1. Maximum length=127. Maximum number of labels: 10</para><para>Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationCmdlet.LicenseBody"> <summary> <para> <para>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>.</para><para>Maximum size 5 MB</para><para>You can specify only one of licenseBody and licenseUrl; otherwise, an error results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationCmdlet.LicenseUrl"> <summary> <para> <para>A link to the S3 object that contains the license of the app that matches the spdxLicenseID value of your application.</para><para>Maximum size 5 MB</para><para>You can specify only one of licenseBody and licenseUrl; otherwise, an error results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationCmdlet.Name"> <summary> <para> <para>The name of the application that you want to publish.</para><para>Minimum length=1. Maximum length=140</para><para>Pattern: "[a-zA-Z0-9\\-]+";</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationCmdlet.ReadmeBody"> <summary> <para> <para>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>.</para><para>Maximum size 5 MB</para><para>You can specify only one of readmeBody and readmeUrl; otherwise, an error results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationCmdlet.ReadmeUrl"> <summary> <para> <para>A link to the S3 object in Markdown language that contains a more detailed description of the application and how it works.</para><para>Maximum size 5 MB</para><para>You can specify only one of readmeBody and readmeUrl; otherwise, an error results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationCmdlet.SemanticVersion"> <summary> <para> <para>The semantic version of the application:</para><para><a href="https://semver.org/">https://semver.org/</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationCmdlet.SourceCodeArchiveUrl"> <summary> <para> <para>A link to the S3 object that contains the ZIP archive of the source code for this version of your application.</para><para>Maximum size 50 MB</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationCmdlet.SourceCodeUrl"> <summary> <para> <para>A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationCmdlet.SpdxLicenseId"> <summary> <para> <para>A valid identifier from <a href="https://spdx.org/licenses/">https://spdx.org/licenses/</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationCmdlet.TemplateBody"> <summary> <para> <para>The local raw packaged AWS SAM template file of your application. The file has the format file://<path>/<filename>.</para><para>You can specify only one of templateBody and templateUrl; otherwise an error results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationCmdlet.TemplateUrl"> <summary> <para> <para>A link to the S3 object containing the packaged AWS SAM template of your application.</para><para>You can specify only one of templateBody and templateUrl; otherwise an error results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServerlessApplicationRepository.Model.CreateApplicationResponse). Specifying the name of a property of type Amazon.ServerlessApplicationRepository.Model.CreateApplicationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationVersionCmdlet"> <summary> Creates an application version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationVersionCmdlet.ApplicationId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationVersionCmdlet.SemanticVersion"> <summary> <para> <para>The semantic version of the new version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationVersionCmdlet.SourceCodeArchiveUrl"> <summary> <para> <para>A link to the S3 object that contains the ZIP archive of the source code for this version of your application.</para><para>Maximum size 50 MB</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationVersionCmdlet.SourceCodeUrl"> <summary> <para> <para>A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationVersionCmdlet.TemplateBody"> <summary> <para> <para>The raw packaged AWS SAM template of your application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationVersionCmdlet.TemplateUrl"> <summary> <para> <para>A link to the packaged AWS SAM template of your application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServerlessApplicationRepository.Model.CreateApplicationVersionResponse). Specifying the name of a property of type Amazon.ServerlessApplicationRepository.Model.CreateApplicationVersionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SemanticVersion parameter. The -PassThru parameter is deprecated, use -Select '^SemanticVersion' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARApplicationVersionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SAR.NewSARCloudFormationChangeSetCmdlet"> <summary> Creates an AWS CloudFormation change set for the given application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARCloudFormationChangeSetCmdlet.ApplicationId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARCloudFormationChangeSetCmdlet.Capability"> <summary> <para> <para>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.</para><para>The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.</para><para>The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html">AWS::IAM::Group</a>, <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html">AWS::IAM::InstanceProfile</a>, <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html">AWS::IAM::Policy</a>, and <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html">AWS::IAM::Role</a>. 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.</para><para>The following resources require you to specify CAPABILITY_RESOURCE_POLICY: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html">AWS::Lambda::Permission</a>, <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html">AWS::IAM:Policy</a>, <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationautoscaling-scalingpolicy.html">AWS::ApplicationAutoScaling::ScalingPolicy</a>, <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html">AWS::S3::BucketPolicy</a>, <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sqs-policy.html">AWS::SQS::QueuePolicy</a>, and <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-policy.html">AWS::SNS:TopicPolicy</a>.</para><para>Applications that contain one or more nested applications require you to specify CAPABILITY_AUTO_EXPAND.</para><para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARCloudFormationChangeSetCmdlet.ChangeSetName"> <summary> <para> <para>This property corresponds to the parameter of the same name for the <i>AWS CloudFormation <a href="https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet">CreateChangeSet</a></i> API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARCloudFormationChangeSetCmdlet.Description"> <summary> <para> <para>This property corresponds to the parameter of the same name for the <i>AWS CloudFormation <a href="https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet">CreateChangeSet</a></i> API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARCloudFormationChangeSetCmdlet.RollbackConfiguration_MonitoringTimeInMinute"> <summary> <para> <para>This property corresponds to the content of the same name for the <i>AWS CloudFormation <a href="https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackConfiguration">RollbackConfiguration</a></i> Data Type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARCloudFormationChangeSetCmdlet.NotificationArn"> <summary> <para> <para>This property corresponds to the parameter of the same name for the <i>AWS CloudFormation <a href="https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet">CreateChangeSet</a></i> API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARCloudFormationChangeSetCmdlet.ParameterOverride"> <summary> <para> <para>A list of parameter values for the parameters of the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARCloudFormationChangeSetCmdlet.ResourceType"> <summary> <para> <para>This property corresponds to the parameter of the same name for the <i>AWS CloudFormation <a href="https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet">CreateChangeSet</a></i> API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARCloudFormationChangeSetCmdlet.RollbackConfiguration_RollbackTrigger"> <summary> <para> <para>This property corresponds to the content of the same name for the <i>AWS CloudFormation <a href="https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/RollbackConfiguration">RollbackConfiguration</a></i> Data Type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARCloudFormationChangeSetCmdlet.SemanticVersion"> <summary> <para> <para>The semantic version of the application:</para><para><a href="https://semver.org/">https://semver.org/</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARCloudFormationChangeSetCmdlet.StackName"> <summary> <para> <para>This property corresponds to the parameter of the same name for the <i>AWS CloudFormation <a href="https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet">CreateChangeSet</a></i> API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARCloudFormationChangeSetCmdlet.Tag"> <summary> <para> <para>This property corresponds to the parameter of the same name for the <i>AWS CloudFormation <a href="https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet">CreateChangeSet</a></i> API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARCloudFormationChangeSetCmdlet.TemplateId"> <summary> <para> <para>The UUID returned by CreateCloudFormationTemplate.</para><para>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}</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARCloudFormationChangeSetCmdlet.ClientToken"> <summary> <para> <para>This property corresponds to the parameter of the same name for the <i>AWS CloudFormation <a href="https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet">CreateChangeSet</a></i> API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARCloudFormationChangeSetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServerlessApplicationRepository.Model.CreateCloudFormationChangeSetResponse). Specifying the name of a property of type Amazon.ServerlessApplicationRepository.Model.CreateCloudFormationChangeSetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARCloudFormationChangeSetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SemanticVersion parameter. The -PassThru parameter is deprecated, use -Select '^SemanticVersion' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARCloudFormationChangeSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SAR.NewSARCloudFormationTemplateCmdlet"> <summary> Creates an AWS CloudFormation template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARCloudFormationTemplateCmdlet.ApplicationId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARCloudFormationTemplateCmdlet.SemanticVersion"> <summary> <para> <para>The semantic version of the application:</para><para><a href="https://semver.org/">https://semver.org/</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARCloudFormationTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServerlessApplicationRepository.Model.CreateCloudFormationTemplateResponse). Specifying the name of a property of type Amazon.ServerlessApplicationRepository.Model.CreateCloudFormationTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARCloudFormationTemplateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApplicationId parameter. The -PassThru parameter is deprecated, use -Select '^ApplicationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.NewSARCloudFormationTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SAR.RemoveSARApplicationCmdlet"> <summary> Deletes the specified application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.RemoveSARApplicationCmdlet.ApplicationId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.RemoveSARApplicationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServerlessApplicationRepository.Model.DeleteApplicationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.RemoveSARApplicationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApplicationId parameter. The -PassThru parameter is deprecated, use -Select '^ApplicationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.RemoveSARApplicationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SAR.RevokeSARApplicationSharingCmdlet"> <summary> Unshares an application from an AWS Organization. <para> This operation can be called only from the organization's master account. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.RevokeSARApplicationSharingCmdlet.ApplicationId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.RevokeSARApplicationSharingCmdlet.OrganizationId"> <summary> <para> <para>The AWS Organization ID to unshare the application from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.RevokeSARApplicationSharingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServerlessApplicationRepository.Model.UnshareApplicationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.RevokeSARApplicationSharingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApplicationId parameter. The -PassThru parameter is deprecated, use -Select '^ApplicationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.RevokeSARApplicationSharingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SAR.SetSARApplicationPolicyCmdlet"> <summary> Sets the permission policy for an application. For the list of actions supported for this operation, see <a href="https://docs.aws.amazon.com/serverlessrepo/latest/devguide/access-control-resource-based.html#application-permissions">Application Permissions</a> . </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.SetSARApplicationPolicyCmdlet.ApplicationId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.SetSARApplicationPolicyCmdlet.Statement"> <summary> <para> <para>An array of policy statements applied to the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.SetSARApplicationPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Statements'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServerlessApplicationRepository.Model.PutApplicationPolicyResponse). Specifying the name of a property of type Amazon.ServerlessApplicationRepository.Model.PutApplicationPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.SetSARApplicationPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApplicationId parameter. The -PassThru parameter is deprecated, use -Select '^ApplicationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.SetSARApplicationPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SAR.UpdateSARApplicationCmdlet"> <summary> Updates the specified application. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.UpdateSARApplicationCmdlet.ApplicationId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.UpdateSARApplicationCmdlet.Author"> <summary> <para> <para>The name of the author publishing the app.</para><para>Minimum length=1. Maximum length=127.</para><para>Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.UpdateSARApplicationCmdlet.Description"> <summary> <para> <para>The description of the application.</para><para>Minimum length=1. Maximum length=256</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.UpdateSARApplicationCmdlet.HomePageUrl"> <summary> <para> <para>A URL with more information about the application, for example the location of your GitHub repository for the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.UpdateSARApplicationCmdlet.Label"> <summary> <para> <para>Labels to improve discovery of apps in search results.</para><para>Minimum length=1. Maximum length=127. Maximum number of labels: 10</para><para>Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.UpdateSARApplicationCmdlet.ReadmeBody"> <summary> <para> <para>A text readme file in Markdown language that contains a more detailed description of the application and how it works.</para><para>Maximum size 5 MB</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.UpdateSARApplicationCmdlet.ReadmeUrl"> <summary> <para> <para>A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.</para><para>Maximum size 5 MB</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.UpdateSARApplicationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServerlessApplicationRepository.Model.UpdateApplicationResponse). Specifying the name of a property of type Amazon.ServerlessApplicationRepository.Model.UpdateApplicationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.UpdateSARApplicationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ApplicationId parameter. The -PassThru parameter is deprecated, use -Select '^ApplicationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SAR.UpdateSARApplicationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |