Documentation
¶
Index ¶
- func CfnService_CFN_RESOURCE_TYPE_NAME() *string
- func CfnService_IsCfnElement(x interface{}) *bool
- func CfnService_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnService_IsConstruct(x interface{}) *bool
- func CfnVpcConnector_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVpcConnector_IsCfnElement(x interface{}) *bool
- func CfnVpcConnector_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnVpcConnector_IsConstruct(x interface{}) *bool
- func NewAssetSource_Override(a AssetSource, props *AssetProps)
- func NewCfnService_Override(c CfnService, scope awscdk.Construct, id *string, props *CfnServiceProps)
- func NewCfnVpcConnector_Override(c CfnVpcConnector, scope awscdk.Construct, id *string, ...)
- func NewEcrPublicSource_Override(e EcrPublicSource, props *EcrPublicProps)
- func NewEcrSource_Override(e EcrSource, props *EcrProps)
- func NewGitHubConnection_Override(g GitHubConnection, arn *string)
- func NewGithubSource_Override(g GithubSource, props *GithubRepositoryProps)
- func NewService_Override(s Service, scope constructs.Construct, id *string, props *ServiceProps)
- func NewSource_Override(s Source)
- func Service_IsConstruct(x interface{}) *bool
- func Service_IsResource(construct awscdk.IConstruct) *bool
- type AssetProps
- type AssetSource
- func AssetSource_FromAsset(props *AssetProps) AssetSource
- func EcrPublicSource_FromAsset(props *AssetProps) AssetSource
- func EcrSource_FromAsset(props *AssetProps) AssetSource
- func GithubSource_FromAsset(props *AssetProps) AssetSource
- func NewAssetSource(props *AssetProps) AssetSource
- func Source_FromAsset(props *AssetProps) AssetSource
- type CfnService
- type CfnServiceProps
- type CfnService_AuthenticationConfigurationProperty
- type CfnService_CodeConfigurationProperty
- type CfnService_CodeConfigurationValuesProperty
- type CfnService_CodeRepositoryProperty
- type CfnService_EgressConfigurationProperty
- type CfnService_EncryptionConfigurationProperty
- type CfnService_HealthCheckConfigurationProperty
- type CfnService_ImageConfigurationProperty
- type CfnService_ImageRepositoryProperty
- type CfnService_InstanceConfigurationProperty
- type CfnService_KeyValuePairProperty
- type CfnService_NetworkConfigurationProperty
- type CfnService_SourceCodeVersionProperty
- type CfnService_SourceConfigurationProperty
- type CfnVpcConnector
- type CfnVpcConnectorProps
- type CodeConfiguration
- type CodeConfigurationValues
- type CodeRepositoryProps
- type ConfigurationSourceType
- type Cpu
- type EcrProps
- type EcrPublicProps
- type EcrPublicSource
- func AssetSource_FromEcrPublic(props *EcrPublicProps) EcrPublicSource
- func EcrPublicSource_FromEcrPublic(props *EcrPublicProps) EcrPublicSource
- func EcrSource_FromEcrPublic(props *EcrPublicProps) EcrPublicSource
- func GithubSource_FromEcrPublic(props *EcrPublicProps) EcrPublicSource
- func NewEcrPublicSource(props *EcrPublicProps) EcrPublicSource
- func Source_FromEcrPublic(props *EcrPublicProps) EcrPublicSource
- type EcrSource
- func AssetSource_FromEcr(props *EcrProps) EcrSource
- func EcrPublicSource_FromEcr(props *EcrProps) EcrSource
- func EcrSource_FromEcr(props *EcrProps) EcrSource
- func GithubSource_FromEcr(props *EcrProps) EcrSource
- func NewEcrSource(props *EcrProps) EcrSource
- func Source_FromEcr(props *EcrProps) EcrSource
- type GitHubConnection
- type GithubRepositoryProps
- type GithubSource
- func AssetSource_FromGitHub(props *GithubRepositoryProps) GithubSource
- func EcrPublicSource_FromGitHub(props *GithubRepositoryProps) GithubSource
- func EcrSource_FromGitHub(props *GithubRepositoryProps) GithubSource
- func GithubSource_FromGitHub(props *GithubRepositoryProps) GithubSource
- func NewGithubSource(props *GithubRepositoryProps) GithubSource
- func Source_FromGitHub(props *GithubRepositoryProps) GithubSource
- type IService
- type ImageConfiguration
- type ImageRepository
- type ImageRepositoryType
- type Memory
- type Runtime
- type Service
- type ServiceAttributes
- type ServiceProps
- type Source
- type SourceCodeVersion
- type SourceConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnService_CFN_RESOURCE_TYPE_NAME ¶
func CfnService_CFN_RESOURCE_TYPE_NAME() *string
func CfnService_IsCfnElement ¶
func CfnService_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.
func CfnService_IsCfnResource ¶
func CfnService_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnService_IsConstruct ¶
func CfnService_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnVpcConnector_CFN_RESOURCE_TYPE_NAME ¶
func CfnVpcConnector_CFN_RESOURCE_TYPE_NAME() *string
func CfnVpcConnector_IsCfnElement ¶
func CfnVpcConnector_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.
func CfnVpcConnector_IsCfnResource ¶
func CfnVpcConnector_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnVpcConnector_IsConstruct ¶
func CfnVpcConnector_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func NewAssetSource_Override ¶
func NewAssetSource_Override(a AssetSource, props *AssetProps)
Experimental.
func NewCfnService_Override ¶
func NewCfnService_Override(c CfnService, scope awscdk.Construct, id *string, props *CfnServiceProps)
Create a new `AWS::AppRunner::Service`.
func NewCfnVpcConnector_Override ¶
func NewCfnVpcConnector_Override(c CfnVpcConnector, scope awscdk.Construct, id *string, props *CfnVpcConnectorProps)
Create a new `AWS::AppRunner::VpcConnector`.
func NewEcrPublicSource_Override ¶
func NewEcrPublicSource_Override(e EcrPublicSource, props *EcrPublicProps)
Experimental.
func NewGitHubConnection_Override ¶
func NewGitHubConnection_Override(g GitHubConnection, arn *string)
Experimental.
func NewGithubSource_Override ¶
func NewGithubSource_Override(g GithubSource, props *GithubRepositoryProps)
Experimental.
func NewService_Override ¶
func NewService_Override(s Service, scope constructs.Construct, id *string, props *ServiceProps)
Experimental.
func Service_IsConstruct ¶
func Service_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func Service_IsResource ¶
func Service_IsResource(construct awscdk.IConstruct) *bool
Check whether the given construct is a Resource. Experimental.
Types ¶
type AssetProps ¶
type AssetProps struct {
// Represents the docker image asset.
// Experimental.
Asset awsecrassets.DockerImageAsset `json:"asset" yaml:"asset"`
// The image configuration for the image built from the asset.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imageconfiguration.html#cfn-apprunner-service-imageconfiguration-port
//
// Experimental.
ImageConfiguration *ImageConfiguration `json:"imageConfiguration" yaml:"imageConfiguration"`
}
Properties of the image repository for `Source.fromAsset()`.
TODO: EXAMPLE
Experimental.
type AssetSource ¶
type AssetSource interface {
Source
Bind(_scope constructs.Construct) *SourceConfig
}
Represents the source from local assets.
TODO: EXAMPLE
Experimental.
func AssetSource_FromAsset ¶
func AssetSource_FromAsset(props *AssetProps) AssetSource
Source from local assets. Experimental.
func EcrPublicSource_FromAsset ¶
func EcrPublicSource_FromAsset(props *AssetProps) AssetSource
Source from local assets. Experimental.
func EcrSource_FromAsset ¶
func EcrSource_FromAsset(props *AssetProps) AssetSource
Source from local assets. Experimental.
func GithubSource_FromAsset ¶
func GithubSource_FromAsset(props *AssetProps) AssetSource
Source from local assets. Experimental.
func Source_FromAsset ¶
func Source_FromAsset(props *AssetProps) AssetSource
Source from local assets. Experimental.
type CfnService ¶
type CfnService interface {
awscdk.CfnResource
awscdk.IInspectable
AttrServiceArn() *string
AttrServiceId() *string
AttrServiceUrl() *string
AttrStatus() *string
AutoScalingConfigurationArn() *string
SetAutoScalingConfigurationArn(val *string)
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
EncryptionConfiguration() interface{}
SetEncryptionConfiguration(val interface{})
HealthCheckConfiguration() interface{}
SetHealthCheckConfiguration(val interface{})
InstanceConfiguration() interface{}
SetInstanceConfiguration(val interface{})
LogicalId() *string
NetworkConfiguration() interface{}
SetNetworkConfiguration(val interface{})
Node() awscdk.ConstructNode
Ref() *string
ServiceName() *string
SetServiceName(val *string)
SourceConfiguration() interface{}
SetSourceConfiguration(val interface{})
Stack() awscdk.Stack
Tags() awscdk.TagManager
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OnPrepare()
OnSynthesize(session constructs.ISynthesisSession)
OnValidate() *[]*string
OverrideLogicalId(newLogicalId *string)
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
Synthesize(session awscdk.ISynthesisSession)
ToString() *string
Validate() *[]*string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::AppRunner::Service`.
Specify an AWS App Runner service by using the `AWS::AppRunner::Service` resource in an AWS CloudFormation template.
The `AWS::AppRunner::Service` resource is an AWS App Runner resource type that specifies an App Runner service.
TODO: EXAMPLE
func NewCfnService ¶
func NewCfnService(scope awscdk.Construct, id *string, props *CfnServiceProps) CfnService
Create a new `AWS::AppRunner::Service`.
type CfnServiceProps ¶
type CfnServiceProps struct {
// The source to deploy to the App Runner service.
//
// It can be a code or an image repository.
SourceConfiguration interface{} `json:"sourceConfiguration" yaml:"sourceConfiguration"`
// The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with the App Runner service.
//
// If not provided, App Runner associates the latest revision of a default auto scaling configuration.
AutoScalingConfigurationArn *string `json:"autoScalingConfigurationArn" yaml:"autoScalingConfigurationArn"`
// An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs.
//
// By default, App Runner uses an AWS managed key .
EncryptionConfiguration interface{} `json:"encryptionConfiguration" yaml:"encryptionConfiguration"`
// The settings for the health check that AWS App Runner performs to monitor the health of the App Runner service.
HealthCheckConfiguration interface{} `json:"healthCheckConfiguration" yaml:"healthCheckConfiguration"`
// The runtime configuration of instances (scaling units) of the App Runner service.
InstanceConfiguration interface{} `json:"instanceConfiguration" yaml:"instanceConfiguration"`
// Configuration settings related to network traffic of the web application that the App Runner service runs.
NetworkConfiguration interface{} `json:"networkConfiguration" yaml:"networkConfiguration"`
// A name for the App Runner service.
//
// It must be unique across all the running App Runner services in your AWS account in the AWS Region .
//
// If you don't specify a name, AWS CloudFormation generates a name for your Service.
ServiceName *string `json:"serviceName" yaml:"serviceName"`
// An optional list of metadata items that you can associate with the App Runner service resource.
//
// A tag is a key-value pair.
Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}
Properties for defining a `CfnService`.
TODO: EXAMPLE
type CfnService_AuthenticationConfigurationProperty ¶
type CfnService_AuthenticationConfigurationProperty struct {
// The Amazon Resource Name (ARN) of the IAM role that grants the App Runner service access to a source repository.
//
// It's required for ECR image repositories (but not for ECR Public repositories).
AccessRoleArn *string `json:"accessRoleArn" yaml:"accessRoleArn"`
// The Amazon Resource Name (ARN) of the App Runner connection that enables the App Runner service to connect to a source repository.
//
// It's required for GitHub code repositories.
ConnectionArn *string `json:"connectionArn" yaml:"connectionArn"`
}
Describes resources needed to authenticate access to some source repositories.
The specific resource depends on the repository provider.
TODO: EXAMPLE
type CfnService_CodeConfigurationProperty ¶
type CfnService_CodeConfigurationProperty struct {
// The source of the App Runner configuration. Values are interpreted as follows:.
//
// - `REPOSITORY` – App Runner reads configuration values from the `apprunner.yaml` file in the source code repository and ignores `CodeConfigurationValues` .
// - `API` – App Runner uses configuration values provided in `CodeConfigurationValues` and ignores the `apprunner.yaml` file in the source code repository.
ConfigurationSource *string `json:"configurationSource" yaml:"configurationSource"`
// The basic configuration for building and running the App Runner service.
//
// Use it to quickly launch an App Runner service without providing a `apprunner.yaml` file in the source code repository (or ignoring the file if it exists).
CodeConfigurationValues interface{} `json:"codeConfigurationValues" yaml:"codeConfigurationValues"`
}
Describes the configuration that AWS App Runner uses to build and run an App Runner service from a source code repository.
TODO: EXAMPLE
type CfnService_CodeConfigurationValuesProperty ¶
type CfnService_CodeConfigurationValuesProperty struct {
// A runtime environment type for building and running an App Runner service.
//
// It represents a programming language runtime.
Runtime *string `json:"runtime" yaml:"runtime"`
// The command App Runner runs to build your application.
BuildCommand *string `json:"buildCommand" yaml:"buildCommand"`
// The port that your application listens to in the container.
//
// Default: `8080`
Port *string `json:"port" yaml:"port"`
// The environment variables that are available to your running App Runner service.
//
// An array of key-value pairs. Keys with a prefix of `AWSAPPRUNNER` are reserved for system use and aren't valid.
RuntimeEnvironmentVariables interface{} `json:"runtimeEnvironmentVariables" yaml:"runtimeEnvironmentVariables"`
// The command App Runner runs to start your application.
StartCommand *string `json:"startCommand" yaml:"startCommand"`
}
Describes the basic configuration needed for building and running an AWS App Runner service.
This type doesn't support the full set of possible configuration options. Fur full configuration capabilities, use a `apprunner.yaml` file in the source code repository.
TODO: EXAMPLE
type CfnService_CodeRepositoryProperty ¶
type CfnService_CodeRepositoryProperty struct {
// The location of the repository that contains the source code.
RepositoryUrl *string `json:"repositoryUrl" yaml:"repositoryUrl"`
// The version that should be used within the source code repository.
SourceCodeVersion interface{} `json:"sourceCodeVersion" yaml:"sourceCodeVersion"`
// Configuration for building and running the service from a source code repository.
CodeConfiguration interface{} `json:"codeConfiguration" yaml:"codeConfiguration"`
}
Describes a source code repository.
TODO: EXAMPLE
type CfnService_EgressConfigurationProperty ¶
type CfnService_EgressConfigurationProperty struct {
// The type of egress configuration.
//
// Set to `DEFAULT` for access to resources hosted on public networks.
//
// Set to `VPC` to associate your service to a custom VPC specified by `VpcConnectorArn` .
EgressType *string `json:"egressType" yaml:"egressType"`
// The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to associate with your App Runner service.
//
// Only valid when `EgressType = VPC` .
VpcConnectorArn *string `json:"vpcConnectorArn" yaml:"vpcConnectorArn"`
}
Describes configuration settings related to outbound network traffic of an AWS App Runner service.
TODO: EXAMPLE
type CfnService_EncryptionConfigurationProperty ¶
type CfnService_EncryptionConfigurationProperty struct {
// The ARN of the KMS key that's used for encryption.
KmsKey *string `json:"kmsKey" yaml:"kmsKey"`
}
Describes a custom encryption key that AWS App Runner uses to encrypt copies of the source repository and service logs.
TODO: EXAMPLE
type CfnService_HealthCheckConfigurationProperty ¶
type CfnService_HealthCheckConfigurationProperty struct {
// The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
//
// Default: `1`
HealthyThreshold *float64 `json:"healthyThreshold" yaml:"healthyThreshold"`
// The time interval, in seconds, between health checks.
//
// Default: `5`
Interval *float64 `json:"interval" yaml:"interval"`
// The URL that health check requests are sent to.
//
// `Path` is only applicable when you set `Protocol` to `HTTP` .
//
// Default: `"/"`
Path *string `json:"path" yaml:"path"`
// The IP protocol that App Runner uses to perform health checks for your service.
//
// If you set `Protocol` to `HTTP` , App Runner sends health check requests to the HTTP path specified by `Path` .
//
// Default: `TCP`
Protocol *string `json:"protocol" yaml:"protocol"`
// The time, in seconds, to wait for a health check response before deciding it failed.
//
// Default: `2`
Timeout *float64 `json:"timeout" yaml:"timeout"`
// The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.
//
// Default: `5`
UnhealthyThreshold *float64 `json:"unhealthyThreshold" yaml:"unhealthyThreshold"`
}
Describes the settings for the health check that AWS App Runner performs to monitor the health of a service.
TODO: EXAMPLE
type CfnService_ImageConfigurationProperty ¶
type CfnService_ImageConfigurationProperty struct {
// The port that your application listens to in the container.
//
// Default: `8080`
Port *string `json:"port" yaml:"port"`
// Environment variables that are available to your running App Runner service.
//
// An array of key-value pairs. Keys with a prefix of `AWSAPPRUNNER` are reserved for system use and aren't valid.
RuntimeEnvironmentVariables interface{} `json:"runtimeEnvironmentVariables" yaml:"runtimeEnvironmentVariables"`
// An optional command that App Runner runs to start the application in the source image.
//
// If specified, this command overrides the Docker image’s default start command.
StartCommand *string `json:"startCommand" yaml:"startCommand"`
}
Describes the configuration that AWS App Runner uses to run an App Runner service using an image pulled from a source image repository.
TODO: EXAMPLE
type CfnService_ImageRepositoryProperty ¶
type CfnService_ImageRepositoryProperty struct {
// The identifier of an image.
//
// For an image in Amazon Elastic Container Registry (Amazon ECR), this is an image name. For the image name format, see [Pulling an image](https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-pull-ecr-image.html) in the *Amazon ECR User Guide* .
ImageIdentifier *string `json:"imageIdentifier" yaml:"imageIdentifier"`
// The type of the image repository.
//
// This reflects the repository provider and whether the repository is private or public.
ImageRepositoryType *string `json:"imageRepositoryType" yaml:"imageRepositoryType"`
// Configuration for running the identified image.
ImageConfiguration interface{} `json:"imageConfiguration" yaml:"imageConfiguration"`
}
Describes a source image repository.
TODO: EXAMPLE
type CfnService_InstanceConfigurationProperty ¶
type CfnService_InstanceConfigurationProperty struct {
// The number of CPU units reserved for each instance of your App Runner service.
//
// Default: `1 vCPU`
Cpu *string `json:"cpu" yaml:"cpu"`
// The Amazon Resource Name (ARN) of an IAM role that provides permissions to your App Runner service.
//
// These are permissions that your code needs when it calls any AWS APIs.
InstanceRoleArn *string `json:"instanceRoleArn" yaml:"instanceRoleArn"`
// The amount of memory, in MB or GB, reserved for each instance of your App Runner service.
//
// Default: `2 GB`
Memory *string `json:"memory" yaml:"memory"`
}
Describes the runtime configuration of an AWS App Runner service instance (scaling unit).
TODO: EXAMPLE
type CfnService_KeyValuePairProperty ¶
type CfnService_KeyValuePairProperty struct {
// The key name string to map to a value.
Name *string `json:"name" yaml:"name"`
// The value string to which the key name is mapped.
Value *string `json:"value" yaml:"value"`
}
Describes a key-value pair, which is a string-to-string mapping.
TODO: EXAMPLE
type CfnService_NetworkConfigurationProperty ¶
type CfnService_NetworkConfigurationProperty struct {
// Network configuration settings for outbound message traffic.
EgressConfiguration interface{} `json:"egressConfiguration" yaml:"egressConfiguration"`
}
Describes configuration settings related to network traffic of an AWS App Runner service.
Consists of embedded objects for each configurable network feature.
TODO: EXAMPLE
type CfnService_SourceCodeVersionProperty ¶
type CfnService_SourceCodeVersionProperty struct {
// The type of version identifier.
//
// For a git-based repository, branches represent versions.
Type *string `json:"type" yaml:"type"`
// A source code version.
//
// For a git-based repository, a branch name maps to a specific version. App Runner uses the most recent commit to the branch.
Value *string `json:"value" yaml:"value"`
}
Identifies a version of code that AWS App Runner refers to within a source code repository.
TODO: EXAMPLE
type CfnService_SourceConfigurationProperty ¶
type CfnService_SourceConfigurationProperty struct {
// Describes the resources that are needed to authenticate access to some source repositories.
AuthenticationConfiguration interface{} `json:"authenticationConfiguration" yaml:"authenticationConfiguration"`
// If `true` , continuous integration from the source repository is enabled for the App Runner service.
//
// Each repository change (including any source code commit or new image version) starts a deployment.
//
// Default: App Runner sets to `false` for a source image that uses an ECR Public repository or an ECR repository that's in an AWS account other than the one that the service is in. App Runner sets to `true` in all other cases (which currently include a source code repository or a source image using a same-account ECR repository).
AutoDeploymentsEnabled interface{} `json:"autoDeploymentsEnabled" yaml:"autoDeploymentsEnabled"`
// The description of a source code repository.
//
// You must provide either this member or `ImageRepository` (but not both).
CodeRepository interface{} `json:"codeRepository" yaml:"codeRepository"`
// The description of a source image repository.
//
// You must provide either this member or `CodeRepository` (but not both).
ImageRepository interface{} `json:"imageRepository" yaml:"imageRepository"`
}
Describes the source deployed to an AWS App Runner service.
It can be a code or an image repository.
TODO: EXAMPLE
type CfnVpcConnector ¶
type CfnVpcConnector interface {
awscdk.CfnResource
awscdk.IInspectable
AttrVpcConnectorArn() *string
AttrVpcConnectorRevision() *float64
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
LogicalId() *string
Node() awscdk.ConstructNode
Ref() *string
SecurityGroups() *[]*string
SetSecurityGroups(val *[]*string)
Stack() awscdk.Stack
Subnets() *[]*string
SetSubnets(val *[]*string)
Tags() awscdk.TagManager
UpdatedProperites() *map[string]interface{}
VpcConnectorName() *string
SetVpcConnectorName(val *string)
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OnPrepare()
OnSynthesize(session constructs.ISynthesisSession)
OnValidate() *[]*string
OverrideLogicalId(newLogicalId *string)
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
Synthesize(session awscdk.ISynthesisSession)
ToString() *string
Validate() *[]*string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::AppRunner::VpcConnector`.
Specify an AWS App Runner VPC connector by using the `AWS::AppRunner::VpcConnector` resource in an AWS CloudFormation template.
The `AWS::AppRunner::VpcConnector` resource is an AWS App Runner resource type that specifies an App Runner VPC connector.
App Runner requires this resource when you want to associate your App Runner service to a custom Amazon Virtual Private Cloud ( Amazon VPC ).
TODO: EXAMPLE
func NewCfnVpcConnector ¶
func NewCfnVpcConnector(scope awscdk.Construct, id *string, props *CfnVpcConnectorProps) CfnVpcConnector
Create a new `AWS::AppRunner::VpcConnector`.
type CfnVpcConnectorProps ¶
type CfnVpcConnectorProps struct {
// A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC.
//
// Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.
Subnets *[]*string `json:"subnets" yaml:"subnets"`
// A list of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets.
//
// If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.
SecurityGroups *[]*string `json:"securityGroups" yaml:"securityGroups"`
// A list of metadata items that you can associate with your VPC connector resource.
//
// A tag is a key-value pair.
Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
// A name for the VPC connector.
//
// If you don't specify a name, AWS CloudFormation generates a name for your VPC connector.
VpcConnectorName *string `json:"vpcConnectorName" yaml:"vpcConnectorName"`
}
Properties for defining a `CfnVpcConnector`.
TODO: EXAMPLE
type CodeConfiguration ¶
type CodeConfiguration struct {
// The source of the App Runner configuration.
// Experimental.
ConfigurationSource ConfigurationSourceType `json:"configurationSource" yaml:"configurationSource"`
// The basic configuration for building and running the App Runner service.
//
// Use it to quickly launch an App Runner service without providing a apprunner.yaml file in the
// source code repository (or ignoring the file if it exists).
// Experimental.
ConfigurationValues *CodeConfigurationValues `json:"configurationValues" yaml:"configurationValues"`
}
Describes the configuration that AWS App Runner uses to build and run an App Runner service from a source code repository.
TODO: EXAMPLE
Experimental.
type CodeConfigurationValues ¶
type CodeConfigurationValues struct {
// A runtime environment type for building and running an App Runner service.
//
// It represents
// a programming language runtime.
// Experimental.
Runtime Runtime `json:"runtime" yaml:"runtime"`
// The command App Runner runs to build your application.
// Experimental.
BuildCommand *string `json:"buildCommand" yaml:"buildCommand"`
// The environment variables that are available to your running App Runner service.
// Experimental.
Environment *map[string]*string `json:"environment" yaml:"environment"`
// The port that your application listens to in the container.
// Experimental.
Port *string `json:"port" yaml:"port"`
// The command App Runner runs to start your application.
// Experimental.
StartCommand *string `json:"startCommand" yaml:"startCommand"`
}
Describes the basic configuration needed for building and running an AWS App Runner service.
This type doesn't support the full set of possible configuration options. Fur full configuration capabilities, use a `apprunner.yaml` file in the source code repository.
TODO: EXAMPLE
Experimental.
type CodeRepositoryProps ¶
type CodeRepositoryProps struct {
// Configuration for building and running the service from a source code repository.
// Experimental.
CodeConfiguration *CodeConfiguration `json:"codeConfiguration" yaml:"codeConfiguration"`
// The App Runner connection for GitHub.
// Experimental.
Connection GitHubConnection `json:"connection" yaml:"connection"`
// The location of the repository that contains the source code.
// Experimental.
RepositoryUrl *string `json:"repositoryUrl" yaml:"repositoryUrl"`
// The version that should be used within the source code repository.
// Experimental.
SourceCodeVersion *SourceCodeVersion `json:"sourceCodeVersion" yaml:"sourceCodeVersion"`
}
Properties of the CodeRepository.
TODO: EXAMPLE
Experimental.
type ConfigurationSourceType ¶
type ConfigurationSourceType string
The source of the App Runner configuration.
TODO: EXAMPLE
Experimental.
const ( ConfigurationSourceType_REPOSITORY ConfigurationSourceType = "REPOSITORY" ConfigurationSourceType_API ConfigurationSourceType = "API" )
type Cpu ¶
type Cpu interface {
Unit() *string
}
The number of CPU units reserved for each instance of your App Runner service.
TODO: EXAMPLE
Experimental.
func Cpu_ONE_VCPU ¶
func Cpu_ONE_VCPU() Cpu
func Cpu_Of ¶
Custom CPU unit. See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-instanceconfiguration.html#cfn-apprunner-service-instanceconfiguration-cpu
Experimental.
func Cpu_TWO_VCPU ¶
func Cpu_TWO_VCPU() Cpu
type EcrProps ¶
type EcrProps struct {
// Represents the ECR repository.
// Experimental.
Repository awsecr.IRepository `json:"repository" yaml:"repository"`
// The image configuration for the image from ECR.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imageconfiguration.html#cfn-apprunner-service-imageconfiguration-port
//
// Experimental.
ImageConfiguration *ImageConfiguration `json:"imageConfiguration" yaml:"imageConfiguration"`
// Image tag.
// Experimental.
Tag *string `json:"tag" yaml:"tag"`
}
Properties of the image repository for `Source.fromEcr()`.
TODO: EXAMPLE
Experimental.
type EcrPublicProps ¶
type EcrPublicProps struct {
// The ECR Public image URI.
// Experimental.
ImageIdentifier *string `json:"imageIdentifier" yaml:"imageIdentifier"`
// The image configuration for the image from ECR Public.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imageconfiguration.html#cfn-apprunner-service-imageconfiguration-port
//
// Experimental.
ImageConfiguration *ImageConfiguration `json:"imageConfiguration" yaml:"imageConfiguration"`
}
Properties of the image repository for `Source.fromEcrPublic()`.
TODO: EXAMPLE
Experimental.
type EcrPublicSource ¶
type EcrPublicSource interface {
Source
Bind(_scope constructs.Construct) *SourceConfig
}
Represents the service source from ECR Public.
TODO: EXAMPLE
Experimental.
func AssetSource_FromEcrPublic ¶
func AssetSource_FromEcrPublic(props *EcrPublicProps) EcrPublicSource
Source from the ECR Public repository. Experimental.
func EcrPublicSource_FromEcrPublic ¶
func EcrPublicSource_FromEcrPublic(props *EcrPublicProps) EcrPublicSource
Source from the ECR Public repository. Experimental.
func EcrSource_FromEcrPublic ¶
func EcrSource_FromEcrPublic(props *EcrPublicProps) EcrPublicSource
Source from the ECR Public repository. Experimental.
func GithubSource_FromEcrPublic ¶
func GithubSource_FromEcrPublic(props *EcrPublicProps) EcrPublicSource
Source from the ECR Public repository. Experimental.
func NewEcrPublicSource ¶
func NewEcrPublicSource(props *EcrPublicProps) EcrPublicSource
Experimental.
func Source_FromEcrPublic ¶
func Source_FromEcrPublic(props *EcrPublicProps) EcrPublicSource
Source from the ECR Public repository. Experimental.
type EcrSource ¶
type EcrSource interface {
Source
Bind(_scope constructs.Construct) *SourceConfig
}
Represents the service source from ECR.
TODO: EXAMPLE
Experimental.
func AssetSource_FromEcr ¶
Source from the ECR repository. Experimental.
func EcrPublicSource_FromEcr ¶
Source from the ECR repository. Experimental.
func EcrSource_FromEcr ¶
Source from the ECR repository. Experimental.
func GithubSource_FromEcr ¶
Source from the ECR repository. Experimental.
func Source_FromEcr ¶
Source from the ECR repository. Experimental.
type GitHubConnection ¶
type GitHubConnection interface {
ConnectionArn() *string
}
Represents the App Runner connection that enables the App Runner service to connect to a source repository.
It's required for GitHub code repositories.
TODO: EXAMPLE
Experimental.
func GitHubConnection_FromConnectionArn ¶
func GitHubConnection_FromConnectionArn(arn *string) GitHubConnection
Using existing App Runner connection by specifying the connection ARN.
Returns: Connection Experimental.
type GithubRepositoryProps ¶
type GithubRepositoryProps struct {
// The source of the App Runner configuration.
// Experimental.
ConfigurationSource ConfigurationSourceType `json:"configurationSource" yaml:"configurationSource"`
// ARN of the connection to Github.
//
// Only required for Github source.
// Experimental.
Connection GitHubConnection `json:"connection" yaml:"connection"`
// The location of the repository that contains the source code.
// Experimental.
RepositoryUrl *string `json:"repositoryUrl" yaml:"repositoryUrl"`
// The branch name that represents a specific version for the repository.
// Experimental.
Branch *string `json:"branch" yaml:"branch"`
// The code configuration values.
//
// Will be ignored if configurationSource is `REPOSITORY`.
// Experimental.
CodeConfigurationValues *CodeConfigurationValues `json:"codeConfigurationValues" yaml:"codeConfigurationValues"`
}
Properties of the Github repository for `Source.fromGitHub()`.
TODO: EXAMPLE
Experimental.
type GithubSource ¶
type GithubSource interface {
Source
Bind(_scope constructs.Construct) *SourceConfig
}
Represents the service source from a Github repository.
TODO: EXAMPLE
Experimental.
func AssetSource_FromGitHub ¶
func AssetSource_FromGitHub(props *GithubRepositoryProps) GithubSource
Source from the GitHub repository. Experimental.
func EcrPublicSource_FromGitHub ¶
func EcrPublicSource_FromGitHub(props *GithubRepositoryProps) GithubSource
Source from the GitHub repository. Experimental.
func EcrSource_FromGitHub ¶
func EcrSource_FromGitHub(props *GithubRepositoryProps) GithubSource
Source from the GitHub repository. Experimental.
func GithubSource_FromGitHub ¶
func GithubSource_FromGitHub(props *GithubRepositoryProps) GithubSource
Source from the GitHub repository. Experimental.
func NewGithubSource ¶
func NewGithubSource(props *GithubRepositoryProps) GithubSource
Experimental.
func Source_FromGitHub ¶
func Source_FromGitHub(props *GithubRepositoryProps) GithubSource
Source from the GitHub repository. Experimental.
type IService ¶
type IService interface {
awscdk.IResource
// The ARN of the service.
// Experimental.
ServiceArn() *string
// The Name of the service.
// Experimental.
ServiceName() *string
}
Represents the App Runner Service. Experimental.
func Service_FromServiceAttributes ¶
func Service_FromServiceAttributes(scope constructs.Construct, id *string, attrs *ServiceAttributes) IService
Import from service attributes. Experimental.
func Service_FromServiceName ¶
func Service_FromServiceName(scope constructs.Construct, id *string, serviceName *string) IService
Import from service name. Experimental.
type ImageConfiguration ¶
type ImageConfiguration struct {
// Environment variables that are available to your running App Runner service.
// Experimental.
Environment *map[string]*string `json:"environment" yaml:"environment"`
// The port that your application listens to in the container.
// Experimental.
Port *float64 `json:"port" yaml:"port"`
// An optional command that App Runner runs to start the application in the source image.
//
// If specified, this command overrides the Docker image’s default start command.
// Experimental.
StartCommand *string `json:"startCommand" yaml:"startCommand"`
}
Describes the configuration that AWS App Runner uses to run an App Runner service using an image pulled from a source image repository.
TODO: EXAMPLE
Experimental.
type ImageRepository ¶
type ImageRepository struct {
// The identifier of the image.
//
// For `ECR_PUBLIC` imageRepositoryType, the identifier domain should
// always be `public.ecr.aws`. For `ECR`, the pattern should be
// `([0-9]{12}.dkr.ecr.[a-z\-]+-[0-9]{1}.amazonaws.com\/.*)`.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imagerepository.html for more details.
//
// Experimental.
ImageIdentifier *string `json:"imageIdentifier" yaml:"imageIdentifier"`
// The type of the image repository.
//
// This reflects the repository provider and whether
// the repository is private or public.
// Experimental.
ImageRepositoryType ImageRepositoryType `json:"imageRepositoryType" yaml:"imageRepositoryType"`
// Configuration for running the identified image.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imageconfiguration.html#cfn-apprunner-service-imageconfiguration-port
//
// Experimental.
ImageConfiguration *ImageConfiguration `json:"imageConfiguration" yaml:"imageConfiguration"`
}
Describes a source image repository.
TODO: EXAMPLE
Experimental.
type ImageRepositoryType ¶
type ImageRepositoryType string
The image repository types. Experimental.
const ( ImageRepositoryType_ECR_PUBLIC ImageRepositoryType = "ECR_PUBLIC" ImageRepositoryType_ECR ImageRepositoryType = "ECR" )
type Memory ¶
type Memory interface {
Unit() *string
}
The amount of memory reserved for each instance of your App Runner service.
TODO: EXAMPLE
Experimental.
func Memory_FOUR_GB ¶
func Memory_FOUR_GB() Memory
func Memory_Of ¶
Custom Memory unit. See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-instanceconfiguration.html#cfn-apprunner-service-instanceconfiguration-memory
Experimental.
func Memory_THREE_GB ¶
func Memory_THREE_GB() Memory
func Memory_TWO_GB ¶
func Memory_TWO_GB() Memory
type Runtime ¶
type Runtime interface {
Name() *string
}
The code runtimes.
TODO: EXAMPLE
Experimental.
func Runtime_NODEJS_12 ¶
func Runtime_NODEJS_12() Runtime
func Runtime_Of ¶
Other runtimes. See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfigurationvalues.html#cfn-apprunner-service-codeconfigurationvalues-runtime for all available runtimes.
Experimental.
func Runtime_PYTHON_3 ¶
func Runtime_PYTHON_3() Runtime
type Service ¶
type Service interface {
awscdk.Resource
Env() *awscdk.ResourceEnvironment
Node() awscdk.ConstructNode
PhysicalName() *string
ServiceArn() *string
ServiceId() *string
ServiceName() *string
ServiceStatus() *string
ServiceUrl() *string
Stack() awscdk.Stack
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
GetResourceNameAttribute(nameAttr *string) *string
OnPrepare()
OnSynthesize(session constructs.ISynthesisSession)
OnValidate() *[]*string
Prepare()
Synthesize(session awscdk.ISynthesisSession)
ToString() *string
Validate() *[]*string
}
The App Runner Service.
TODO: EXAMPLE
Experimental.
func NewService ¶
func NewService(scope constructs.Construct, id *string, props *ServiceProps) Service
Experimental.
type ServiceAttributes ¶
type ServiceAttributes struct {
// The ARN of the service.
// Experimental.
ServiceArn *string `json:"serviceArn" yaml:"serviceArn"`
// The name of the service.
// Experimental.
ServiceName *string `json:"serviceName" yaml:"serviceName"`
// The status of the service.
// Experimental.
ServiceStatus *string `json:"serviceStatus" yaml:"serviceStatus"`
// The URL of the service.
// Experimental.
ServiceUrl *string `json:"serviceUrl" yaml:"serviceUrl"`
}
Attributes for the App Runner Service.
TODO: EXAMPLE
Experimental.
type ServiceProps ¶
type ServiceProps struct {
// The source of the repository for the service.
// Experimental.
Source Source `json:"source" yaml:"source"`
// The IAM role that grants the App Runner service access to a source repository.
//
// It's required for ECR image repositories (but not for ECR Public repositories).
//
// The role must be assumable by the 'build.apprunner.amazonaws.com' service principal.
// See: https://docs.aws.amazon.com/apprunner/latest/dg/security_iam_service-with-iam.html#security_iam_service-with-iam-roles-service.access
//
// Experimental.
AccessRole awsiam.IRole `json:"accessRole" yaml:"accessRole"`
// The number of CPU units reserved for each instance of your App Runner service.
// Experimental.
Cpu Cpu `json:"cpu" yaml:"cpu"`
// The IAM role that provides permissions to your App Runner service.
//
// These are permissions that your code needs when it calls any AWS APIs.
//
// The role must be assumable by the 'tasks.apprunner.amazonaws.com' service principal.
// See: https://docs.aws.amazon.com/apprunner/latest/dg/security_iam_service-with-iam.html#security_iam_service-with-iam-roles-service.instance
//
// Experimental.
InstanceRole awsiam.IRole `json:"instanceRole" yaml:"instanceRole"`
// The amount of memory reserved for each instance of your App Runner service.
// Experimental.
Memory Memory `json:"memory" yaml:"memory"`
// Name of the service.
// Experimental.
ServiceName *string `json:"serviceName" yaml:"serviceName"`
}
Properties of the AppRunner Service.
TODO: EXAMPLE
Experimental.
type Source ¶
type Source interface {
Bind(scope constructs.Construct) *SourceConfig
}
Represents the App Runner service source.
TODO: EXAMPLE
Experimental.
type SourceCodeVersion ¶
type SourceCodeVersion struct {
// The type of version identifier.
// Experimental.
Type *string `json:"type" yaml:"type"`
// A source code version.
// Experimental.
Value *string `json:"value" yaml:"value"`
}
Identifies a version of code that AWS App Runner refers to within a source code repository.
TODO: EXAMPLE
Experimental.
type SourceConfig ¶
type SourceConfig struct {
// The code repository configuration (mutually exclusive with `imageRepository`).
// Experimental.
CodeRepository *CodeRepositoryProps `json:"codeRepository" yaml:"codeRepository"`
// The ECR repository (required to grant the pull privileges for the iam role).
// Experimental.
EcrRepository awsecr.IRepository `json:"ecrRepository" yaml:"ecrRepository"`
// The image repository configuration (mutually exclusive with `codeRepository`).
// Experimental.
ImageRepository *ImageRepository `json:"imageRepository" yaml:"imageRepository"`
}
Result of binding `Source` into a `Service`.
TODO: EXAMPLE
Experimental.