Documentation ¶
Index ¶
- func AsgCapacityProvider_IsConstruct(x interface{}) *bool
- func BaseService_IsConstruct(x interface{}) *bool
- func BaseService_IsResource(construct constructs.IConstruct) *bool
- func BuiltInAttributes_AMI_ID() *string
- func BuiltInAttributes_AVAILABILITY_ZONE() *string
- func BuiltInAttributes_INSTANCE_ID() *string
- func BuiltInAttributes_INSTANCE_TYPE() *string
- func BuiltInAttributes_OS_TYPE() *string
- func CfnCapacityProvider_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCapacityProvider_IsCfnElement(x interface{}) *bool
- func CfnCapacityProvider_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnCapacityProvider_IsConstruct(x interface{}) *bool
- func CfnClusterCapacityProviderAssociations_CFN_RESOURCE_TYPE_NAME() *string
- func CfnClusterCapacityProviderAssociations_IsCfnElement(x interface{}) *bool
- func CfnClusterCapacityProviderAssociations_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnClusterCapacityProviderAssociations_IsConstruct(x interface{}) *bool
- func CfnCluster_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCluster_IsCfnElement(x interface{}) *bool
- func CfnCluster_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnCluster_IsConstruct(x interface{}) *bool
- func CfnPrimaryTaskSet_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPrimaryTaskSet_IsCfnElement(x interface{}) *bool
- func CfnPrimaryTaskSet_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnPrimaryTaskSet_IsConstruct(x interface{}) *bool
- 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 CfnTaskDefinition_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTaskDefinition_IsCfnElement(x interface{}) *bool
- func CfnTaskDefinition_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnTaskDefinition_IsConstruct(x interface{}) *bool
- func CfnTaskSet_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTaskSet_IsCfnElement(x interface{}) *bool
- func CfnTaskSet_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnTaskSet_IsConstruct(x interface{}) *bool
- func Cluster_IsConstruct(x interface{}) *bool
- func Cluster_IsResource(construct constructs.IConstruct) *bool
- func ContainerDefinition_IsConstruct(x interface{}) *bool
- func Ec2Service_IsConstruct(x interface{}) *bool
- func Ec2Service_IsResource(construct constructs.IConstruct) *bool
- func Ec2TaskDefinition_IsConstruct(x interface{}) *bool
- func Ec2TaskDefinition_IsResource(construct constructs.IConstruct) *bool
- func ExternalService_IsConstruct(x interface{}) *bool
- func ExternalService_IsResource(construct constructs.IConstruct) *bool
- func ExternalTaskDefinition_IsConstruct(x interface{}) *bool
- func ExternalTaskDefinition_IsResource(construct constructs.IConstruct) *bool
- func FargateService_IsConstruct(x interface{}) *bool
- func FargateService_IsResource(construct constructs.IConstruct) *bool
- func FargateTaskDefinition_IsConstruct(x interface{}) *bool
- func FargateTaskDefinition_IsResource(construct constructs.IConstruct) *bool
- func FirelensLogRouter_IsConstruct(x interface{}) *bool
- func LinuxParameters_IsConstruct(x interface{}) *bool
- func NewAppMeshProxyConfiguration_Override(a AppMeshProxyConfiguration, props *AppMeshProxyConfigurationConfigProps)
- func NewAsgCapacityProvider_Override(a AsgCapacityProvider, scope constructs.Construct, id *string, ...)
- func NewAssetEnvironmentFile_Override(a AssetEnvironmentFile, path *string, options *awss3assets.AssetOptions)
- func NewAssetImage_Override(a AssetImage, directory *string, props *AssetImageProps)
- func NewAwsLogDriver_Override(a AwsLogDriver, props *AwsLogDriverProps)
- func NewBaseService_Override(b BaseService, scope constructs.Construct, id *string, props *BaseServiceProps, ...)
- func NewBottleRocketImage_Override(b BottleRocketImage, props *BottleRocketImageProps)
- func NewBuiltInAttributes_Override(b BuiltInAttributes)
- func NewCfnCapacityProvider_Override(c CfnCapacityProvider, scope constructs.Construct, id *string, ...)
- func NewCfnClusterCapacityProviderAssociations_Override(c CfnClusterCapacityProviderAssociations, scope constructs.Construct, ...)
- func NewCfnCluster_Override(c CfnCluster, scope constructs.Construct, id *string, props *CfnClusterProps)
- func NewCfnPrimaryTaskSet_Override(c CfnPrimaryTaskSet, scope constructs.Construct, id *string, ...)
- func NewCfnService_Override(c CfnService, scope constructs.Construct, id *string, props *CfnServiceProps)
- func NewCfnTaskDefinition_Override(c CfnTaskDefinition, scope constructs.Construct, id *string, ...)
- func NewCfnTaskSet_Override(c CfnTaskSet, scope constructs.Construct, id *string, props *CfnTaskSetProps)
- func NewCluster_Override(c Cluster, scope constructs.Construct, id *string, props *ClusterProps)
- func NewContainerDefinition_Override(c ContainerDefinition, scope constructs.Construct, id *string, ...)
- func NewContainerImage_Override(c ContainerImage)
- func NewEc2Service_Override(e Ec2Service, scope constructs.Construct, id *string, props *Ec2ServiceProps)
- func NewEc2TaskDefinition_Override(e Ec2TaskDefinition, scope constructs.Construct, id *string, ...)
- func NewEcrImage_Override(e EcrImage, repository awsecr.IRepository, tagOrDigest *string)
- func NewEcsOptimizedAmi_Override(e EcsOptimizedAmi, props *EcsOptimizedAmiProps)
- func NewEnvironmentFile_Override(e EnvironmentFile)
- func NewExternalService_Override(e ExternalService, scope constructs.Construct, id *string, ...)
- func NewExternalTaskDefinition_Override(e ExternalTaskDefinition, scope constructs.Construct, id *string, ...)
- func NewFargateService_Override(f FargateService, scope constructs.Construct, id *string, ...)
- func NewFargateTaskDefinition_Override(f FargateTaskDefinition, scope constructs.Construct, id *string, ...)
- func NewFireLensLogDriver_Override(f FireLensLogDriver, props *FireLensLogDriverProps)
- func NewFirelensLogRouter_Override(f FirelensLogRouter, scope constructs.Construct, id *string, ...)
- func NewFluentdLogDriver_Override(f FluentdLogDriver, props *FluentdLogDriverProps)
- func NewGelfLogDriver_Override(g GelfLogDriver, props *GelfLogDriverProps)
- func NewGenericLogDriver_Override(g GenericLogDriver, props *GenericLogDriverProps)
- func NewJournaldLogDriver_Override(j JournaldLogDriver, props *JournaldLogDriverProps)
- func NewJsonFileLogDriver_Override(j JsonFileLogDriver, props *JsonFileLogDriverProps)
- func NewLinuxParameters_Override(l LinuxParameters, scope constructs.Construct, id *string, ...)
- func NewListenerConfig_Override(l ListenerConfig)
- func NewLogDriver_Override(l LogDriver)
- func NewLogDrivers_Override(l LogDrivers)
- func NewProxyConfiguration_Override(p ProxyConfiguration)
- func NewProxyConfigurations_Override(p ProxyConfigurations)
- func NewRepositoryImage_Override(r RepositoryImage, imageName *string, props *RepositoryImageProps)
- func NewS3EnvironmentFile_Override(s S3EnvironmentFile, bucket awss3.IBucket, key *string, objectVersion *string)
- func NewScalableTaskCount_Override(s ScalableTaskCount, scope constructs.Construct, id *string, ...)
- func NewSecret_Override(s Secret)
- func NewSplunkLogDriver_Override(s SplunkLogDriver, props *SplunkLogDriverProps)
- func NewSyslogLogDriver_Override(s SyslogLogDriver, props *SyslogLogDriverProps)
- func NewTagParameterContainerImage_Override(t TagParameterContainerImage, repository awsecr.IRepository)
- func NewTaskDefinition_Override(t TaskDefinition, scope constructs.Construct, id *string, ...)
- func ScalableTaskCount_IsConstruct(x interface{}) *bool
- func TaskDefinition_IsConstruct(x interface{}) *bool
- func TaskDefinition_IsResource(construct constructs.IConstruct) *bool
- type AddAutoScalingGroupCapacityOptions
- type AddCapacityOptions
- type AmiHardwareType
- type AppMeshProxyConfiguration
- type AppMeshProxyConfigurationConfigProps
- type AppMeshProxyConfigurationProps
- type AsgCapacityProvider
- type AsgCapacityProviderProps
- type AssetEnvironmentFile
- func AssetEnvironmentFile_FromAsset(path *string, options *awss3assets.AssetOptions) AssetEnvironmentFile
- func EnvironmentFile_FromAsset(path *string, options *awss3assets.AssetOptions) AssetEnvironmentFile
- func NewAssetEnvironmentFile(path *string, options *awss3assets.AssetOptions) AssetEnvironmentFile
- func S3EnvironmentFile_FromAsset(path *string, options *awss3assets.AssetOptions) AssetEnvironmentFile
- type AssetImage
- func AssetImage_FromAsset(directory *string, props *AssetImageProps) AssetImage
- func ContainerImage_FromAsset(directory *string, props *AssetImageProps) AssetImage
- func EcrImage_FromAsset(directory *string, props *AssetImageProps) AssetImage
- func NewAssetImage(directory *string, props *AssetImageProps) AssetImage
- func RepositoryImage_FromAsset(directory *string, props *AssetImageProps) AssetImage
- func TagParameterContainerImage_FromAsset(directory *string, props *AssetImageProps) AssetImage
- type AssetImageProps
- type AssociateCloudMapServiceOptions
- type AuthorizationConfig
- type AwsLogDriver
- type AwsLogDriverMode
- type AwsLogDriverProps
- type BaseLogDriverProps
- type BaseService
- type BaseServiceOptions
- type BaseServiceProps
- type BinPackResource
- type BottleRocketImage
- type BottleRocketImageProps
- type BottlerocketEcsVariant
- type BuiltInAttributes
- type Capability
- type CapacityProviderStrategy
- type CfnCapacityProvider
- type CfnCapacityProviderProps
- type CfnCapacityProvider_AutoScalingGroupProviderProperty
- type CfnCapacityProvider_ManagedScalingProperty
- type CfnCluster
- type CfnClusterCapacityProviderAssociations
- type CfnClusterCapacityProviderAssociationsProps
- type CfnClusterCapacityProviderAssociations_CapacityProviderStrategyProperty
- type CfnClusterProps
- type CfnCluster_CapacityProviderStrategyItemProperty
- type CfnCluster_ClusterConfigurationProperty
- type CfnCluster_ClusterSettingsProperty
- type CfnCluster_ExecuteCommandConfigurationProperty
- type CfnCluster_ExecuteCommandLogConfigurationProperty
- type CfnPrimaryTaskSet
- type CfnPrimaryTaskSetProps
- type CfnService
- type CfnServiceProps
- type CfnService_AwsVpcConfigurationProperty
- type CfnService_CapacityProviderStrategyItemProperty
- type CfnService_DeploymentCircuitBreakerProperty
- type CfnService_DeploymentConfigurationProperty
- type CfnService_DeploymentControllerProperty
- type CfnService_LoadBalancerProperty
- type CfnService_NetworkConfigurationProperty
- type CfnService_PlacementConstraintProperty
- type CfnService_PlacementStrategyProperty
- type CfnService_ServiceRegistryProperty
- type CfnTaskDefinition
- type CfnTaskDefinitionProps
- type CfnTaskDefinition_AuthorizationConfigProperty
- type CfnTaskDefinition_ContainerDefinitionProperty
- type CfnTaskDefinition_ContainerDependencyProperty
- type CfnTaskDefinition_DeviceProperty
- type CfnTaskDefinition_DockerVolumeConfigurationProperty
- type CfnTaskDefinition_EfsVolumeConfigurationProperty
- type CfnTaskDefinition_EnvironmentFileProperty
- type CfnTaskDefinition_EphemeralStorageProperty
- type CfnTaskDefinition_FirelensConfigurationProperty
- type CfnTaskDefinition_HealthCheckProperty
- type CfnTaskDefinition_HostEntryProperty
- type CfnTaskDefinition_HostVolumePropertiesProperty
- type CfnTaskDefinition_InferenceAcceleratorProperty
- type CfnTaskDefinition_KernelCapabilitiesProperty
- type CfnTaskDefinition_KeyValuePairProperty
- type CfnTaskDefinition_LinuxParametersProperty
- type CfnTaskDefinition_LogConfigurationProperty
- type CfnTaskDefinition_MountPointProperty
- type CfnTaskDefinition_PortMappingProperty
- type CfnTaskDefinition_ProxyConfigurationProperty
- type CfnTaskDefinition_RepositoryCredentialsProperty
- type CfnTaskDefinition_ResourceRequirementProperty
- type CfnTaskDefinition_RuntimePlatformProperty
- type CfnTaskDefinition_SecretProperty
- type CfnTaskDefinition_SystemControlProperty
- type CfnTaskDefinition_TaskDefinitionPlacementConstraintProperty
- type CfnTaskDefinition_TmpfsProperty
- type CfnTaskDefinition_UlimitProperty
- type CfnTaskDefinition_VolumeFromProperty
- type CfnTaskDefinition_VolumeProperty
- type CfnTaskSet
- type CfnTaskSetProps
- type CfnTaskSet_AwsVpcConfigurationProperty
- type CfnTaskSet_LoadBalancerProperty
- type CfnTaskSet_NetworkConfigurationProperty
- type CfnTaskSet_ScaleProperty
- type CfnTaskSet_ServiceRegistryProperty
- type CloudMapNamespaceOptions
- type CloudMapOptions
- type Cluster
- type ClusterAttributes
- type ClusterProps
- type CommonTaskDefinitionAttributes
- type CommonTaskDefinitionProps
- type Compatibility
- type ContainerDefinition
- type ContainerDefinitionOptions
- type ContainerDefinitionProps
- type ContainerDependency
- type ContainerDependencyCondition
- type ContainerImage
- func AssetImage_FromDockerImageAsset(asset awsecrassets.DockerImageAsset) ContainerImage
- func AssetImage_FromTarball(tarballFile *string) ContainerImage
- func ContainerImage_FromDockerImageAsset(asset awsecrassets.DockerImageAsset) ContainerImage
- func ContainerImage_FromTarball(tarballFile *string) ContainerImage
- func EcrImage_FromDockerImageAsset(asset awsecrassets.DockerImageAsset) ContainerImage
- func EcrImage_FromTarball(tarballFile *string) ContainerImage
- func RepositoryImage_FromDockerImageAsset(asset awsecrassets.DockerImageAsset) ContainerImage
- func RepositoryImage_FromTarball(tarballFile *string) ContainerImage
- func TagParameterContainerImage_FromDockerImageAsset(asset awsecrassets.DockerImageAsset) ContainerImage
- func TagParameterContainerImage_FromTarball(tarballFile *string) ContainerImage
- type ContainerImageConfig
- type CpuUtilizationScalingProps
- type DeploymentCircuitBreaker
- type DeploymentController
- type DeploymentControllerType
- type Device
- type DevicePermission
- type DockerVolumeConfiguration
- type Ec2Service
- type Ec2ServiceAttributes
- type Ec2ServiceProps
- type Ec2TaskDefinition
- type Ec2TaskDefinitionAttributes
- type Ec2TaskDefinitionProps
- type EcrImage
- func AssetImage_FromEcrRepository(repository awsecr.IRepository, tag *string) EcrImage
- func ContainerImage_FromEcrRepository(repository awsecr.IRepository, tag *string) EcrImage
- func EcrImage_FromEcrRepository(repository awsecr.IRepository, tag *string) EcrImage
- func NewEcrImage(repository awsecr.IRepository, tagOrDigest *string) EcrImage
- func RepositoryImage_FromEcrRepository(repository awsecr.IRepository, tag *string) EcrImage
- func TagParameterContainerImage_FromEcrRepository(repository awsecr.IRepository, tag *string) EcrImage
- type EcsOptimizedAmideprecated
- type EcsOptimizedAmiPropsdeprecated
- type EcsOptimizedImage
- func EcsOptimizedImage_AmazonLinux(options *EcsOptimizedImageOptions) EcsOptimizedImage
- func EcsOptimizedImage_AmazonLinux2(hardwareType AmiHardwareType, options *EcsOptimizedImageOptions) EcsOptimizedImage
- func EcsOptimizedImage_Windows(windowsVersion WindowsOptimizedVersion, options *EcsOptimizedImageOptions) EcsOptimizedImage
- type EcsOptimizedImageOptions
- type EcsTarget
- type EfsVolumeConfiguration
- type EnvironmentFile
- type EnvironmentFileConfig
- type EnvironmentFileType
- type ExecuteCommandConfiguration
- type ExecuteCommandLogConfiguration
- type ExecuteCommandLogging
- type ExternalService
- type ExternalServiceAttributes
- type ExternalServiceProps
- type ExternalTaskDefinition
- type ExternalTaskDefinitionAttributes
- type ExternalTaskDefinitionProps
- type FargatePlatformVersion
- type FargateService
- type FargateServiceAttributes
- type FargateServiceProps
- type FargateTaskDefinition
- type FargateTaskDefinitionAttributes
- type FargateTaskDefinitionProps
- type FireLensLogDriver
- type FireLensLogDriverProps
- type FirelensConfig
- type FirelensConfigFileType
- type FirelensLogRouter
- type FirelensLogRouterDefinitionOptions
- type FirelensLogRouterProps
- type FirelensLogRouterType
- type FirelensOptions
- type FluentdLogDriver
- type FluentdLogDriverProps
- type GelfCompressionType
- type GelfLogDriver
- type GelfLogDriverProps
- type GenericLogDriver
- type GenericLogDriverProps
- type HealthCheck
- type Host
- type IBaseService
- func Ec2Service_FromEc2ServiceAttributes(scope constructs.Construct, id *string, attrs *Ec2ServiceAttributes) IBaseService
- func ExternalService_FromExternalServiceAttributes(scope constructs.Construct, id *string, attrs *ExternalServiceAttributes) IBaseService
- func FargateService_FromFargateServiceAttributes(scope constructs.Construct, id *string, attrs *FargateServiceAttributes) IBaseService
- type ICluster
- type IEc2Service
- type IEc2TaskDefinition
- type IEcsLoadBalancerTarget
- type IExternalService
- type IExternalTaskDefinition
- type IFargateService
- type IFargateTaskDefinition
- func FargateTaskDefinition_FromFargateTaskDefinitionArn(scope constructs.Construct, id *string, fargateTaskDefinitionArn *string) IFargateTaskDefinition
- func FargateTaskDefinition_FromFargateTaskDefinitionAttributes(scope constructs.Construct, id *string, attrs *FargateTaskDefinitionAttributes) IFargateTaskDefinition
- type IService
- type ITaskDefinition
- func Ec2TaskDefinition_FromTaskDefinitionArn(scope constructs.Construct, id *string, taskDefinitionArn *string) ITaskDefinition
- func Ec2TaskDefinition_FromTaskDefinitionAttributes(scope constructs.Construct, id *string, attrs *TaskDefinitionAttributes) ITaskDefinition
- func ExternalTaskDefinition_FromTaskDefinitionArn(scope constructs.Construct, id *string, taskDefinitionArn *string) ITaskDefinition
- func ExternalTaskDefinition_FromTaskDefinitionAttributes(scope constructs.Construct, id *string, attrs *TaskDefinitionAttributes) ITaskDefinition
- func FargateTaskDefinition_FromTaskDefinitionArn(scope constructs.Construct, id *string, taskDefinitionArn *string) ITaskDefinition
- func FargateTaskDefinition_FromTaskDefinitionAttributes(scope constructs.Construct, id *string, attrs *TaskDefinitionAttributes) ITaskDefinition
- func TaskDefinition_FromTaskDefinitionArn(scope constructs.Construct, id *string, taskDefinitionArn *string) ITaskDefinition
- func TaskDefinition_FromTaskDefinitionAttributes(scope constructs.Construct, id *string, attrs *TaskDefinitionAttributes) ITaskDefinition
- type ITaskDefinitionExtension
- type InferenceAccelerator
- type IpcMode
- type JournaldLogDriver
- type JournaldLogDriverProps
- type JsonFileLogDriver
- type JsonFileLogDriverProps
- type LaunchType
- type LinuxParameters
- type LinuxParametersProps
- type ListenerConfig
- type LoadBalancerTargetOptions
- type LogDriver
- func AwsLogDriver_AwsLogs(props *AwsLogDriverProps) LogDriver
- func FireLensLogDriver_AwsLogs(props *AwsLogDriverProps) LogDriver
- func FluentdLogDriver_AwsLogs(props *AwsLogDriverProps) LogDriver
- func GelfLogDriver_AwsLogs(props *AwsLogDriverProps) LogDriver
- func GenericLogDriver_AwsLogs(props *AwsLogDriverProps) LogDriver
- func JournaldLogDriver_AwsLogs(props *AwsLogDriverProps) LogDriver
- func JsonFileLogDriver_AwsLogs(props *AwsLogDriverProps) LogDriver
- func LogDriver_AwsLogs(props *AwsLogDriverProps) LogDriver
- func LogDrivers_AwsLogs(props *AwsLogDriverProps) LogDriver
- func LogDrivers_Firelens(props *FireLensLogDriverProps) LogDriver
- func LogDrivers_Fluentd(props *FluentdLogDriverProps) LogDriver
- func LogDrivers_Gelf(props *GelfLogDriverProps) LogDriver
- func LogDrivers_Journald(props *JournaldLogDriverProps) LogDriver
- func LogDrivers_JsonFile(props *JsonFileLogDriverProps) LogDriver
- func LogDrivers_Splunk(props *SplunkLogDriverProps) LogDriver
- func LogDrivers_Syslog(props *SyslogLogDriverProps) LogDriver
- func SplunkLogDriver_AwsLogs(props *AwsLogDriverProps) LogDriver
- func SyslogLogDriver_AwsLogs(props *AwsLogDriverProps) LogDriver
- type LogDriverConfig
- type LogDrivers
- type MachineImageType
- type MemoryUtilizationScalingProps
- type MountPoint
- type NetworkMode
- type PidMode
- type PlacementConstraint
- type PlacementStrategy
- func PlacementStrategy_PackedBy(resource BinPackResource) PlacementStrategy
- func PlacementStrategy_PackedByCpu() PlacementStrategy
- func PlacementStrategy_PackedByMemory() PlacementStrategy
- func PlacementStrategy_Randomly() PlacementStrategy
- func PlacementStrategy_SpreadAcross(fields ...*string) PlacementStrategy
- func PlacementStrategy_SpreadAcrossInstances() PlacementStrategy
- type PortMapping
- type PropagatedTagSource
- type Protocol
- type ProxyConfiguration
- type ProxyConfigurations
- type RepositoryImage
- func AssetImage_FromRegistry(name *string, props *RepositoryImageProps) RepositoryImage
- func ContainerImage_FromRegistry(name *string, props *RepositoryImageProps) RepositoryImage
- func EcrImage_FromRegistry(name *string, props *RepositoryImageProps) RepositoryImage
- func NewRepositoryImage(imageName *string, props *RepositoryImageProps) RepositoryImage
- func RepositoryImage_FromRegistry(name *string, props *RepositoryImageProps) RepositoryImage
- func TagParameterContainerImage_FromRegistry(name *string, props *RepositoryImageProps) RepositoryImage
- type RepositoryImageProps
- type RequestCountScalingProps
- type S3EnvironmentFile
- func AssetEnvironmentFile_FromBucket(bucket awss3.IBucket, key *string, objectVersion *string) S3EnvironmentFile
- func EnvironmentFile_FromBucket(bucket awss3.IBucket, key *string, objectVersion *string) S3EnvironmentFile
- func NewS3EnvironmentFile(bucket awss3.IBucket, key *string, objectVersion *string) S3EnvironmentFile
- func S3EnvironmentFile_FromBucket(bucket awss3.IBucket, key *string, objectVersion *string) S3EnvironmentFile
- type ScalableTaskCount
- type ScalableTaskCountProps
- type Scope
- type ScratchSpace
- type Secret
- type SplunkLogDriver
- type SplunkLogDriverProps
- type SplunkLogFormat
- type SyslogLogDriver
- type SyslogLogDriverProps
- type SystemControl
- type TagParameterContainerImage
- type TaskDefinition
- type TaskDefinitionAttributes
- type TaskDefinitionProps
- type Tmpfs
- type TmpfsMountOption
- type TrackCustomMetricProps
- type Ulimit
- type UlimitName
- type Volume
- type VolumeFrom
- type WindowsOptimizedVersion
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AsgCapacityProvider_IsConstruct ¶
func AsgCapacityProvider_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func BaseService_IsConstruct ¶
func BaseService_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func BaseService_IsResource ¶
func BaseService_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource. Experimental.
func BuiltInAttributes_AMI_ID ¶
func BuiltInAttributes_AMI_ID() *string
func BuiltInAttributes_AVAILABILITY_ZONE ¶
func BuiltInAttributes_AVAILABILITY_ZONE() *string
func BuiltInAttributes_INSTANCE_ID ¶
func BuiltInAttributes_INSTANCE_ID() *string
func BuiltInAttributes_INSTANCE_TYPE ¶
func BuiltInAttributes_INSTANCE_TYPE() *string
func BuiltInAttributes_OS_TYPE ¶
func BuiltInAttributes_OS_TYPE() *string
func CfnCapacityProvider_CFN_RESOURCE_TYPE_NAME ¶
func CfnCapacityProvider_CFN_RESOURCE_TYPE_NAME() *string
func CfnCapacityProvider_IsCfnElement ¶
func CfnCapacityProvider_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 CfnCapacityProvider_IsCfnResource ¶
func CfnCapacityProvider_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnCapacityProvider_IsConstruct ¶
func CfnCapacityProvider_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnClusterCapacityProviderAssociations_CFN_RESOURCE_TYPE_NAME ¶
func CfnClusterCapacityProviderAssociations_CFN_RESOURCE_TYPE_NAME() *string
func CfnClusterCapacityProviderAssociations_IsCfnElement ¶
func CfnClusterCapacityProviderAssociations_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 CfnClusterCapacityProviderAssociations_IsCfnResource ¶
func CfnClusterCapacityProviderAssociations_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnClusterCapacityProviderAssociations_IsConstruct ¶
func CfnClusterCapacityProviderAssociations_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnCluster_CFN_RESOURCE_TYPE_NAME ¶
func CfnCluster_CFN_RESOURCE_TYPE_NAME() *string
func CfnCluster_IsCfnElement ¶
func CfnCluster_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 CfnCluster_IsCfnResource ¶
func CfnCluster_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnCluster_IsConstruct ¶
func CfnCluster_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnPrimaryTaskSet_CFN_RESOURCE_TYPE_NAME ¶
func CfnPrimaryTaskSet_CFN_RESOURCE_TYPE_NAME() *string
func CfnPrimaryTaskSet_IsCfnElement ¶
func CfnPrimaryTaskSet_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 CfnPrimaryTaskSet_IsCfnResource ¶
func CfnPrimaryTaskSet_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnPrimaryTaskSet_IsConstruct ¶
func CfnPrimaryTaskSet_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
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
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnTaskDefinition_CFN_RESOURCE_TYPE_NAME ¶
func CfnTaskDefinition_CFN_RESOURCE_TYPE_NAME() *string
func CfnTaskDefinition_IsCfnElement ¶
func CfnTaskDefinition_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 CfnTaskDefinition_IsCfnResource ¶
func CfnTaskDefinition_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnTaskDefinition_IsConstruct ¶
func CfnTaskDefinition_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnTaskSet_CFN_RESOURCE_TYPE_NAME ¶
func CfnTaskSet_CFN_RESOURCE_TYPE_NAME() *string
func CfnTaskSet_IsCfnElement ¶
func CfnTaskSet_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 CfnTaskSet_IsCfnResource ¶
func CfnTaskSet_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnTaskSet_IsConstruct ¶
func CfnTaskSet_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func Cluster_IsConstruct ¶
func Cluster_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func Cluster_IsResource ¶
func Cluster_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource. Experimental.
func ContainerDefinition_IsConstruct ¶
func ContainerDefinition_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func Ec2Service_IsConstruct ¶
func Ec2Service_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func Ec2Service_IsResource ¶
func Ec2Service_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource. Experimental.
func Ec2TaskDefinition_IsConstruct ¶
func Ec2TaskDefinition_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func Ec2TaskDefinition_IsResource ¶
func Ec2TaskDefinition_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource. Experimental.
func ExternalService_IsConstruct ¶
func ExternalService_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func ExternalService_IsResource ¶
func ExternalService_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource. Experimental.
func ExternalTaskDefinition_IsConstruct ¶
func ExternalTaskDefinition_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func ExternalTaskDefinition_IsResource ¶
func ExternalTaskDefinition_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource. Experimental.
func FargateService_IsConstruct ¶
func FargateService_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func FargateService_IsResource ¶
func FargateService_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource. Experimental.
func FargateTaskDefinition_IsConstruct ¶
func FargateTaskDefinition_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func FargateTaskDefinition_IsResource ¶
func FargateTaskDefinition_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource. Experimental.
func FirelensLogRouter_IsConstruct ¶
func FirelensLogRouter_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func LinuxParameters_IsConstruct ¶
func LinuxParameters_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func NewAppMeshProxyConfiguration_Override ¶
func NewAppMeshProxyConfiguration_Override(a AppMeshProxyConfiguration, props *AppMeshProxyConfigurationConfigProps)
Constructs a new instance of the AppMeshProxyConfiguration class. Experimental.
func NewAsgCapacityProvider_Override ¶
func NewAsgCapacityProvider_Override(a AsgCapacityProvider, scope constructs.Construct, id *string, props *AsgCapacityProviderProps)
Experimental.
func NewAssetEnvironmentFile_Override ¶
func NewAssetEnvironmentFile_Override(a AssetEnvironmentFile, path *string, options *awss3assets.AssetOptions)
Experimental.
func NewAssetImage_Override ¶
func NewAssetImage_Override(a AssetImage, directory *string, props *AssetImageProps)
Constructs a new instance of the AssetImage class. Experimental.
func NewAwsLogDriver_Override ¶
func NewAwsLogDriver_Override(a AwsLogDriver, props *AwsLogDriverProps)
Constructs a new instance of the AwsLogDriver class. Experimental.
func NewBaseService_Override ¶
func NewBaseService_Override(b BaseService, scope constructs.Construct, id *string, props *BaseServiceProps, additionalProps interface{}, taskDefinition TaskDefinition)
Constructs a new instance of the BaseService class. Experimental.
func NewBottleRocketImage_Override ¶
func NewBottleRocketImage_Override(b BottleRocketImage, props *BottleRocketImageProps)
Constructs a new instance of the BottleRocketImage class. Experimental.
func NewBuiltInAttributes_Override ¶
func NewBuiltInAttributes_Override(b BuiltInAttributes)
Experimental.
func NewCfnCapacityProvider_Override ¶
func NewCfnCapacityProvider_Override(c CfnCapacityProvider, scope constructs.Construct, id *string, props *CfnCapacityProviderProps)
Create a new `AWS::ECS::CapacityProvider`.
func NewCfnClusterCapacityProviderAssociations_Override ¶
func NewCfnClusterCapacityProviderAssociations_Override(c CfnClusterCapacityProviderAssociations, scope constructs.Construct, id *string, props *CfnClusterCapacityProviderAssociationsProps)
Create a new `AWS::ECS::ClusterCapacityProviderAssociations`.
func NewCfnCluster_Override ¶
func NewCfnCluster_Override(c CfnCluster, scope constructs.Construct, id *string, props *CfnClusterProps)
Create a new `AWS::ECS::Cluster`.
func NewCfnPrimaryTaskSet_Override ¶
func NewCfnPrimaryTaskSet_Override(c CfnPrimaryTaskSet, scope constructs.Construct, id *string, props *CfnPrimaryTaskSetProps)
Create a new `AWS::ECS::PrimaryTaskSet`.
func NewCfnService_Override ¶
func NewCfnService_Override(c CfnService, scope constructs.Construct, id *string, props *CfnServiceProps)
Create a new `AWS::ECS::Service`.
func NewCfnTaskDefinition_Override ¶
func NewCfnTaskDefinition_Override(c CfnTaskDefinition, scope constructs.Construct, id *string, props *CfnTaskDefinitionProps)
Create a new `AWS::ECS::TaskDefinition`.
func NewCfnTaskSet_Override ¶
func NewCfnTaskSet_Override(c CfnTaskSet, scope constructs.Construct, id *string, props *CfnTaskSetProps)
Create a new `AWS::ECS::TaskSet`.
func NewCluster_Override ¶
func NewCluster_Override(c Cluster, scope constructs.Construct, id *string, props *ClusterProps)
Constructs a new instance of the Cluster class. Experimental.
func NewContainerDefinition_Override ¶
func NewContainerDefinition_Override(c ContainerDefinition, scope constructs.Construct, id *string, props *ContainerDefinitionProps)
Constructs a new instance of the ContainerDefinition class. Experimental.
func NewEc2Service_Override ¶
func NewEc2Service_Override(e Ec2Service, scope constructs.Construct, id *string, props *Ec2ServiceProps)
Constructs a new instance of the Ec2Service class. Experimental.
func NewEc2TaskDefinition_Override ¶
func NewEc2TaskDefinition_Override(e Ec2TaskDefinition, scope constructs.Construct, id *string, props *Ec2TaskDefinitionProps)
Constructs a new instance of the Ec2TaskDefinition class. Experimental.
func NewEcrImage_Override ¶
func NewEcrImage_Override(e EcrImage, repository awsecr.IRepository, tagOrDigest *string)
Constructs a new instance of the EcrImage class. Experimental.
func NewEcsOptimizedAmi_Override ¶
func NewEcsOptimizedAmi_Override(e EcsOptimizedAmi, props *EcsOptimizedAmiProps)
Constructs a new instance of the EcsOptimizedAmi class. Deprecated: see {@link EcsOptimizedImage#amazonLinux}, {@link EcsOptimizedImage#amazonLinux} and {@link EcsOptimizedImage#windows}
func NewEnvironmentFile_Override ¶
func NewEnvironmentFile_Override(e EnvironmentFile)
Experimental.
func NewExternalService_Override ¶
func NewExternalService_Override(e ExternalService, scope constructs.Construct, id *string, props *ExternalServiceProps)
Constructs a new instance of the ExternalService class. Experimental.
func NewExternalTaskDefinition_Override ¶
func NewExternalTaskDefinition_Override(e ExternalTaskDefinition, scope constructs.Construct, id *string, props *ExternalTaskDefinitionProps)
Constructs a new instance of the ExternalTaskDefinition class. Experimental.
func NewFargateService_Override ¶
func NewFargateService_Override(f FargateService, scope constructs.Construct, id *string, props *FargateServiceProps)
Constructs a new instance of the FargateService class. Experimental.
func NewFargateTaskDefinition_Override ¶
func NewFargateTaskDefinition_Override(f FargateTaskDefinition, scope constructs.Construct, id *string, props *FargateTaskDefinitionProps)
Constructs a new instance of the FargateTaskDefinition class. Experimental.
func NewFireLensLogDriver_Override ¶
func NewFireLensLogDriver_Override(f FireLensLogDriver, props *FireLensLogDriverProps)
Constructs a new instance of the FireLensLogDriver class. Experimental.
func NewFirelensLogRouter_Override ¶
func NewFirelensLogRouter_Override(f FirelensLogRouter, scope constructs.Construct, id *string, props *FirelensLogRouterProps)
Constructs a new instance of the FirelensLogRouter class. Experimental.
func NewFluentdLogDriver_Override ¶
func NewFluentdLogDriver_Override(f FluentdLogDriver, props *FluentdLogDriverProps)
Constructs a new instance of the FluentdLogDriver class. Experimental.
func NewGelfLogDriver_Override ¶
func NewGelfLogDriver_Override(g GelfLogDriver, props *GelfLogDriverProps)
Constructs a new instance of the GelfLogDriver class. Experimental.
func NewGenericLogDriver_Override ¶
func NewGenericLogDriver_Override(g GenericLogDriver, props *GenericLogDriverProps)
Constructs a new instance of the GenericLogDriver class. Experimental.
func NewJournaldLogDriver_Override ¶
func NewJournaldLogDriver_Override(j JournaldLogDriver, props *JournaldLogDriverProps)
Constructs a new instance of the JournaldLogDriver class. Experimental.
func NewJsonFileLogDriver_Override ¶
func NewJsonFileLogDriver_Override(j JsonFileLogDriver, props *JsonFileLogDriverProps)
Constructs a new instance of the JsonFileLogDriver class. Experimental.
func NewLinuxParameters_Override ¶
func NewLinuxParameters_Override(l LinuxParameters, scope constructs.Construct, id *string, props *LinuxParametersProps)
Constructs a new instance of the LinuxParameters class. Experimental.
func NewProxyConfiguration_Override ¶
func NewProxyConfiguration_Override(p ProxyConfiguration)
Experimental.
func NewProxyConfigurations_Override ¶
func NewProxyConfigurations_Override(p ProxyConfigurations)
Experimental.
func NewRepositoryImage_Override ¶
func NewRepositoryImage_Override(r RepositoryImage, imageName *string, props *RepositoryImageProps)
Constructs a new instance of the RepositoryImage class. Experimental.
func NewS3EnvironmentFile_Override ¶
func NewS3EnvironmentFile_Override(s S3EnvironmentFile, bucket awss3.IBucket, key *string, objectVersion *string)
Experimental.
func NewScalableTaskCount_Override ¶
func NewScalableTaskCount_Override(s ScalableTaskCount, scope constructs.Construct, id *string, props *ScalableTaskCountProps)
Constructs a new instance of the ScalableTaskCount class. Experimental.
func NewSplunkLogDriver_Override ¶
func NewSplunkLogDriver_Override(s SplunkLogDriver, props *SplunkLogDriverProps)
Constructs a new instance of the SplunkLogDriver class. Experimental.
func NewSyslogLogDriver_Override ¶
func NewSyslogLogDriver_Override(s SyslogLogDriver, props *SyslogLogDriverProps)
Constructs a new instance of the SyslogLogDriver class. Experimental.
func NewTagParameterContainerImage_Override ¶
func NewTagParameterContainerImage_Override(t TagParameterContainerImage, repository awsecr.IRepository)
Experimental.
func NewTaskDefinition_Override ¶
func NewTaskDefinition_Override(t TaskDefinition, scope constructs.Construct, id *string, props *TaskDefinitionProps)
Constructs a new instance of the TaskDefinition class. Experimental.
func ScalableTaskCount_IsConstruct ¶
func ScalableTaskCount_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func TaskDefinition_IsConstruct ¶
func TaskDefinition_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func TaskDefinition_IsResource ¶
func TaskDefinition_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource. Experimental.
Types ¶
type AddAutoScalingGroupCapacityOptions ¶
type AddAutoScalingGroupCapacityOptions struct { // Specifies whether the containers can access the container instance role. // Experimental. CanContainersAccessInstanceRole *bool `json:"canContainersAccessInstanceRole"` // What type of machine image this is. // // Depending on the setting, different UserData will automatically be added // to the `AutoScalingGroup` to configure it properly for use with ECS. // // If you create an `AutoScalingGroup` yourself and are adding it via // `addAutoScalingGroup()`, you must specify this value. If you are adding an // `autoScalingGroup` via `addCapacity`, this value will be determined // from the `machineImage` you pass. // Experimental. MachineImageType MachineImageType `json:"machineImageType"` // Specify whether to enable Automated Draining for Spot Instances running Amazon ECS Services. // // For more information, see [Using Spot Instances](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-spot.html). // Experimental. SpotInstanceDraining *bool `json:"spotInstanceDraining"` // The time period to wait before force terminating an instance that is draining. // // This creates a Lambda function that is used by a lifecycle hook for the // AutoScalingGroup that will delay instance termination until all ECS tasks // have drained from the instance. Set to 0 to disable task draining. // // Set to 0 to disable task draining. // Deprecated: The lifecycle draining hook is not configured if using the EC2 Capacity Provider. Enable managed termination protection instead. TaskDrainTime awscdk.Duration `json:"taskDrainTime"` // If {@link AddAutoScalingGroupCapacityOptions.taskDrainTime} is non-zero, then the ECS cluster creates an SNS Topic to as part of a system to drain instances of tasks when the instance is being shut down. If this property is provided, then this key will be used to encrypt the contents of that SNS Topic. See [SNS Data Encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-data-encryption.html) for more information. // Experimental. TopicEncryptionKey awskms.IKey `json:"topicEncryptionKey"` }
The properties for adding an AutoScalingGroup.
TODO: EXAMPLE
Experimental.
type AddCapacityOptions ¶
type AddCapacityOptions struct { // Specifies whether the containers can access the container instance role. // Experimental. CanContainersAccessInstanceRole *bool `json:"canContainersAccessInstanceRole"` // What type of machine image this is. // // Depending on the setting, different UserData will automatically be added // to the `AutoScalingGroup` to configure it properly for use with ECS. // // If you create an `AutoScalingGroup` yourself and are adding it via // `addAutoScalingGroup()`, you must specify this value. If you are adding an // `autoScalingGroup` via `addCapacity`, this value will be determined // from the `machineImage` you pass. // Experimental. MachineImageType MachineImageType `json:"machineImageType"` // Specify whether to enable Automated Draining for Spot Instances running Amazon ECS Services. // // For more information, see [Using Spot Instances](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-spot.html). // Experimental. SpotInstanceDraining *bool `json:"spotInstanceDraining"` // The time period to wait before force terminating an instance that is draining. // // This creates a Lambda function that is used by a lifecycle hook for the // AutoScalingGroup that will delay instance termination until all ECS tasks // have drained from the instance. Set to 0 to disable task draining. // // Set to 0 to disable task draining. // Deprecated: The lifecycle draining hook is not configured if using the EC2 Capacity Provider. Enable managed termination protection instead. TaskDrainTime awscdk.Duration `json:"taskDrainTime"` // If {@link AddAutoScalingGroupCapacityOptions.taskDrainTime} is non-zero, then the ECS cluster creates an SNS Topic to as part of a system to drain instances of tasks when the instance is being shut down. If this property is provided, then this key will be used to encrypt the contents of that SNS Topic. See [SNS Data Encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-data-encryption.html) for more information. // Experimental. TopicEncryptionKey awskms.IKey `json:"topicEncryptionKey"` // Whether the instances can initiate connections to anywhere by default. // Experimental. AllowAllOutbound *bool `json:"allowAllOutbound"` // Whether instances in the Auto Scaling Group should have public IP addresses associated with them. // Experimental. AssociatePublicIpAddress *bool `json:"associatePublicIpAddress"` // The name of the Auto Scaling group. // // This name must be unique per Region per account. // Experimental. AutoScalingGroupName *string `json:"autoScalingGroupName"` // Specifies how block devices are exposed to the instance. You can specify virtual devices and EBS volumes. // // Each instance that is launched has an associated root device volume, // either an Amazon EBS volume or an instance store volume. // You can use block device mappings to specify additional EBS volumes or // instance store volumes to attach to an instance when it is launched. // See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html // // Experimental. BlockDevices *[]*awsautoscaling.BlockDevice `json:"blockDevices"` // Default scaling cooldown for this AutoScalingGroup. // Experimental. Cooldown awscdk.Duration `json:"cooldown"` // Initial amount of instances in the fleet. // // If this is set to a number, every deployment will reset the amount of // instances to this number. It is recommended to leave this value blank. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-desiredcapacity // // Experimental. DesiredCapacity *float64 `json:"desiredCapacity"` // Enable monitoring for group metrics, these metrics describe the group rather than any of its instances. // // To report all group metrics use `GroupMetrics.all()` // Group metrics are reported in a granularity of 1 minute at no additional charge. // Experimental. GroupMetrics *[]awsautoscaling.GroupMetrics `json:"groupMetrics"` // Configuration for health checks. // Experimental. HealthCheck awsautoscaling.HealthCheck `json:"healthCheck"` // If the ASG has scheduled actions, don't reset unchanged group sizes. // // Only used if the ASG has scheduled actions (which may scale your ASG up // or down regardless of cdk deployments). If true, the size of the group // will only be reset if it has been changed in the CDK app. If false, the // sizes will always be changed back to what they were in the CDK app // on deployment. // Experimental. IgnoreUnmodifiedSizeProperties *bool `json:"ignoreUnmodifiedSizeProperties"` // Controls whether instances in this group are launched with detailed or basic monitoring. // // When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account // is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. // See: https://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html#enable-as-instance-metrics // // Experimental. InstanceMonitoring awsautoscaling.Monitoring `json:"instanceMonitoring"` // Name of SSH keypair to grant access to instances. // Experimental. KeyName *string `json:"keyName"` // Maximum number of instances in the fleet. // Experimental. MaxCapacity *float64 `json:"maxCapacity"` // The maximum amount of time that an instance can be in service. // // The maximum duration applies // to all current and future instances in the group. As an instance approaches its maximum duration, // it is terminated and replaced, and cannot be used again. // // You must specify a value of at least 604,800 seconds (7 days). To clear a previously set value, // leave this property undefined. // See: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html // // Experimental. MaxInstanceLifetime awscdk.Duration `json:"maxInstanceLifetime"` // Minimum number of instances in the fleet. // Experimental. MinCapacity *float64 `json:"minCapacity"` // Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. // // By default, Auto Scaling can terminate an instance at any time after launch // when scaling in an Auto Scaling Group, subject to the group's termination // policy. However, you may wish to protect newly-launched instances from // being scaled in if they are going to run critical applications that should // not be prematurely terminated. // // This flag must be enabled if the Auto Scaling Group will be associated with // an ECS Capacity Provider with managed termination protection. // Experimental. NewInstancesProtectedFromScaleIn *bool `json:"newInstancesProtectedFromScaleIn"` // Configure autoscaling group to send notifications about fleet changes to an SNS topic(s). // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-as-group.html#cfn-as-group-notificationconfigurations // // Experimental. Notifications *[]*awsautoscaling.NotificationConfiguration `json:"notifications"` // SNS topic to send notifications about fleet changes. // Deprecated: use `notifications` NotificationsTopic awssns.ITopic `json:"notificationsTopic"` // Configuration for replacing updates. // // Only used if updateType == UpdateType.ReplacingUpdate. Specifies how // many instances must signal success for the update to succeed. // Deprecated: Use `signals` instead ReplacingUpdateMinSuccessfulInstancesPercent *float64 `json:"replacingUpdateMinSuccessfulInstancesPercent"` // How many ResourceSignal calls CloudFormation expects before the resource is considered created. // Deprecated: Use `signals` instead. ResourceSignalCount *float64 `json:"resourceSignalCount"` // The length of time to wait for the resourceSignalCount. // // The maximum value is 43200 (12 hours). // Deprecated: Use `signals` instead. ResourceSignalTimeout awscdk.Duration `json:"resourceSignalTimeout"` // Configuration for rolling updates. // // Only used if updateType == UpdateType.RollingUpdate. // Deprecated: Use `updatePolicy` instead RollingUpdateConfiguration *awsautoscaling.RollingUpdateConfiguration `json:"rollingUpdateConfiguration"` // Configure waiting for signals during deployment. // // Use this to pause the CloudFormation deployment to wait for the instances // in the AutoScalingGroup to report successful startup during // creation and updates. The UserData script needs to invoke `cfn-signal` // with a success or failure code after it is done setting up the instance. // // Without waiting for signals, the CloudFormation deployment will proceed as // soon as the AutoScalingGroup has been created or updated but before the // instances in the group have been started. // // For example, to have instances wait for an Elastic Load Balancing health check before // they signal success, add a health-check verification by using the // cfn-init helper script. For an example, see the verify_instance_health // command in the Auto Scaling rolling updates sample template: // // https://github.com/awslabs/aws-cloudformation-templates/blob/master/aws/services/AutoScaling/AutoScalingRollingUpdates.yaml // Experimental. Signals awsautoscaling.Signals `json:"signals"` // The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request. // // Spot Instances are // launched when the price you specify exceeds the current Spot market price. // Experimental. SpotPrice *string `json:"spotPrice"` // What to do when an AutoScalingGroup's instance configuration is changed. // // This is applied when any of the settings on the ASG are changed that // affect how the instances should be created (VPC, instance type, startup // scripts, etc.). It indicates how the existing instances should be // replaced with new instances matching the new config. By default, nothing // is done and only new instances are launched with the new config. // Experimental. UpdatePolicy awsautoscaling.UpdatePolicy `json:"updatePolicy"` // What to do when an AutoScalingGroup's instance configuration is changed. // // This is applied when any of the settings on the ASG are changed that // affect how the instances should be created (VPC, instance type, startup // scripts, etc.). It indicates how the existing instances should be // replaced with new instances matching the new config. By default, nothing // is done and only new instances are launched with the new config. // Deprecated: Use `updatePolicy` instead UpdateType awsautoscaling.UpdateType `json:"updateType"` // Where to place instances within the VPC. // Experimental. VpcSubnets *awsec2.SubnetSelection `json:"vpcSubnets"` // The EC2 instance type to use when launching instances into the AutoScalingGroup. // Experimental. InstanceType awsec2.InstanceType `json:"instanceType"` // The ECS-optimized AMI variant to use. // // The default is to use an ECS-optimized AMI of Amazon Linux 2 which is // automatically updated to the latest version on every deployment. This will // replace the instances in the AutoScalingGroup. Make sure you have not disabled // task draining, to avoid downtime when the AMI updates. // // To use an image that does not update on every deployment, pass: // // “`ts // const machineImage = ecs.EcsOptimizedImage.amazonLinux2(ecs.AmiHardwareType.STANDARD, { // cachedInContext: true, // }); // “` // // For more information, see [Amazon ECS-optimized // AMIs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html). // // You must define either `machineImage` or `machineImageType`, not both. // Experimental. MachineImage awsec2.IMachineImage `json:"machineImage"` }
The properties for adding instance capacity to an AutoScalingGroup.
TODO: EXAMPLE
Experimental.
type AmiHardwareType ¶
type AmiHardwareType string
The ECS-optimized AMI variant to use.
For more information, see [Amazon ECS-optimized AMIs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html).
TODO: EXAMPLE
Experimental.
const ( AmiHardwareType_STANDARD AmiHardwareType = "STANDARD" AmiHardwareType_GPU AmiHardwareType = "GPU" AmiHardwareType_ARM AmiHardwareType = "ARM" )
type AppMeshProxyConfiguration ¶
type AppMeshProxyConfiguration interface { ProxyConfiguration Bind(_scope constructs.Construct, _taskDefinition TaskDefinition) *CfnTaskDefinition_ProxyConfigurationProperty }
The class for App Mesh proxy configurations.
For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see [Amazon ECS-optimized AMIs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html).
For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later.
TODO: EXAMPLE
Experimental.
func NewAppMeshProxyConfiguration ¶
func NewAppMeshProxyConfiguration(props *AppMeshProxyConfigurationConfigProps) AppMeshProxyConfiguration
Constructs a new instance of the AppMeshProxyConfiguration class. Experimental.
type AppMeshProxyConfigurationConfigProps ¶
type AppMeshProxyConfigurationConfigProps struct { // The name of the container that will serve as the App Mesh proxy. // Experimental. ContainerName *string `json:"containerName"` // The set of network configuration parameters to provide the Container Network Interface (CNI) plugin. // Experimental. Properties *AppMeshProxyConfigurationProps `json:"properties"` }
The configuration to use when setting an App Mesh proxy configuration.
TODO: EXAMPLE
Experimental.
type AppMeshProxyConfigurationProps ¶
type AppMeshProxyConfigurationProps struct { // The list of ports that the application uses. // // Network traffic to these ports is forwarded to the ProxyIngressPort and ProxyEgressPort. // Experimental. AppPorts *[]*float64 `json:"appPorts"` // The egress traffic going to these specified IP addresses is ignored and not redirected to the ProxyEgressPort. // // It can be an empty list. // Experimental. EgressIgnoredIPs *[]*string `json:"egressIgnoredIPs"` // The egress traffic going to these specified ports is ignored and not redirected to the ProxyEgressPort. // // It can be an empty list. // Experimental. EgressIgnoredPorts *[]*float64 `json:"egressIgnoredPorts"` // The group ID (GID) of the proxy container as defined by the user parameter in a container definition. // // This is used to ensure the proxy ignores its own traffic. If IgnoredUID is specified, this field can be empty. // Experimental. IgnoredGID *float64 `json:"ignoredGID"` // The user ID (UID) of the proxy container as defined by the user parameter in a container definition. // // This is used to ensure the proxy ignores its own traffic. If IgnoredGID is specified, this field can be empty. // Experimental. IgnoredUID *float64 `json:"ignoredUID"` // Specifies the port that outgoing traffic from the AppPorts is directed to. // Experimental. ProxyEgressPort *float64 `json:"proxyEgressPort"` // Specifies the port that incoming traffic to the AppPorts is directed to. // Experimental. ProxyIngressPort *float64 `json:"proxyIngressPort"` }
Interface for setting the properties of proxy configuration.
TODO: EXAMPLE
Experimental.
type AsgCapacityProvider ¶
type AsgCapacityProvider interface { constructs.Construct AutoScalingGroup() awsautoscaling.AutoScalingGroup CapacityProviderName() *string EnableManagedTerminationProtection() *bool MachineImageType() MachineImageType Node() constructs.Node ToString() *string }
An Auto Scaling Group Capacity Provider.
This allows an ECS cluster to target a specific EC2 Auto Scaling Group for the placement of tasks. Optionally (and recommended), ECS can manage the number of instances in the ASG to fit the tasks, and can ensure that instances are not prematurely terminated while there are still tasks running on them.
TODO: EXAMPLE
Experimental.
func NewAsgCapacityProvider ¶
func NewAsgCapacityProvider(scope constructs.Construct, id *string, props *AsgCapacityProviderProps) AsgCapacityProvider
Experimental.
type AsgCapacityProviderProps ¶
type AsgCapacityProviderProps struct { // Specifies whether the containers can access the container instance role. // Experimental. CanContainersAccessInstanceRole *bool `json:"canContainersAccessInstanceRole"` // What type of machine image this is. // // Depending on the setting, different UserData will automatically be added // to the `AutoScalingGroup` to configure it properly for use with ECS. // // If you create an `AutoScalingGroup` yourself and are adding it via // `addAutoScalingGroup()`, you must specify this value. If you are adding an // `autoScalingGroup` via `addCapacity`, this value will be determined // from the `machineImage` you pass. // Experimental. MachineImageType MachineImageType `json:"machineImageType"` // Specify whether to enable Automated Draining for Spot Instances running Amazon ECS Services. // // For more information, see [Using Spot Instances](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-spot.html). // Experimental. SpotInstanceDraining *bool `json:"spotInstanceDraining"` // The time period to wait before force terminating an instance that is draining. // // This creates a Lambda function that is used by a lifecycle hook for the // AutoScalingGroup that will delay instance termination until all ECS tasks // have drained from the instance. Set to 0 to disable task draining. // // Set to 0 to disable task draining. // Deprecated: The lifecycle draining hook is not configured if using the EC2 Capacity Provider. Enable managed termination protection instead. TaskDrainTime awscdk.Duration `json:"taskDrainTime"` // If {@link AddAutoScalingGroupCapacityOptions.taskDrainTime} is non-zero, then the ECS cluster creates an SNS Topic to as part of a system to drain instances of tasks when the instance is being shut down. If this property is provided, then this key will be used to encrypt the contents of that SNS Topic. See [SNS Data Encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-data-encryption.html) for more information. // Experimental. TopicEncryptionKey awskms.IKey `json:"topicEncryptionKey"` // The autoscaling group to add as a Capacity Provider. // Experimental. AutoScalingGroup awsautoscaling.IAutoScalingGroup `json:"autoScalingGroup"` // The name of the capacity provider. // // If a name is specified, // it cannot start with `aws`, `ecs`, or `fargate`. If no name is specified, // a default name in the CFNStackName-CFNResourceName-RandomString format is used. // Experimental. CapacityProviderName *string `json:"capacityProviderName"` // Whether to enable managed scaling. // Experimental. EnableManagedScaling *bool `json:"enableManagedScaling"` // Whether to enable managed termination protection. // Experimental. EnableManagedTerminationProtection *bool `json:"enableManagedTerminationProtection"` // Maximum scaling step size. // // In most cases this should be left alone. // Experimental. MaximumScalingStepSize *float64 `json:"maximumScalingStepSize"` // Minimum scaling step size. // // In most cases this should be left alone. // Experimental. MinimumScalingStepSize *float64 `json:"minimumScalingStepSize"` // Target capacity percent. // // In most cases this should be left alone. // Experimental. TargetCapacityPercent *float64 `json:"targetCapacityPercent"` }
The options for creating an Auto Scaling Group Capacity Provider.
TODO: EXAMPLE
Experimental.
type AssetEnvironmentFile ¶
type AssetEnvironmentFile interface { EnvironmentFile Path() *string Bind(scope constructs.Construct) *EnvironmentFileConfig }
Environment file from a local directory.
TODO: EXAMPLE
Experimental.
func AssetEnvironmentFile_FromAsset ¶
func AssetEnvironmentFile_FromAsset(path *string, options *awss3assets.AssetOptions) AssetEnvironmentFile
Loads the environment file from a local disk path. Experimental.
func EnvironmentFile_FromAsset ¶
func EnvironmentFile_FromAsset(path *string, options *awss3assets.AssetOptions) AssetEnvironmentFile
Loads the environment file from a local disk path. Experimental.
func NewAssetEnvironmentFile ¶
func NewAssetEnvironmentFile(path *string, options *awss3assets.AssetOptions) AssetEnvironmentFile
Experimental.
func S3EnvironmentFile_FromAsset ¶
func S3EnvironmentFile_FromAsset(path *string, options *awss3assets.AssetOptions) AssetEnvironmentFile
Loads the environment file from a local disk path. Experimental.
type AssetImage ¶
type AssetImage interface { ContainerImage Bind(scope constructs.Construct, containerDefinition ContainerDefinition) *ContainerImageConfig }
An image that will be built from a local directory with a Dockerfile.
TODO: EXAMPLE
Experimental.
func AssetImage_FromAsset ¶
func AssetImage_FromAsset(directory *string, props *AssetImageProps) AssetImage
Reference an image that's constructed directly from sources on disk.
If you already have a `DockerImageAsset` instance, you can use the `ContainerImage.fromDockerImageAsset` method instead. Experimental.
func ContainerImage_FromAsset ¶
func ContainerImage_FromAsset(directory *string, props *AssetImageProps) AssetImage
Reference an image that's constructed directly from sources on disk.
If you already have a `DockerImageAsset` instance, you can use the `ContainerImage.fromDockerImageAsset` method instead. Experimental.
func EcrImage_FromAsset ¶
func EcrImage_FromAsset(directory *string, props *AssetImageProps) AssetImage
Reference an image that's constructed directly from sources on disk.
If you already have a `DockerImageAsset` instance, you can use the `ContainerImage.fromDockerImageAsset` method instead. Experimental.
func NewAssetImage ¶
func NewAssetImage(directory *string, props *AssetImageProps) AssetImage
Constructs a new instance of the AssetImage class. Experimental.
func RepositoryImage_FromAsset ¶
func RepositoryImage_FromAsset(directory *string, props *AssetImageProps) AssetImage
Reference an image that's constructed directly from sources on disk.
If you already have a `DockerImageAsset` instance, you can use the `ContainerImage.fromDockerImageAsset` method instead. Experimental.
func TagParameterContainerImage_FromAsset ¶
func TagParameterContainerImage_FromAsset(directory *string, props *AssetImageProps) AssetImage
Reference an image that's constructed directly from sources on disk.
If you already have a `DockerImageAsset` instance, you can use the `ContainerImage.fromDockerImageAsset` method instead. Experimental.
type AssetImageProps ¶
type AssetImageProps struct { // Glob patterns to exclude from the copy. // Experimental. Exclude *[]*string `json:"exclude"` // A strategy for how to handle symlinks. // Deprecated: use `followSymlinks` instead Follow assets.FollowMode `json:"follow"` // The ignore behavior to use for exclude patterns. // Experimental. IgnoreMode awscdk.IgnoreMode `json:"ignoreMode"` // Extra information to encode into the fingerprint (e.g. build instructions and other inputs). // Experimental. ExtraHash *string `json:"extraHash"` // A strategy for how to handle symlinks. // Experimental. FollowSymlinks awscdk.SymlinkFollowMode `json:"followSymlinks"` // Build args to pass to the `docker build` command. // // Since Docker build arguments are resolved before deployment, keys and // values cannot refer to unresolved tokens (such as `lambda.functionArn` or // `queue.queueUrl`). // Experimental. BuildArgs *map[string]*string `json:"buildArgs"` // Path to the Dockerfile (relative to the directory). // Experimental. File *string `json:"file"` // Options to control which parameters are used to invalidate the asset hash. // Experimental. Invalidation *awsecrassets.DockerImageAssetInvalidationOptions `json:"invalidation"` // ECR repository name. // // Specify this property if you need to statically address the image, e.g. // from a Kubernetes Pod. Note, this is only the repository name, without the // registry and the tag parts. // Deprecated: to control the location of docker image assets, please override // `Stack.addDockerImageAsset`. this feature will be removed in future // releases. RepositoryName *string `json:"repositoryName"` // Docker target to build to. // Experimental. Target *string `json:"target"` }
The properties for building an AssetImage.
TODO: EXAMPLE
Experimental.
type AssociateCloudMapServiceOptions ¶
type AssociateCloudMapServiceOptions struct { // The cloudmap service to register with. // Experimental. Service awsservicediscovery.IService `json:"service"` // The container to point to for a SRV record. // Experimental. Container ContainerDefinition `json:"container"` // The port to point to for a SRV record. // Experimental. ContainerPort *float64 `json:"containerPort"` }
The options for using a cloudmap service.
TODO: EXAMPLE
Experimental.
type AuthorizationConfig ¶
type AuthorizationConfig struct { // The access point ID to use. // // If an access point is specified, the root directory value will be // relative to the directory set for the access point. // If specified, transit encryption must be enabled in the EFSVolumeConfiguration. // Experimental. AccessPointId *string `json:"accessPointId"` // Whether or not to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system. // // If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. // // Valid values: ENABLED | DISABLED // Experimental. Iam *string `json:"iam"` }
The authorization configuration details for the Amazon EFS file system.
TODO: EXAMPLE
Experimental.
type AwsLogDriver ¶
type AwsLogDriver interface { LogDriver LogGroup() awslogs.ILogGroup SetLogGroup(val awslogs.ILogGroup) Bind(scope constructs.Construct, containerDefinition ContainerDefinition) *LogDriverConfig }
A log driver that sends log information to CloudWatch Logs.
TODO: EXAMPLE
Experimental.
func NewAwsLogDriver ¶
func NewAwsLogDriver(props *AwsLogDriverProps) AwsLogDriver
Constructs a new instance of the AwsLogDriver class. Experimental.
type AwsLogDriverMode ¶
type AwsLogDriverMode string
awslogs provides two modes for delivering messages from the container to the log driver.
TODO: EXAMPLE
Experimental.
const ( AwsLogDriverMode_BLOCKING AwsLogDriverMode = "BLOCKING" AwsLogDriverMode_NON_BLOCKING AwsLogDriverMode = "NON_BLOCKING" )
type AwsLogDriverProps ¶
type AwsLogDriverProps struct { // This option defines a multiline start pattern in Python strftime format. // // A log message consists of a line that matches the pattern and any // following lines that don’t match the pattern. Thus the matched line is // the delimiter between log messages. // Experimental. DatetimeFormat *string `json:"datetimeFormat"` // The log group to log to. // Experimental. LogGroup awslogs.ILogGroup `json:"logGroup"` // The number of days log events are kept in CloudWatch Logs when the log group is automatically created by this construct. // Experimental. LogRetention awslogs.RetentionDays `json:"logRetention"` // The delivery mode of log messages from the container to awslogs. // Experimental. Mode AwsLogDriverMode `json:"mode"` // This option defines a multiline start pattern using a regular expression. // // A log message consists of a line that matches the pattern and any // following lines that don’t match the pattern. Thus the matched line is // the delimiter between log messages. // // This option is ignored if datetimeFormat is also configured. // Experimental. MultilinePattern *string `json:"multilinePattern"` // Prefix for the log streams. // // The awslogs-stream-prefix option allows you to associate a log stream // with the specified prefix, the container name, and the ID of the Amazon // ECS task to which the container belongs. If you specify a prefix with // this option, then the log stream takes the following format: // // prefix-name/container-name/ecs-task-id // Experimental. StreamPrefix *string `json:"streamPrefix"` }
Specifies the awslogs log driver configuration options.
TODO: EXAMPLE
Experimental.
type BaseLogDriverProps ¶
type BaseLogDriverProps struct { // The env option takes an array of keys. // // If there is collision between // label and env keys, the value of the env takes precedence. Adds additional fields // to the extra attributes of a logging message. // Experimental. Env *[]*string `json:"env"` // The env-regex option is similar to and compatible with env. // // Its value is a regular // expression to match logging-related environment variables. It is used for advanced // log tag options. // Experimental. EnvRegex *string `json:"envRegex"` // The labels option takes an array of keys. // // If there is collision // between label and env keys, the value of the env takes precedence. Adds additional // fields to the extra attributes of a logging message. // Experimental. Labels *[]*string `json:"labels"` // By default, Docker uses the first 12 characters of the container ID to tag log messages. // // Refer to the log tag option documentation for customizing the // log tag format. // Experimental. Tag *string `json:"tag"` }
TODO: EXAMPLE
Experimental.
type BaseService ¶
type BaseService interface { awscdk.Resource IBaseService awselasticloadbalancing.ILoadBalancerTarget awselasticloadbalancingv2.IApplicationLoadBalancerTarget awselasticloadbalancingv2.INetworkLoadBalancerTarget CloudmapService() awsservicediscovery.Service SetCloudmapService(val awsservicediscovery.Service) CloudMapService() awsservicediscovery.IService Cluster() ICluster Connections() awsec2.Connections Env() *awscdk.ResourceEnvironment LoadBalancers() *[]*CfnService_LoadBalancerProperty SetLoadBalancers(val *[]*CfnService_LoadBalancerProperty) NetworkConfiguration() *CfnService_NetworkConfigurationProperty SetNetworkConfiguration(val *CfnService_NetworkConfigurationProperty) Node() constructs.Node PhysicalName() *string ServiceArn() *string ServiceName() *string ServiceRegistries() *[]*CfnService_ServiceRegistryProperty SetServiceRegistries(val *[]*CfnService_ServiceRegistryProperty) Stack() awscdk.Stack TaskDefinition() TaskDefinition ApplyRemovalPolicy(policy awscdk.RemovalPolicy) AssociateCloudMapService(options *AssociateCloudMapServiceOptions) AttachToApplicationTargetGroup(targetGroup awselasticloadbalancingv2.IApplicationTargetGroup) *awselasticloadbalancingv2.LoadBalancerTargetProps AttachToClassicLB(loadBalancer awselasticloadbalancing.LoadBalancer) AttachToNetworkTargetGroup(targetGroup awselasticloadbalancingv2.INetworkTargetGroup) *awselasticloadbalancingv2.LoadBalancerTargetProps AutoScaleTaskCount(props *awsapplicationautoscaling.EnableScalingProps) ScalableTaskCount ConfigureAwsVpcNetworking(vpc awsec2.IVpc, assignPublicIp *bool, vpcSubnets *awsec2.SubnetSelection, securityGroup awsec2.ISecurityGroup) ConfigureAwsVpcNetworkingWithSecurityGroups(vpc awsec2.IVpc, assignPublicIp *bool, vpcSubnets *awsec2.SubnetSelection, securityGroups *[]awsec2.ISecurityGroup) EnableCloudMap(options *CloudMapOptions) awsservicediscovery.Service GeneratePhysicalName() *string GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string GetResourceNameAttribute(nameAttr *string) *string LoadBalancerTarget(options *LoadBalancerTargetOptions) IEcsLoadBalancerTarget Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricCpuUtilization(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricMemoryUtilization(props *awscloudwatch.MetricOptions) awscloudwatch.Metric RegisterLoadBalancerTargets(targets ...*EcsTarget) ToString() *string }
The base class for Ec2Service and FargateService services. Experimental.
type BaseServiceOptions ¶
type BaseServiceOptions struct { // A list of Capacity Provider strategies used to place a service. // Experimental. CapacityProviderStrategies *[]*CapacityProviderStrategy `json:"capacityProviderStrategies"` // Whether to enable the deployment circuit breaker. // // If this property is defined, circuit breaker will be implicitly // enabled. // Experimental. CircuitBreaker *DeploymentCircuitBreaker `json:"circuitBreaker"` // The options for configuring an Amazon ECS service to use service discovery. // Experimental. CloudMapOptions *CloudMapOptions `json:"cloudMapOptions"` // The name of the cluster that hosts the service. // Experimental. Cluster ICluster `json:"cluster"` // Specifies which deployment controller to use for the service. // // For more information, see // [Amazon ECS Deployment Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) // Experimental. DeploymentController *DeploymentController `json:"deploymentController"` // The desired number of instantiations of the task definition to keep running on the service. // Experimental. DesiredCount *float64 `json:"desiredCount"` // Specifies whether to enable Amazon ECS managed tags for the tasks within the service. // // For more information, see // [Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) // Experimental. EnableECSManagedTags *bool `json:"enableECSManagedTags"` // Whether to enable the ability to execute into a container. // Experimental. EnableExecuteCommand *bool `json:"enableExecuteCommand"` // The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. // Experimental. HealthCheckGracePeriod awscdk.Duration `json:"healthCheckGracePeriod"` // The maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment. // Experimental. MaxHealthyPercent *float64 `json:"maxHealthyPercent"` // The minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment. // Experimental. MinHealthyPercent *float64 `json:"minHealthyPercent"` // Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. // // Valid values are: PropagatedTagSource.SERVICE, PropagatedTagSource.TASK_DEFINITION or PropagatedTagSource.NONE // Experimental. PropagateTags PropagatedTagSource `json:"propagateTags"` // Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. // // Tags can only be propagated to the tasks within the service during service creation. // Deprecated: Use `propagateTags` instead. PropagateTaskTagsFrom PropagatedTagSource `json:"propagateTaskTagsFrom"` // The name of the service. // Experimental. ServiceName *string `json:"serviceName"` }
The properties for the base Ec2Service or FargateService service.
TODO: EXAMPLE
Experimental.
type BaseServiceProps ¶
type BaseServiceProps struct { // A list of Capacity Provider strategies used to place a service. // Experimental. CapacityProviderStrategies *[]*CapacityProviderStrategy `json:"capacityProviderStrategies"` // Whether to enable the deployment circuit breaker. // // If this property is defined, circuit breaker will be implicitly // enabled. // Experimental. CircuitBreaker *DeploymentCircuitBreaker `json:"circuitBreaker"` // The options for configuring an Amazon ECS service to use service discovery. // Experimental. CloudMapOptions *CloudMapOptions `json:"cloudMapOptions"` // The name of the cluster that hosts the service. // Experimental. Cluster ICluster `json:"cluster"` // Specifies which deployment controller to use for the service. // // For more information, see // [Amazon ECS Deployment Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) // Experimental. DeploymentController *DeploymentController `json:"deploymentController"` // The desired number of instantiations of the task definition to keep running on the service. // Experimental. DesiredCount *float64 `json:"desiredCount"` // Specifies whether to enable Amazon ECS managed tags for the tasks within the service. // // For more information, see // [Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) // Experimental. EnableECSManagedTags *bool `json:"enableECSManagedTags"` // Whether to enable the ability to execute into a container. // Experimental. EnableExecuteCommand *bool `json:"enableExecuteCommand"` // The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. // Experimental. HealthCheckGracePeriod awscdk.Duration `json:"healthCheckGracePeriod"` // The maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment. // Experimental. MaxHealthyPercent *float64 `json:"maxHealthyPercent"` // The minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment. // Experimental. MinHealthyPercent *float64 `json:"minHealthyPercent"` // Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. // // Valid values are: PropagatedTagSource.SERVICE, PropagatedTagSource.TASK_DEFINITION or PropagatedTagSource.NONE // Experimental. PropagateTags PropagatedTagSource `json:"propagateTags"` // Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. // // Tags can only be propagated to the tasks within the service during service creation. // Deprecated: Use `propagateTags` instead. PropagateTaskTagsFrom PropagatedTagSource `json:"propagateTaskTagsFrom"` // The name of the service. // Experimental. ServiceName *string `json:"serviceName"` // The launch type on which to run your service. // // LaunchType will be omitted if capacity provider strategies are specified on the service. // See: - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-capacityproviderstrategy // // Valid values are: LaunchType.ECS or LaunchType.FARGATE or LaunchType.EXTERNAL // // Experimental. LaunchType LaunchType `json:"launchType"` }
Complete base service properties that are required to be supplied by the implementation of the BaseService class.
TODO: EXAMPLE
Experimental.
type BinPackResource ¶
type BinPackResource string
Instance resource used for bin packing. Experimental.
const ( BinPackResource_CPU BinPackResource = "CPU" BinPackResource_MEMORY BinPackResource = "MEMORY" )
type BottleRocketImage ¶
type BottleRocketImage interface { awsec2.IMachineImage GetImage(scope constructs.Construct) *awsec2.MachineImageConfig }
Construct an Bottlerocket image from the latest AMI published in SSM.
TODO: EXAMPLE
Experimental.
func NewBottleRocketImage ¶
func NewBottleRocketImage(props *BottleRocketImageProps) BottleRocketImage
Constructs a new instance of the BottleRocketImage class. Experimental.
type BottleRocketImageProps ¶
type BottleRocketImageProps struct { // The CPU architecture. // Experimental. Architecture awsec2.InstanceArchitecture `json:"architecture"` // Whether the AMI ID is cached to be stable between deployments. // // By default, the newest image is used on each deployment. This will cause // instances to be replaced whenever a new version is released, and may cause // downtime if there aren't enough running instances in the AutoScalingGroup // to reschedule the tasks on. // // If set to true, the AMI ID will be cached in `cdk.context.json` and the // same value will be used on future runs. Your instances will not be replaced // but your AMI version will grow old over time. To refresh the AMI lookup, // you will have to evict the value from the cache using the `cdk context` // command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for // more information. // // Can not be set to `true` in environment-agnostic stacks. // Experimental. CachedInContext *bool `json:"cachedInContext"` // The Amazon ECS variant to use. // // Only `aws-ecs-1` is currently available // Experimental. Variant BottlerocketEcsVariant `json:"variant"` }
Properties for BottleRocketImage.
TODO: EXAMPLE
Experimental.
type BottlerocketEcsVariant ¶
type BottlerocketEcsVariant string
Amazon ECS variant. Experimental.
const (
BottlerocketEcsVariant_AWS_ECS_1 BottlerocketEcsVariant = "AWS_ECS_1"
)
type BuiltInAttributes ¶
type BuiltInAttributes interface { }
The built-in container instance attributes.
TODO: EXAMPLE
Experimental.
type Capability ¶
type Capability string
A Linux capability. Experimental.
const ( Capability_ALL Capability = "ALL" Capability_AUDIT_CONTROL Capability = "AUDIT_CONTROL" Capability_AUDIT_WRITE Capability = "AUDIT_WRITE" Capability_BLOCK_SUSPEND Capability = "BLOCK_SUSPEND" Capability_CHOWN Capability = "CHOWN" Capability_DAC_OVERRIDE Capability = "DAC_OVERRIDE" Capability_DAC_READ_SEARCH Capability = "DAC_READ_SEARCH" Capability_FOWNER Capability = "FOWNER" Capability_FSETID Capability = "FSETID" Capability_IPC_LOCK Capability = "IPC_LOCK" Capability_IPC_OWNER Capability = "IPC_OWNER" Capability_KILL Capability = "KILL" Capability_LEASE Capability = "LEASE" Capability_LINUX_IMMUTABLE Capability = "LINUX_IMMUTABLE" Capability_MAC_ADMIN Capability = "MAC_ADMIN" Capability_MAC_OVERRIDE Capability = "MAC_OVERRIDE" Capability_MKNOD Capability = "MKNOD" Capability_NET_ADMIN Capability = "NET_ADMIN" Capability_NET_BIND_SERVICE Capability = "NET_BIND_SERVICE" Capability_NET_BROADCAST Capability = "NET_BROADCAST" Capability_NET_RAW Capability = "NET_RAW" Capability_SETFCAP Capability = "SETFCAP" Capability_SETGID Capability = "SETGID" Capability_SETPCAP Capability = "SETPCAP" Capability_SETUID Capability = "SETUID" Capability_SYS_ADMIN Capability = "SYS_ADMIN" Capability_SYS_BOOT Capability = "SYS_BOOT" Capability_SYS_CHROOT Capability = "SYS_CHROOT" Capability_SYS_MODULE Capability = "SYS_MODULE" Capability_SYS_NICE Capability = "SYS_NICE" Capability_SYS_PACCT Capability = "SYS_PACCT" Capability_SYS_PTRACE Capability = "SYS_PTRACE" Capability_SYS_RAWIO Capability = "SYS_RAWIO" Capability_SYS_RESOURCE Capability = "SYS_RESOURCE" Capability_SYS_TIME Capability = "SYS_TIME" Capability_SYS_TTY_CONFIG Capability = "SYS_TTY_CONFIG" Capability_SYSLOG Capability = "SYSLOG" Capability_WAKE_ALARM Capability = "WAKE_ALARM" )
type CapacityProviderStrategy ¶
type CapacityProviderStrategy struct { // The base value designates how many tasks, at a minimum, to run on the specified capacity provider. // // Only one // capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default // value of 0 is used. // Experimental. Base *float64 `json:"base"` // The name of the capacity provider. // Experimental. CapacityProvider *string `json:"capacityProvider"` // The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. // // The weight value is taken into consideration after the base value, if defined, is satisfied. // Experimental. Weight *float64 `json:"weight"` }
A Capacity Provider strategy to use for the service.
NOTE: defaultCapacityProviderStrategy on cluster not currently supported.
TODO: EXAMPLE
Experimental.
type CfnCapacityProvider ¶
type CfnCapacityProvider interface { awscdk.CfnResource awscdk.IInspectable AutoScalingGroupProvider() interface{} SetAutoScalingGroupProvider(val interface{}) CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string CreationStack() *[]*string LogicalId() *string Name() *string SetName(val *string) Node() constructs.Node Ref() *string 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) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::ECS::CapacityProvider`.
TODO: EXAMPLE
func NewCfnCapacityProvider ¶
func NewCfnCapacityProvider(scope constructs.Construct, id *string, props *CfnCapacityProviderProps) CfnCapacityProvider
Create a new `AWS::ECS::CapacityProvider`.
type CfnCapacityProviderProps ¶
type CfnCapacityProviderProps struct { // `AWS::ECS::CapacityProvider.AutoScalingGroupProvider`. AutoScalingGroupProvider interface{} `json:"autoScalingGroupProvider"` // `AWS::ECS::CapacityProvider.Name`. Name *string `json:"name"` // `AWS::ECS::CapacityProvider.Tags`. Tags *[]*awscdk.CfnTag `json:"tags"` }
Properties for defining a `AWS::ECS::CapacityProvider`.
TODO: EXAMPLE
type CfnCapacityProvider_AutoScalingGroupProviderProperty ¶
type CfnCapacityProvider_AutoScalingGroupProviderProperty struct { // `CfnCapacityProvider.AutoScalingGroupProviderProperty.AutoScalingGroupArn`. AutoScalingGroupArn *string `json:"autoScalingGroupArn"` // `CfnCapacityProvider.AutoScalingGroupProviderProperty.ManagedScaling`. ManagedScaling interface{} `json:"managedScaling"` // `CfnCapacityProvider.AutoScalingGroupProviderProperty.ManagedTerminationProtection`. ManagedTerminationProtection *string `json:"managedTerminationProtection"` }
TODO: EXAMPLE
type CfnCapacityProvider_ManagedScalingProperty ¶
type CfnCapacityProvider_ManagedScalingProperty struct { // `CfnCapacityProvider.ManagedScalingProperty.InstanceWarmupPeriod`. InstanceWarmupPeriod *float64 `json:"instanceWarmupPeriod"` // `CfnCapacityProvider.ManagedScalingProperty.MaximumScalingStepSize`. MaximumScalingStepSize *float64 `json:"maximumScalingStepSize"` // `CfnCapacityProvider.ManagedScalingProperty.MinimumScalingStepSize`. MinimumScalingStepSize *float64 `json:"minimumScalingStepSize"` // `CfnCapacityProvider.ManagedScalingProperty.Status`. Status *string `json:"status"` // `CfnCapacityProvider.ManagedScalingProperty.TargetCapacity`. TargetCapacity *float64 `json:"targetCapacity"` }
TODO: EXAMPLE
type CfnCluster ¶
type CfnCluster interface { awscdk.CfnResource awscdk.IInspectable AttrArn() *string CapacityProviders() *[]*string SetCapacityProviders(val *[]*string) CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string ClusterName() *string SetClusterName(val *string) ClusterSettings() interface{} SetClusterSettings(val interface{}) Configuration() interface{} SetConfiguration(val interface{}) CreationStack() *[]*string DefaultCapacityProviderStrategy() interface{} SetDefaultCapacityProviderStrategy(val interface{}) LogicalId() *string Node() constructs.Node Ref() *string 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) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::ECS::Cluster`.
TODO: EXAMPLE
func NewCfnCluster ¶
func NewCfnCluster(scope constructs.Construct, id *string, props *CfnClusterProps) CfnCluster
Create a new `AWS::ECS::Cluster`.
type CfnClusterCapacityProviderAssociations ¶
type CfnClusterCapacityProviderAssociations interface { awscdk.CfnResource awscdk.IInspectable CapacityProviders() *[]*string SetCapacityProviders(val *[]*string) CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string Cluster() *string SetCluster(val *string) CreationStack() *[]*string DefaultCapacityProviderStrategy() interface{} SetDefaultCapacityProviderStrategy(val interface{}) LogicalId() *string Node() constructs.Node Ref() *string Stack() awscdk.Stack 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) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::ECS::ClusterCapacityProviderAssociations`.
TODO: EXAMPLE
func NewCfnClusterCapacityProviderAssociations ¶
func NewCfnClusterCapacityProviderAssociations(scope constructs.Construct, id *string, props *CfnClusterCapacityProviderAssociationsProps) CfnClusterCapacityProviderAssociations
Create a new `AWS::ECS::ClusterCapacityProviderAssociations`.
type CfnClusterCapacityProviderAssociationsProps ¶
type CfnClusterCapacityProviderAssociationsProps struct { // `AWS::ECS::ClusterCapacityProviderAssociations.CapacityProviders`. CapacityProviders *[]*string `json:"capacityProviders"` // `AWS::ECS::ClusterCapacityProviderAssociations.Cluster`. Cluster *string `json:"cluster"` // `AWS::ECS::ClusterCapacityProviderAssociations.DefaultCapacityProviderStrategy`. DefaultCapacityProviderStrategy interface{} `json:"defaultCapacityProviderStrategy"` }
Properties for defining a `AWS::ECS::ClusterCapacityProviderAssociations`.
TODO: EXAMPLE
type CfnClusterCapacityProviderAssociations_CapacityProviderStrategyProperty ¶
type CfnClusterCapacityProviderAssociations_CapacityProviderStrategyProperty struct { // `CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty.Base`. Base *float64 `json:"base"` // `CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty.CapacityProvider`. CapacityProvider *string `json:"capacityProvider"` // `CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty.Weight`. Weight *float64 `json:"weight"` }
TODO: EXAMPLE
type CfnClusterProps ¶
type CfnClusterProps struct { // `AWS::ECS::Cluster.CapacityProviders`. CapacityProviders *[]*string `json:"capacityProviders"` // `AWS::ECS::Cluster.ClusterName`. ClusterName *string `json:"clusterName"` // `AWS::ECS::Cluster.ClusterSettings`. ClusterSettings interface{} `json:"clusterSettings"` // `AWS::ECS::Cluster.Configuration`. Configuration interface{} `json:"configuration"` // `AWS::ECS::Cluster.DefaultCapacityProviderStrategy`. DefaultCapacityProviderStrategy interface{} `json:"defaultCapacityProviderStrategy"` // `AWS::ECS::Cluster.Tags`. Tags *[]*awscdk.CfnTag `json:"tags"` }
Properties for defining a `AWS::ECS::Cluster`.
TODO: EXAMPLE
type CfnCluster_CapacityProviderStrategyItemProperty ¶
type CfnCluster_CapacityProviderStrategyItemProperty struct { // `CfnCluster.CapacityProviderStrategyItemProperty.Base`. Base *float64 `json:"base"` // `CfnCluster.CapacityProviderStrategyItemProperty.CapacityProvider`. CapacityProvider *string `json:"capacityProvider"` // `CfnCluster.CapacityProviderStrategyItemProperty.Weight`. Weight *float64 `json:"weight"` }
TODO: EXAMPLE
type CfnCluster_ClusterConfigurationProperty ¶
type CfnCluster_ClusterConfigurationProperty struct {
// `CfnCluster.ClusterConfigurationProperty.ExecuteCommandConfiguration`.
ExecuteCommandConfiguration interface{} `json:"executeCommandConfiguration"`
}
TODO: EXAMPLE
type CfnCluster_ClusterSettingsProperty ¶
type CfnCluster_ClusterSettingsProperty struct { // `CfnCluster.ClusterSettingsProperty.Name`. Name *string `json:"name"` // `CfnCluster.ClusterSettingsProperty.Value`. Value *string `json:"value"` }
TODO: EXAMPLE
type CfnCluster_ExecuteCommandConfigurationProperty ¶
type CfnCluster_ExecuteCommandConfigurationProperty struct { // `CfnCluster.ExecuteCommandConfigurationProperty.KmsKeyId`. KmsKeyId *string `json:"kmsKeyId"` // `CfnCluster.ExecuteCommandConfigurationProperty.LogConfiguration`. LogConfiguration interface{} `json:"logConfiguration"` // `CfnCluster.ExecuteCommandConfigurationProperty.Logging`. Logging *string `json:"logging"` }
TODO: EXAMPLE
type CfnCluster_ExecuteCommandLogConfigurationProperty ¶
type CfnCluster_ExecuteCommandLogConfigurationProperty struct { // `CfnCluster.ExecuteCommandLogConfigurationProperty.CloudWatchEncryptionEnabled`. CloudWatchEncryptionEnabled interface{} `json:"cloudWatchEncryptionEnabled"` // `CfnCluster.ExecuteCommandLogConfigurationProperty.CloudWatchLogGroupName`. CloudWatchLogGroupName *string `json:"cloudWatchLogGroupName"` // `CfnCluster.ExecuteCommandLogConfigurationProperty.S3BucketName`. S3BucketName *string `json:"s3BucketName"` // `CfnCluster.ExecuteCommandLogConfigurationProperty.S3EncryptionEnabled`. S3EncryptionEnabled interface{} `json:"s3EncryptionEnabled"` // `CfnCluster.ExecuteCommandLogConfigurationProperty.S3KeyPrefix`. S3KeyPrefix *string `json:"s3KeyPrefix"` }
TODO: EXAMPLE
type CfnPrimaryTaskSet ¶
type CfnPrimaryTaskSet interface { awscdk.CfnResource awscdk.IInspectable CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string Cluster() *string SetCluster(val *string) CreationStack() *[]*string LogicalId() *string Node() constructs.Node Ref() *string Service() *string SetService(val *string) Stack() awscdk.Stack TaskSetId() *string SetTaskSetId(val *string) 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) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::ECS::PrimaryTaskSet`.
TODO: EXAMPLE
func NewCfnPrimaryTaskSet ¶
func NewCfnPrimaryTaskSet(scope constructs.Construct, id *string, props *CfnPrimaryTaskSetProps) CfnPrimaryTaskSet
Create a new `AWS::ECS::PrimaryTaskSet`.
type CfnPrimaryTaskSetProps ¶
type CfnPrimaryTaskSetProps struct { // `AWS::ECS::PrimaryTaskSet.Cluster`. Cluster *string `json:"cluster"` // `AWS::ECS::PrimaryTaskSet.Service`. Service *string `json:"service"` // `AWS::ECS::PrimaryTaskSet.TaskSetId`. TaskSetId *string `json:"taskSetId"` }
Properties for defining a `AWS::ECS::PrimaryTaskSet`.
TODO: EXAMPLE
type CfnService ¶
type CfnService interface { awscdk.CfnResource awscdk.IInspectable AttrName() *string AttrServiceArn() *string CapacityProviderStrategy() interface{} SetCapacityProviderStrategy(val interface{}) CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string Cluster() *string SetCluster(val *string) CreationStack() *[]*string DeploymentConfiguration() interface{} SetDeploymentConfiguration(val interface{}) DeploymentController() interface{} SetDeploymentController(val interface{}) DesiredCount() *float64 SetDesiredCount(val *float64) EnableEcsManagedTags() interface{} SetEnableEcsManagedTags(val interface{}) EnableExecuteCommand() interface{} SetEnableExecuteCommand(val interface{}) HealthCheckGracePeriodSeconds() *float64 SetHealthCheckGracePeriodSeconds(val *float64) LaunchType() *string SetLaunchType(val *string) LoadBalancers() interface{} SetLoadBalancers(val interface{}) LogicalId() *string NetworkConfiguration() interface{} SetNetworkConfiguration(val interface{}) Node() constructs.Node PlacementConstraints() interface{} SetPlacementConstraints(val interface{}) PlacementStrategies() interface{} SetPlacementStrategies(val interface{}) PlatformVersion() *string SetPlatformVersion(val *string) PropagateTags() *string SetPropagateTags(val *string) Ref() *string Role() *string SetRole(val *string) SchedulingStrategy() *string SetSchedulingStrategy(val *string) ServiceName() *string SetServiceName(val *string) ServiceRegistries() interface{} SetServiceRegistries(val interface{}) Stack() awscdk.Stack Tags() awscdk.TagManager TaskDefinition() *string SetTaskDefinition(val *string) 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) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::ECS::Service`.
TODO: EXAMPLE
func NewCfnService ¶
func NewCfnService(scope constructs.Construct, id *string, props *CfnServiceProps) CfnService
Create a new `AWS::ECS::Service`.
type CfnServiceProps ¶
type CfnServiceProps struct { // `AWS::ECS::Service.CapacityProviderStrategy`. CapacityProviderStrategy interface{} `json:"capacityProviderStrategy"` // `AWS::ECS::Service.Cluster`. Cluster *string `json:"cluster"` // `AWS::ECS::Service.DeploymentConfiguration`. DeploymentConfiguration interface{} `json:"deploymentConfiguration"` // `AWS::ECS::Service.DeploymentController`. DeploymentController interface{} `json:"deploymentController"` // `AWS::ECS::Service.DesiredCount`. DesiredCount *float64 `json:"desiredCount"` // `AWS::ECS::Service.EnableECSManagedTags`. EnableEcsManagedTags interface{} `json:"enableEcsManagedTags"` // `AWS::ECS::Service.EnableExecuteCommand`. EnableExecuteCommand interface{} `json:"enableExecuteCommand"` // `AWS::ECS::Service.HealthCheckGracePeriodSeconds`. HealthCheckGracePeriodSeconds *float64 `json:"healthCheckGracePeriodSeconds"` // `AWS::ECS::Service.LaunchType`. LaunchType *string `json:"launchType"` // `AWS::ECS::Service.LoadBalancers`. LoadBalancers interface{} `json:"loadBalancers"` // `AWS::ECS::Service.NetworkConfiguration`. NetworkConfiguration interface{} `json:"networkConfiguration"` // `AWS::ECS::Service.PlacementConstraints`. PlacementConstraints interface{} `json:"placementConstraints"` // `AWS::ECS::Service.PlacementStrategies`. PlacementStrategies interface{} `json:"placementStrategies"` // `AWS::ECS::Service.PlatformVersion`. PlatformVersion *string `json:"platformVersion"` // `AWS::ECS::Service.PropagateTags`. PropagateTags *string `json:"propagateTags"` // `AWS::ECS::Service.Role`. Role *string `json:"role"` // `AWS::ECS::Service.SchedulingStrategy`. SchedulingStrategy *string `json:"schedulingStrategy"` // `AWS::ECS::Service.ServiceName`. ServiceName *string `json:"serviceName"` // `AWS::ECS::Service.ServiceRegistries`. ServiceRegistries interface{} `json:"serviceRegistries"` // `AWS::ECS::Service.Tags`. Tags *[]*awscdk.CfnTag `json:"tags"` // `AWS::ECS::Service.TaskDefinition`. TaskDefinition *string `json:"taskDefinition"` }
Properties for defining a `AWS::ECS::Service`.
TODO: EXAMPLE
type CfnService_AwsVpcConfigurationProperty ¶
type CfnService_AwsVpcConfigurationProperty struct { // `CfnService.AwsVpcConfigurationProperty.AssignPublicIp`. AssignPublicIp *string `json:"assignPublicIp"` // `CfnService.AwsVpcConfigurationProperty.SecurityGroups`. SecurityGroups *[]*string `json:"securityGroups"` // `CfnService.AwsVpcConfigurationProperty.Subnets`. Subnets *[]*string `json:"subnets"` }
TODO: EXAMPLE
type CfnService_CapacityProviderStrategyItemProperty ¶
type CfnService_CapacityProviderStrategyItemProperty struct { // `CfnService.CapacityProviderStrategyItemProperty.Base`. Base *float64 `json:"base"` // `CfnService.CapacityProviderStrategyItemProperty.CapacityProvider`. CapacityProvider *string `json:"capacityProvider"` // `CfnService.CapacityProviderStrategyItemProperty.Weight`. Weight *float64 `json:"weight"` }
TODO: EXAMPLE
type CfnService_DeploymentCircuitBreakerProperty ¶
type CfnService_DeploymentCircuitBreakerProperty struct { // `CfnService.DeploymentCircuitBreakerProperty.Enable`. Enable interface{} `json:"enable"` // `CfnService.DeploymentCircuitBreakerProperty.Rollback`. Rollback interface{} `json:"rollback"` }
TODO: EXAMPLE
type CfnService_DeploymentConfigurationProperty ¶
type CfnService_DeploymentConfigurationProperty struct { // `CfnService.DeploymentConfigurationProperty.DeploymentCircuitBreaker`. DeploymentCircuitBreaker interface{} `json:"deploymentCircuitBreaker"` // `CfnService.DeploymentConfigurationProperty.MaximumPercent`. MaximumPercent *float64 `json:"maximumPercent"` // `CfnService.DeploymentConfigurationProperty.MinimumHealthyPercent`. MinimumHealthyPercent *float64 `json:"minimumHealthyPercent"` }
TODO: EXAMPLE
type CfnService_DeploymentControllerProperty ¶
type CfnService_DeploymentControllerProperty struct { // `CfnService.DeploymentControllerProperty.Type`. Type *string `json:"type"` }
TODO: EXAMPLE
type CfnService_LoadBalancerProperty ¶
type CfnService_LoadBalancerProperty struct { // `CfnService.LoadBalancerProperty.ContainerName`. ContainerName *string `json:"containerName"` // `CfnService.LoadBalancerProperty.ContainerPort`. ContainerPort *float64 `json:"containerPort"` // `CfnService.LoadBalancerProperty.LoadBalancerName`. LoadBalancerName *string `json:"loadBalancerName"` // `CfnService.LoadBalancerProperty.TargetGroupArn`. TargetGroupArn *string `json:"targetGroupArn"` }
TODO: EXAMPLE
type CfnService_NetworkConfigurationProperty ¶
type CfnService_NetworkConfigurationProperty struct {
// `CfnService.NetworkConfigurationProperty.AwsvpcConfiguration`.
AwsvpcConfiguration interface{} `json:"awsvpcConfiguration"`
}
TODO: EXAMPLE
type CfnService_PlacementConstraintProperty ¶
type CfnService_PlacementConstraintProperty struct { // `CfnService.PlacementConstraintProperty.Expression`. Expression *string `json:"expression"` // `CfnService.PlacementConstraintProperty.Type`. Type *string `json:"type"` }
TODO: EXAMPLE
type CfnService_PlacementStrategyProperty ¶
type CfnService_PlacementStrategyProperty struct { // `CfnService.PlacementStrategyProperty.Field`. Field *string `json:"field"` // `CfnService.PlacementStrategyProperty.Type`. Type *string `json:"type"` }
TODO: EXAMPLE
type CfnService_ServiceRegistryProperty ¶
type CfnService_ServiceRegistryProperty struct { // `CfnService.ServiceRegistryProperty.ContainerName`. ContainerName *string `json:"containerName"` // `CfnService.ServiceRegistryProperty.ContainerPort`. ContainerPort *float64 `json:"containerPort"` // `CfnService.ServiceRegistryProperty.Port`. Port *float64 `json:"port"` // `CfnService.ServiceRegistryProperty.RegistryArn`. RegistryArn *string `json:"registryArn"` }
TODO: EXAMPLE
type CfnTaskDefinition ¶
type CfnTaskDefinition interface { awscdk.CfnResource awscdk.IInspectable AttrTaskDefinitionArn() *string CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string ContainerDefinitions() interface{} SetContainerDefinitions(val interface{}) Cpu() *string SetCpu(val *string) CreationStack() *[]*string EphemeralStorage() interface{} SetEphemeralStorage(val interface{}) ExecutionRoleArn() *string SetExecutionRoleArn(val *string) Family() *string SetFamily(val *string) InferenceAccelerators() interface{} SetInferenceAccelerators(val interface{}) IpcMode() *string SetIpcMode(val *string) LogicalId() *string Memory() *string SetMemory(val *string) NetworkMode() *string SetNetworkMode(val *string) Node() constructs.Node PidMode() *string SetPidMode(val *string) PlacementConstraints() interface{} SetPlacementConstraints(val interface{}) ProxyConfiguration() interface{} SetProxyConfiguration(val interface{}) Ref() *string RequiresCompatibilities() *[]*string SetRequiresCompatibilities(val *[]*string) RuntimePlatform() interface{} SetRuntimePlatform(val interface{}) Stack() awscdk.Stack Tags() awscdk.TagManager TaskRoleArn() *string SetTaskRoleArn(val *string) UpdatedProperites() *map[string]interface{} Volumes() interface{} SetVolumes(val 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) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::ECS::TaskDefinition`.
TODO: EXAMPLE
func NewCfnTaskDefinition ¶
func NewCfnTaskDefinition(scope constructs.Construct, id *string, props *CfnTaskDefinitionProps) CfnTaskDefinition
Create a new `AWS::ECS::TaskDefinition`.
type CfnTaskDefinitionProps ¶
type CfnTaskDefinitionProps struct { // `AWS::ECS::TaskDefinition.ContainerDefinitions`. ContainerDefinitions interface{} `json:"containerDefinitions"` // `AWS::ECS::TaskDefinition.Cpu`. Cpu *string `json:"cpu"` // `AWS::ECS::TaskDefinition.EphemeralStorage`. EphemeralStorage interface{} `json:"ephemeralStorage"` // `AWS::ECS::TaskDefinition.ExecutionRoleArn`. ExecutionRoleArn *string `json:"executionRoleArn"` // `AWS::ECS::TaskDefinition.Family`. Family *string `json:"family"` // `AWS::ECS::TaskDefinition.InferenceAccelerators`. InferenceAccelerators interface{} `json:"inferenceAccelerators"` // `AWS::ECS::TaskDefinition.IpcMode`. IpcMode *string `json:"ipcMode"` // `AWS::ECS::TaskDefinition.Memory`. Memory *string `json:"memory"` // `AWS::ECS::TaskDefinition.NetworkMode`. NetworkMode *string `json:"networkMode"` // `AWS::ECS::TaskDefinition.PidMode`. PidMode *string `json:"pidMode"` // `AWS::ECS::TaskDefinition.PlacementConstraints`. PlacementConstraints interface{} `json:"placementConstraints"` // `AWS::ECS::TaskDefinition.ProxyConfiguration`. ProxyConfiguration interface{} `json:"proxyConfiguration"` // `AWS::ECS::TaskDefinition.RequiresCompatibilities`. RequiresCompatibilities *[]*string `json:"requiresCompatibilities"` // `AWS::ECS::TaskDefinition.RuntimePlatform`. RuntimePlatform interface{} `json:"runtimePlatform"` // `AWS::ECS::TaskDefinition.Tags`. Tags *[]*awscdk.CfnTag `json:"tags"` // `AWS::ECS::TaskDefinition.TaskRoleArn`. TaskRoleArn *string `json:"taskRoleArn"` // `AWS::ECS::TaskDefinition.Volumes`. Volumes interface{} `json:"volumes"` }
Properties for defining a `AWS::ECS::TaskDefinition`.
TODO: EXAMPLE
type CfnTaskDefinition_AuthorizationConfigProperty ¶
type CfnTaskDefinition_AuthorizationConfigProperty struct { // `CfnTaskDefinition.AuthorizationConfigProperty.AccessPointId`. AccessPointId *string `json:"accessPointId"` // `CfnTaskDefinition.AuthorizationConfigProperty.IAM`. Iam *string `json:"iam"` }
TODO: EXAMPLE
type CfnTaskDefinition_ContainerDefinitionProperty ¶
type CfnTaskDefinition_ContainerDefinitionProperty struct { // `CfnTaskDefinition.ContainerDefinitionProperty.Command`. Command *[]*string `json:"command"` // `CfnTaskDefinition.ContainerDefinitionProperty.Cpu`. Cpu *float64 `json:"cpu"` // `CfnTaskDefinition.ContainerDefinitionProperty.DependsOn`. DependsOn interface{} `json:"dependsOn"` // `CfnTaskDefinition.ContainerDefinitionProperty.DisableNetworking`. DisableNetworking interface{} `json:"disableNetworking"` // `CfnTaskDefinition.ContainerDefinitionProperty.DnsSearchDomains`. DnsSearchDomains *[]*string `json:"dnsSearchDomains"` // `CfnTaskDefinition.ContainerDefinitionProperty.DnsServers`. DnsServers *[]*string `json:"dnsServers"` // `CfnTaskDefinition.ContainerDefinitionProperty.DockerLabels`. DockerLabels interface{} `json:"dockerLabels"` // `CfnTaskDefinition.ContainerDefinitionProperty.DockerSecurityOptions`. DockerSecurityOptions *[]*string `json:"dockerSecurityOptions"` // `CfnTaskDefinition.ContainerDefinitionProperty.EntryPoint`. EntryPoint *[]*string `json:"entryPoint"` // `CfnTaskDefinition.ContainerDefinitionProperty.Environment`. Environment interface{} `json:"environment"` // `CfnTaskDefinition.ContainerDefinitionProperty.EnvironmentFiles`. EnvironmentFiles interface{} `json:"environmentFiles"` // `CfnTaskDefinition.ContainerDefinitionProperty.Essential`. Essential interface{} `json:"essential"` // `CfnTaskDefinition.ContainerDefinitionProperty.ExtraHosts`. ExtraHosts interface{} `json:"extraHosts"` // `CfnTaskDefinition.ContainerDefinitionProperty.FirelensConfiguration`. FirelensConfiguration interface{} `json:"firelensConfiguration"` // `CfnTaskDefinition.ContainerDefinitionProperty.HealthCheck`. HealthCheck interface{} `json:"healthCheck"` // `CfnTaskDefinition.ContainerDefinitionProperty.Hostname`. Hostname *string `json:"hostname"` // `CfnTaskDefinition.ContainerDefinitionProperty.Image`. Image *string `json:"image"` // `CfnTaskDefinition.ContainerDefinitionProperty.Interactive`. Interactive interface{} `json:"interactive"` // `CfnTaskDefinition.ContainerDefinitionProperty.Links`. Links *[]*string `json:"links"` // `CfnTaskDefinition.ContainerDefinitionProperty.LinuxParameters`. LinuxParameters interface{} `json:"linuxParameters"` // `CfnTaskDefinition.ContainerDefinitionProperty.LogConfiguration`. LogConfiguration interface{} `json:"logConfiguration"` // `CfnTaskDefinition.ContainerDefinitionProperty.Memory`. Memory *float64 `json:"memory"` // `CfnTaskDefinition.ContainerDefinitionProperty.MemoryReservation`. MemoryReservation *float64 `json:"memoryReservation"` // `CfnTaskDefinition.ContainerDefinitionProperty.MountPoints`. MountPoints interface{} `json:"mountPoints"` // `CfnTaskDefinition.ContainerDefinitionProperty.Name`. Name *string `json:"name"` // `CfnTaskDefinition.ContainerDefinitionProperty.PortMappings`. PortMappings interface{} `json:"portMappings"` // `CfnTaskDefinition.ContainerDefinitionProperty.Privileged`. Privileged interface{} `json:"privileged"` // `CfnTaskDefinition.ContainerDefinitionProperty.PseudoTerminal`. PseudoTerminal interface{} `json:"pseudoTerminal"` // `CfnTaskDefinition.ContainerDefinitionProperty.ReadonlyRootFilesystem`. ReadonlyRootFilesystem interface{} `json:"readonlyRootFilesystem"` // `CfnTaskDefinition.ContainerDefinitionProperty.RepositoryCredentials`. RepositoryCredentials interface{} `json:"repositoryCredentials"` // `CfnTaskDefinition.ContainerDefinitionProperty.ResourceRequirements`. ResourceRequirements interface{} `json:"resourceRequirements"` // `CfnTaskDefinition.ContainerDefinitionProperty.Secrets`. Secrets interface{} `json:"secrets"` // `CfnTaskDefinition.ContainerDefinitionProperty.StartTimeout`. StartTimeout *float64 `json:"startTimeout"` // `CfnTaskDefinition.ContainerDefinitionProperty.StopTimeout`. StopTimeout *float64 `json:"stopTimeout"` // `CfnTaskDefinition.ContainerDefinitionProperty.SystemControls`. SystemControls interface{} `json:"systemControls"` // `CfnTaskDefinition.ContainerDefinitionProperty.Ulimits`. Ulimits interface{} `json:"ulimits"` // `CfnTaskDefinition.ContainerDefinitionProperty.User`. User *string `json:"user"` // `CfnTaskDefinition.ContainerDefinitionProperty.VolumesFrom`. VolumesFrom interface{} `json:"volumesFrom"` // `CfnTaskDefinition.ContainerDefinitionProperty.WorkingDirectory`. WorkingDirectory *string `json:"workingDirectory"` }
TODO: EXAMPLE
type CfnTaskDefinition_ContainerDependencyProperty ¶
type CfnTaskDefinition_ContainerDependencyProperty struct { // `CfnTaskDefinition.ContainerDependencyProperty.Condition`. Condition *string `json:"condition"` // `CfnTaskDefinition.ContainerDependencyProperty.ContainerName`. ContainerName *string `json:"containerName"` }
TODO: EXAMPLE
type CfnTaskDefinition_DeviceProperty ¶
type CfnTaskDefinition_DeviceProperty struct { // `CfnTaskDefinition.DeviceProperty.ContainerPath`. ContainerPath *string `json:"containerPath"` // `CfnTaskDefinition.DeviceProperty.HostPath`. HostPath *string `json:"hostPath"` // `CfnTaskDefinition.DeviceProperty.Permissions`. Permissions *[]*string `json:"permissions"` }
TODO: EXAMPLE
type CfnTaskDefinition_DockerVolumeConfigurationProperty ¶
type CfnTaskDefinition_DockerVolumeConfigurationProperty struct { // `CfnTaskDefinition.DockerVolumeConfigurationProperty.Autoprovision`. Autoprovision interface{} `json:"autoprovision"` // `CfnTaskDefinition.DockerVolumeConfigurationProperty.Driver`. Driver *string `json:"driver"` // `CfnTaskDefinition.DockerVolumeConfigurationProperty.DriverOpts`. DriverOpts interface{} `json:"driverOpts"` // `CfnTaskDefinition.DockerVolumeConfigurationProperty.Labels`. Labels interface{} `json:"labels"` // `CfnTaskDefinition.DockerVolumeConfigurationProperty.Scope`. Scope *string `json:"scope"` }
TODO: EXAMPLE
type CfnTaskDefinition_EfsVolumeConfigurationProperty ¶
type CfnTaskDefinition_EfsVolumeConfigurationProperty struct { // `CfnTaskDefinition.EfsVolumeConfigurationProperty.AuthorizationConfig`. AuthorizationConfig interface{} `json:"authorizationConfig"` // `CfnTaskDefinition.EfsVolumeConfigurationProperty.FileSystemId`. FileSystemId *string `json:"fileSystemId"` // `CfnTaskDefinition.EfsVolumeConfigurationProperty.RootDirectory`. RootDirectory *string `json:"rootDirectory"` // `CfnTaskDefinition.EfsVolumeConfigurationProperty.TransitEncryption`. TransitEncryption *string `json:"transitEncryption"` // `CfnTaskDefinition.EfsVolumeConfigurationProperty.TransitEncryptionPort`. TransitEncryptionPort *float64 `json:"transitEncryptionPort"` }
TODO: EXAMPLE
type CfnTaskDefinition_EnvironmentFileProperty ¶
type CfnTaskDefinition_EnvironmentFileProperty struct { // `CfnTaskDefinition.EnvironmentFileProperty.Type`. Type *string `json:"type"` // `CfnTaskDefinition.EnvironmentFileProperty.Value`. Value *string `json:"value"` }
TODO: EXAMPLE
type CfnTaskDefinition_EphemeralStorageProperty ¶
type CfnTaskDefinition_EphemeralStorageProperty struct { // `CfnTaskDefinition.EphemeralStorageProperty.SizeInGiB`. SizeInGiB *float64 `json:"sizeInGiB"` }
TODO: EXAMPLE
type CfnTaskDefinition_FirelensConfigurationProperty ¶
type CfnTaskDefinition_FirelensConfigurationProperty struct { // `CfnTaskDefinition.FirelensConfigurationProperty.Options`. Options interface{} `json:"options"` // `CfnTaskDefinition.FirelensConfigurationProperty.Type`. Type *string `json:"type"` }
TODO: EXAMPLE
type CfnTaskDefinition_HealthCheckProperty ¶
type CfnTaskDefinition_HealthCheckProperty struct { // `CfnTaskDefinition.HealthCheckProperty.Command`. Command *[]*string `json:"command"` // `CfnTaskDefinition.HealthCheckProperty.Interval`. Interval *float64 `json:"interval"` // `CfnTaskDefinition.HealthCheckProperty.Retries`. Retries *float64 `json:"retries"` // `CfnTaskDefinition.HealthCheckProperty.StartPeriod`. StartPeriod *float64 `json:"startPeriod"` // `CfnTaskDefinition.HealthCheckProperty.Timeout`. Timeout *float64 `json:"timeout"` }
TODO: EXAMPLE
type CfnTaskDefinition_HostEntryProperty ¶
type CfnTaskDefinition_HostEntryProperty struct { // `CfnTaskDefinition.HostEntryProperty.Hostname`. Hostname *string `json:"hostname"` // `CfnTaskDefinition.HostEntryProperty.IpAddress`. IpAddress *string `json:"ipAddress"` }
TODO: EXAMPLE
type CfnTaskDefinition_HostVolumePropertiesProperty ¶
type CfnTaskDefinition_HostVolumePropertiesProperty struct { // `CfnTaskDefinition.HostVolumePropertiesProperty.SourcePath`. SourcePath *string `json:"sourcePath"` }
TODO: EXAMPLE
type CfnTaskDefinition_InferenceAcceleratorProperty ¶
type CfnTaskDefinition_InferenceAcceleratorProperty struct { // `CfnTaskDefinition.InferenceAcceleratorProperty.DeviceName`. DeviceName *string `json:"deviceName"` // `CfnTaskDefinition.InferenceAcceleratorProperty.DeviceType`. DeviceType *string `json:"deviceType"` }
TODO: EXAMPLE
type CfnTaskDefinition_KernelCapabilitiesProperty ¶
type CfnTaskDefinition_KernelCapabilitiesProperty struct { // `CfnTaskDefinition.KernelCapabilitiesProperty.Add`. Add *[]*string `json:"add"` // `CfnTaskDefinition.KernelCapabilitiesProperty.Drop`. Drop *[]*string `json:"drop"` }
TODO: EXAMPLE
type CfnTaskDefinition_KeyValuePairProperty ¶
type CfnTaskDefinition_KeyValuePairProperty struct { // `CfnTaskDefinition.KeyValuePairProperty.Name`. Name *string `json:"name"` // `CfnTaskDefinition.KeyValuePairProperty.Value`. Value *string `json:"value"` }
TODO: EXAMPLE
type CfnTaskDefinition_LinuxParametersProperty ¶
type CfnTaskDefinition_LinuxParametersProperty struct { // `CfnTaskDefinition.LinuxParametersProperty.Capabilities`. Capabilities interface{} `json:"capabilities"` // `CfnTaskDefinition.LinuxParametersProperty.Devices`. Devices interface{} `json:"devices"` // `CfnTaskDefinition.LinuxParametersProperty.InitProcessEnabled`. InitProcessEnabled interface{} `json:"initProcessEnabled"` // `CfnTaskDefinition.LinuxParametersProperty.MaxSwap`. MaxSwap *float64 `json:"maxSwap"` SharedMemorySize *float64 `json:"sharedMemorySize"` // `CfnTaskDefinition.LinuxParametersProperty.Swappiness`. Swappiness *float64 `json:"swappiness"` // `CfnTaskDefinition.LinuxParametersProperty.Tmpfs`. Tmpfs interface{} `json:"tmpfs"` }
TODO: EXAMPLE
type CfnTaskDefinition_LogConfigurationProperty ¶
type CfnTaskDefinition_LogConfigurationProperty struct { // `CfnTaskDefinition.LogConfigurationProperty.LogDriver`. LogDriver *string `json:"logDriver"` // `CfnTaskDefinition.LogConfigurationProperty.Options`. Options interface{} `json:"options"` // `CfnTaskDefinition.LogConfigurationProperty.SecretOptions`. SecretOptions interface{} `json:"secretOptions"` }
TODO: EXAMPLE
type CfnTaskDefinition_MountPointProperty ¶
type CfnTaskDefinition_MountPointProperty struct { // `CfnTaskDefinition.MountPointProperty.ContainerPath`. ContainerPath *string `json:"containerPath"` // `CfnTaskDefinition.MountPointProperty.ReadOnly`. ReadOnly interface{} `json:"readOnly"` // `CfnTaskDefinition.MountPointProperty.SourceVolume`. SourceVolume *string `json:"sourceVolume"` }
TODO: EXAMPLE
type CfnTaskDefinition_PortMappingProperty ¶
type CfnTaskDefinition_PortMappingProperty struct { // `CfnTaskDefinition.PortMappingProperty.ContainerPort`. ContainerPort *float64 `json:"containerPort"` // `CfnTaskDefinition.PortMappingProperty.HostPort`. HostPort *float64 `json:"hostPort"` // `CfnTaskDefinition.PortMappingProperty.Protocol`. Protocol *string `json:"protocol"` }
TODO: EXAMPLE
type CfnTaskDefinition_ProxyConfigurationProperty ¶
type CfnTaskDefinition_ProxyConfigurationProperty struct { // `CfnTaskDefinition.ProxyConfigurationProperty.ContainerName`. ContainerName *string `json:"containerName"` // `CfnTaskDefinition.ProxyConfigurationProperty.ProxyConfigurationProperties`. ProxyConfigurationProperties interface{} `json:"proxyConfigurationProperties"` // `CfnTaskDefinition.ProxyConfigurationProperty.Type`. Type *string `json:"type"` }
TODO: EXAMPLE
type CfnTaskDefinition_RepositoryCredentialsProperty ¶
type CfnTaskDefinition_RepositoryCredentialsProperty struct { // `CfnTaskDefinition.RepositoryCredentialsProperty.CredentialsParameter`. CredentialsParameter *string `json:"credentialsParameter"` }
TODO: EXAMPLE
type CfnTaskDefinition_ResourceRequirementProperty ¶
type CfnTaskDefinition_ResourceRequirementProperty struct { // `CfnTaskDefinition.ResourceRequirementProperty.Type`. Type *string `json:"type"` // `CfnTaskDefinition.ResourceRequirementProperty.Value`. Value *string `json:"value"` }
TODO: EXAMPLE
type CfnTaskDefinition_RuntimePlatformProperty ¶
type CfnTaskDefinition_RuntimePlatformProperty struct { // `CfnTaskDefinition.RuntimePlatformProperty.CpuArchitecture`. CpuArchitecture *string `json:"cpuArchitecture"` // `CfnTaskDefinition.RuntimePlatformProperty.OperatingSystemFamily`. OperatingSystemFamily *string `json:"operatingSystemFamily"` }
TODO: EXAMPLE
type CfnTaskDefinition_SecretProperty ¶
type CfnTaskDefinition_SecretProperty struct { // `CfnTaskDefinition.SecretProperty.Name`. Name *string `json:"name"` // `CfnTaskDefinition.SecretProperty.ValueFrom`. ValueFrom *string `json:"valueFrom"` }
TODO: EXAMPLE
type CfnTaskDefinition_SystemControlProperty ¶
type CfnTaskDefinition_SystemControlProperty struct { // `CfnTaskDefinition.SystemControlProperty.Namespace`. Namespace *string `json:"namespace"` // `CfnTaskDefinition.SystemControlProperty.Value`. Value *string `json:"value"` }
TODO: EXAMPLE
type CfnTaskDefinition_TaskDefinitionPlacementConstraintProperty ¶
type CfnTaskDefinition_TaskDefinitionPlacementConstraintProperty struct { // `CfnTaskDefinition.TaskDefinitionPlacementConstraintProperty.Expression`. Expression *string `json:"expression"` // `CfnTaskDefinition.TaskDefinitionPlacementConstraintProperty.Type`. Type *string `json:"type"` }
TODO: EXAMPLE
type CfnTaskDefinition_TmpfsProperty ¶
type CfnTaskDefinition_TmpfsProperty struct { // `CfnTaskDefinition.TmpfsProperty.ContainerPath`. ContainerPath *string `json:"containerPath"` // `CfnTaskDefinition.TmpfsProperty.MountOptions`. MountOptions *[]*string `json:"mountOptions"` // `CfnTaskDefinition.TmpfsProperty.Size`. Size *float64 `json:"size"` }
TODO: EXAMPLE
type CfnTaskDefinition_UlimitProperty ¶
type CfnTaskDefinition_UlimitProperty struct { // `CfnTaskDefinition.UlimitProperty.HardLimit`. HardLimit *float64 `json:"hardLimit"` // `CfnTaskDefinition.UlimitProperty.Name`. Name *string `json:"name"` // `CfnTaskDefinition.UlimitProperty.SoftLimit`. SoftLimit *float64 `json:"softLimit"` }
TODO: EXAMPLE
type CfnTaskDefinition_VolumeFromProperty ¶
type CfnTaskDefinition_VolumeFromProperty struct { // `CfnTaskDefinition.VolumeFromProperty.ReadOnly`. ReadOnly interface{} `json:"readOnly"` // `CfnTaskDefinition.VolumeFromProperty.SourceContainer`. SourceContainer *string `json:"sourceContainer"` }
TODO: EXAMPLE
type CfnTaskDefinition_VolumeProperty ¶
type CfnTaskDefinition_VolumeProperty struct { // `CfnTaskDefinition.VolumeProperty.DockerVolumeConfiguration`. DockerVolumeConfiguration interface{} `json:"dockerVolumeConfiguration"` // `CfnTaskDefinition.VolumeProperty.EfsVolumeConfiguration`. EfsVolumeConfiguration interface{} `json:"efsVolumeConfiguration"` // `CfnTaskDefinition.VolumeProperty.Host`. Host interface{} `json:"host"` // `CfnTaskDefinition.VolumeProperty.Name`. Name *string `json:"name"` }
TODO: EXAMPLE
type CfnTaskSet ¶
type CfnTaskSet interface { awscdk.CfnResource awscdk.IInspectable AttrId() *string CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} CfnResourceType() *string Cluster() *string SetCluster(val *string) CreationStack() *[]*string ExternalId() *string SetExternalId(val *string) LaunchType() *string SetLaunchType(val *string) LoadBalancers() interface{} SetLoadBalancers(val interface{}) LogicalId() *string NetworkConfiguration() interface{} SetNetworkConfiguration(val interface{}) Node() constructs.Node PlatformVersion() *string SetPlatformVersion(val *string) Ref() *string Scale() interface{} SetScale(val interface{}) Service() *string SetService(val *string) ServiceRegistries() interface{} SetServiceRegistries(val interface{}) Stack() awscdk.Stack TaskDefinition() *string SetTaskDefinition(val *string) 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) OverrideLogicalId(newLogicalId *string) RenderProperties(props *map[string]interface{}) *map[string]interface{} ShouldSynthesize() *bool ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::ECS::TaskSet`.
TODO: EXAMPLE
func NewCfnTaskSet ¶
func NewCfnTaskSet(scope constructs.Construct, id *string, props *CfnTaskSetProps) CfnTaskSet
Create a new `AWS::ECS::TaskSet`.
type CfnTaskSetProps ¶
type CfnTaskSetProps struct { // `AWS::ECS::TaskSet.Cluster`. Cluster *string `json:"cluster"` // `AWS::ECS::TaskSet.ExternalId`. ExternalId *string `json:"externalId"` // `AWS::ECS::TaskSet.LaunchType`. LaunchType *string `json:"launchType"` // `AWS::ECS::TaskSet.LoadBalancers`. LoadBalancers interface{} `json:"loadBalancers"` // `AWS::ECS::TaskSet.NetworkConfiguration`. NetworkConfiguration interface{} `json:"networkConfiguration"` // `AWS::ECS::TaskSet.PlatformVersion`. PlatformVersion *string `json:"platformVersion"` // `AWS::ECS::TaskSet.Scale`. Scale interface{} `json:"scale"` // `AWS::ECS::TaskSet.Service`. Service *string `json:"service"` // `AWS::ECS::TaskSet.ServiceRegistries`. ServiceRegistries interface{} `json:"serviceRegistries"` // `AWS::ECS::TaskSet.TaskDefinition`. TaskDefinition *string `json:"taskDefinition"` }
Properties for defining a `AWS::ECS::TaskSet`.
TODO: EXAMPLE
type CfnTaskSet_AwsVpcConfigurationProperty ¶
type CfnTaskSet_AwsVpcConfigurationProperty struct { // `CfnTaskSet.AwsVpcConfigurationProperty.AssignPublicIp`. AssignPublicIp *string `json:"assignPublicIp"` // `CfnTaskSet.AwsVpcConfigurationProperty.SecurityGroups`. SecurityGroups *[]*string `json:"securityGroups"` // `CfnTaskSet.AwsVpcConfigurationProperty.Subnets`. Subnets *[]*string `json:"subnets"` }
TODO: EXAMPLE
type CfnTaskSet_LoadBalancerProperty ¶
type CfnTaskSet_LoadBalancerProperty struct { // `CfnTaskSet.LoadBalancerProperty.ContainerName`. ContainerName *string `json:"containerName"` // `CfnTaskSet.LoadBalancerProperty.ContainerPort`. ContainerPort *float64 `json:"containerPort"` // `CfnTaskSet.LoadBalancerProperty.LoadBalancerName`. LoadBalancerName *string `json:"loadBalancerName"` // `CfnTaskSet.LoadBalancerProperty.TargetGroupArn`. TargetGroupArn *string `json:"targetGroupArn"` }
TODO: EXAMPLE
type CfnTaskSet_NetworkConfigurationProperty ¶
type CfnTaskSet_NetworkConfigurationProperty struct {
// `CfnTaskSet.NetworkConfigurationProperty.AwsVpcConfiguration`.
AwsVpcConfiguration interface{} `json:"awsVpcConfiguration"`
}
TODO: EXAMPLE
type CfnTaskSet_ScaleProperty ¶
type CfnTaskSet_ScaleProperty struct { // `CfnTaskSet.ScaleProperty.Unit`. Unit *string `json:"unit"` // `CfnTaskSet.ScaleProperty.Value`. Value *float64 `json:"value"` }
TODO: EXAMPLE
type CfnTaskSet_ServiceRegistryProperty ¶
type CfnTaskSet_ServiceRegistryProperty struct { // `CfnTaskSet.ServiceRegistryProperty.ContainerName`. ContainerName *string `json:"containerName"` // `CfnTaskSet.ServiceRegistryProperty.ContainerPort`. ContainerPort *float64 `json:"containerPort"` // `CfnTaskSet.ServiceRegistryProperty.Port`. Port *float64 `json:"port"` // `CfnTaskSet.ServiceRegistryProperty.RegistryArn`. RegistryArn *string `json:"registryArn"` }
TODO: EXAMPLE
type CloudMapNamespaceOptions ¶
type CloudMapNamespaceOptions struct { // The name of the namespace, such as example.com. // Experimental. Name *string `json:"name"` // The type of CloudMap Namespace to create. // Experimental. Type awsservicediscovery.NamespaceType `json:"type"` // The VPC to associate the namespace with. // // This property is required for private DNS namespaces. // Experimental. Vpc awsec2.IVpc `json:"vpc"` }
The options for creating an AWS Cloud Map namespace.
TODO: EXAMPLE
Experimental.
type CloudMapOptions ¶
type CloudMapOptions struct { // The service discovery namespace for the Cloud Map service to attach to the ECS service. // Experimental. CloudMapNamespace awsservicediscovery.INamespace `json:"cloudMapNamespace"` // The container to point to for a SRV record. // Experimental. Container ContainerDefinition `json:"container"` // The port to point to for a SRV record. // Experimental. ContainerPort *float64 `json:"containerPort"` // The DNS record type that you want AWS Cloud Map to create. // // The supported record types are A or SRV. // Experimental. DnsRecordType awsservicediscovery.DnsRecordType `json:"dnsRecordType"` // The amount of time that you want DNS resolvers to cache the settings for this record. // Experimental. DnsTtl awscdk.Duration `json:"dnsTtl"` // The number of 30-second intervals that you want Cloud Map to wait after receiving an UpdateInstanceCustomHealthStatus request before it changes the health status of a service instance. // // NOTE: This is used for HealthCheckCustomConfig // Experimental. FailureThreshold *float64 `json:"failureThreshold"` // The name of the Cloud Map service to attach to the ECS service. // Experimental. Name *string `json:"name"` }
The options to enabling AWS Cloud Map for an Amazon ECS service.
TODO: EXAMPLE
Experimental.
type Cluster ¶
type Cluster interface { awscdk.Resource ICluster AutoscalingGroup() awsautoscaling.IAutoScalingGroup ClusterArn() *string ClusterName() *string Connections() awsec2.Connections DefaultCloudMapNamespace() awsservicediscovery.INamespace Env() *awscdk.ResourceEnvironment ExecuteCommandConfiguration() *ExecuteCommandConfiguration HasEc2Capacity() *bool Node() constructs.Node PhysicalName() *string Stack() awscdk.Stack Vpc() awsec2.IVpc AddAsgCapacityProvider(provider AsgCapacityProvider, options *AddAutoScalingGroupCapacityOptions) AddAutoScalingGroup(autoScalingGroup awsautoscaling.AutoScalingGroup, options *AddAutoScalingGroupCapacityOptions) AddCapacity(id *string, options *AddCapacityOptions) awsautoscaling.AutoScalingGroup AddCapacityProvider(provider *string) AddDefaultCloudMapNamespace(options *CloudMapNamespaceOptions) awsservicediscovery.INamespace ApplyRemovalPolicy(policy awscdk.RemovalPolicy) EnableFargateCapacityProviders() GeneratePhysicalName() *string GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string GetResourceNameAttribute(nameAttr *string) *string Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricCpuReservation(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricCpuUtilization(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricMemoryReservation(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricMemoryUtilization(props *awscloudwatch.MetricOptions) awscloudwatch.Metric ToString() *string }
A regional grouping of one or more container instances on which you can run tasks and services.
TODO: EXAMPLE
Experimental.
func NewCluster ¶
func NewCluster(scope constructs.Construct, id *string, props *ClusterProps) Cluster
Constructs a new instance of the Cluster class. Experimental.
type ClusterAttributes ¶
type ClusterAttributes struct { // Autoscaling group added to the cluster if capacity is added. // Experimental. AutoscalingGroup awsautoscaling.IAutoScalingGroup `json:"autoscalingGroup"` // The Amazon Resource Name (ARN) that identifies the cluster. // Experimental. ClusterArn *string `json:"clusterArn"` // The name of the cluster. // Experimental. ClusterName *string `json:"clusterName"` // The AWS Cloud Map namespace to associate with the cluster. // Experimental. DefaultCloudMapNamespace awsservicediscovery.INamespace `json:"defaultCloudMapNamespace"` // The execute command configuration for the cluster. // Experimental. ExecuteCommandConfiguration *ExecuteCommandConfiguration `json:"executeCommandConfiguration"` // Specifies whether the cluster has EC2 instance capacity. // Experimental. HasEc2Capacity *bool `json:"hasEc2Capacity"` // The security groups associated with the container instances registered to the cluster. // Experimental. SecurityGroups *[]awsec2.ISecurityGroup `json:"securityGroups"` // The VPC associated with the cluster. // Experimental. Vpc awsec2.IVpc `json:"vpc"` }
The properties to import from the ECS cluster.
TODO: EXAMPLE
Experimental.
type ClusterProps ¶
type ClusterProps struct { // The ec2 capacity to add to the cluster. // Experimental. Capacity *AddCapacityOptions `json:"capacity"` // The capacity providers to add to the cluster. // Deprecated: Use {@link ClusterProps.enableFargateCapacityProviders} instead. CapacityProviders *[]*string `json:"capacityProviders"` // The name for the cluster. // Experimental. ClusterName *string `json:"clusterName"` // If true CloudWatch Container Insights will be enabled for the cluster. // Experimental. ContainerInsights *bool `json:"containerInsights"` // The service discovery namespace created in this cluster. // Experimental. DefaultCloudMapNamespace *CloudMapNamespaceOptions `json:"defaultCloudMapNamespace"` // Whether to enable Fargate Capacity Providers. // Experimental. EnableFargateCapacityProviders *bool `json:"enableFargateCapacityProviders"` // The execute command configuration for the cluster. // Experimental. ExecuteCommandConfiguration *ExecuteCommandConfiguration `json:"executeCommandConfiguration"` // The VPC where your ECS instances will be running or your ENIs will be deployed. // Experimental. Vpc awsec2.IVpc `json:"vpc"` }
The properties used to define an ECS cluster.
TODO: EXAMPLE
Experimental.
type CommonTaskDefinitionAttributes ¶
type CommonTaskDefinitionAttributes struct { // The networking mode to use for the containers in the task. // Experimental. NetworkMode NetworkMode `json:"networkMode"` // The arn of the task definition. // Experimental. TaskDefinitionArn *string `json:"taskDefinitionArn"` // The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf. // Experimental. TaskRole awsiam.IRole `json:"taskRole"` }
The common task definition attributes used across all types of task definitions.
TODO: EXAMPLE
Experimental.
type CommonTaskDefinitionProps ¶
type CommonTaskDefinitionProps struct { // The name of the IAM task execution role that grants the ECS agent permission to call AWS APIs on your behalf. // // The role will be used to retrieve container images from ECR and create CloudWatch log groups. // Experimental. ExecutionRole awsiam.IRole `json:"executionRole"` // The name of a family that this task definition is registered to. // // A family groups multiple versions of a task definition. // Experimental. Family *string `json:"family"` // The configuration details for the App Mesh proxy. // Experimental. ProxyConfiguration ProxyConfiguration `json:"proxyConfiguration"` // The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf. // Experimental. TaskRole awsiam.IRole `json:"taskRole"` // The list of volume definitions for the task. // // For more information, see // [Task Definition Parameter Volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide//task_definition_parameters.html#volumes). // Experimental. Volumes *[]*Volume `json:"volumes"` }
The common properties for all task definitions.
For more information, see [Task Definition Parameters](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html).
TODO: EXAMPLE
Experimental.
type Compatibility ¶
type Compatibility string
The task launch type compatibility requirement.
TODO: EXAMPLE
Experimental.
const ( Compatibility_EC2 Compatibility = "EC2" Compatibility_EC2_AND_FARGATE Compatibility = "EC2_AND_FARGATE" Compatibility_EXTERNAL Compatibility = "EXTERNAL" Compatibility_FARGATE Compatibility = "FARGATE" )
type ContainerDefinition ¶
type ContainerDefinition interface { constructs.Construct ContainerDependencies() *[]*ContainerDependency ContainerName() *string ContainerPort() *float64 EnvironmentFiles() *[]*EnvironmentFileConfig Essential() *bool IngressPort() *float64 LinuxParameters() LinuxParameters LogDriverConfig() *LogDriverConfig MemoryLimitSpecified() *bool MountPoints() *[]*MountPoint Node() constructs.Node PortMappings() *[]*PortMapping ReferencesSecretJsonField() *bool TaskDefinition() TaskDefinition Ulimits() *[]*Ulimit VolumesFrom() *[]*VolumeFrom AddContainerDependencies(containerDependencies ...*ContainerDependency) AddInferenceAcceleratorResource(inferenceAcceleratorResources ...*string) AddLink(container ContainerDefinition, alias *string) AddMountPoints(mountPoints ...*MountPoint) AddPortMappings(portMappings ...*PortMapping) AddScratch(scratch *ScratchSpace) AddToExecutionPolicy(statement awsiam.PolicyStatement) AddUlimits(ulimits ...*Ulimit) AddVolumesFrom(volumesFrom ...*VolumeFrom) FindPortMapping(containerPort *float64, protocol Protocol) *PortMapping RenderContainerDefinition(_taskDefinition TaskDefinition) *CfnTaskDefinition_ContainerDefinitionProperty ToString() *string }
A container definition is used in a task definition to describe the containers that are launched as part of a task.
TODO: EXAMPLE
Experimental.
func NewContainerDefinition ¶
func NewContainerDefinition(scope constructs.Construct, id *string, props *ContainerDefinitionProps) ContainerDefinition
Constructs a new instance of the ContainerDefinition class. Experimental.
type ContainerDefinitionOptions ¶
type ContainerDefinitionOptions struct { // The command that is passed to the container. // // If you provide a shell command as a single string, you have to quote command-line arguments. // Experimental. Command *[]*string `json:"command"` // The name of the container. // Experimental. ContainerName *string `json:"containerName"` // The minimum number of CPU units to reserve for the container. // Experimental. Cpu *float64 `json:"cpu"` // Specifies whether networking is disabled within the container. // // When this parameter is true, networking is disabled within the container. // Experimental. DisableNetworking *bool `json:"disableNetworking"` // A list of DNS search domains that are presented to the container. // Experimental. DnsSearchDomains *[]*string `json:"dnsSearchDomains"` // A list of DNS servers that are presented to the container. // Experimental. DnsServers *[]*string `json:"dnsServers"` // A key/value map of labels to add to the container. // Experimental. DockerLabels *map[string]*string `json:"dockerLabels"` // A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. // Experimental. DockerSecurityOptions *[]*string `json:"dockerSecurityOptions"` // The ENTRYPOINT value to pass to the container. // See: https://docs.docker.com/engine/reference/builder/#entrypoint // // Experimental. EntryPoint *[]*string `json:"entryPoint"` // The environment variables to pass to the container. // Experimental. Environment *map[string]*string `json:"environment"` // The environment files to pass to the container. // See: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html // // Experimental. EnvironmentFiles *[]EnvironmentFile `json:"environmentFiles"` // Specifies whether the container is marked essential. // // If the essential parameter of a container is marked as true, and that container fails // or stops for any reason, all other containers that are part of the task are stopped. // If the essential parameter of a container is marked as false, then its failure does not // affect the rest of the containers in a task. All tasks must have at least one essential container. // // If this parameter is omitted, a container is assumed to be essential. // Experimental. Essential *bool `json:"essential"` // A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. // Experimental. ExtraHosts *map[string]*string `json:"extraHosts"` // The number of GPUs assigned to the container. // Experimental. GpuCount *float64 `json:"gpuCount"` // The health check command and associated configuration parameters for the container. // Experimental. HealthCheck *HealthCheck `json:"healthCheck"` // The hostname to use for your container. // Experimental. Hostname *string `json:"hostname"` // The image used to start a container. // // This string is passed directly to the Docker daemon. // Images in the Docker Hub registry are available by default. // Other repositories are specified with either repository-url/image:tag or repository-url/image@digest. // TODO: Update these to specify using classes of IContainerImage // Experimental. Image ContainerImage `json:"image"` // The inference accelerators referenced by the container. // Experimental. InferenceAcceleratorResources *[]*string `json:"inferenceAcceleratorResources"` // Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. // // For more information see [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html). // Experimental. LinuxParameters LinuxParameters `json:"linuxParameters"` // The log configuration specification for the container. // Experimental. Logging LogDriver `json:"logging"` // The amount (in MiB) of memory to present to the container. // // If your container attempts to exceed the allocated memory, the container // is terminated. // // At least one of memoryLimitMiB and memoryReservationMiB is required for non-Fargate services. // Experimental. MemoryLimitMiB *float64 `json:"memoryLimitMiB"` // The soft limit (in MiB) of memory to reserve for the container. // // When system memory is under heavy contention, Docker attempts to keep the // container memory to this soft limit. However, your container can consume more // memory when it needs to, up to either the hard limit specified with the memory // parameter (if applicable), or all of the available memory on the container // instance, whichever comes first. // // At least one of memoryLimitMiB and memoryReservationMiB is required for non-Fargate services. // Experimental. MemoryReservationMiB *float64 `json:"memoryReservationMiB"` // The port mappings to add to the container definition. // Experimental. PortMappings *[]*PortMapping `json:"portMappings"` // Specifies whether the container is marked as privileged. // // When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). // Experimental. Privileged *bool `json:"privileged"` // When this parameter is true, the container is given read-only access to its root file system. // Experimental. ReadonlyRootFilesystem *bool `json:"readonlyRootFilesystem"` // The secret environment variables to pass to the container. // Experimental. Secrets *map[string]Secret `json:"secrets"` // Time duration (in seconds) to wait before giving up on resolving dependencies for a container. // Experimental. StartTimeout awscdk.Duration `json:"startTimeout"` // Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own. // Experimental. StopTimeout awscdk.Duration `json:"stopTimeout"` // A list of namespaced kernel parameters to set in the container. // See: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#container_definition_systemcontrols // // Experimental. SystemControls *[]*SystemControl `json:"systemControls"` // The user name to use inside the container. // Experimental. User *string `json:"user"` // The working directory in which to run commands inside the container. // Experimental. WorkingDirectory *string `json:"workingDirectory"` }
TODO: EXAMPLE
Experimental.
type ContainerDefinitionProps ¶
type ContainerDefinitionProps struct { // The command that is passed to the container. // // If you provide a shell command as a single string, you have to quote command-line arguments. // Experimental. Command *[]*string `json:"command"` // The name of the container. // Experimental. ContainerName *string `json:"containerName"` // The minimum number of CPU units to reserve for the container. // Experimental. Cpu *float64 `json:"cpu"` // Specifies whether networking is disabled within the container. // // When this parameter is true, networking is disabled within the container. // Experimental. DisableNetworking *bool `json:"disableNetworking"` // A list of DNS search domains that are presented to the container. // Experimental. DnsSearchDomains *[]*string `json:"dnsSearchDomains"` // A list of DNS servers that are presented to the container. // Experimental. DnsServers *[]*string `json:"dnsServers"` // A key/value map of labels to add to the container. // Experimental. DockerLabels *map[string]*string `json:"dockerLabels"` // A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. // Experimental. DockerSecurityOptions *[]*string `json:"dockerSecurityOptions"` // The ENTRYPOINT value to pass to the container. // See: https://docs.docker.com/engine/reference/builder/#entrypoint // // Experimental. EntryPoint *[]*string `json:"entryPoint"` // The environment variables to pass to the container. // Experimental. Environment *map[string]*string `json:"environment"` // The environment files to pass to the container. // See: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html // // Experimental. EnvironmentFiles *[]EnvironmentFile `json:"environmentFiles"` // Specifies whether the container is marked essential. // // If the essential parameter of a container is marked as true, and that container fails // or stops for any reason, all other containers that are part of the task are stopped. // If the essential parameter of a container is marked as false, then its failure does not // affect the rest of the containers in a task. All tasks must have at least one essential container. // // If this parameter is omitted, a container is assumed to be essential. // Experimental. Essential *bool `json:"essential"` // A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. // Experimental. ExtraHosts *map[string]*string `json:"extraHosts"` // The number of GPUs assigned to the container. // Experimental. GpuCount *float64 `json:"gpuCount"` // The health check command and associated configuration parameters for the container. // Experimental. HealthCheck *HealthCheck `json:"healthCheck"` // The hostname to use for your container. // Experimental. Hostname *string `json:"hostname"` // The image used to start a container. // // This string is passed directly to the Docker daemon. // Images in the Docker Hub registry are available by default. // Other repositories are specified with either repository-url/image:tag or repository-url/image@digest. // TODO: Update these to specify using classes of IContainerImage // Experimental. Image ContainerImage `json:"image"` // The inference accelerators referenced by the container. // Experimental. InferenceAcceleratorResources *[]*string `json:"inferenceAcceleratorResources"` // Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. // // For more information see [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html). // Experimental. LinuxParameters LinuxParameters `json:"linuxParameters"` // The log configuration specification for the container. // Experimental. Logging LogDriver `json:"logging"` // The amount (in MiB) of memory to present to the container. // // If your container attempts to exceed the allocated memory, the container // is terminated. // // At least one of memoryLimitMiB and memoryReservationMiB is required for non-Fargate services. // Experimental. MemoryLimitMiB *float64 `json:"memoryLimitMiB"` // The soft limit (in MiB) of memory to reserve for the container. // // When system memory is under heavy contention, Docker attempts to keep the // container memory to this soft limit. However, your container can consume more // memory when it needs to, up to either the hard limit specified with the memory // parameter (if applicable), or all of the available memory on the container // instance, whichever comes first. // // At least one of memoryLimitMiB and memoryReservationMiB is required for non-Fargate services. // Experimental. MemoryReservationMiB *float64 `json:"memoryReservationMiB"` // The port mappings to add to the container definition. // Experimental. PortMappings *[]*PortMapping `json:"portMappings"` // Specifies whether the container is marked as privileged. // // When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). // Experimental. Privileged *bool `json:"privileged"` // When this parameter is true, the container is given read-only access to its root file system. // Experimental. ReadonlyRootFilesystem *bool `json:"readonlyRootFilesystem"` // The secret environment variables to pass to the container. // Experimental. Secrets *map[string]Secret `json:"secrets"` // Time duration (in seconds) to wait before giving up on resolving dependencies for a container. // Experimental. StartTimeout awscdk.Duration `json:"startTimeout"` // Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own. // Experimental. StopTimeout awscdk.Duration `json:"stopTimeout"` // A list of namespaced kernel parameters to set in the container. // See: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#container_definition_systemcontrols // // Experimental. SystemControls *[]*SystemControl `json:"systemControls"` // The user name to use inside the container. // Experimental. User *string `json:"user"` // The working directory in which to run commands inside the container. // Experimental. WorkingDirectory *string `json:"workingDirectory"` // The name of the task definition that includes this container definition. // // [disable-awslint:ref-via-interface] // Experimental. TaskDefinition TaskDefinition `json:"taskDefinition"` }
The properties in a container definition.
TODO: EXAMPLE
Experimental.
type ContainerDependency ¶
type ContainerDependency struct { // The state the container needs to be in to satisfy the dependency and proceed with startup. // // Valid values are ContainerDependencyCondition.START, ContainerDependencyCondition.COMPLETE, // ContainerDependencyCondition.SUCCESS and ContainerDependencyCondition.HEALTHY. // Experimental. Condition ContainerDependencyCondition `json:"condition"` // The container to depend on. // Experimental. Container ContainerDefinition `json:"container"` }
The details of a dependency on another container in the task definition.
TODO: EXAMPLE
See: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDependency.html
Experimental.
type ContainerDependencyCondition ¶
type ContainerDependencyCondition string
Experimental.
const ( ContainerDependencyCondition_COMPLETE ContainerDependencyCondition = "COMPLETE" ContainerDependencyCondition_HEALTHY ContainerDependencyCondition = "HEALTHY" ContainerDependencyCondition_START ContainerDependencyCondition = "START" ContainerDependencyCondition_SUCCESS ContainerDependencyCondition = "SUCCESS" )
type ContainerImage ¶
type ContainerImage interface {
Bind(scope constructs.Construct, containerDefinition ContainerDefinition) *ContainerImageConfig
}
Constructs for types of container images.
TODO: EXAMPLE
Experimental.
func AssetImage_FromDockerImageAsset ¶
func AssetImage_FromDockerImageAsset(asset awsecrassets.DockerImageAsset) ContainerImage
Use an existing `DockerImageAsset` for this container image. Experimental.
func AssetImage_FromTarball ¶
func AssetImage_FromTarball(tarballFile *string) ContainerImage
Use an existing tarball for this container image.
Use this method if the container image has already been created by another process (e.g. jib) and you want to add it as a container image asset. Experimental.
func ContainerImage_FromDockerImageAsset ¶
func ContainerImage_FromDockerImageAsset(asset awsecrassets.DockerImageAsset) ContainerImage
Use an existing `DockerImageAsset` for this container image. Experimental.
func ContainerImage_FromTarball ¶
func ContainerImage_FromTarball(tarballFile *string) ContainerImage
Use an existing tarball for this container image.
Use this method if the container image has already been created by another process (e.g. jib) and you want to add it as a container image asset. Experimental.
func EcrImage_FromDockerImageAsset ¶
func EcrImage_FromDockerImageAsset(asset awsecrassets.DockerImageAsset) ContainerImage
Use an existing `DockerImageAsset` for this container image. Experimental.
func EcrImage_FromTarball ¶
func EcrImage_FromTarball(tarballFile *string) ContainerImage
Use an existing tarball for this container image.
Use this method if the container image has already been created by another process (e.g. jib) and you want to add it as a container image asset. Experimental.
func RepositoryImage_FromDockerImageAsset ¶
func RepositoryImage_FromDockerImageAsset(asset awsecrassets.DockerImageAsset) ContainerImage
Use an existing `DockerImageAsset` for this container image. Experimental.
func RepositoryImage_FromTarball ¶
func RepositoryImage_FromTarball(tarballFile *string) ContainerImage
Use an existing tarball for this container image.
Use this method if the container image has already been created by another process (e.g. jib) and you want to add it as a container image asset. Experimental.
func TagParameterContainerImage_FromDockerImageAsset ¶
func TagParameterContainerImage_FromDockerImageAsset(asset awsecrassets.DockerImageAsset) ContainerImage
Use an existing `DockerImageAsset` for this container image. Experimental.
func TagParameterContainerImage_FromTarball ¶
func TagParameterContainerImage_FromTarball(tarballFile *string) ContainerImage
Use an existing tarball for this container image.
Use this method if the container image has already been created by another process (e.g. jib) and you want to add it as a container image asset. Experimental.
type ContainerImageConfig ¶
type ContainerImageConfig struct { // Specifies the name of the container image. // Experimental. ImageName *string `json:"imageName"` // Specifies the credentials used to access the image repository. // Experimental. RepositoryCredentials *CfnTaskDefinition_RepositoryCredentialsProperty `json:"repositoryCredentials"` }
The configuration for creating a container image.
TODO: EXAMPLE
Experimental.
type CpuUtilizationScalingProps ¶
type CpuUtilizationScalingProps struct { // Indicates whether scale in by the target tracking policy is disabled. // // If the value is true, scale in is disabled and the target tracking policy // won't remove capacity from the scalable resource. Otherwise, scale in is // enabled and the target tracking policy can remove capacity from the // scalable resource. // Experimental. DisableScaleIn *bool `json:"disableScaleIn"` // A name for the scaling policy. // Experimental. PolicyName *string `json:"policyName"` // Period after a scale in activity completes before another scale in activity can start. // Experimental. ScaleInCooldown awscdk.Duration `json:"scaleInCooldown"` // Period after a scale out activity completes before another scale out activity can start. // Experimental. ScaleOutCooldown awscdk.Duration `json:"scaleOutCooldown"` // The target value for CPU utilization across all tasks in the service. // Experimental. TargetUtilizationPercent *float64 `json:"targetUtilizationPercent"` }
The properties for enabling scaling based on CPU utilization.
TODO: EXAMPLE
Experimental.
type DeploymentCircuitBreaker ¶
type DeploymentCircuitBreaker struct { // Whether to enable rollback on deployment failure. // Experimental. Rollback *bool `json:"rollback"` }
The deployment circuit breaker to use for the service.
TODO: EXAMPLE
Experimental.
type DeploymentController ¶
type DeploymentController struct { // The deployment controller type to use. // Experimental. Type DeploymentControllerType `json:"type"` }
The deployment controller to use for the service.
TODO: EXAMPLE
Experimental.
type DeploymentControllerType ¶
type DeploymentControllerType string
The deployment controller type to use for the service.
TODO: EXAMPLE
Experimental.
const ( DeploymentControllerType_CODE_DEPLOY DeploymentControllerType = "CODE_DEPLOY" DeploymentControllerType_ECS DeploymentControllerType = "ECS" DeploymentControllerType_EXTERNAL DeploymentControllerType = "EXTERNAL" )
type Device ¶
type Device struct { // The path inside the container at which to expose the host device. // Experimental. ContainerPath *string `json:"containerPath"` // The path for the device on the host container instance. // Experimental. HostPath *string `json:"hostPath"` // The explicit permissions to provide to the container for the device. // // By default, the container has permissions for read, write, and mknod for the device. // Experimental. Permissions *[]DevicePermission `json:"permissions"` }
A container instance host device.
TODO: EXAMPLE
Experimental.
type DevicePermission ¶
type DevicePermission string
Permissions for device access. Experimental.
const ( DevicePermission_MKNOD DevicePermission = "MKNOD" DevicePermission_READ DevicePermission = "READ" DevicePermission_WRITE DevicePermission = "WRITE" )
type DockerVolumeConfiguration ¶
type DockerVolumeConfiguration struct { // Specifies whether the Docker volume should be created if it does not already exist. // // If true is specified, the Docker volume will be created for you. // Experimental. Autoprovision *bool `json:"autoprovision"` // The Docker volume driver to use. // Experimental. Driver *string `json:"driver"` // A map of Docker driver-specific options passed through. // Experimental. DriverOpts *map[string]*string `json:"driverOpts"` // Custom metadata to add to your Docker volume. // Experimental. Labels *map[string]*string `json:"labels"` // The scope for the Docker volume that determines its lifecycle. // Experimental. Scope Scope `json:"scope"` }
The configuration for a Docker volume.
Docker volumes are only supported when you are using the EC2 launch type.
TODO: EXAMPLE
Experimental.
type Ec2Service ¶
type Ec2Service interface { BaseService IEc2Service CloudmapService() awsservicediscovery.Service SetCloudmapService(val awsservicediscovery.Service) CloudMapService() awsservicediscovery.IService Cluster() ICluster Connections() awsec2.Connections Env() *awscdk.ResourceEnvironment LoadBalancers() *[]*CfnService_LoadBalancerProperty SetLoadBalancers(val *[]*CfnService_LoadBalancerProperty) NetworkConfiguration() *CfnService_NetworkConfigurationProperty SetNetworkConfiguration(val *CfnService_NetworkConfigurationProperty) Node() constructs.Node PhysicalName() *string ServiceArn() *string ServiceName() *string ServiceRegistries() *[]*CfnService_ServiceRegistryProperty SetServiceRegistries(val *[]*CfnService_ServiceRegistryProperty) Stack() awscdk.Stack TaskDefinition() TaskDefinition AddPlacementConstraints(constraints ...PlacementConstraint) AddPlacementStrategies(strategies ...PlacementStrategy) ApplyRemovalPolicy(policy awscdk.RemovalPolicy) AssociateCloudMapService(options *AssociateCloudMapServiceOptions) AttachToApplicationTargetGroup(targetGroup awselasticloadbalancingv2.IApplicationTargetGroup) *awselasticloadbalancingv2.LoadBalancerTargetProps AttachToClassicLB(loadBalancer awselasticloadbalancing.LoadBalancer) AttachToNetworkTargetGroup(targetGroup awselasticloadbalancingv2.INetworkTargetGroup) *awselasticloadbalancingv2.LoadBalancerTargetProps AutoScaleTaskCount(props *awsapplicationautoscaling.EnableScalingProps) ScalableTaskCount ConfigureAwsVpcNetworking(vpc awsec2.IVpc, assignPublicIp *bool, vpcSubnets *awsec2.SubnetSelection, securityGroup awsec2.ISecurityGroup) ConfigureAwsVpcNetworkingWithSecurityGroups(vpc awsec2.IVpc, assignPublicIp *bool, vpcSubnets *awsec2.SubnetSelection, securityGroups *[]awsec2.ISecurityGroup) EnableCloudMap(options *CloudMapOptions) awsservicediscovery.Service GeneratePhysicalName() *string GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string GetResourceNameAttribute(nameAttr *string) *string LoadBalancerTarget(options *LoadBalancerTargetOptions) IEcsLoadBalancerTarget Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricCpuUtilization(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricMemoryUtilization(props *awscloudwatch.MetricOptions) awscloudwatch.Metric RegisterLoadBalancerTargets(targets ...*EcsTarget) ToString() *string }
This creates a service using the EC2 launch type on an ECS cluster.
TODO: EXAMPLE
Experimental.
func NewEc2Service ¶
func NewEc2Service(scope constructs.Construct, id *string, props *Ec2ServiceProps) Ec2Service
Constructs a new instance of the Ec2Service class. Experimental.
type Ec2ServiceAttributes ¶
type Ec2ServiceAttributes struct { // The cluster that hosts the service. // Experimental. Cluster ICluster `json:"cluster"` // The service ARN. // Experimental. ServiceArn *string `json:"serviceArn"` // The name of the service. // Experimental. ServiceName *string `json:"serviceName"` }
The properties to import from the service using the EC2 launch type.
TODO: EXAMPLE
Experimental.
type Ec2ServiceProps ¶
type Ec2ServiceProps struct { // A list of Capacity Provider strategies used to place a service. // Experimental. CapacityProviderStrategies *[]*CapacityProviderStrategy `json:"capacityProviderStrategies"` // Whether to enable the deployment circuit breaker. // // If this property is defined, circuit breaker will be implicitly // enabled. // Experimental. CircuitBreaker *DeploymentCircuitBreaker `json:"circuitBreaker"` // The options for configuring an Amazon ECS service to use service discovery. // Experimental. CloudMapOptions *CloudMapOptions `json:"cloudMapOptions"` // The name of the cluster that hosts the service. // Experimental. Cluster ICluster `json:"cluster"` // Specifies which deployment controller to use for the service. // // For more information, see // [Amazon ECS Deployment Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) // Experimental. DeploymentController *DeploymentController `json:"deploymentController"` // The desired number of instantiations of the task definition to keep running on the service. // Experimental. DesiredCount *float64 `json:"desiredCount"` // Specifies whether to enable Amazon ECS managed tags for the tasks within the service. // // For more information, see // [Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) // Experimental. EnableECSManagedTags *bool `json:"enableECSManagedTags"` // Whether to enable the ability to execute into a container. // Experimental. EnableExecuteCommand *bool `json:"enableExecuteCommand"` // The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. // Experimental. HealthCheckGracePeriod awscdk.Duration `json:"healthCheckGracePeriod"` // The maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment. // Experimental. MaxHealthyPercent *float64 `json:"maxHealthyPercent"` // The minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment. // Experimental. MinHealthyPercent *float64 `json:"minHealthyPercent"` // Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. // // Valid values are: PropagatedTagSource.SERVICE, PropagatedTagSource.TASK_DEFINITION or PropagatedTagSource.NONE // Experimental. PropagateTags PropagatedTagSource `json:"propagateTags"` // Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. // // Tags can only be propagated to the tasks within the service during service creation. // Deprecated: Use `propagateTags` instead. PropagateTaskTagsFrom PropagatedTagSource `json:"propagateTaskTagsFrom"` // The name of the service. // Experimental. ServiceName *string `json:"serviceName"` // The task definition to use for tasks in the service. // // [disable-awslint:ref-via-interface] // Experimental. TaskDefinition TaskDefinition `json:"taskDefinition"` // Specifies whether the task's elastic network interface receives a public IP address. // // If true, each task will receive a public IP address. // // This property is only used for tasks that use the awsvpc network mode. // Experimental. AssignPublicIp *bool `json:"assignPublicIp"` // Specifies whether the service will use the daemon scheduling strategy. // // If true, the service scheduler deploys exactly one task on each container instance in your cluster. // // When you are using this strategy, do not specify a desired number of tasks orany task placement strategies. // Experimental. Daemon *bool `json:"daemon"` // The placement constraints to use for tasks in the service. // // For more information, see // [Amazon ECS Task Placement Constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html). // Experimental. PlacementConstraints *[]PlacementConstraint `json:"placementConstraints"` // The placement strategies to use for tasks in the service. // // For more information, see // [Amazon ECS Task Placement Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html). // Experimental. PlacementStrategies *[]PlacementStrategy `json:"placementStrategies"` // The security groups to associate with the service. // // If you do not specify a security group, a new security group is created. // // This property is only used for tasks that use the awsvpc network mode. // Deprecated: use securityGroups instead. SecurityGroup awsec2.ISecurityGroup `json:"securityGroup"` // The security groups to associate with the service. // // If you do not specify a security group, a new security group is created. // // This property is only used for tasks that use the awsvpc network mode. // Experimental. SecurityGroups *[]awsec2.ISecurityGroup `json:"securityGroups"` // The subnets to associate with the service. // // This property is only used for tasks that use the awsvpc network mode. // Experimental. VpcSubnets *awsec2.SubnetSelection `json:"vpcSubnets"` }
The properties for defining a service using the EC2 launch type.
TODO: EXAMPLE
Experimental.
type Ec2TaskDefinition ¶
type Ec2TaskDefinition interface { TaskDefinition IEc2TaskDefinition Compatibility() Compatibility Containers() *[]ContainerDefinition DefaultContainer() ContainerDefinition SetDefaultContainer(val ContainerDefinition) Env() *awscdk.ResourceEnvironment EphemeralStorageGiB() *float64 ExecutionRole() awsiam.IRole Family() *string InferenceAccelerators() *[]*InferenceAccelerator IsEc2Compatible() *bool IsExternalCompatible() *bool IsFargateCompatible() *bool NetworkMode() NetworkMode Node() constructs.Node PhysicalName() *string ReferencesSecretJsonField() *bool Stack() awscdk.Stack TaskDefinitionArn() *string TaskRole() awsiam.IRole AddContainer(id *string, props *ContainerDefinitionOptions) ContainerDefinition AddExtension(extension ITaskDefinitionExtension) AddFirelensLogRouter(id *string, props *FirelensLogRouterDefinitionOptions) FirelensLogRouter AddInferenceAccelerator(inferenceAccelerator *InferenceAccelerator) AddPlacementConstraint(constraint PlacementConstraint) AddToExecutionRolePolicy(statement awsiam.PolicyStatement) AddToTaskRolePolicy(statement awsiam.PolicyStatement) AddVolume(volume *Volume) ApplyRemovalPolicy(policy awscdk.RemovalPolicy) FindContainer(containerName *string) ContainerDefinition GeneratePhysicalName() *string GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string GetResourceNameAttribute(nameAttr *string) *string ObtainExecutionRole() awsiam.IRole ToString() *string }
The details of a task definition run on an EC2 cluster.
TODO: EXAMPLE
Experimental.
func NewEc2TaskDefinition ¶
func NewEc2TaskDefinition(scope constructs.Construct, id *string, props *Ec2TaskDefinitionProps) Ec2TaskDefinition
Constructs a new instance of the Ec2TaskDefinition class. Experimental.
type Ec2TaskDefinitionAttributes ¶
type Ec2TaskDefinitionAttributes struct { // The networking mode to use for the containers in the task. // Experimental. NetworkMode NetworkMode `json:"networkMode"` // The arn of the task definition. // Experimental. TaskDefinitionArn *string `json:"taskDefinitionArn"` // The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf. // Experimental. TaskRole awsiam.IRole `json:"taskRole"` }
Attributes used to import an existing EC2 task definition.
TODO: EXAMPLE
Experimental.
type Ec2TaskDefinitionProps ¶
type Ec2TaskDefinitionProps struct { // The name of the IAM task execution role that grants the ECS agent permission to call AWS APIs on your behalf. // // The role will be used to retrieve container images from ECR and create CloudWatch log groups. // Experimental. ExecutionRole awsiam.IRole `json:"executionRole"` // The name of a family that this task definition is registered to. // // A family groups multiple versions of a task definition. // Experimental. Family *string `json:"family"` // The configuration details for the App Mesh proxy. // Experimental. ProxyConfiguration ProxyConfiguration `json:"proxyConfiguration"` // The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf. // Experimental. TaskRole awsiam.IRole `json:"taskRole"` // The list of volume definitions for the task. // // For more information, see // [Task Definition Parameter Volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide//task_definition_parameters.html#volumes). // Experimental. Volumes *[]*Volume `json:"volumes"` // The inference accelerators to use for the containers in the task. // // Not supported in Fargate. // Experimental. InferenceAccelerators *[]*InferenceAccelerator `json:"inferenceAccelerators"` // The IPC resource namespace to use for the containers in the task. // // Not supported in Fargate and Windows containers. // Experimental. IpcMode IpcMode `json:"ipcMode"` // The Docker networking mode to use for the containers in the task. // // The valid values are none, bridge, awsvpc, and host. // Experimental. NetworkMode NetworkMode `json:"networkMode"` // The process namespace to use for the containers in the task. // // Not supported in Fargate and Windows containers. // Experimental. PidMode PidMode `json:"pidMode"` // An array of placement constraint objects to use for the task. // // You can // specify a maximum of 10 constraints per task (this limit includes // constraints in the task definition and those specified at run time). // Experimental. PlacementConstraints *[]PlacementConstraint `json:"placementConstraints"` }
The properties for a task definition run on an EC2 cluster.
TODO: EXAMPLE
Experimental.
type EcrImage ¶
type EcrImage interface { ContainerImage ImageName() *string Bind(_scope constructs.Construct, containerDefinition ContainerDefinition) *ContainerImageConfig }
An image from an Amazon ECR repository.
TODO: EXAMPLE
Experimental.
func AssetImage_FromEcrRepository ¶
func AssetImage_FromEcrRepository(repository awsecr.IRepository, tag *string) EcrImage
Reference an image in an ECR repository. Experimental.
func ContainerImage_FromEcrRepository ¶
func ContainerImage_FromEcrRepository(repository awsecr.IRepository, tag *string) EcrImage
Reference an image in an ECR repository. Experimental.
func EcrImage_FromEcrRepository ¶
func EcrImage_FromEcrRepository(repository awsecr.IRepository, tag *string) EcrImage
Reference an image in an ECR repository. Experimental.
func NewEcrImage ¶
func NewEcrImage(repository awsecr.IRepository, tagOrDigest *string) EcrImage
Constructs a new instance of the EcrImage class. Experimental.
func RepositoryImage_FromEcrRepository ¶
func RepositoryImage_FromEcrRepository(repository awsecr.IRepository, tag *string) EcrImage
Reference an image in an ECR repository. Experimental.
func TagParameterContainerImage_FromEcrRepository ¶
func TagParameterContainerImage_FromEcrRepository(repository awsecr.IRepository, tag *string) EcrImage
Reference an image in an ECR repository. Experimental.
type EcsOptimizedAmi
deprecated
type EcsOptimizedAmi interface { awsec2.IMachineImage GetImage(scope constructs.Construct) *awsec2.MachineImageConfig }
Construct a Linux or Windows machine image from the latest ECS Optimized AMI published in SSM.
TODO: EXAMPLE
Deprecated: see {@link EcsOptimizedImage#amazonLinux}, {@link EcsOptimizedImage#amazonLinux} and {@link EcsOptimizedImage#windows}
func NewEcsOptimizedAmi ¶
func NewEcsOptimizedAmi(props *EcsOptimizedAmiProps) EcsOptimizedAmi
Constructs a new instance of the EcsOptimizedAmi class. Deprecated: see {@link EcsOptimizedImage#amazonLinux}, {@link EcsOptimizedImage#amazonLinux} and {@link EcsOptimizedImage#windows}
type EcsOptimizedAmiProps
deprecated
type EcsOptimizedAmiProps struct { // Whether the AMI ID is cached to be stable between deployments. // // By default, the newest image is used on each deployment. This will cause // instances to be replaced whenever a new version is released, and may cause // downtime if there aren't enough running instances in the AutoScalingGroup // to reschedule the tasks on. // // If set to true, the AMI ID will be cached in `cdk.context.json` and the // same value will be used on future runs. Your instances will not be replaced // but your AMI version will grow old over time. To refresh the AMI lookup, // you will have to evict the value from the cache using the `cdk context` // command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for // more information. // // Can not be set to `true` in environment-agnostic stacks. // Deprecated: see {@link EcsOptimizedImage} CachedInContext *bool `json:"cachedInContext"` // The Amazon Linux generation to use. // Deprecated: see {@link EcsOptimizedImage} Generation awsec2.AmazonLinuxGeneration `json:"generation"` // The ECS-optimized AMI variant to use. // Deprecated: see {@link EcsOptimizedImage} HardwareType AmiHardwareType `json:"hardwareType"` // The Windows Server version to use. // Deprecated: see {@link EcsOptimizedImage} WindowsVersion WindowsOptimizedVersion `json:"windowsVersion"` }
The properties that define which ECS-optimized AMI is used.
TODO: EXAMPLE
Deprecated: see {@link EcsOptimizedImage}
type EcsOptimizedImage ¶
type EcsOptimizedImage interface { awsec2.IMachineImage GetImage(scope constructs.Construct) *awsec2.MachineImageConfig }
Construct a Linux or Windows machine image from the latest ECS Optimized AMI published in SSM.
TODO: EXAMPLE
Experimental.
func EcsOptimizedImage_AmazonLinux ¶
func EcsOptimizedImage_AmazonLinux(options *EcsOptimizedImageOptions) EcsOptimizedImage
Construct an Amazon Linux AMI image from the latest ECS Optimized AMI published in SSM. Experimental.
func EcsOptimizedImage_AmazonLinux2 ¶
func EcsOptimizedImage_AmazonLinux2(hardwareType AmiHardwareType, options *EcsOptimizedImageOptions) EcsOptimizedImage
Construct an Amazon Linux 2 image from the latest ECS Optimized AMI published in SSM. Experimental.
func EcsOptimizedImage_Windows ¶
func EcsOptimizedImage_Windows(windowsVersion WindowsOptimizedVersion, options *EcsOptimizedImageOptions) EcsOptimizedImage
Construct a Windows image from the latest ECS Optimized AMI published in SSM. Experimental.
type EcsOptimizedImageOptions ¶
type EcsOptimizedImageOptions struct { // Whether the AMI ID is cached to be stable between deployments. // // By default, the newest image is used on each deployment. This will cause // instances to be replaced whenever a new version is released, and may cause // downtime if there aren't enough running instances in the AutoScalingGroup // to reschedule the tasks on. // // If set to true, the AMI ID will be cached in `cdk.context.json` and the // same value will be used on future runs. Your instances will not be replaced // but your AMI version will grow old over time. To refresh the AMI lookup, // you will have to evict the value from the cache using the `cdk context` // command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for // more information. // // Can not be set to `true` in environment-agnostic stacks. // Experimental. CachedInContext *bool `json:"cachedInContext"` }
Additional configuration properties for EcsOptimizedImage factory functions.
TODO: EXAMPLE
Experimental.
type EcsTarget ¶
type EcsTarget struct { // The name of the container. // Experimental. ContainerName *string `json:"containerName"` // Listener and properties for adding target group to the listener. // Experimental. Listener ListenerConfig `json:"listener"` // ID for a target group to be created. // Experimental. NewTargetGroupId *string `json:"newTargetGroupId"` // The port number of the container. // // Only applicable when using application/network load balancers. // Experimental. ContainerPort *float64 `json:"containerPort"` // The protocol used for the port mapping. // // Only applicable when using application load balancers. // Experimental. Protocol Protocol `json:"protocol"` }
TODO: EXAMPLE
Experimental.
type EfsVolumeConfiguration ¶
type EfsVolumeConfiguration struct { // The authorization configuration details for the Amazon EFS file system. // Experimental. AuthorizationConfig *AuthorizationConfig `json:"authorizationConfig"` // The Amazon EFS file system ID to use. // Experimental. FileSystemId *string `json:"fileSystemId"` // The directory within the Amazon EFS file system to mount as the root directory inside the host. // // Specifying / will have the same effect as omitting this parameter. // Experimental. RootDirectory *string `json:"rootDirectory"` // Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. // // Transit encryption must be enabled if Amazon EFS IAM authorization is used. // // Valid values: ENABLED | DISABLED // Experimental. TransitEncryption *string `json:"transitEncryption"` // The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. // // EFS mount helper uses. // Experimental. TransitEncryptionPort *float64 `json:"transitEncryptionPort"` }
The configuration for an Elastic FileSystem volume.
TODO: EXAMPLE
Experimental.
type EnvironmentFile ¶
type EnvironmentFile interface {
Bind(scope constructs.Construct) *EnvironmentFileConfig
}
Constructs for types of environment files.
TODO: EXAMPLE
Experimental.
type EnvironmentFileConfig ¶
type EnvironmentFileConfig struct { // The type of environment file. // Experimental. FileType EnvironmentFileType `json:"fileType"` // The location of the environment file in S3. // Experimental. S3Location *awss3.Location `json:"s3Location"` }
Configuration for the environment file.
TODO: EXAMPLE
Experimental.
type EnvironmentFileType ¶
type EnvironmentFileType string
Type of environment file to be included in the container definition. Experimental.
const (
EnvironmentFileType_S3 EnvironmentFileType = "S3"
)
type ExecuteCommandConfiguration ¶
type ExecuteCommandConfiguration struct { // The AWS Key Management Service key ID to encrypt the data between the local client and the container. // Experimental. KmsKey awskms.IKey `json:"kmsKey"` // The log configuration for the results of the execute command actions. // // The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. // Experimental. LogConfiguration *ExecuteCommandLogConfiguration `json:"logConfiguration"` // The log settings to use for logging the execute command session. // Experimental. Logging ExecuteCommandLogging `json:"logging"` }
The details of the execute command configuration.
For more information, see ExecuteCommandConfiguration https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandconfiguration.html
TODO: EXAMPLE
Experimental.
type ExecuteCommandLogConfiguration ¶
type ExecuteCommandLogConfiguration struct { // Whether or not to enable encryption on the CloudWatch logs. // Experimental. CloudWatchEncryptionEnabled *bool `json:"cloudWatchEncryptionEnabled"` // The name of the CloudWatch log group to send logs to. // // The CloudWatch log group must already be created. // Experimental. CloudWatchLogGroup awslogs.ILogGroup `json:"cloudWatchLogGroup"` // The name of the S3 bucket to send logs to. // // The S3 bucket must already be created. // Experimental. S3Bucket awss3.IBucket `json:"s3Bucket"` // Whether or not to enable encryption on the CloudWatch logs. // Experimental. S3EncryptionEnabled *bool `json:"s3EncryptionEnabled"` // An optional folder in the S3 bucket to place logs in. // Experimental. S3KeyPrefix *string `json:"s3KeyPrefix"` }
The log configuration for the results of the execute command actions.
The logs can be sent to CloudWatch Logs and/ or an Amazon S3 bucket. For more information, see ExecuteCommandLogConfiguration https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandlogconfiguration.html
TODO: EXAMPLE
Experimental.
type ExecuteCommandLogging ¶
type ExecuteCommandLogging string
The log settings to use to for logging the execute command session.
For more information, see [Logging] https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-executecommandconfiguration.html#cfn-ecs-cluster-executecommandconfiguration-logging
TODO: EXAMPLE
Experimental.
const ( ExecuteCommandLogging_DEFAULT ExecuteCommandLogging = "DEFAULT" ExecuteCommandLogging_NONE ExecuteCommandLogging = "NONE" ExecuteCommandLogging_OVERRIDE ExecuteCommandLogging = "OVERRIDE" )
type ExternalService ¶
type ExternalService interface { BaseService IExternalService CloudmapService() awsservicediscovery.Service SetCloudmapService(val awsservicediscovery.Service) CloudMapService() awsservicediscovery.IService Cluster() ICluster Connections() awsec2.Connections Env() *awscdk.ResourceEnvironment LoadBalancers() *[]*CfnService_LoadBalancerProperty SetLoadBalancers(val *[]*CfnService_LoadBalancerProperty) NetworkConfiguration() *CfnService_NetworkConfigurationProperty SetNetworkConfiguration(val *CfnService_NetworkConfigurationProperty) Node() constructs.Node PhysicalName() *string ServiceArn() *string ServiceName() *string ServiceRegistries() *[]*CfnService_ServiceRegistryProperty SetServiceRegistries(val *[]*CfnService_ServiceRegistryProperty) Stack() awscdk.Stack TaskDefinition() TaskDefinition ApplyRemovalPolicy(policy awscdk.RemovalPolicy) AssociateCloudMapService(_options *AssociateCloudMapServiceOptions) AttachToApplicationTargetGroup(_targetGroup awselasticloadbalancingv2.IApplicationTargetGroup) *awselasticloadbalancingv2.LoadBalancerTargetProps AttachToClassicLB(loadBalancer awselasticloadbalancing.LoadBalancer) AttachToNetworkTargetGroup(targetGroup awselasticloadbalancingv2.INetworkTargetGroup) *awselasticloadbalancingv2.LoadBalancerTargetProps AutoScaleTaskCount(_props *awsapplicationautoscaling.EnableScalingProps) ScalableTaskCount ConfigureAwsVpcNetworking(vpc awsec2.IVpc, assignPublicIp *bool, vpcSubnets *awsec2.SubnetSelection, securityGroup awsec2.ISecurityGroup) ConfigureAwsVpcNetworkingWithSecurityGroups(_vpc awsec2.IVpc, _assignPublicIp *bool, _vpcSubnets *awsec2.SubnetSelection, _securityGroups *[]awsec2.ISecurityGroup) EnableCloudMap(_options *CloudMapOptions) awsservicediscovery.Service GeneratePhysicalName() *string GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string GetResourceNameAttribute(nameAttr *string) *string LoadBalancerTarget(_options *LoadBalancerTargetOptions) IEcsLoadBalancerTarget Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricCpuUtilization(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricMemoryUtilization(props *awscloudwatch.MetricOptions) awscloudwatch.Metric RegisterLoadBalancerTargets(_targets ...*EcsTarget) ToString() *string }
This creates a service using the External launch type on an ECS cluster.
TODO: EXAMPLE
Experimental.
func NewExternalService ¶
func NewExternalService(scope constructs.Construct, id *string, props *ExternalServiceProps) ExternalService
Constructs a new instance of the ExternalService class. Experimental.
type ExternalServiceAttributes ¶
type ExternalServiceAttributes struct { // The cluster that hosts the service. // Experimental. Cluster ICluster `json:"cluster"` // The service ARN. // Experimental. ServiceArn *string `json:"serviceArn"` // The name of the service. // Experimental. ServiceName *string `json:"serviceName"` }
The properties to import from the service using the External launch type.
TODO: EXAMPLE
Experimental.
type ExternalServiceProps ¶
type ExternalServiceProps struct { // A list of Capacity Provider strategies used to place a service. // Experimental. CapacityProviderStrategies *[]*CapacityProviderStrategy `json:"capacityProviderStrategies"` // Whether to enable the deployment circuit breaker. // // If this property is defined, circuit breaker will be implicitly // enabled. // Experimental. CircuitBreaker *DeploymentCircuitBreaker `json:"circuitBreaker"` // The options for configuring an Amazon ECS service to use service discovery. // Experimental. CloudMapOptions *CloudMapOptions `json:"cloudMapOptions"` // The name of the cluster that hosts the service. // Experimental. Cluster ICluster `json:"cluster"` // Specifies which deployment controller to use for the service. // // For more information, see // [Amazon ECS Deployment Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) // Experimental. DeploymentController *DeploymentController `json:"deploymentController"` // The desired number of instantiations of the task definition to keep running on the service. // Experimental. DesiredCount *float64 `json:"desiredCount"` // Specifies whether to enable Amazon ECS managed tags for the tasks within the service. // // For more information, see // [Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) // Experimental. EnableECSManagedTags *bool `json:"enableECSManagedTags"` // Whether to enable the ability to execute into a container. // Experimental. EnableExecuteCommand *bool `json:"enableExecuteCommand"` // The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. // Experimental. HealthCheckGracePeriod awscdk.Duration `json:"healthCheckGracePeriod"` // The maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment. // Experimental. MaxHealthyPercent *float64 `json:"maxHealthyPercent"` // The minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment. // Experimental. MinHealthyPercent *float64 `json:"minHealthyPercent"` // Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. // // Valid values are: PropagatedTagSource.SERVICE, PropagatedTagSource.TASK_DEFINITION or PropagatedTagSource.NONE // Experimental. PropagateTags PropagatedTagSource `json:"propagateTags"` // Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. // // Tags can only be propagated to the tasks within the service during service creation. // Deprecated: Use `propagateTags` instead. PropagateTaskTagsFrom PropagatedTagSource `json:"propagateTaskTagsFrom"` // The name of the service. // Experimental. ServiceName *string `json:"serviceName"` // The task definition to use for tasks in the service. // // [disable-awslint:ref-via-interface] // Experimental. TaskDefinition TaskDefinition `json:"taskDefinition"` // The security groups to associate with the service. // // If you do not specify a security group, a new security group is created. // Experimental. SecurityGroups *[]awsec2.ISecurityGroup `json:"securityGroups"` }
The properties for defining a service using the External launch type.
TODO: EXAMPLE
Experimental.
type ExternalTaskDefinition ¶
type ExternalTaskDefinition interface { TaskDefinition IExternalTaskDefinition Compatibility() Compatibility Containers() *[]ContainerDefinition DefaultContainer() ContainerDefinition SetDefaultContainer(val ContainerDefinition) Env() *awscdk.ResourceEnvironment EphemeralStorageGiB() *float64 ExecutionRole() awsiam.IRole Family() *string InferenceAccelerators() *[]*InferenceAccelerator IsEc2Compatible() *bool IsExternalCompatible() *bool IsFargateCompatible() *bool NetworkMode() NetworkMode Node() constructs.Node PhysicalName() *string ReferencesSecretJsonField() *bool Stack() awscdk.Stack TaskDefinitionArn() *string TaskRole() awsiam.IRole AddContainer(id *string, props *ContainerDefinitionOptions) ContainerDefinition AddExtension(extension ITaskDefinitionExtension) AddFirelensLogRouter(id *string, props *FirelensLogRouterDefinitionOptions) FirelensLogRouter AddInferenceAccelerator(_inferenceAccelerator *InferenceAccelerator) AddPlacementConstraint(constraint PlacementConstraint) AddToExecutionRolePolicy(statement awsiam.PolicyStatement) AddToTaskRolePolicy(statement awsiam.PolicyStatement) AddVolume(_volume *Volume) ApplyRemovalPolicy(policy awscdk.RemovalPolicy) FindContainer(containerName *string) ContainerDefinition GeneratePhysicalName() *string GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string GetResourceNameAttribute(nameAttr *string) *string ObtainExecutionRole() awsiam.IRole ToString() *string }
The details of a task definition run on an External cluster.
TODO: EXAMPLE
Experimental.
func NewExternalTaskDefinition ¶
func NewExternalTaskDefinition(scope constructs.Construct, id *string, props *ExternalTaskDefinitionProps) ExternalTaskDefinition
Constructs a new instance of the ExternalTaskDefinition class. Experimental.
type ExternalTaskDefinitionAttributes ¶
type ExternalTaskDefinitionAttributes struct { // The networking mode to use for the containers in the task. // Experimental. NetworkMode NetworkMode `json:"networkMode"` // The arn of the task definition. // Experimental. TaskDefinitionArn *string `json:"taskDefinitionArn"` // The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf. // Experimental. TaskRole awsiam.IRole `json:"taskRole"` }
Attributes used to import an existing External task definition.
TODO: EXAMPLE
Experimental.
type ExternalTaskDefinitionProps ¶
type ExternalTaskDefinitionProps struct { // The name of the IAM task execution role that grants the ECS agent permission to call AWS APIs on your behalf. // // The role will be used to retrieve container images from ECR and create CloudWatch log groups. // Experimental. ExecutionRole awsiam.IRole `json:"executionRole"` // The name of a family that this task definition is registered to. // // A family groups multiple versions of a task definition. // Experimental. Family *string `json:"family"` // The configuration details for the App Mesh proxy. // Experimental. ProxyConfiguration ProxyConfiguration `json:"proxyConfiguration"` // The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf. // Experimental. TaskRole awsiam.IRole `json:"taskRole"` // The list of volume definitions for the task. // // For more information, see // [Task Definition Parameter Volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide//task_definition_parameters.html#volumes). // Experimental. Volumes *[]*Volume `json:"volumes"` }
The properties for a task definition run on an External cluster.
TODO: EXAMPLE
Experimental.
type FargatePlatformVersion ¶
type FargatePlatformVersion string
The platform version on which to run your service.
TODO: EXAMPLE
See: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
Experimental.
const ( FargatePlatformVersion_LATEST FargatePlatformVersion = "LATEST" FargatePlatformVersion_VERSION1_0 FargatePlatformVersion = "VERSION1_0" FargatePlatformVersion_VERSION1_1 FargatePlatformVersion = "VERSION1_1" FargatePlatformVersion_VERSION1_2 FargatePlatformVersion = "VERSION1_2" FargatePlatformVersion_VERSION1_3 FargatePlatformVersion = "VERSION1_3" FargatePlatformVersion_VERSION1_4 FargatePlatformVersion = "VERSION1_4" )
type FargateService ¶
type FargateService interface { BaseService IFargateService CloudmapService() awsservicediscovery.Service SetCloudmapService(val awsservicediscovery.Service) CloudMapService() awsservicediscovery.IService Cluster() ICluster Connections() awsec2.Connections Env() *awscdk.ResourceEnvironment LoadBalancers() *[]*CfnService_LoadBalancerProperty SetLoadBalancers(val *[]*CfnService_LoadBalancerProperty) NetworkConfiguration() *CfnService_NetworkConfigurationProperty SetNetworkConfiguration(val *CfnService_NetworkConfigurationProperty) Node() constructs.Node PhysicalName() *string ServiceArn() *string ServiceName() *string ServiceRegistries() *[]*CfnService_ServiceRegistryProperty SetServiceRegistries(val *[]*CfnService_ServiceRegistryProperty) Stack() awscdk.Stack TaskDefinition() TaskDefinition ApplyRemovalPolicy(policy awscdk.RemovalPolicy) AssociateCloudMapService(options *AssociateCloudMapServiceOptions) AttachToApplicationTargetGroup(targetGroup awselasticloadbalancingv2.IApplicationTargetGroup) *awselasticloadbalancingv2.LoadBalancerTargetProps AttachToClassicLB(loadBalancer awselasticloadbalancing.LoadBalancer) AttachToNetworkTargetGroup(targetGroup awselasticloadbalancingv2.INetworkTargetGroup) *awselasticloadbalancingv2.LoadBalancerTargetProps AutoScaleTaskCount(props *awsapplicationautoscaling.EnableScalingProps) ScalableTaskCount ConfigureAwsVpcNetworking(vpc awsec2.IVpc, assignPublicIp *bool, vpcSubnets *awsec2.SubnetSelection, securityGroup awsec2.ISecurityGroup) ConfigureAwsVpcNetworkingWithSecurityGroups(vpc awsec2.IVpc, assignPublicIp *bool, vpcSubnets *awsec2.SubnetSelection, securityGroups *[]awsec2.ISecurityGroup) EnableCloudMap(options *CloudMapOptions) awsservicediscovery.Service GeneratePhysicalName() *string GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string GetResourceNameAttribute(nameAttr *string) *string LoadBalancerTarget(options *LoadBalancerTargetOptions) IEcsLoadBalancerTarget Metric(metricName *string, props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricCpuUtilization(props *awscloudwatch.MetricOptions) awscloudwatch.Metric MetricMemoryUtilization(props *awscloudwatch.MetricOptions) awscloudwatch.Metric RegisterLoadBalancerTargets(targets ...*EcsTarget) ToString() *string }
This creates a service using the Fargate launch type on an ECS cluster.
TODO: EXAMPLE
Experimental.
func NewFargateService ¶
func NewFargateService(scope constructs.Construct, id *string, props *FargateServiceProps) FargateService
Constructs a new instance of the FargateService class. Experimental.
type FargateServiceAttributes ¶
type FargateServiceAttributes struct { // The cluster that hosts the service. // Experimental. Cluster ICluster `json:"cluster"` // The service ARN. // Experimental. ServiceArn *string `json:"serviceArn"` // The name of the service. // Experimental. ServiceName *string `json:"serviceName"` }
The properties to import from the service using the Fargate launch type.
TODO: EXAMPLE
Experimental.
type FargateServiceProps ¶
type FargateServiceProps struct { // A list of Capacity Provider strategies used to place a service. // Experimental. CapacityProviderStrategies *[]*CapacityProviderStrategy `json:"capacityProviderStrategies"` // Whether to enable the deployment circuit breaker. // // If this property is defined, circuit breaker will be implicitly // enabled. // Experimental. CircuitBreaker *DeploymentCircuitBreaker `json:"circuitBreaker"` // The options for configuring an Amazon ECS service to use service discovery. // Experimental. CloudMapOptions *CloudMapOptions `json:"cloudMapOptions"` // The name of the cluster that hosts the service. // Experimental. Cluster ICluster `json:"cluster"` // Specifies which deployment controller to use for the service. // // For more information, see // [Amazon ECS Deployment Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) // Experimental. DeploymentController *DeploymentController `json:"deploymentController"` // The desired number of instantiations of the task definition to keep running on the service. // Experimental. DesiredCount *float64 `json:"desiredCount"` // Specifies whether to enable Amazon ECS managed tags for the tasks within the service. // // For more information, see // [Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) // Experimental. EnableECSManagedTags *bool `json:"enableECSManagedTags"` // Whether to enable the ability to execute into a container. // Experimental. EnableExecuteCommand *bool `json:"enableExecuteCommand"` // The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. // Experimental. HealthCheckGracePeriod awscdk.Duration `json:"healthCheckGracePeriod"` // The maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment. // Experimental. MaxHealthyPercent *float64 `json:"maxHealthyPercent"` // The minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment. // Experimental. MinHealthyPercent *float64 `json:"minHealthyPercent"` // Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. // // Valid values are: PropagatedTagSource.SERVICE, PropagatedTagSource.TASK_DEFINITION or PropagatedTagSource.NONE // Experimental. PropagateTags PropagatedTagSource `json:"propagateTags"` // Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. // // Tags can only be propagated to the tasks within the service during service creation. // Deprecated: Use `propagateTags` instead. PropagateTaskTagsFrom PropagatedTagSource `json:"propagateTaskTagsFrom"` // The name of the service. // Experimental. ServiceName *string `json:"serviceName"` // The task definition to use for tasks in the service. // // [disable-awslint:ref-via-interface] // Experimental. TaskDefinition TaskDefinition `json:"taskDefinition"` // Specifies whether the task's elastic network interface receives a public IP address. // // If true, each task will receive a public IP address. // Experimental. AssignPublicIp *bool `json:"assignPublicIp"` // The platform version on which to run your service. // // If one is not specified, the LATEST platform version is used by default. For more information, see // [AWS Fargate Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) // in the Amazon Elastic Container Service Developer Guide. // Experimental. PlatformVersion FargatePlatformVersion `json:"platformVersion"` // The security groups to associate with the service. // // If you do not specify a security group, a new security group is created. // Deprecated: use securityGroups instead. SecurityGroup awsec2.ISecurityGroup `json:"securityGroup"` // The security groups to associate with the service. // // If you do not specify a security group, a new security group is created. // Experimental. SecurityGroups *[]awsec2.ISecurityGroup `json:"securityGroups"` // The subnets to associate with the service. // Experimental. VpcSubnets *awsec2.SubnetSelection `json:"vpcSubnets"` }
The properties for defining a service using the Fargate launch type.
TODO: EXAMPLE
Experimental.
type FargateTaskDefinition ¶
type FargateTaskDefinition interface { TaskDefinition IFargateTaskDefinition Compatibility() Compatibility Containers() *[]ContainerDefinition DefaultContainer() ContainerDefinition SetDefaultContainer(val ContainerDefinition) Env() *awscdk.ResourceEnvironment EphemeralStorageGiB() *float64 ExecutionRole() awsiam.IRole Family() *string InferenceAccelerators() *[]*InferenceAccelerator IsEc2Compatible() *bool IsExternalCompatible() *bool IsFargateCompatible() *bool NetworkMode() NetworkMode Node() constructs.Node PhysicalName() *string ReferencesSecretJsonField() *bool Stack() awscdk.Stack TaskDefinitionArn() *string TaskRole() awsiam.IRole AddContainer(id *string, props *ContainerDefinitionOptions) ContainerDefinition AddExtension(extension ITaskDefinitionExtension) AddFirelensLogRouter(id *string, props *FirelensLogRouterDefinitionOptions) FirelensLogRouter AddInferenceAccelerator(inferenceAccelerator *InferenceAccelerator) AddPlacementConstraint(constraint PlacementConstraint) AddToExecutionRolePolicy(statement awsiam.PolicyStatement) AddToTaskRolePolicy(statement awsiam.PolicyStatement) AddVolume(volume *Volume) ApplyRemovalPolicy(policy awscdk.RemovalPolicy) FindContainer(containerName *string) ContainerDefinition GeneratePhysicalName() *string GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string GetResourceNameAttribute(nameAttr *string) *string ObtainExecutionRole() awsiam.IRole ToString() *string }
The details of a task definition run on a Fargate cluster.
TODO: EXAMPLE
Experimental.
func NewFargateTaskDefinition ¶
func NewFargateTaskDefinition(scope constructs.Construct, id *string, props *FargateTaskDefinitionProps) FargateTaskDefinition
Constructs a new instance of the FargateTaskDefinition class. Experimental.
type FargateTaskDefinitionAttributes ¶
type FargateTaskDefinitionAttributes struct { // The networking mode to use for the containers in the task. // Experimental. NetworkMode NetworkMode `json:"networkMode"` // The arn of the task definition. // Experimental. TaskDefinitionArn *string `json:"taskDefinitionArn"` // The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf. // Experimental. TaskRole awsiam.IRole `json:"taskRole"` }
Attributes used to import an existing Fargate task definition.
TODO: EXAMPLE
Experimental.
type FargateTaskDefinitionProps ¶
type FargateTaskDefinitionProps struct { // The name of the IAM task execution role that grants the ECS agent permission to call AWS APIs on your behalf. // // The role will be used to retrieve container images from ECR and create CloudWatch log groups. // Experimental. ExecutionRole awsiam.IRole `json:"executionRole"` // The name of a family that this task definition is registered to. // // A family groups multiple versions of a task definition. // Experimental. Family *string `json:"family"` // The configuration details for the App Mesh proxy. // Experimental. ProxyConfiguration ProxyConfiguration `json:"proxyConfiguration"` // The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf. // Experimental. TaskRole awsiam.IRole `json:"taskRole"` // The list of volume definitions for the task. // // For more information, see // [Task Definition Parameter Volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide//task_definition_parameters.html#volumes). // Experimental. Volumes *[]*Volume `json:"volumes"` // The number of cpu units used by the task. // // For tasks using the Fargate launch type, // this field is required and you must use one of the following values, // which determines your range of valid values for the memory parameter: // // 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) // // 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) // // 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) // // 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) // // 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) // Experimental. Cpu *float64 `json:"cpu"` // The amount (in GiB) of ephemeral storage to be allocated to the task. // // The maximum supported value is 200 GiB. // // NOTE: This parameter is only supported for tasks hosted on AWS Fargate using platform version 1.4.0 or later. // Experimental. EphemeralStorageGiB *float64 `json:"ephemeralStorageGiB"` // The amount (in MiB) of memory used by the task. // // For tasks using the Fargate launch type, // this field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter: // // 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU) // // 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU) // // 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU) // // Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU) // // Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU) // Experimental. MemoryLimitMiB *float64 `json:"memoryLimitMiB"` }
The properties for a task definition.
TODO: EXAMPLE
Experimental.
type FireLensLogDriver ¶
type FireLensLogDriver interface { LogDriver Bind(_scope constructs.Construct, _containerDefinition ContainerDefinition) *LogDriverConfig }
FireLens enables you to use task definition parameters to route logs to an AWS service or AWS Partner Network (APN) destination for log storage and analytics.
TODO: EXAMPLE
Experimental.
func NewFireLensLogDriver ¶
func NewFireLensLogDriver(props *FireLensLogDriverProps) FireLensLogDriver
Constructs a new instance of the FireLensLogDriver class. Experimental.
type FireLensLogDriverProps ¶
type FireLensLogDriverProps struct { // The env option takes an array of keys. // // If there is collision between // label and env keys, the value of the env takes precedence. Adds additional fields // to the extra attributes of a logging message. // Experimental. Env *[]*string `json:"env"` // The env-regex option is similar to and compatible with env. // // Its value is a regular // expression to match logging-related environment variables. It is used for advanced // log tag options. // Experimental. EnvRegex *string `json:"envRegex"` // The labels option takes an array of keys. // // If there is collision // between label and env keys, the value of the env takes precedence. Adds additional // fields to the extra attributes of a logging message. // Experimental. Labels *[]*string `json:"labels"` // By default, Docker uses the first 12 characters of the container ID to tag log messages. // // Refer to the log tag option documentation for customizing the // log tag format. // Experimental. Tag *string `json:"tag"` // The configuration options to send to the log driver. // Experimental. Options *map[string]*string `json:"options"` // The secrets to pass to the log configuration. // Experimental. SecretOptions *map[string]Secret `json:"secretOptions"` }
Specifies the firelens log driver configuration options.
TODO: EXAMPLE
Experimental.
type FirelensConfig ¶
type FirelensConfig struct { // Firelens options. // Experimental. Options *FirelensOptions `json:"options"` // The log router to use. // Experimental. Type FirelensLogRouterType `json:"type"` }
Firelens Configuration https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html#firelens-taskdef.
TODO: EXAMPLE
Experimental.
type FirelensConfigFileType ¶
type FirelensConfigFileType string
Firelens configuration file type, s3 or file path.
https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html#firelens-taskdef-customconfig Experimental.
const ( FirelensConfigFileType_FILE FirelensConfigFileType = "FILE" FirelensConfigFileType_S3 FirelensConfigFileType = "S3" )
type FirelensLogRouter ¶
type FirelensLogRouter interface { ContainerDefinition ContainerDependencies() *[]*ContainerDependency ContainerName() *string ContainerPort() *float64 EnvironmentFiles() *[]*EnvironmentFileConfig Essential() *bool FirelensConfig() *FirelensConfig IngressPort() *float64 LinuxParameters() LinuxParameters LogDriverConfig() *LogDriverConfig MemoryLimitSpecified() *bool MountPoints() *[]*MountPoint Node() constructs.Node PortMappings() *[]*PortMapping ReferencesSecretJsonField() *bool TaskDefinition() TaskDefinition Ulimits() *[]*Ulimit VolumesFrom() *[]*VolumeFrom AddContainerDependencies(containerDependencies ...*ContainerDependency) AddInferenceAcceleratorResource(inferenceAcceleratorResources ...*string) AddLink(container ContainerDefinition, alias *string) AddMountPoints(mountPoints ...*MountPoint) AddPortMappings(portMappings ...*PortMapping) AddScratch(scratch *ScratchSpace) AddToExecutionPolicy(statement awsiam.PolicyStatement) AddUlimits(ulimits ...*Ulimit) AddVolumesFrom(volumesFrom ...*VolumeFrom) FindPortMapping(containerPort *float64, protocol Protocol) *PortMapping RenderContainerDefinition(_taskDefinition TaskDefinition) *CfnTaskDefinition_ContainerDefinitionProperty ToString() *string }
Firelens log router.
TODO: EXAMPLE
Experimental.
func NewFirelensLogRouter ¶
func NewFirelensLogRouter(scope constructs.Construct, id *string, props *FirelensLogRouterProps) FirelensLogRouter
Constructs a new instance of the FirelensLogRouter class. Experimental.
type FirelensLogRouterDefinitionOptions ¶
type FirelensLogRouterDefinitionOptions struct { // The command that is passed to the container. // // If you provide a shell command as a single string, you have to quote command-line arguments. // Experimental. Command *[]*string `json:"command"` // The name of the container. // Experimental. ContainerName *string `json:"containerName"` // The minimum number of CPU units to reserve for the container. // Experimental. Cpu *float64 `json:"cpu"` // Specifies whether networking is disabled within the container. // // When this parameter is true, networking is disabled within the container. // Experimental. DisableNetworking *bool `json:"disableNetworking"` // A list of DNS search domains that are presented to the container. // Experimental. DnsSearchDomains *[]*string `json:"dnsSearchDomains"` // A list of DNS servers that are presented to the container. // Experimental. DnsServers *[]*string `json:"dnsServers"` // A key/value map of labels to add to the container. // Experimental. DockerLabels *map[string]*string `json:"dockerLabels"` // A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. // Experimental. DockerSecurityOptions *[]*string `json:"dockerSecurityOptions"` // The ENTRYPOINT value to pass to the container. // See: https://docs.docker.com/engine/reference/builder/#entrypoint // // Experimental. EntryPoint *[]*string `json:"entryPoint"` // The environment variables to pass to the container. // Experimental. Environment *map[string]*string `json:"environment"` // The environment files to pass to the container. // See: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html // // Experimental. EnvironmentFiles *[]EnvironmentFile `json:"environmentFiles"` // Specifies whether the container is marked essential. // // If the essential parameter of a container is marked as true, and that container fails // or stops for any reason, all other containers that are part of the task are stopped. // If the essential parameter of a container is marked as false, then its failure does not // affect the rest of the containers in a task. All tasks must have at least one essential container. // // If this parameter is omitted, a container is assumed to be essential. // Experimental. Essential *bool `json:"essential"` // A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. // Experimental. ExtraHosts *map[string]*string `json:"extraHosts"` // The number of GPUs assigned to the container. // Experimental. GpuCount *float64 `json:"gpuCount"` // The health check command and associated configuration parameters for the container. // Experimental. HealthCheck *HealthCheck `json:"healthCheck"` // The hostname to use for your container. // Experimental. Hostname *string `json:"hostname"` // The image used to start a container. // // This string is passed directly to the Docker daemon. // Images in the Docker Hub registry are available by default. // Other repositories are specified with either repository-url/image:tag or repository-url/image@digest. // TODO: Update these to specify using classes of IContainerImage // Experimental. Image ContainerImage `json:"image"` // The inference accelerators referenced by the container. // Experimental. InferenceAcceleratorResources *[]*string `json:"inferenceAcceleratorResources"` // Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. // // For more information see [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html). // Experimental. LinuxParameters LinuxParameters `json:"linuxParameters"` // The log configuration specification for the container. // Experimental. Logging LogDriver `json:"logging"` // The amount (in MiB) of memory to present to the container. // // If your container attempts to exceed the allocated memory, the container // is terminated. // // At least one of memoryLimitMiB and memoryReservationMiB is required for non-Fargate services. // Experimental. MemoryLimitMiB *float64 `json:"memoryLimitMiB"` // The soft limit (in MiB) of memory to reserve for the container. // // When system memory is under heavy contention, Docker attempts to keep the // container memory to this soft limit. However, your container can consume more // memory when it needs to, up to either the hard limit specified with the memory // parameter (if applicable), or all of the available memory on the container // instance, whichever comes first. // // At least one of memoryLimitMiB and memoryReservationMiB is required for non-Fargate services. // Experimental. MemoryReservationMiB *float64 `json:"memoryReservationMiB"` // The port mappings to add to the container definition. // Experimental. PortMappings *[]*PortMapping `json:"portMappings"` // Specifies whether the container is marked as privileged. // // When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). // Experimental. Privileged *bool `json:"privileged"` // When this parameter is true, the container is given read-only access to its root file system. // Experimental. ReadonlyRootFilesystem *bool `json:"readonlyRootFilesystem"` // The secret environment variables to pass to the container. // Experimental. Secrets *map[string]Secret `json:"secrets"` // Time duration (in seconds) to wait before giving up on resolving dependencies for a container. // Experimental. StartTimeout awscdk.Duration `json:"startTimeout"` // Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own. // Experimental. StopTimeout awscdk.Duration `json:"stopTimeout"` // A list of namespaced kernel parameters to set in the container. // See: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#container_definition_systemcontrols // // Experimental. SystemControls *[]*SystemControl `json:"systemControls"` // The user name to use inside the container. // Experimental. User *string `json:"user"` // The working directory in which to run commands inside the container. // Experimental. WorkingDirectory *string `json:"workingDirectory"` // Firelens configuration. // Experimental. FirelensConfig *FirelensConfig `json:"firelensConfig"` }
The options for creating a firelens log router.
TODO: EXAMPLE
Experimental.
type FirelensLogRouterProps ¶
type FirelensLogRouterProps struct { // The command that is passed to the container. // // If you provide a shell command as a single string, you have to quote command-line arguments. // Experimental. Command *[]*string `json:"command"` // The name of the container. // Experimental. ContainerName *string `json:"containerName"` // The minimum number of CPU units to reserve for the container. // Experimental. Cpu *float64 `json:"cpu"` // Specifies whether networking is disabled within the container. // // When this parameter is true, networking is disabled within the container. // Experimental. DisableNetworking *bool `json:"disableNetworking"` // A list of DNS search domains that are presented to the container. // Experimental. DnsSearchDomains *[]*string `json:"dnsSearchDomains"` // A list of DNS servers that are presented to the container. // Experimental. DnsServers *[]*string `json:"dnsServers"` // A key/value map of labels to add to the container. // Experimental. DockerLabels *map[string]*string `json:"dockerLabels"` // A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. // Experimental. DockerSecurityOptions *[]*string `json:"dockerSecurityOptions"` // The ENTRYPOINT value to pass to the container. // See: https://docs.docker.com/engine/reference/builder/#entrypoint // // Experimental. EntryPoint *[]*string `json:"entryPoint"` // The environment variables to pass to the container. // Experimental. Environment *map[string]*string `json:"environment"` // The environment files to pass to the container. // See: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html // // Experimental. EnvironmentFiles *[]EnvironmentFile `json:"environmentFiles"` // Specifies whether the container is marked essential. // // If the essential parameter of a container is marked as true, and that container fails // or stops for any reason, all other containers that are part of the task are stopped. // If the essential parameter of a container is marked as false, then its failure does not // affect the rest of the containers in a task. All tasks must have at least one essential container. // // If this parameter is omitted, a container is assumed to be essential. // Experimental. Essential *bool `json:"essential"` // A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. // Experimental. ExtraHosts *map[string]*string `json:"extraHosts"` // The number of GPUs assigned to the container. // Experimental. GpuCount *float64 `json:"gpuCount"` // The health check command and associated configuration parameters for the container. // Experimental. HealthCheck *HealthCheck `json:"healthCheck"` // The hostname to use for your container. // Experimental. Hostname *string `json:"hostname"` // The image used to start a container. // // This string is passed directly to the Docker daemon. // Images in the Docker Hub registry are available by default. // Other repositories are specified with either repository-url/image:tag or repository-url/image@digest. // TODO: Update these to specify using classes of IContainerImage // Experimental. Image ContainerImage `json:"image"` // The inference accelerators referenced by the container. // Experimental. InferenceAcceleratorResources *[]*string `json:"inferenceAcceleratorResources"` // Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. // // For more information see [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html). // Experimental. LinuxParameters LinuxParameters `json:"linuxParameters"` // The log configuration specification for the container. // Experimental. Logging LogDriver `json:"logging"` // The amount (in MiB) of memory to present to the container. // // If your container attempts to exceed the allocated memory, the container // is terminated. // // At least one of memoryLimitMiB and memoryReservationMiB is required for non-Fargate services. // Experimental. MemoryLimitMiB *float64 `json:"memoryLimitMiB"` // The soft limit (in MiB) of memory to reserve for the container. // // When system memory is under heavy contention, Docker attempts to keep the // container memory to this soft limit. However, your container can consume more // memory when it needs to, up to either the hard limit specified with the memory // parameter (if applicable), or all of the available memory on the container // instance, whichever comes first. // // At least one of memoryLimitMiB and memoryReservationMiB is required for non-Fargate services. // Experimental. MemoryReservationMiB *float64 `json:"memoryReservationMiB"` // The port mappings to add to the container definition. // Experimental. PortMappings *[]*PortMapping `json:"portMappings"` // Specifies whether the container is marked as privileged. // // When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). // Experimental. Privileged *bool `json:"privileged"` // When this parameter is true, the container is given read-only access to its root file system. // Experimental. ReadonlyRootFilesystem *bool `json:"readonlyRootFilesystem"` // The secret environment variables to pass to the container. // Experimental. Secrets *map[string]Secret `json:"secrets"` // Time duration (in seconds) to wait before giving up on resolving dependencies for a container. // Experimental. StartTimeout awscdk.Duration `json:"startTimeout"` // Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own. // Experimental. StopTimeout awscdk.Duration `json:"stopTimeout"` // A list of namespaced kernel parameters to set in the container. // See: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#container_definition_systemcontrols // // Experimental. SystemControls *[]*SystemControl `json:"systemControls"` // The user name to use inside the container. // Experimental. User *string `json:"user"` // The working directory in which to run commands inside the container. // Experimental. WorkingDirectory *string `json:"workingDirectory"` // The name of the task definition that includes this container definition. // // [disable-awslint:ref-via-interface] // Experimental. TaskDefinition TaskDefinition `json:"taskDefinition"` // Firelens configuration. // Experimental. FirelensConfig *FirelensConfig `json:"firelensConfig"` }
The properties in a firelens log router.
TODO: EXAMPLE
Experimental.
type FirelensLogRouterType ¶
type FirelensLogRouterType string
Firelens log router type, fluentbit or fluentd.
https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html Experimental.
const ( FirelensLogRouterType_FLUENTBIT FirelensLogRouterType = "FLUENTBIT" FirelensLogRouterType_FLUENTD FirelensLogRouterType = "FLUENTD" )
type FirelensOptions ¶
type FirelensOptions struct { // Custom configuration file, s3 or file. // Experimental. ConfigFileType FirelensConfigFileType `json:"configFileType"` // Custom configuration file, S3 ARN or a file path. // Experimental. ConfigFileValue *string `json:"configFileValue"` // By default, Amazon ECS adds additional fields in your log entries that help identify the source of the logs. // // You can disable this action by setting enable-ecs-log-metadata to false. // Experimental. EnableECSLogMetadata *bool `json:"enableECSLogMetadata"` }
The options for firelens log router https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html#firelens-taskdef-customconfig.
TODO: EXAMPLE
Experimental.
type FluentdLogDriver ¶
type FluentdLogDriver interface { LogDriver Bind(_scope constructs.Construct, _containerDefinition ContainerDefinition) *LogDriverConfig }
A log driver that sends log information to journald Logs.
TODO: EXAMPLE
Experimental.
func NewFluentdLogDriver ¶
func NewFluentdLogDriver(props *FluentdLogDriverProps) FluentdLogDriver
Constructs a new instance of the FluentdLogDriver class. Experimental.
type FluentdLogDriverProps ¶
type FluentdLogDriverProps struct { // The env option takes an array of keys. // // If there is collision between // label and env keys, the value of the env takes precedence. Adds additional fields // to the extra attributes of a logging message. // Experimental. Env *[]*string `json:"env"` // The env-regex option is similar to and compatible with env. // // Its value is a regular // expression to match logging-related environment variables. It is used for advanced // log tag options. // Experimental. EnvRegex *string `json:"envRegex"` // The labels option takes an array of keys. // // If there is collision // between label and env keys, the value of the env takes precedence. Adds additional // fields to the extra attributes of a logging message. // Experimental. Labels *[]*string `json:"labels"` // By default, Docker uses the first 12 characters of the container ID to tag log messages. // // Refer to the log tag option documentation for customizing the // log tag format. // Experimental. Tag *string `json:"tag"` // By default, the logging driver connects to localhost:24224. // // Supply the // address option to connect to a different address. tcp(default) and unix // sockets are supported. // Experimental. Address *string `json:"address"` // Docker connects to Fluentd in the background. // // Messages are buffered until // the connection is established. // Experimental. AsyncConnect *bool `json:"asyncConnect"` // The amount of data to buffer before flushing to disk. // Experimental. BufferLimit *float64 `json:"bufferLimit"` // The maximum number of retries. // Experimental. MaxRetries *float64 `json:"maxRetries"` // How long to wait between retries. // Experimental. RetryWait awscdk.Duration `json:"retryWait"` // Generates event logs in nanosecond resolution. // Experimental. SubSecondPrecision *bool `json:"subSecondPrecision"` }
Specifies the fluentd log driver configuration options.
[Source](https://docs.docker.com/config/containers/logging/fluentd/)
TODO: EXAMPLE
Experimental.
type GelfCompressionType ¶
type GelfCompressionType string
The type of compression the GELF driver uses to compress each log message. Experimental.
const ( GelfCompressionType_GZIP GelfCompressionType = "GZIP" GelfCompressionType_NONE GelfCompressionType = "NONE" GelfCompressionType_ZLIB GelfCompressionType = "ZLIB" )
type GelfLogDriver ¶
type GelfLogDriver interface { LogDriver Bind(_scope constructs.Construct, _containerDefinition ContainerDefinition) *LogDriverConfig }
A log driver that sends log information to journald Logs.
TODO: EXAMPLE
Experimental.
func NewGelfLogDriver ¶
func NewGelfLogDriver(props *GelfLogDriverProps) GelfLogDriver
Constructs a new instance of the GelfLogDriver class. Experimental.
type GelfLogDriverProps ¶
type GelfLogDriverProps struct { // The env option takes an array of keys. // // If there is collision between // label and env keys, the value of the env takes precedence. Adds additional fields // to the extra attributes of a logging message. // Experimental. Env *[]*string `json:"env"` // The env-regex option is similar to and compatible with env. // // Its value is a regular // expression to match logging-related environment variables. It is used for advanced // log tag options. // Experimental. EnvRegex *string `json:"envRegex"` // The labels option takes an array of keys. // // If there is collision // between label and env keys, the value of the env takes precedence. Adds additional // fields to the extra attributes of a logging message. // Experimental. Labels *[]*string `json:"labels"` // By default, Docker uses the first 12 characters of the container ID to tag log messages. // // Refer to the log tag option documentation for customizing the // log tag format. // Experimental. Tag *string `json:"tag"` // The address of the GELF server. // // tcp and udp are the only supported URI // specifier and you must specify the port. // Experimental. Address *string `json:"address"` // UDP Only The level of compression when gzip or zlib is the gelf-compression-type. // // An integer in the range of -1 to 9 (BestCompression). Higher levels provide more // compression at lower speed. Either -1 or 0 disables compression. // Experimental. CompressionLevel *float64 `json:"compressionLevel"` // UDP Only The type of compression the GELF driver uses to compress each log message. // // Allowed values are gzip, zlib and none. // Experimental. CompressionType GelfCompressionType `json:"compressionType"` // TCP Only The maximum number of reconnection attempts when the connection drop. // // A positive integer. // Experimental. TcpMaxReconnect *float64 `json:"tcpMaxReconnect"` // TCP Only The number of seconds to wait between reconnection attempts. // // A positive integer. // Experimental. TcpReconnectDelay awscdk.Duration `json:"tcpReconnectDelay"` }
Specifies the journald log driver configuration options.
[Source](https://docs.docker.com/config/containers/logging/gelf/)
TODO: EXAMPLE
Experimental.
type GenericLogDriver ¶
type GenericLogDriver interface { LogDriver Bind(_scope constructs.Construct, _containerDefinition ContainerDefinition) *LogDriverConfig }
A log driver that sends logs to the specified driver.
TODO: EXAMPLE
Experimental.
func NewGenericLogDriver ¶
func NewGenericLogDriver(props *GenericLogDriverProps) GenericLogDriver
Constructs a new instance of the GenericLogDriver class. Experimental.
type GenericLogDriverProps ¶
type GenericLogDriverProps struct { // The log driver to use for the container. // // The valid values listed for this parameter are log drivers // that the Amazon ECS container agent can communicate with by default. // // For tasks using the Fargate launch type, the supported log drivers are awslogs and splunk. // For tasks using the EC2 launch type, the supported log drivers are awslogs, syslog, gelf, fluentd, splunk, journald, and json-file. // // For more information about using the awslogs log driver, see // [Using the awslogs Log Driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) // in the Amazon Elastic Container Service Developer Guide. // Experimental. LogDriver *string `json:"logDriver"` // The configuration options to send to the log driver. // Experimental. Options *map[string]*string `json:"options"` // The secrets to pass to the log configuration. // Experimental. SecretOptions *map[string]Secret `json:"secretOptions"` }
The configuration to use when creating a log driver.
TODO: EXAMPLE
Experimental.
type HealthCheck ¶
type HealthCheck struct { // A string array representing the command that the container runs to determine if it is healthy. // // The string array must start with CMD to execute the command arguments directly, or // CMD-SHELL to run the command with the container's default shell. // // For example: [ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ] // Experimental. Command *[]*string `json:"command"` // The time period in seconds between each health check execution. // // You may specify between 5 and 300 seconds. // Experimental. Interval awscdk.Duration `json:"interval"` // The number of times to retry a failed health check before the container is considered unhealthy. // // You may specify between 1 and 10 retries. // Experimental. Retries *float64 `json:"retries"` // The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. // // You may specify between 0 and 300 seconds. // Experimental. StartPeriod awscdk.Duration `json:"startPeriod"` // The time period in seconds to wait for a health check to succeed before it is considered a failure. // // You may specify between 2 and 60 seconds. // Experimental. Timeout awscdk.Duration `json:"timeout"` }
The health check command and associated configuration parameters for the container.
TODO: EXAMPLE
Experimental.
type Host ¶
type Host struct { // Specifies the path on the host container instance that is presented to the container. // // If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. // If the location does exist, the contents of the source path folder are exported. // // This property is not supported for tasks that use the Fargate launch type. // Experimental. SourcePath *string `json:"sourcePath"` }
The details on a container instance bind mount host volume.
TODO: EXAMPLE
Experimental.
type IBaseService ¶
type IBaseService interface { IService // The cluster that hosts the service. // Experimental. Cluster() ICluster }
The interface for BaseService. Experimental.
func Ec2Service_FromEc2ServiceAttributes ¶
func Ec2Service_FromEc2ServiceAttributes(scope constructs.Construct, id *string, attrs *Ec2ServiceAttributes) IBaseService
Imports from the specified service attrributes. Experimental.
func ExternalService_FromExternalServiceAttributes ¶
func ExternalService_FromExternalServiceAttributes(scope constructs.Construct, id *string, attrs *ExternalServiceAttributes) IBaseService
Imports from the specified service attrributes. Experimental.
func FargateService_FromFargateServiceAttributes ¶
func FargateService_FromFargateServiceAttributes(scope constructs.Construct, id *string, attrs *FargateServiceAttributes) IBaseService
Imports from the specified service attrributes. Experimental.
type ICluster ¶
type ICluster interface { awscdk.IResource // The autoscaling group added to the cluster if capacity is associated to the cluster. // Experimental. AutoscalingGroup() awsautoscaling.IAutoScalingGroup // The Amazon Resource Name (ARN) that identifies the cluster. // Experimental. ClusterArn() *string // The name of the cluster. // Experimental. ClusterName() *string // Manage the allowed network connections for the cluster with Security Groups. // Experimental. Connections() awsec2.Connections // The AWS Cloud Map namespace to associate with the cluster. // Experimental. DefaultCloudMapNamespace() awsservicediscovery.INamespace // The execute command configuration for the cluster. // Experimental. ExecuteCommandConfiguration() *ExecuteCommandConfiguration // Specifies whether the cluster has EC2 instance capacity. // Experimental. HasEc2Capacity() *bool // The VPC associated with the cluster. // Experimental. Vpc() awsec2.IVpc }
A regional grouping of one or more container instances on which you can run tasks and services. Experimental.
func Cluster_FromClusterAttributes ¶
func Cluster_FromClusterAttributes(scope constructs.Construct, id *string, attrs *ClusterAttributes) ICluster
Import an existing cluster to the stack from its attributes. Experimental.
type IEc2Service ¶
type IEc2Service interface { IService }
The interface for a service using the EC2 launch type on an ECS cluster. Experimental.
func Ec2Service_FromEc2ServiceArn ¶
func Ec2Service_FromEc2ServiceArn(scope constructs.Construct, id *string, ec2ServiceArn *string) IEc2Service
Imports from the specified service ARN. Experimental.
type IEc2TaskDefinition ¶
type IEc2TaskDefinition interface { ITaskDefinition }
The interface of a task definition run on an EC2 cluster. Experimental.
func Ec2TaskDefinition_FromEc2TaskDefinitionArn ¶
func Ec2TaskDefinition_FromEc2TaskDefinitionArn(scope constructs.Construct, id *string, ec2TaskDefinitionArn *string) IEc2TaskDefinition
Imports a task definition from the specified task definition ARN. Experimental.
func Ec2TaskDefinition_FromEc2TaskDefinitionAttributes ¶
func Ec2TaskDefinition_FromEc2TaskDefinitionAttributes(scope constructs.Construct, id *string, attrs *Ec2TaskDefinitionAttributes) IEc2TaskDefinition
Imports an existing Ec2 task definition from its attributes. Experimental.
type IEcsLoadBalancerTarget ¶
type IEcsLoadBalancerTarget interface { awselasticloadbalancingv2.IApplicationLoadBalancerTarget awselasticloadbalancing.ILoadBalancerTarget awselasticloadbalancingv2.INetworkLoadBalancerTarget }
Interface for ECS load balancer target. Experimental.
type IExternalService ¶
type IExternalService interface { IService }
The interface for a service using the External launch type on an ECS cluster. Experimental.
func ExternalService_FromExternalServiceArn ¶
func ExternalService_FromExternalServiceArn(scope constructs.Construct, id *string, externalServiceArn *string) IExternalService
Imports from the specified service ARN. Experimental.
type IExternalTaskDefinition ¶
type IExternalTaskDefinition interface { ITaskDefinition }
The interface of a task definition run on an External cluster. Experimental.
func ExternalTaskDefinition_FromEc2TaskDefinitionArn ¶
func ExternalTaskDefinition_FromEc2TaskDefinitionArn(scope constructs.Construct, id *string, externalTaskDefinitionArn *string) IExternalTaskDefinition
Imports a task definition from the specified task definition ARN. Experimental.
func ExternalTaskDefinition_FromExternalTaskDefinitionAttributes ¶
func ExternalTaskDefinition_FromExternalTaskDefinitionAttributes(scope constructs.Construct, id *string, attrs *ExternalTaskDefinitionAttributes) IExternalTaskDefinition
Imports an existing External task definition from its attributes. Experimental.
type IFargateService ¶
type IFargateService interface { IService }
The interface for a service using the Fargate launch type on an ECS cluster. Experimental.
func FargateService_FromFargateServiceArn ¶
func FargateService_FromFargateServiceArn(scope constructs.Construct, id *string, fargateServiceArn *string) IFargateService
Imports from the specified service ARN. Experimental.
type IFargateTaskDefinition ¶
type IFargateTaskDefinition interface { ITaskDefinition }
The interface of a task definition run on a Fargate cluster. Experimental.
func FargateTaskDefinition_FromFargateTaskDefinitionArn ¶
func FargateTaskDefinition_FromFargateTaskDefinitionArn(scope constructs.Construct, id *string, fargateTaskDefinitionArn *string) IFargateTaskDefinition
Imports a task definition from the specified task definition ARN. Experimental.
func FargateTaskDefinition_FromFargateTaskDefinitionAttributes ¶
func FargateTaskDefinition_FromFargateTaskDefinitionAttributes(scope constructs.Construct, id *string, attrs *FargateTaskDefinitionAttributes) IFargateTaskDefinition
Import an existing Fargate task definition from its attributes. Experimental.
type IService ¶
type IService interface { awscdk.IResource // The Amazon Resource Name (ARN) of the service. // Experimental. ServiceArn() *string // The name of the service. // Experimental. ServiceName() *string }
The interface for a service. Experimental.
type ITaskDefinition ¶
type ITaskDefinition interface { awscdk.IResource // What launch types this task definition should be compatible with. // Experimental. Compatibility() Compatibility // Execution role for this task definition. // Experimental. ExecutionRole() awsiam.IRole // Return true if the task definition can be run on an EC2 cluster. // Experimental. IsEc2Compatible() *bool // Return true if the task definition can be run on a ECS Anywhere cluster. // Experimental. IsExternalCompatible() *bool // Return true if the task definition can be run on a Fargate cluster. // Experimental. IsFargateCompatible() *bool // The networking mode to use for the containers in the task. // Experimental. NetworkMode() NetworkMode // ARN of this task definition. // Experimental. TaskDefinitionArn() *string // The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf. // Experimental. TaskRole() awsiam.IRole }
The interface for all task definitions. Experimental.
func Ec2TaskDefinition_FromTaskDefinitionArn ¶
func Ec2TaskDefinition_FromTaskDefinitionArn(scope constructs.Construct, id *string, taskDefinitionArn *string) ITaskDefinition
Imports a task definition from the specified task definition ARN.
The task will have a compatibility of EC2+Fargate. Experimental.
func Ec2TaskDefinition_FromTaskDefinitionAttributes ¶
func Ec2TaskDefinition_FromTaskDefinitionAttributes(scope constructs.Construct, id *string, attrs *TaskDefinitionAttributes) ITaskDefinition
Create a task definition from a task definition reference. Experimental.
func ExternalTaskDefinition_FromTaskDefinitionArn ¶
func ExternalTaskDefinition_FromTaskDefinitionArn(scope constructs.Construct, id *string, taskDefinitionArn *string) ITaskDefinition
Imports a task definition from the specified task definition ARN.
The task will have a compatibility of EC2+Fargate. Experimental.
func ExternalTaskDefinition_FromTaskDefinitionAttributes ¶
func ExternalTaskDefinition_FromTaskDefinitionAttributes(scope constructs.Construct, id *string, attrs *TaskDefinitionAttributes) ITaskDefinition
Create a task definition from a task definition reference. Experimental.
func FargateTaskDefinition_FromTaskDefinitionArn ¶
func FargateTaskDefinition_FromTaskDefinitionArn(scope constructs.Construct, id *string, taskDefinitionArn *string) ITaskDefinition
Imports a task definition from the specified task definition ARN.
The task will have a compatibility of EC2+Fargate. Experimental.
func FargateTaskDefinition_FromTaskDefinitionAttributes ¶
func FargateTaskDefinition_FromTaskDefinitionAttributes(scope constructs.Construct, id *string, attrs *TaskDefinitionAttributes) ITaskDefinition
Create a task definition from a task definition reference. Experimental.
func TaskDefinition_FromTaskDefinitionArn ¶
func TaskDefinition_FromTaskDefinitionArn(scope constructs.Construct, id *string, taskDefinitionArn *string) ITaskDefinition
Imports a task definition from the specified task definition ARN.
The task will have a compatibility of EC2+Fargate. Experimental.
func TaskDefinition_FromTaskDefinitionAttributes ¶
func TaskDefinition_FromTaskDefinitionAttributes(scope constructs.Construct, id *string, attrs *TaskDefinitionAttributes) ITaskDefinition
Create a task definition from a task definition reference. Experimental.
type ITaskDefinitionExtension ¶
type ITaskDefinitionExtension interface { // Apply the extension to the given TaskDefinition. // Experimental. Extend(taskDefinition TaskDefinition) }
An extension for Task Definitions.
Classes that want to make changes to a TaskDefinition (such as adding helper containers) can implement this interface, and can then be "added" to a TaskDefinition like so:
taskDefinition.addExtension(new MyExtension("some_parameter"));
Experimental.
type InferenceAccelerator ¶
type InferenceAccelerator struct { // The Elastic Inference accelerator device name. // Experimental. DeviceName *string `json:"deviceName"` // The Elastic Inference accelerator type to use. // // The allowed values are: eia2.medium, eia2.large and eia2.xlarge. // Experimental. DeviceType *string `json:"deviceType"` }
Elastic Inference Accelerator.
For more information, see [Elastic Inference Basics](https://docs.aws.amazon.com/elastic-inference/latest/developerguide/basics.html)
TODO: EXAMPLE
Experimental.
type IpcMode ¶
type IpcMode string
The IPC resource namespace to use for the containers in the task. Experimental.
type JournaldLogDriver ¶
type JournaldLogDriver interface { LogDriver Bind(_scope constructs.Construct, _containerDefinition ContainerDefinition) *LogDriverConfig }
A log driver that sends log information to journald Logs.
TODO: EXAMPLE
Experimental.
func NewJournaldLogDriver ¶
func NewJournaldLogDriver(props *JournaldLogDriverProps) JournaldLogDriver
Constructs a new instance of the JournaldLogDriver class. Experimental.
type JournaldLogDriverProps ¶
type JournaldLogDriverProps struct { // The env option takes an array of keys. // // If there is collision between // label and env keys, the value of the env takes precedence. Adds additional fields // to the extra attributes of a logging message. // Experimental. Env *[]*string `json:"env"` // The env-regex option is similar to and compatible with env. // // Its value is a regular // expression to match logging-related environment variables. It is used for advanced // log tag options. // Experimental. EnvRegex *string `json:"envRegex"` // The labels option takes an array of keys. // // If there is collision // between label and env keys, the value of the env takes precedence. Adds additional // fields to the extra attributes of a logging message. // Experimental. Labels *[]*string `json:"labels"` // By default, Docker uses the first 12 characters of the container ID to tag log messages. // // Refer to the log tag option documentation for customizing the // log tag format. // Experimental. Tag *string `json:"tag"` }
Specifies the journald log driver configuration options.
[Source](https://docs.docker.com/config/containers/logging/journald/)
TODO: EXAMPLE
Experimental.
type JsonFileLogDriver ¶
type JsonFileLogDriver interface { LogDriver Bind(_scope constructs.Construct, _containerDefinition ContainerDefinition) *LogDriverConfig }
A log driver that sends log information to json-file Logs.
TODO: EXAMPLE
Experimental.
func NewJsonFileLogDriver ¶
func NewJsonFileLogDriver(props *JsonFileLogDriverProps) JsonFileLogDriver
Constructs a new instance of the JsonFileLogDriver class. Experimental.
type JsonFileLogDriverProps ¶
type JsonFileLogDriverProps struct { // The env option takes an array of keys. // // If there is collision between // label and env keys, the value of the env takes precedence. Adds additional fields // to the extra attributes of a logging message. // Experimental. Env *[]*string `json:"env"` // The env-regex option is similar to and compatible with env. // // Its value is a regular // expression to match logging-related environment variables. It is used for advanced // log tag options. // Experimental. EnvRegex *string `json:"envRegex"` // The labels option takes an array of keys. // // If there is collision // between label and env keys, the value of the env takes precedence. Adds additional // fields to the extra attributes of a logging message. // Experimental. Labels *[]*string `json:"labels"` // By default, Docker uses the first 12 characters of the container ID to tag log messages. // // Refer to the log tag option documentation for customizing the // log tag format. // Experimental. Tag *string `json:"tag"` // Toggles compression for rotated logs. // Experimental. Compress *bool `json:"compress"` // The maximum number of log files that can be present. // // If rolling the logs creates // excess files, the oldest file is removed. Only effective when max-size is also set. // A positive integer. // Experimental. MaxFile *float64 `json:"maxFile"` // The maximum size of the log before it is rolled. // // A positive integer plus a modifier // representing the unit of measure (k, m, or g). // Experimental. MaxSize *string `json:"maxSize"` }
Specifies the json-file log driver configuration options.
[Source](https://docs.docker.com/config/containers/logging/json-file/)
TODO: EXAMPLE
Experimental.
type LaunchType ¶
type LaunchType string
The launch type of an ECS service. Experimental.
const ( LaunchType_EC2 LaunchType = "EC2" LaunchType_EXTERNAL LaunchType = "EXTERNAL" LaunchType_FARGATE LaunchType = "FARGATE" )
type LinuxParameters ¶
type LinuxParameters interface { constructs.Construct Node() constructs.Node AddCapabilities(cap ...Capability) AddDevices(device ...*Device) AddTmpfs(tmpfs ...*Tmpfs) DropCapabilities(cap ...Capability) RenderLinuxParameters() *CfnTaskDefinition_LinuxParametersProperty ToString() *string }
Linux-specific options that are applied to the container.
TODO: EXAMPLE
Experimental.
func NewLinuxParameters ¶
func NewLinuxParameters(scope constructs.Construct, id *string, props *LinuxParametersProps) LinuxParameters
Constructs a new instance of the LinuxParameters class. Experimental.
type LinuxParametersProps ¶
type LinuxParametersProps struct { // Specifies whether to run an init process inside the container that forwards signals and reaps processes. // Experimental. InitProcessEnabled *bool `json:"initProcessEnabled"` // Experimental. SharedMemorySize *float64 `json:"sharedMemorySize"` }
The properties for defining Linux-specific options that are applied to the container.
TODO: EXAMPLE
Experimental.
type ListenerConfig ¶
type ListenerConfig interface {
AddTargets(id *string, target *LoadBalancerTargetOptions, service BaseService)
}
Base class for configuring listener when registering targets.
TODO: EXAMPLE
Experimental.
func ListenerConfig_ApplicationListener ¶
func ListenerConfig_ApplicationListener(listener awselasticloadbalancingv2.ApplicationListener, props *awselasticloadbalancingv2.AddApplicationTargetsProps) ListenerConfig
Create a config for adding target group to ALB listener. Experimental.
func ListenerConfig_NetworkListener ¶
func ListenerConfig_NetworkListener(listener awselasticloadbalancingv2.NetworkListener, props *awselasticloadbalancingv2.AddNetworkTargetsProps) ListenerConfig
Create a config for adding target group to NLB listener. Experimental.
type LoadBalancerTargetOptions ¶
type LoadBalancerTargetOptions struct { // The name of the container. // Experimental. ContainerName *string `json:"containerName"` // The port number of the container. // // Only applicable when using application/network load balancers. // Experimental. ContainerPort *float64 `json:"containerPort"` // The protocol used for the port mapping. // // Only applicable when using application load balancers. // Experimental. Protocol Protocol `json:"protocol"` }
Properties for defining an ECS target.
The port mapping for it must already have been created through addPortMapping().
TODO: EXAMPLE
Experimental.
type LogDriver ¶
type LogDriver interface {
Bind(scope constructs.Construct, containerDefinition ContainerDefinition) *LogDriverConfig
}
The base class for log drivers.
TODO: EXAMPLE
Experimental.
func AwsLogDriver_AwsLogs ¶
func AwsLogDriver_AwsLogs(props *AwsLogDriverProps) LogDriver
Creates a log driver configuration that sends log information to CloudWatch Logs. Experimental.
func FireLensLogDriver_AwsLogs ¶
func FireLensLogDriver_AwsLogs(props *AwsLogDriverProps) LogDriver
Creates a log driver configuration that sends log information to CloudWatch Logs. Experimental.
func FluentdLogDriver_AwsLogs ¶
func FluentdLogDriver_AwsLogs(props *AwsLogDriverProps) LogDriver
Creates a log driver configuration that sends log information to CloudWatch Logs. Experimental.
func GelfLogDriver_AwsLogs ¶
func GelfLogDriver_AwsLogs(props *AwsLogDriverProps) LogDriver
Creates a log driver configuration that sends log information to CloudWatch Logs. Experimental.
func GenericLogDriver_AwsLogs ¶
func GenericLogDriver_AwsLogs(props *AwsLogDriverProps) LogDriver
Creates a log driver configuration that sends log information to CloudWatch Logs. Experimental.
func JournaldLogDriver_AwsLogs ¶
func JournaldLogDriver_AwsLogs(props *AwsLogDriverProps) LogDriver
Creates a log driver configuration that sends log information to CloudWatch Logs. Experimental.
func JsonFileLogDriver_AwsLogs ¶
func JsonFileLogDriver_AwsLogs(props *AwsLogDriverProps) LogDriver
Creates a log driver configuration that sends log information to CloudWatch Logs. Experimental.
func LogDriver_AwsLogs ¶
func LogDriver_AwsLogs(props *AwsLogDriverProps) LogDriver
Creates a log driver configuration that sends log information to CloudWatch Logs. Experimental.
func LogDrivers_AwsLogs ¶
func LogDrivers_AwsLogs(props *AwsLogDriverProps) LogDriver
Creates a log driver configuration that sends log information to CloudWatch Logs. Experimental.
func LogDrivers_Firelens ¶
func LogDrivers_Firelens(props *FireLensLogDriverProps) LogDriver
Creates a log driver configuration that sends log information to firelens log router.
For detail configurations, please refer to Amazon ECS FireLens Examples: https://github.com/aws-samples/amazon-ecs-firelens-examples Experimental.
func LogDrivers_Fluentd ¶
func LogDrivers_Fluentd(props *FluentdLogDriverProps) LogDriver
Creates a log driver configuration that sends log information to fluentd Logs. Experimental.
func LogDrivers_Gelf ¶
func LogDrivers_Gelf(props *GelfLogDriverProps) LogDriver
Creates a log driver configuration that sends log information to gelf Logs. Experimental.
func LogDrivers_Journald ¶
func LogDrivers_Journald(props *JournaldLogDriverProps) LogDriver
Creates a log driver configuration that sends log information to journald Logs. Experimental.
func LogDrivers_JsonFile ¶
func LogDrivers_JsonFile(props *JsonFileLogDriverProps) LogDriver
Creates a log driver configuration that sends log information to json-file Logs. Experimental.
func LogDrivers_Splunk ¶
func LogDrivers_Splunk(props *SplunkLogDriverProps) LogDriver
Creates a log driver configuration that sends log information to splunk Logs. Experimental.
func LogDrivers_Syslog ¶
func LogDrivers_Syslog(props *SyslogLogDriverProps) LogDriver
Creates a log driver configuration that sends log information to syslog Logs. Experimental.
func SplunkLogDriver_AwsLogs ¶
func SplunkLogDriver_AwsLogs(props *AwsLogDriverProps) LogDriver
Creates a log driver configuration that sends log information to CloudWatch Logs. Experimental.
func SyslogLogDriver_AwsLogs ¶
func SyslogLogDriver_AwsLogs(props *AwsLogDriverProps) LogDriver
Creates a log driver configuration that sends log information to CloudWatch Logs. Experimental.
type LogDriverConfig ¶
type LogDriverConfig struct { // The log driver to use for the container. // // The valid values listed for this parameter are log drivers // that the Amazon ECS container agent can communicate with by default. // // For tasks using the Fargate launch type, the supported log drivers are awslogs, splunk, and awsfirelens. // For tasks using the EC2 launch type, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, // logentries,syslog, splunk, and awsfirelens. // // For more information about using the awslogs log driver, see // [Using the awslogs Log Driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) // in the Amazon Elastic Container Service Developer Guide. // // For more information about using the awsfirelens log driver, see // [Custom Log Routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) // in the Amazon Elastic Container Service Developer Guide. // Experimental. LogDriver *string `json:"logDriver"` // The configuration options to send to the log driver. // Experimental. Options *map[string]*string `json:"options"` // The secrets to pass to the log configuration. // Experimental. SecretOptions *[]*CfnTaskDefinition_SecretProperty `json:"secretOptions"` }
The configuration to use when creating a log driver.
TODO: EXAMPLE
Experimental.
type LogDrivers ¶
type LogDrivers interface { }
The base class for log drivers.
TODO: EXAMPLE
Experimental.
type MachineImageType ¶
type MachineImageType string
The machine image type.
TODO: EXAMPLE
Experimental.
const ( MachineImageType_AMAZON_LINUX_2 MachineImageType = "AMAZON_LINUX_2" MachineImageType_BOTTLEROCKET MachineImageType = "BOTTLEROCKET" )
type MemoryUtilizationScalingProps ¶
type MemoryUtilizationScalingProps struct { // Indicates whether scale in by the target tracking policy is disabled. // // If the value is true, scale in is disabled and the target tracking policy // won't remove capacity from the scalable resource. Otherwise, scale in is // enabled and the target tracking policy can remove capacity from the // scalable resource. // Experimental. DisableScaleIn *bool `json:"disableScaleIn"` // A name for the scaling policy. // Experimental. PolicyName *string `json:"policyName"` // Period after a scale in activity completes before another scale in activity can start. // Experimental. ScaleInCooldown awscdk.Duration `json:"scaleInCooldown"` // Period after a scale out activity completes before another scale out activity can start. // Experimental. ScaleOutCooldown awscdk.Duration `json:"scaleOutCooldown"` // The target value for memory utilization across all tasks in the service. // Experimental. TargetUtilizationPercent *float64 `json:"targetUtilizationPercent"` }
The properties for enabling scaling based on memory utilization.
TODO: EXAMPLE
Experimental.
type MountPoint ¶
type MountPoint struct { // The path on the container to mount the host volume at. // Experimental. ContainerPath *string `json:"containerPath"` // Specifies whether to give the container read-only access to the volume. // // If this value is true, the container has read-only access to the volume. // If this value is false, then the container can write to the volume. // Experimental. ReadOnly *bool `json:"readOnly"` // The name of the volume to mount. // // Must be a volume name referenced in the name parameter of task definition volume. // Experimental. SourceVolume *string `json:"sourceVolume"` }
The details of data volume mount points for a container.
TODO: EXAMPLE
Experimental.
type NetworkMode ¶
type NetworkMode string
The networking mode to use for the containers in the task.
TODO: EXAMPLE
Experimental.
const ( NetworkMode_AWS_VPC NetworkMode = "AWS_VPC" NetworkMode_BRIDGE NetworkMode = "BRIDGE" NetworkMode_HOST NetworkMode = "HOST" NetworkMode_NAT NetworkMode = "NAT" NetworkMode_NONE NetworkMode = "NONE" )
type PidMode ¶
type PidMode string
The process namespace to use for the containers in the task. Experimental.
type PlacementConstraint ¶
type PlacementConstraint interface {
ToJson() *[]*CfnService_PlacementConstraintProperty
}
The placement constraints to use for tasks in the service. For more information, see [Amazon ECS Task Placement Constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html).
Tasks will only be placed on instances that match these rules.
TODO: EXAMPLE
Experimental.
func PlacementConstraint_DistinctInstances ¶
func PlacementConstraint_DistinctInstances() PlacementConstraint
Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Experimental.
func PlacementConstraint_MemberOf ¶
func PlacementConstraint_MemberOf(expressions ...*string) PlacementConstraint
Use memberOf to restrict the selection to a group of valid candidates specified by a query expression.
Multiple expressions can be specified. For more information, see [Cluster Query Language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html).
You can specify multiple expressions in one call. The tasks will only be placed on instances matching all expressions. See: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html
Experimental.
type PlacementStrategy ¶
type PlacementStrategy interface {
ToJson() *[]*CfnService_PlacementStrategyProperty
}
The placement strategies to use for tasks in the service. For more information, see [Amazon ECS Task Placement Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html).
Tasks will preferentially be placed on instances that match these rules.
TODO: EXAMPLE
Experimental.
func PlacementStrategy_PackedBy ¶
func PlacementStrategy_PackedBy(resource BinPackResource) PlacementStrategy
Places tasks on the container instances with the least available capacity of the specified resource. Experimental.
func PlacementStrategy_PackedByCpu ¶
func PlacementStrategy_PackedByCpu() PlacementStrategy
Places tasks on container instances with the least available amount of CPU capacity.
This minimizes the number of instances in use. Experimental.
func PlacementStrategy_PackedByMemory ¶
func PlacementStrategy_PackedByMemory() PlacementStrategy
Places tasks on container instances with the least available amount of memory capacity.
This minimizes the number of instances in use. Experimental.
func PlacementStrategy_Randomly ¶
func PlacementStrategy_Randomly() PlacementStrategy
Places tasks randomly. Experimental.
func PlacementStrategy_SpreadAcross ¶
func PlacementStrategy_SpreadAcross(fields ...*string) PlacementStrategy
Places tasks evenly based on the specified value.
You can use one of the built-in attributes found on `BuiltInAttributes` or supply your own custom instance attributes. If more than one attribute is supplied, spreading is done in order. Experimental.
func PlacementStrategy_SpreadAcrossInstances ¶
func PlacementStrategy_SpreadAcrossInstances() PlacementStrategy
Places tasks evenly across all container instances in the cluster. Experimental.
type PortMapping ¶
type PortMapping struct { // The port number on the container that is bound to the user-specified or automatically assigned host port. // // If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort. // If you are using containers in a task with the bridge network mode and you specify a container port and not a host port, // your container automatically receives a host port in the ephemeral port range. // // For more information, see hostPort. // Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance. // Experimental. ContainerPort *float64 `json:"containerPort"` // The port number on the container instance to reserve for your container. // // If you are using containers in a task with the awsvpc or host network mode, // the hostPort can either be left blank or set to the same value as the containerPort. // // If you are using containers in a task with the bridge network mode, // you can specify a non-reserved host port for your container port mapping, or // you can omit the hostPort (or set it to 0) while specifying a containerPort and // your container automatically receives a port in the ephemeral port range for // your container instance operating system and Docker version. // Experimental. HostPort *float64 `json:"hostPort"` // The protocol used for the port mapping. // // Valid values are Protocol.TCP and Protocol.UDP. // Experimental. Protocol Protocol `json:"protocol"` }
Port mappings allow containers to access ports on the host container instance to send or receive traffic.
TODO: EXAMPLE
Experimental.
type PropagatedTagSource ¶
type PropagatedTagSource string
Propagate tags from either service or task definition. Experimental.
const ( PropagatedTagSource_NONE PropagatedTagSource = "NONE" PropagatedTagSource_SERVICE PropagatedTagSource = "SERVICE" PropagatedTagSource_TASK_DEFINITION PropagatedTagSource = "TASK_DEFINITION" )
type ProxyConfiguration ¶
type ProxyConfiguration interface {
Bind(_scope constructs.Construct, _taskDefinition TaskDefinition) *CfnTaskDefinition_ProxyConfigurationProperty
}
The base class for proxy configurations. Experimental.
func ProxyConfigurations_AppMeshProxyConfiguration ¶
func ProxyConfigurations_AppMeshProxyConfiguration(props *AppMeshProxyConfigurationConfigProps) ProxyConfiguration
Constructs a new instance of the ProxyConfiguration class. Experimental.
type ProxyConfigurations ¶
type ProxyConfigurations interface { }
The base class for proxy configurations.
TODO: EXAMPLE
Experimental.
type RepositoryImage ¶
type RepositoryImage interface { ContainerImage Bind(scope constructs.Construct, containerDefinition ContainerDefinition) *ContainerImageConfig }
An image hosted in a public or private repository.
For images hosted in Amazon ECR, see EcrImage(https://docs.aws.amazon.com/AmazonECR/latest/userguide/images.html).
TODO: EXAMPLE
Experimental.
func AssetImage_FromRegistry ¶
func AssetImage_FromRegistry(name *string, props *RepositoryImageProps) RepositoryImage
Reference an image on DockerHub or another online registry. Experimental.
func ContainerImage_FromRegistry ¶
func ContainerImage_FromRegistry(name *string, props *RepositoryImageProps) RepositoryImage
Reference an image on DockerHub or another online registry. Experimental.
func EcrImage_FromRegistry ¶
func EcrImage_FromRegistry(name *string, props *RepositoryImageProps) RepositoryImage
Reference an image on DockerHub or another online registry. Experimental.
func NewRepositoryImage ¶
func NewRepositoryImage(imageName *string, props *RepositoryImageProps) RepositoryImage
Constructs a new instance of the RepositoryImage class. Experimental.
func RepositoryImage_FromRegistry ¶
func RepositoryImage_FromRegistry(name *string, props *RepositoryImageProps) RepositoryImage
Reference an image on DockerHub or another online registry. Experimental.
func TagParameterContainerImage_FromRegistry ¶
func TagParameterContainerImage_FromRegistry(name *string, props *RepositoryImageProps) RepositoryImage
Reference an image on DockerHub or another online registry. Experimental.
type RepositoryImageProps ¶
type RepositoryImageProps struct { // The secret to expose to the container that contains the credentials for the image repository. // // The supported value is the full ARN of an AWS Secrets Manager secret. // Experimental. Credentials awssecretsmanager.ISecret `json:"credentials"` }
The properties for an image hosted in a public or private repository.
TODO: EXAMPLE
Experimental.
type RequestCountScalingProps ¶
type RequestCountScalingProps struct { // Indicates whether scale in by the target tracking policy is disabled. // // If the value is true, scale in is disabled and the target tracking policy // won't remove capacity from the scalable resource. Otherwise, scale in is // enabled and the target tracking policy can remove capacity from the // scalable resource. // Experimental. DisableScaleIn *bool `json:"disableScaleIn"` // A name for the scaling policy. // Experimental. PolicyName *string `json:"policyName"` // Period after a scale in activity completes before another scale in activity can start. // Experimental. ScaleInCooldown awscdk.Duration `json:"scaleInCooldown"` // Period after a scale out activity completes before another scale out activity can start. // Experimental. ScaleOutCooldown awscdk.Duration `json:"scaleOutCooldown"` // The number of ALB requests per target. // Experimental. RequestsPerTarget *float64 `json:"requestsPerTarget"` // The ALB target group name. // Experimental. TargetGroup awselasticloadbalancingv2.ApplicationTargetGroup `json:"targetGroup"` }
The properties for enabling scaling based on Application Load Balancer (ALB) request counts.
TODO: EXAMPLE
Experimental.
type S3EnvironmentFile ¶
type S3EnvironmentFile interface { EnvironmentFile Bind(_scope constructs.Construct) *EnvironmentFileConfig }
Environment file from S3.
TODO: EXAMPLE
Experimental.
func AssetEnvironmentFile_FromBucket ¶
func AssetEnvironmentFile_FromBucket(bucket awss3.IBucket, key *string, objectVersion *string) S3EnvironmentFile
Loads the environment file from an S3 bucket.
Returns: `S3EnvironmentFile` associated with the specified S3 object. Experimental.
func EnvironmentFile_FromBucket ¶
func EnvironmentFile_FromBucket(bucket awss3.IBucket, key *string, objectVersion *string) S3EnvironmentFile
Loads the environment file from an S3 bucket.
Returns: `S3EnvironmentFile` associated with the specified S3 object. Experimental.
func NewS3EnvironmentFile ¶
func NewS3EnvironmentFile(bucket awss3.IBucket, key *string, objectVersion *string) S3EnvironmentFile
Experimental.
func S3EnvironmentFile_FromBucket ¶
func S3EnvironmentFile_FromBucket(bucket awss3.IBucket, key *string, objectVersion *string) S3EnvironmentFile
Loads the environment file from an S3 bucket.
Returns: `S3EnvironmentFile` associated with the specified S3 object. Experimental.
type ScalableTaskCount ¶
type ScalableTaskCount interface { awsapplicationautoscaling.BaseScalableAttribute Node() constructs.Node Props() *awsapplicationautoscaling.BaseScalableAttributeProps DoScaleOnMetric(id *string, props *awsapplicationautoscaling.BasicStepScalingPolicyProps) DoScaleOnSchedule(id *string, props *awsapplicationautoscaling.ScalingSchedule) DoScaleToTrackMetric(id *string, props *awsapplicationautoscaling.BasicTargetTrackingScalingPolicyProps) ScaleOnCpuUtilization(id *string, props *CpuUtilizationScalingProps) ScaleOnMemoryUtilization(id *string, props *MemoryUtilizationScalingProps) ScaleOnMetric(id *string, props *awsapplicationautoscaling.BasicStepScalingPolicyProps) ScaleOnRequestCount(id *string, props *RequestCountScalingProps) ScaleOnSchedule(id *string, props *awsapplicationautoscaling.ScalingSchedule) ScaleToTrackCustomMetric(id *string, props *TrackCustomMetricProps) ToString() *string }
The scalable attribute representing task count.
TODO: EXAMPLE
Experimental.
func NewScalableTaskCount ¶
func NewScalableTaskCount(scope constructs.Construct, id *string, props *ScalableTaskCountProps) ScalableTaskCount
Constructs a new instance of the ScalableTaskCount class. Experimental.
type ScalableTaskCountProps ¶
type ScalableTaskCountProps struct { // Maximum capacity to scale to. // Experimental. MaxCapacity *float64 `json:"maxCapacity"` // Minimum capacity to scale to. // Experimental. MinCapacity *float64 `json:"minCapacity"` // Scalable dimension of the attribute. // Experimental. Dimension *string `json:"dimension"` // Resource ID of the attribute. // Experimental. ResourceId *string `json:"resourceId"` // Role to use for scaling. // Experimental. Role awsiam.IRole `json:"role"` // Service namespace of the scalable attribute. // Experimental. ServiceNamespace awsapplicationautoscaling.ServiceNamespace `json:"serviceNamespace"` }
The properties of a scalable attribute representing task count.
TODO: EXAMPLE
Experimental.
type Scope ¶
type Scope string
The scope for the Docker volume that determines its lifecycle.
Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops. Experimental.
type ScratchSpace ¶
type ScratchSpace struct { // The path on the container to mount the scratch volume at. // Experimental. ContainerPath *string `json:"containerPath"` // The name of the scratch volume to mount. // // Must be a volume name referenced in the name parameter of task definition volume. // Experimental. Name *string `json:"name"` // Specifies whether to give the container read-only access to the scratch volume. // // If this value is true, the container has read-only access to the scratch volume. // If this value is false, then the container can write to the scratch volume. // Experimental. ReadOnly *bool `json:"readOnly"` // Experimental. SourcePath *string `json:"sourcePath"` }
The temporary disk space mounted to the container.
TODO: EXAMPLE
Experimental.
type Secret ¶
type Secret interface { Arn() *string HasField() *bool GrantRead(grantee awsiam.IGrantable) awsiam.Grant }
A secret environment variable.
TODO: EXAMPLE
Experimental.
func Secret_FromSecretsManager ¶
func Secret_FromSecretsManager(secret awssecretsmanager.ISecret, field *string) Secret
Creates a environment variable value from a secret stored in AWS Secrets Manager. Experimental.
func Secret_FromSsmParameter ¶
func Secret_FromSsmParameter(parameter awsssm.IParameter) Secret
Creates an environment variable value from a parameter stored in AWS Systems Manager Parameter Store. Experimental.
type SplunkLogDriver ¶
type SplunkLogDriver interface { LogDriver Bind(_scope constructs.Construct, _containerDefinition ContainerDefinition) *LogDriverConfig }
A log driver that sends log information to splunk Logs.
TODO: EXAMPLE
Experimental.
func NewSplunkLogDriver ¶
func NewSplunkLogDriver(props *SplunkLogDriverProps) SplunkLogDriver
Constructs a new instance of the SplunkLogDriver class. Experimental.
type SplunkLogDriverProps ¶
type SplunkLogDriverProps struct { // The env option takes an array of keys. // // If there is collision between // label and env keys, the value of the env takes precedence. Adds additional fields // to the extra attributes of a logging message. // Experimental. Env *[]*string `json:"env"` // The env-regex option is similar to and compatible with env. // // Its value is a regular // expression to match logging-related environment variables. It is used for advanced // log tag options. // Experimental. EnvRegex *string `json:"envRegex"` // The labels option takes an array of keys. // // If there is collision // between label and env keys, the value of the env takes precedence. Adds additional // fields to the extra attributes of a logging message. // Experimental. Labels *[]*string `json:"labels"` // By default, Docker uses the first 12 characters of the container ID to tag log messages. // // Refer to the log tag option documentation for customizing the // log tag format. // Experimental. Tag *string `json:"tag"` // Name to use for validating server certificate. // Experimental. CaName *string `json:"caName"` // Path to root certificate. // Experimental. CaPath *string `json:"caPath"` // Message format. // // Can be inline, json or raw. // Experimental. Format SplunkLogFormat `json:"format"` // Enable/disable gzip compression to send events to Splunk Enterprise or Splunk Cloud instance. // Experimental. Gzip *bool `json:"gzip"` // Set compression level for gzip. // // Valid values are -1 (default), 0 (no compression), // 1 (best speed) ... 9 (best compression). // Experimental. GzipLevel *float64 `json:"gzipLevel"` // Event index. // Experimental. Index *string `json:"index"` // Ignore server certificate validation. // Experimental. InsecureSkipVerify *string `json:"insecureSkipVerify"` // Splunk HTTP Event Collector token (Secret). // // The splunk-token is added to the SecretOptions property of the Log Driver Configuration. So the secret value will not be // resolved or viewable as plain text. // // Please provide at least one of `token` or `secretToken`. // Experimental. SecretToken Secret `json:"secretToken"` // Event source. // Experimental. Source *string `json:"source"` // Event source type. // Experimental. SourceType *string `json:"sourceType"` // Splunk HTTP Event Collector token. // // The splunk-token is added to the Options property of the Log Driver Configuration. So the secret value will be resolved and // viewable in plain text in the console. // // Please provide at least one of `token` or `secretToken`. // Deprecated: Use {@link SplunkLogDriverProps.secretToken} instead. Token awscdk.SecretValue `json:"token"` // Path to your Splunk Enterprise, self-service Splunk Cloud instance, or Splunk Cloud managed cluster (including port and scheme used by HTTP Event Collector) in one of the following formats: https://your_splunk_instance:8088 or https://input-prd-p-XXXXXXX.cloud.splunk.com:8088 or https://http-inputs-XXXXXXXX.splunkcloud.com. // Experimental. Url *string `json:"url"` // Verify on start, that docker can connect to Splunk server. // Experimental. VerifyConnection *bool `json:"verifyConnection"` }
Specifies the splunk log driver configuration options.
[Source](https://docs.docker.com/config/containers/logging/splunk/)
TODO: EXAMPLE
Experimental.
type SplunkLogFormat ¶
type SplunkLogFormat string
Log Message Format. Experimental.
const ( SplunkLogFormat_INLINE SplunkLogFormat = "INLINE" SplunkLogFormat_JSON SplunkLogFormat = "JSON" SplunkLogFormat_RAW SplunkLogFormat = "RAW" )
type SyslogLogDriver ¶
type SyslogLogDriver interface { LogDriver Bind(_scope constructs.Construct, _containerDefinition ContainerDefinition) *LogDriverConfig }
A log driver that sends log information to syslog Logs.
TODO: EXAMPLE
Experimental.
func NewSyslogLogDriver ¶
func NewSyslogLogDriver(props *SyslogLogDriverProps) SyslogLogDriver
Constructs a new instance of the SyslogLogDriver class. Experimental.
type SyslogLogDriverProps ¶
type SyslogLogDriverProps struct { // The env option takes an array of keys. // // If there is collision between // label and env keys, the value of the env takes precedence. Adds additional fields // to the extra attributes of a logging message. // Experimental. Env *[]*string `json:"env"` // The env-regex option is similar to and compatible with env. // // Its value is a regular // expression to match logging-related environment variables. It is used for advanced // log tag options. // Experimental. EnvRegex *string `json:"envRegex"` // The labels option takes an array of keys. // // If there is collision // between label and env keys, the value of the env takes precedence. Adds additional // fields to the extra attributes of a logging message. // Experimental. Labels *[]*string `json:"labels"` // By default, Docker uses the first 12 characters of the container ID to tag log messages. // // Refer to the log tag option documentation for customizing the // log tag format. // Experimental. Tag *string `json:"tag"` // The address of an external syslog server. // // The URI specifier may be // [tcp|udp|tcp+tls]://host:port, unix://path, or unixgram://path. // Experimental. Address *string `json:"address"` // The syslog facility to use. // // Can be the number or name for any valid // syslog facility. See the syslog documentation: // https://tools.ietf.org/html/rfc5424#section-6.2.1. // Experimental. Facility *string `json:"facility"` // The syslog message format to use. // // If not specified the local UNIX syslog // format is used, without a specified hostname. Specify rfc3164 for the RFC-3164 // compatible format, rfc5424 for RFC-5424 compatible format, or rfc5424micro // for RFC-5424 compatible format with microsecond timestamp resolution. // Experimental. Format *string `json:"format"` // The absolute path to the trust certificates signed by the CA. // // Ignored // if the address protocol is not tcp+tls. // Experimental. TlsCaCert *string `json:"tlsCaCert"` // The absolute path to the TLS certificate file. // // Ignored if the address // protocol is not tcp+tls. // Experimental. TlsCert *string `json:"tlsCert"` // The absolute path to the TLS key file. // // Ignored if the address protocol // is not tcp+tls. // Experimental. TlsKey *string `json:"tlsKey"` // If set to true, TLS verification is skipped when connecting to the syslog daemon. // // Ignored if the address protocol is not tcp+tls. // Experimental. TlsSkipVerify *bool `json:"tlsSkipVerify"` }
Specifies the syslog log driver configuration options.
[Source](https://docs.docker.com/config/containers/logging/syslog/)
TODO: EXAMPLE
Experimental.
type SystemControl ¶
type SystemControl struct { // The namespaced kernel parameter for which to set a value. // Experimental. Namespace *string `json:"namespace"` // The value for the namespaced kernel parameter specified in namespace. // Experimental. Value *string `json:"value"` }
Kernel parameters to set in the container.
TODO: EXAMPLE
Experimental.
type TagParameterContainerImage ¶
type TagParameterContainerImage interface { ContainerImage TagParameterName() *string TagParameterValue() *string Bind(scope constructs.Construct, containerDefinition ContainerDefinition) *ContainerImageConfig }
A special type of {@link ContainerImage} that uses an ECR repository for the image, but a CloudFormation Parameter for the tag of the image in that repository.
This allows providing this tag through the Parameter at deploy time, for example in a CodePipeline that pushes a new tag of the image to the repository during a build step, and then provides that new tag through the CloudFormation Parameter in the deploy step.
TODO: EXAMPLE
See: #tagParameterName
Experimental.
func NewTagParameterContainerImage ¶
func NewTagParameterContainerImage(repository awsecr.IRepository) TagParameterContainerImage
Experimental.
type TaskDefinition ¶
type TaskDefinition interface { awscdk.Resource ITaskDefinition Compatibility() Compatibility Containers() *[]ContainerDefinition DefaultContainer() ContainerDefinition SetDefaultContainer(val ContainerDefinition) Env() *awscdk.ResourceEnvironment EphemeralStorageGiB() *float64 ExecutionRole() awsiam.IRole Family() *string InferenceAccelerators() *[]*InferenceAccelerator IsEc2Compatible() *bool IsExternalCompatible() *bool IsFargateCompatible() *bool NetworkMode() NetworkMode Node() constructs.Node PhysicalName() *string ReferencesSecretJsonField() *bool Stack() awscdk.Stack TaskDefinitionArn() *string TaskRole() awsiam.IRole AddContainer(id *string, props *ContainerDefinitionOptions) ContainerDefinition AddExtension(extension ITaskDefinitionExtension) AddFirelensLogRouter(id *string, props *FirelensLogRouterDefinitionOptions) FirelensLogRouter AddInferenceAccelerator(inferenceAccelerator *InferenceAccelerator) AddPlacementConstraint(constraint PlacementConstraint) AddToExecutionRolePolicy(statement awsiam.PolicyStatement) AddToTaskRolePolicy(statement awsiam.PolicyStatement) AddVolume(volume *Volume) ApplyRemovalPolicy(policy awscdk.RemovalPolicy) FindContainer(containerName *string) ContainerDefinition GeneratePhysicalName() *string GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string GetResourceNameAttribute(nameAttr *string) *string ObtainExecutionRole() awsiam.IRole ToString() *string }
The base class for all task definitions.
TODO: EXAMPLE
Experimental.
func NewTaskDefinition ¶
func NewTaskDefinition(scope constructs.Construct, id *string, props *TaskDefinitionProps) TaskDefinition
Constructs a new instance of the TaskDefinition class. Experimental.
type TaskDefinitionAttributes ¶
type TaskDefinitionAttributes struct { // The networking mode to use for the containers in the task. // Experimental. NetworkMode NetworkMode `json:"networkMode"` // The arn of the task definition. // Experimental. TaskDefinitionArn *string `json:"taskDefinitionArn"` // The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf. // Experimental. TaskRole awsiam.IRole `json:"taskRole"` // What launch types this task definition should be compatible with. // Experimental. Compatibility Compatibility `json:"compatibility"` }
A reference to an existing task definition.
TODO: EXAMPLE
Experimental.
type TaskDefinitionProps ¶
type TaskDefinitionProps struct { // The name of the IAM task execution role that grants the ECS agent permission to call AWS APIs on your behalf. // // The role will be used to retrieve container images from ECR and create CloudWatch log groups. // Experimental. ExecutionRole awsiam.IRole `json:"executionRole"` // The name of a family that this task definition is registered to. // // A family groups multiple versions of a task definition. // Experimental. Family *string `json:"family"` // The configuration details for the App Mesh proxy. // Experimental. ProxyConfiguration ProxyConfiguration `json:"proxyConfiguration"` // The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf. // Experimental. TaskRole awsiam.IRole `json:"taskRole"` // The list of volume definitions for the task. // // For more information, see // [Task Definition Parameter Volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide//task_definition_parameters.html#volumes). // Experimental. Volumes *[]*Volume `json:"volumes"` // The task launch type compatiblity requirement. // Experimental. Compatibility Compatibility `json:"compatibility"` // The number of cpu units used by the task. // // If you are using the EC2 launch type, this field is optional and any value can be used. // If you are using the Fargate launch type, this field is required and you must use one of the following values, // which determines your range of valid values for the memory parameter: // // 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) // // 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) // // 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) // // 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) // // 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) // Experimental. Cpu *string `json:"cpu"` // The amount (in GiB) of ephemeral storage to be allocated to the task. // // Only supported in Fargate platform version 1.4.0 or later. // Experimental. EphemeralStorageGiB *float64 `json:"ephemeralStorageGiB"` // The inference accelerators to use for the containers in the task. // // Not supported in Fargate. // Experimental. InferenceAccelerators *[]*InferenceAccelerator `json:"inferenceAccelerators"` // The IPC resource namespace to use for the containers in the task. // // Not supported in Fargate and Windows containers. // Experimental. IpcMode IpcMode `json:"ipcMode"` // The amount (in MiB) of memory used by the task. // // If using the EC2 launch type, this field is optional and any value can be used. // If using the Fargate launch type, this field is required and you must use one of the following values, // which determines your range of valid values for the cpu parameter: // // 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU) // // 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU) // // 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU) // // Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU) // // Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU) // Experimental. MemoryMiB *string `json:"memoryMiB"` // The networking mode to use for the containers in the task. // // On Fargate, the only supported networking mode is AwsVpc. // Experimental. NetworkMode NetworkMode `json:"networkMode"` // The process namespace to use for the containers in the task. // // Not supported in Fargate and Windows containers. // Experimental. PidMode PidMode `json:"pidMode"` // The placement constraints to use for tasks in the service. // // You can specify a maximum of 10 constraints per task (this limit includes // constraints in the task definition and those specified at run time). // // Not supported in Fargate. // Experimental. PlacementConstraints *[]PlacementConstraint `json:"placementConstraints"` }
The properties for task definitions.
TODO: EXAMPLE
Experimental.
type Tmpfs ¶
type Tmpfs struct { // The absolute file path where the tmpfs volume is to be mounted. // Experimental. ContainerPath *string `json:"containerPath"` // The list of tmpfs volume mount options. // // For more information, see // [TmpfsMountOptions](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Tmpfs.html). // Experimental. MountOptions *[]TmpfsMountOption `json:"mountOptions"` // The size (in MiB) of the tmpfs volume. // Experimental. Size *float64 `json:"size"` }
The details of a tmpfs mount for a container.
TODO: EXAMPLE
Experimental.
type TmpfsMountOption ¶
type TmpfsMountOption string
The supported options for a tmpfs mount for a container. Experimental.
const ( TmpfsMountOption_ASYNC TmpfsMountOption = "ASYNC" TmpfsMountOption_ATIME TmpfsMountOption = "ATIME" TmpfsMountOption_BIND TmpfsMountOption = "BIND" TmpfsMountOption_DEFAULTS TmpfsMountOption = "DEFAULTS" TmpfsMountOption_DEV TmpfsMountOption = "DEV" TmpfsMountOption_DIRATIME TmpfsMountOption = "DIRATIME" TmpfsMountOption_DIRSYNC TmpfsMountOption = "DIRSYNC" TmpfsMountOption_EXEC TmpfsMountOption = "EXEC" TmpfsMountOption_GID TmpfsMountOption = "GID" TmpfsMountOption_MAND TmpfsMountOption = "MAND" TmpfsMountOption_MODE TmpfsMountOption = "MODE" TmpfsMountOption_MPOL TmpfsMountOption = "MPOL" TmpfsMountOption_NOATIME TmpfsMountOption = "NOATIME" TmpfsMountOption_NODEV TmpfsMountOption = "NODEV" TmpfsMountOption_NODIRATIME TmpfsMountOption = "NODIRATIME" TmpfsMountOption_NOEXEC TmpfsMountOption = "NOEXEC" TmpfsMountOption_NOMAND TmpfsMountOption = "NOMAND" TmpfsMountOption_NORELATIME TmpfsMountOption = "NORELATIME" TmpfsMountOption_NOSTRICTATIME TmpfsMountOption = "NOSTRICTATIME" TmpfsMountOption_NOSUID TmpfsMountOption = "NOSUID" TmpfsMountOption_NR_BLOCKS TmpfsMountOption = "NR_BLOCKS" TmpfsMountOption_NR_INODES TmpfsMountOption = "NR_INODES" TmpfsMountOption_PRIVATE TmpfsMountOption = "PRIVATE" TmpfsMountOption_RBIND TmpfsMountOption = "RBIND" TmpfsMountOption_RELATIME TmpfsMountOption = "RELATIME" TmpfsMountOption_REMOUNT TmpfsMountOption = "REMOUNT" TmpfsMountOption_RO TmpfsMountOption = "RO" TmpfsMountOption_RPRIVATE TmpfsMountOption = "RPRIVATE" TmpfsMountOption_RSHARED TmpfsMountOption = "RSHARED" TmpfsMountOption_RSLAVE TmpfsMountOption = "RSLAVE" TmpfsMountOption_RUNBINDABLE TmpfsMountOption = "RUNBINDABLE" TmpfsMountOption_RW TmpfsMountOption = "RW" TmpfsMountOption_SHARED TmpfsMountOption = "SHARED" TmpfsMountOption_SLAVE TmpfsMountOption = "SLAVE" TmpfsMountOption_STRICTATIME TmpfsMountOption = "STRICTATIME" TmpfsMountOption_SUID TmpfsMountOption = "SUID" TmpfsMountOption_SYNC TmpfsMountOption = "SYNC" TmpfsMountOption_UID TmpfsMountOption = "UID" TmpfsMountOption_UNBINDABLE TmpfsMountOption = "UNBINDABLE" )
type TrackCustomMetricProps ¶
type TrackCustomMetricProps struct { // Indicates whether scale in by the target tracking policy is disabled. // // If the value is true, scale in is disabled and the target tracking policy // won't remove capacity from the scalable resource. Otherwise, scale in is // enabled and the target tracking policy can remove capacity from the // scalable resource. // Experimental. DisableScaleIn *bool `json:"disableScaleIn"` // A name for the scaling policy. // Experimental. PolicyName *string `json:"policyName"` // Period after a scale in activity completes before another scale in activity can start. // Experimental. ScaleInCooldown awscdk.Duration `json:"scaleInCooldown"` // Period after a scale out activity completes before another scale out activity can start. // Experimental. ScaleOutCooldown awscdk.Duration `json:"scaleOutCooldown"` // The custom CloudWatch metric to track. // // The metric must represent utilization; that is, you will always get the following behavior: // // - metric > targetValue => scale out // - metric < targetValue => scale in // Experimental. Metric awscloudwatch.IMetric `json:"metric"` // The target value for the custom CloudWatch metric. // Experimental. TargetValue *float64 `json:"targetValue"` }
The properties for enabling target tracking scaling based on a custom CloudWatch metric.
TODO: EXAMPLE
Experimental.
type Ulimit ¶
type Ulimit struct { // The hard limit for the ulimit type. // Experimental. HardLimit *float64 `json:"hardLimit"` // The type of the ulimit. // // For more information, see [UlimitName](https://docs.aws.amazon.com/cdk/api/latest/typescript/api/aws-ecs/ulimitname.html#aws_ecs_UlimitName). // Experimental. Name UlimitName `json:"name"` // The soft limit for the ulimit type. // Experimental. SoftLimit *float64 `json:"softLimit"` }
The ulimit settings to pass to the container.
NOTE: Does not work for Windows containers.
TODO: EXAMPLE
Experimental.
type UlimitName ¶
type UlimitName string
Type of resource to set a limit on. Experimental.
const ( UlimitName_CORE UlimitName = "CORE" UlimitName_CPU UlimitName = "CPU" UlimitName_DATA UlimitName = "DATA" UlimitName_FSIZE UlimitName = "FSIZE" UlimitName_LOCKS UlimitName = "LOCKS" UlimitName_MEMLOCK UlimitName = "MEMLOCK" UlimitName_MSGQUEUE UlimitName = "MSGQUEUE" UlimitName_NICE UlimitName = "NICE" UlimitName_NOFILE UlimitName = "NOFILE" UlimitName_NPROC UlimitName = "NPROC" UlimitName_RSS UlimitName = "RSS" UlimitName_RTPRIO UlimitName = "RTPRIO" UlimitName_RTTIME UlimitName = "RTTIME" UlimitName_SIGPENDING UlimitName = "SIGPENDING" UlimitName_STACK UlimitName = "STACK" )
type Volume ¶
type Volume struct { // This property is specified when you are using Docker volumes. // // Docker volumes are only supported when you are using the EC2 launch type. // Windows containers only support the use of the local driver. // To use bind mounts, specify a host instead. // Experimental. DockerVolumeConfiguration *DockerVolumeConfiguration `json:"dockerVolumeConfiguration"` // This property is specified when you are using Amazon EFS. // // When specifying Amazon EFS volumes in tasks using the Fargate launch type, // Fargate creates a supervisor container that is responsible for managing the Amazon EFS volume. // The supervisor container uses a small amount of the task's memory. // The supervisor container is visible when querying the task metadata version 4 endpoint, // but is not visible in CloudWatch Container Insights. // Experimental. EfsVolumeConfiguration *EfsVolumeConfiguration `json:"efsVolumeConfiguration"` // This property is specified when you are using bind mount host volumes. // // Bind mount host volumes are supported when you are using either the EC2 or Fargate launch types. // The contents of the host parameter determine whether your bind mount host volume persists on the // host container instance and where it is stored. If the host parameter is empty, then the Docker // daemon assigns a host path for your data volume. However, the data is not guaranteed to persist // after the containers associated with it stop running. // Experimental. Host *Host `json:"host"` // The name of the volume. // // Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. // This name is referenced in the sourceVolume parameter of container definition mountPoints. // Experimental. Name *string `json:"name"` }
A data volume used in a task definition.
For tasks that use a Docker volume, specify a DockerVolumeConfiguration. For tasks that use a bind mount host volume, specify a host and optional sourcePath.
For more information, see [Using Data Volumes in Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html).
TODO: EXAMPLE
Experimental.
type VolumeFrom ¶
type VolumeFrom struct { // Specifies whether the container has read-only access to the volume. // // If this value is true, the container has read-only access to the volume. // If this value is false, then the container can write to the volume. // Experimental. ReadOnly *bool `json:"readOnly"` // The name of another container within the same task definition from which to mount volumes. // Experimental. SourceContainer *string `json:"sourceContainer"` }
The details on a data volume from another container in the same task definition.
TODO: EXAMPLE
Experimental.
type WindowsOptimizedVersion ¶
type WindowsOptimizedVersion string
ECS-optimized Windows version list. Experimental.
const ( WindowsOptimizedVersion_SERVER_2019 WindowsOptimizedVersion = "SERVER_2019" WindowsOptimizedVersion_SERVER_2016 WindowsOptimizedVersion = "SERVER_2016" )