@quadnix/octo-aws-cdk

Index

Anchors/AwsAccount

• AwsAccountAnchorSchema

Anchors/AwsEcs

• AwsEcsAlbAnchorSchema
• AwsEcsClusterAnchorSchema
• AwsEcsExecutionAnchorSchema
• AwsEcsServerAnchorSchema
• AwsEcsServiceAnchorSchema
• AwsEcsTaskDefinitionAnchorImagePortSchema
• AwsEcsTaskDefinitionAnchorImageSchema
• AwsEcsTaskDefinitionAnchorPropertiesSchema
• AwsEcsTaskDefinitionAnchorSchema

Anchors/AwsEfs

• AwsEfsAnchorSchema

Anchors/AwsIam

• AwsIamRoleAnchorSchema

Anchors/AwsRegion

• AwsRegionAnchorSchema

Anchors/AwsS3StorageService

• AwsS3StorageServiceAnchorSchema
• AwsS3StorageServiceDirectoryAnchorSchema

Anchors/AwsSecurityGroup

• AwsSecurityGroupAnchorRuleSchema
• AwsSecurityGroupAnchorSchema

Anchors/AwsSubnet

• AwsSubnetAnchorSchema
• AwsSubnetLocalFilesystemMountAnchorSchema

Modules/Account/AwsCredentialsAccount

• AwsCredentialsAccountModule
• AwsCredentialsAccountModuleSchema

Modules/Account/AwsIniAccount

• AwsIniAccountModule
• AwsIniAccountModuleSchema

Modules/Account/AwsLocalstackAccount

• AwsLocalstackAccountModule
• AwsLocalstackAccountModuleSchema

Modules/Account/AwsMotoAccount

• AwsMotoAccountModule
• AwsMotoAccountModuleSchema

Modules/App/SimpleApp

• SimpleAppModule
• SimpleAppModuleSchema

Modules/Deployment/AwsEcsDeployment

• AwsEcsDeploymentModule
• AwsEcsDeploymentModuleSchema

Modules/Environment/AwsEcsEnvironment

• AwsEcsEnvironmentModule
• AwsEcsEnvironmentModuleSchema

Modules/Execution/AwsEcsExecution

• AwsEcsExecutionModule
• AwsEcsExecutionModuleDeploymentContainerPropertiesImageSchema
• AwsEcsExecutionModuleDeploymentContainerPropertiesSchema
• AwsEcsExecutionModuleSchema

Modules/Filesystem/AwsEfsFilesystem

• AwsEfsFilesystemModule
• AwsEfsFilesystemModuleSchema

Modules/Image/AwsEcrImage

• AwsEcrImageModule
• AwsEcrImageModuleSchema

Modules/Region/AwsMultiAzRegion

• AwsMultiAzRegionId
• AwsMultiAzRegionModule
• AwsMultiAzRegionModuleSchema

Modules/Region/AwsSingleAzRegion

• AwsSingleAzRegionId
• AwsSingleAzRegionModule
• AwsSingleAzRegionModuleSchema

Modules/Server/AwsEcsServer

• AwsEcsServerS3AccessDirectoryPermission
• AwsEcsServerModule
• AwsEcsServerModuleSchema
• AwsEcsServerS3AccessDirectorySchema

Modules/Service/AwsEcsAlbService

• AwsEcsAlbServiceModule
• AwsEcsAlbServiceModuleSchema
• AwsEcsAlbServiceModuleTargetGroupSchema

Modules/Service/AwsS3StaticWebsiteService

• AwsS3StaticWebsiteServiceModule
• AwsS3StaticWebsiteServiceModuleSchema

Modules/Service/AwsS3StorageService

• AwsS3StorageServiceModule
• AwsS3StorageServiceModuleSchema

Modules/Subnet/AwsSimpleSubnet

• AwsSimpleSubnetModule
• AwsSimpleSubnetModuleSchema

Resources/Alb

• AlbSchema

Resources/AlbListener

• AlbListenerActionFixedResponseActionSchema
• AlbListenerActionForwardConfigSchema
• AlbListenerActionRedirectActionSchema
• AlbListenerRuleHostHeaderConditionSchema
• AlbListenerRuleHttpHeaderConditionSchema
• AlbListenerRuleHttpRequestMethodConditionSchema
• AlbListenerRulePathPatternConditionSchema
• AlbListenerRuleQueryStringConditionSchema
• AlbListenerRuleSourceIpConditionSchema
• AlbListenerSchema
• IAlbListenerActionTypes
• IAlbListenerRuleTypes

Resources/AlbTargetGroup

• AlbTargetGroupHealthCheckSchema
• AlbTargetGroupSchema

Resources/Ecr

• EcrImageSchema

Resources/EcsCluster

• EcsClusterSchema

