applications

Creates, updates, deletes or gets an application resource or lists applications in a region

Overview

Name	applications
Type	Resource
Description	Definition of AWS::RefactorSpaces::Application Resource Type
Id	aws.refactorspaces.applications

Fields

Name	Datatype	Description
api_gateway_proxy	object
arn	string
api_gateway_id	string
vpc_link_id	string
nlb_arn	string
nlb_name	string
application_identifier	string
environment_identifier	string
name	string
proxy_type	string
vpc_id	string
stage_name	string
proxy_url	string
tags	array	Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	EnvironmentIdentifier, VpcId, Name, ProxyType, region
delete_resource	DELETE	data__Identifier, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all applications in a region.

SELECT
region,
api_gateway_proxy,
arn,
api_gateway_id,
vpc_link_id,
nlb_arn,
nlb_name,
application_identifier,
environment_identifier,
name,
proxy_type,
vpc_id,
stage_name,
proxy_url,
tags
FROM aws.refactorspaces.applications
WHERE region = 'us-east-1';

Gets all properties from an individual application.

SELECT
region,
api_gateway_proxy,
arn,
api_gateway_id,
vpc_link_id,
nlb_arn,
nlb_name,
application_identifier,
environment_identifier,
name,
proxy_type,
vpc_id,
stage_name,
proxy_url,
tags
FROM aws.refactorspaces.applications
WHERE region = 'us-east-1' AND data__Identifier = '<EnvironmentIdentifier>|<ApplicationIdentifier>';

INSERT example

Use the following StackQL query and manifest file to create a new application resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.refactorspaces.applications (
 EnvironmentIdentifier,
 Name,
 ProxyType,
 VpcId,
 region
)
SELECT 
'{{ EnvironmentIdentifier }}',
 '{{ Name }}',
 '{{ ProxyType }}',
 '{{ VpcId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.refactorspaces.applications (
 ApiGatewayProxy,
 EnvironmentIdentifier,
 Name,
 ProxyType,
 VpcId,
 Tags,
 region
)
SELECT 
 '{{ ApiGatewayProxy }}',
 '{{ EnvironmentIdentifier }}',
 '{{ Name }}',
 '{{ ProxyType }}',
 '{{ VpcId }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: application
    props:
      - name: ApiGatewayProxy
        value:
          StageName: '{{ StageName }}'
          EndpointType: '{{ EndpointType }}'
      - name: EnvironmentIdentifier
        value: '{{ EnvironmentIdentifier }}'
      - name: Name
        value: '{{ Name }}'
      - name: ProxyType
        value: '{{ ProxyType }}'
      - name: VpcId
        value: '{{ VpcId }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.refactorspaces.applications
WHERE data__Identifier = '<EnvironmentIdentifier|ApplicationIdentifier>'
AND region = 'us-east-1';

Permissions

To operate on the applications resource, the following permissions are required:

Create

refactor-spaces:GetApplication,
refactor-spaces:CreateApplication,
refactor-spaces:TagResource,
ec2:CreateTags,
ec2:CreateVpcEndpointServiceConfiguration,
ec2:DescribeVpcs,
ec2:DescribeSubnets,
ec2:DescribeVpcEndpointServiceConfigurations,
ec2:DescribeAccountAttributes,
ec2:DescribeInternetGateways,
ec2:ModifyVpcEndpointServicePermissions,
apigateway:DELETE,
apigateway:GET,
apigateway:PATCH,
apigateway:POST,
apigateway:PUT,
apigateway:UpdateRestApiPolicy,
apigateway:Update*,
apigateway:Delete*,
apigateway:Get*,
apigateway:Put*,
elasticloadbalancing:CreateLoadBalancer,
elasticloadbalancing:DescribeLoadBalancers,
elasticloadbalancing:DescribeTags,
elasticloadbalancing:AddTags,
iam:CreateServiceLinkedRole

Read

refactor-spaces:GetApplication,
refactor-spaces:ListTagsForResource

Delete

refactor-spaces:GetApplication,
refactor-spaces:DeleteApplication,
refactor-spaces:UntagResource,
ec2:DescribeVpcEndpointServiceConfigurations,
ec2:DeleteRoute,
ec2:DeleteSecurityGroup,
ec2:DeleteTransitGateway,
ec2:DeleteTransitGatewayVpcAttachment,
ec2:DeleteVpcEndpointServiceConfigurations,
ec2:DeleteTags,
ec2:RevokeSecurityGroupIngress,
elasticloadbalancing:DeleteLoadBalancer,
apigateway:Update*,
apigateway:Delete*,
apigateway:Get*,
apigateway:Put*

List

refactor-spaces:ListApplications,
refactor-spaces:ListTagsForResource