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	awscc.refactorspaces.applications

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
application_identifier	string
environment_identifier	string
region	string	AWS region.

For more information, see AWS::RefactorSpaces::Application.

Methods

Name	Resource	Accessible by	Required Params
create_resource	applications	INSERT	EnvironmentIdentifier, VpcId, Name, ProxyType, region
delete_resource	applications	DELETE	Identifier, region
list_resources	applications_list_only	SELECT	region
get_resource	applications	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.refactorspaces.applications
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ environment_identifier }}|{{ application_identifier }}';

list (identifiers only)

Lists all applications in a region.

SELECT
  region,
  environment_identifier,
  application_identifier
FROM awscc.refactorspaces.applications_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.refactorspaces.applications (
  EnvironmentIdentifier,
  Name,
  ProxyType,
  VpcId,
  region
)
SELECT
  '{{ environment_identifier }}',
  '{{ name }}',
  '{{ proxy_type }}',
  '{{ vpc_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.refactorspaces.applications (
  ApiGatewayProxy,
  EnvironmentIdentifier,
  Name,
  ProxyType,
  VpcId,
  Tags,
  region
)
SELECT
  '{{ api_gateway_proxy }}',
  '{{ environment_identifier }}',
  '{{ name }}',
  '{{ proxy_type }}',
  '{{ vpc_id }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: application
  props:
    - name: api_gateway_proxy
      value:
        stage_name: '{{ stage_name }}'
        endpoint_type: '{{ endpoint_type }}'
    - name: environment_identifier
      value: '{{ environment_identifier }}'
    - name: name
      value: '{{ name }}'
    - name: proxy_type
      value: '{{ proxy_type }}'
    - name: vpc_id
      value: '{{ vpc_id }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

DELETE example

/*+ delete */
DELETE FROM awscc.refactorspaces.applications
WHERE
  Identifier = '{{ environment_identifier }}|{{ application_identifier }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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,
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:DELETE,
apigateway:GET,
apigateway:PUT,
apigateway:UpdateRestApiPolicy

List

refactor-spaces:ListApplications,
refactor-spaces:ListTagsForResource