Resources/EcsService

• EcsServiceLoadBalancerSchema
• EcsServiceSchema

Resources/EcsTaskDefinition

• EcsTaskDefinitionEnvironmentVariableSchema
• EcsTaskDefinitionImagePortSchema
• EcsTaskDefinitionImageSchema
• EcsTaskDefinitionSchema

Resources/Efs

• EfsSchema

Resources/EfsMountTarget

• EfsMountTargetSchema

Resources/IamRole

• IamRoleSchema
• IIamRoleS3BucketPolicy
• IIamRoleAssumeRolePolicy
• IIamRolePolicyTypes

Resources/IamUser

• IamUserSchema
• IIamUserS3BucketPolicy
• IIamUserPolicyTypes

Resources/InternetGateway

• InternetGatewaySchema

Resources/NatGateway

• NatGatewaySchema

Resources/NetworkAcl

• NetworkAclEntrySchema
• NetworkAclSchema

Resources/RouteTable

• RouteTableSchema

Resources/S3Storage

• S3StoragePermissionSchema
• S3StorageSchema

Resources/S3Website

• S3WebsiteSchema

Resources/SecurityGroup

• SecurityGroupRuleSchema
• SecurityGroupSchema

Resources/Subnet

• SubnetSchema

Resources/Vpc

• VpcSchema

Resources/AlbListener

IAlbListenerActionTypes

IAlbListenerActionTypes:

Defines the types of actions on the ALB Listener. Possible values are fixed-response, forward, or redirect. These values are mapped from the official ALB Listener Action Types document. Please refer to the AWS documentation for more information.

@group

Resources/AlbListener

fixed-response

fixed-response: AlbListenerActionFixedResponseActionSchema

Sends a fixed HTTP response to the client.

forward

forward: AlbListenerActionForwardConfigSchema

Forwards requests to one or more target groups.

redirect

redirect: AlbListenerActionRedirectActionSchema

Redirects requests from one path to another.

IAlbListenerRuleTypes

IAlbListenerRuleTypes:

When the ALB receives an HTTP request, the ALB Listener evaluates rules to determine what to do with the request. This defines the types of rules on the ALB Listener. Possible values are host-header, http-header, http-request-method, path-pattern, query-string, or source-ip. These values are mapped from the official ALB Listener Rules document. Please refer to the AWS documentation for more information.

The official documentation also imposes some restrictions on rules. It is important to review those restrictions, or else resource creation might fail and get into a dirty state.

@group

Resources/AlbListener

host-header

host-header: AlbListenerRuleHostHeaderConditionSchema

Matches requests based on the value of the host header in the HTTP request.

http-header

http-header: AlbListenerRuleHttpHeaderConditionSchema

Matches requests based on the value of a specified HTTP header in the HTTP request.

http-request-method

http-request-method: AlbListenerRuleHttpRequestMethodConditionSchema

Matches requests based on the HTTP method in the HTTP request.

path-pattern

path-pattern: AlbListenerRulePathPatternConditionSchema

Matches requests based on the value of the path in the HTTP request.

query-string

query-string: AlbListenerRuleQueryStringConditionSchema

Matches requests based on the value of the query string in the HTTP request.

source-ip

source-ip: AlbListenerRuleSourceIpConditionSchema

Matches requests based on the source IP address.

Resources/IamRole

IIamRoleAssumeRolePolicy

IIamRoleAssumeRolePolicy: ecs-tasks.amazonaws.com

List of IAM entities regarding roles, policies, and permissions. Possible values are,

• ecs-tasks.amazonaws.com: This is an AWS service principal for ECS tasks. It is used in IAM trust policies to allow ECS tasks to assume a role. You must add this to the set of policies if you are running ECS tasks in your cluster.

@group

Resources/IamRole

IIamRolePolicyTypes

IIamRolePolicyTypes:

Defines the types of policies that can be attached to this IAM role.

@group

Resources/IamRole

assume-role-policy

assume-role-policy: IIamRoleAssumeRolePolicy

You can provide a policy that allows the role to assume another role, or establish trust relationships. See IIamRoleAssumeRolePolicy for options.

aws-policy

aws-policy: string

You can provide a policy that allows the role to perform actions on AWS resources. This can be a predefined AWS managed policy ARN or custom policy ARN that you create.

s3-storage-access-policy

s3-storage-access-policy: IIamRoleS3BucketPolicy

You can provide options to create a policy for accessing a S3 bucket.

Resources/IamUser

IIamUserPolicyTypes

IIamUserPolicyTypes:

Defines the types of policies that can be attached to this IAM user.

@group

Resources/IamUser

s3-storage-access-policy

s3-storage-access-policy: IIamUserS3BucketPolicy

You can provide options to create a policy for accessing a S3 bucket.