Class CfnServiceProps
Properties for defining a CfnService
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.AppRunner
Assembly: Amazon.CDK.AWS.AppRunner.dll
Syntax (csharp)
public class CfnServiceProps : Object, ICfnServiceProps
Syntax (vb)
Public Class CfnServiceProps
Inherits Object
Implements ICfnServiceProps
Remarks
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppRunner;
var cfnServiceProps = new CfnServiceProps {
SourceConfiguration = new SourceConfigurationProperty {
AuthenticationConfiguration = new AuthenticationConfigurationProperty {
AccessRoleArn = "accessRoleArn",
ConnectionArn = "connectionArn"
},
AutoDeploymentsEnabled = false,
CodeRepository = new CodeRepositoryProperty {
RepositoryUrl = "repositoryUrl",
SourceCodeVersion = new SourceCodeVersionProperty {
Type = "type",
Value = "value"
},
// the properties below are optional
CodeConfiguration = new CodeConfigurationProperty {
ConfigurationSource = "configurationSource",
// the properties below are optional
CodeConfigurationValues = new CodeConfigurationValuesProperty {
Runtime = "runtime",
// the properties below are optional
BuildCommand = "buildCommand",
Port = "port",
RuntimeEnvironmentSecrets = new [] { new KeyValuePairProperty {
Name = "name",
Value = "value"
} },
RuntimeEnvironmentVariables = new [] { new KeyValuePairProperty {
Name = "name",
Value = "value"
} },
StartCommand = "startCommand"
}
}
},
ImageRepository = new ImageRepositoryProperty {
ImageIdentifier = "imageIdentifier",
ImageRepositoryType = "imageRepositoryType",
// the properties below are optional
ImageConfiguration = new ImageConfigurationProperty {
Port = "port",
RuntimeEnvironmentSecrets = new [] { new KeyValuePairProperty {
Name = "name",
Value = "value"
} },
RuntimeEnvironmentVariables = new [] { new KeyValuePairProperty {
Name = "name",
Value = "value"
} },
StartCommand = "startCommand"
}
}
},
// the properties below are optional
AutoScalingConfigurationArn = "autoScalingConfigurationArn",
EncryptionConfiguration = new EncryptionConfigurationProperty {
KmsKey = "kmsKey"
},
HealthCheckConfiguration = new HealthCheckConfigurationProperty {
HealthyThreshold = 123,
Interval = 123,
Path = "path",
Protocol = "protocol",
Timeout = 123,
UnhealthyThreshold = 123
},
InstanceConfiguration = new InstanceConfigurationProperty {
Cpu = "cpu",
InstanceRoleArn = "instanceRoleArn",
Memory = "memory"
},
NetworkConfiguration = new NetworkConfigurationProperty {
EgressConfiguration = new EgressConfigurationProperty {
EgressType = "egressType",
// the properties below are optional
VpcConnectorArn = "vpcConnectorArn"
},
IngressConfiguration = new IngressConfigurationProperty {
IsPubliclyAccessible = false
}
},
ObservabilityConfiguration = new ServiceObservabilityConfigurationProperty {
ObservabilityEnabled = false,
// the properties below are optional
ObservabilityConfigurationArn = "observabilityConfigurationArn"
},
ServiceName = "serviceName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
Synopsis
Constructors
CfnServiceProps() |
Properties
AutoScalingConfigurationArn | The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service. |
EncryptionConfiguration | An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs. |
HealthCheckConfiguration | The settings for the health check that AWS App Runner performs to monitor the health of the App Runner service. |
InstanceConfiguration | The runtime configuration of instances (scaling units) of your service. |
NetworkConfiguration | Configuration settings related to network traffic of the web application that the App Runner service runs. |
ObservabilityConfiguration | The observability configuration of your service. |
ServiceName | A name for the App Runner service. |
SourceConfiguration | The source to deploy to the App Runner service. |
Tags | An optional list of metadata items that you can associate with the App Runner service resource. |
Constructors
CfnServiceProps()
public CfnServiceProps()
Properties
AutoScalingConfigurationArn
The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service.
public string AutoScalingConfigurationArn { get; set; }
Property Value
System.String
Remarks
If not provided, App Runner associates the latest revision of a default auto scaling configuration.
Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3
Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability
EncryptionConfiguration
An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs.
public object EncryptionConfiguration { get; set; }
Property Value
System.Object
Remarks
By default, App Runner uses an AWS managed key .
HealthCheckConfiguration
The settings for the health check that AWS App Runner performs to monitor the health of the App Runner service.
public object HealthCheckConfiguration { get; set; }
Property Value
System.Object
Remarks
InstanceConfiguration
The runtime configuration of instances (scaling units) of your service.
public object InstanceConfiguration { get; set; }
Property Value
System.Object
Remarks
NetworkConfiguration
Configuration settings related to network traffic of the web application that the App Runner service runs.
public object NetworkConfiguration { get; set; }
Property Value
System.Object
Remarks
ObservabilityConfiguration
The observability configuration of your service.
public object ObservabilityConfiguration { get; set; }
Property Value
System.Object
Remarks
ServiceName
A name for the App Runner service.
public string ServiceName { get; set; }
Property Value
System.String
Remarks
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.
SourceConfiguration
The source to deploy to the App Runner service.
public object SourceConfiguration { get; set; }
Property Value
System.Object
Remarks
It can be a code or an image repository.
Tags
An optional list of metadata items that you can associate with the App Runner service resource.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
A tag is a key-value pair.