KubernetesManifest
Represents a manifest within the Kubernetes system.
Alternatively, you can use cluster.addManifest(resource[, resource, ...]) to define resources on this cluster.
Applies/deletes the manifest using kubectl.
Example
declare const cluster: eks.Cluster;
const namespace = cluster.addManifest('my-namespace', {
apiVersion: 'v1',
kind: 'Namespace',
metadata: { name: 'my-app' },
});
const service = cluster.addManifest('my-service', {
metadata: {
name: 'myservice',
namespace: 'my-app',
},
spec: { }, // ...
});
service.node.addDependency(namespace); // will apply `my-namespace` before `my-service`.
# cluster: eks.Cluster
namespace = cluster.add_manifest("my-namespace", {
"api_version": "v1",
"kind": "Namespace",
"metadata": {"name": "my-app"}
})
service = cluster.add_manifest("my-service", {
"metadata": {
"name": "myservice",
"namespace": "my-app"
},
"spec": {}
})
service.node.add_dependency(namespace)
Cluster cluster;
KubernetesManifest namespace = cluster.addManifest("my-namespace", Map.of(
"apiVersion", "v1",
"kind", "Namespace",
"metadata", Map.of("name", "my-app")));
KubernetesManifest service = cluster.addManifest("my-service", Map.of(
"metadata", Map.of(
"name", "myservice",
"namespace", "my-app"),
"spec", Map.of()));
service.node.addDependency(namespace);
// Install: dotnet add package Amazon.CDK.Lib
Cluster cluster;
var namespace = cluster.AddManifest("my-namespace", new Dictionary<string, object> {
{ "apiVersion", "v1" },
{ "kind", "Namespace" },
{ "metadata", new Dictionary<string, string> { { "name", "my-app" } } }
});
var service = cluster.AddManifest("my-service", new Dictionary<string, object> {
{ "metadata", new Dictionary<string, string> {
{ "name", "myservice" },
{ "namespace", "my-app" }
} },
{ "spec", new Dictionary<string, object> { } }
});
service.Node.AddDependency(namespace);
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var cluster Cluster
namespace := cluster.addManifest(jsii.String("my-namespace"), map[string]interface{}{
"apiVersion": jsii.String("v1"),
"kind": jsii.String("Namespace"),
"metadata": map[string]*string{
"name": jsii.String("my-app"),
},
})
service := cluster.addManifest(jsii.String("my-service"), map[string]interface{}{
"metadata": map[string]*string{
"name": jsii.String("myservice"),
"namespace": jsii.String("my-app"),
},
"spec": map[string]interface{}{
},
})
service.Node.AddDependency(namespace)
Initializer
new KubernetesManifest(scope: Construct, id: string, props: KubernetesManifestProps)
KubernetesManifest(scope: Construct, id: str, props: KubernetesManifestProps)
new KubernetesManifest(Construct scope, String id, KubernetesManifestProps props)
new KubernetesManifest(Construct scope, string id, KubernetesManifestProps props)
NewKubernetesManifest(Scope Construct, Id *string, Props KubernetesManifestProps)
Construct Props
[disable-awslint:ref-via-interface]
ingressAlbSchemeAlbSchemeingress_alb_schemeAlbSchemeingressAlbSchemeAlbSchemeIngressAlbSchemeAlbSchemeIngressAlbSchemeAlbScheme= AlbScheme.INTERNAL#Only applicable if ingressAlb is set to true.
manifest{ [key: string]: any }[]manifesttyping.List[typing.Mapping[str, Any]]manifestList<Map<String, Object>>ManifestIDictionary<string, object>[]Manifest*[]*map[string]interface{}required#notes · example
Consists of any number of child resources.
When the resources are created/updated, this manifest will be applied to the cluster through kubectl apply and when the resources or the stack is deleted, the resources in the manifest will be deleted through kubectl delete.
[{
apiVersion: 'v1',
kind: 'Pod',
metadata: { name: 'mypod' },
spec: {
containers: [ { name: 'hello', image: 'paulbouwer/hello-kubernetes:1.5', ports: [ { containerPort: 8080 } ] } ]
}
}]
If this is set, we will use kubectl apply instead of kubectl create when the resource is created. Otherwise, if there is already a resource in the cluster with the same name, the operation will fail.
Default: based on the prune option of the cluster, which is true unless otherwise specified.
notes
To address this, kubectl apply has a --prune option which will query the cluster for all resources with a specific label and will remove all the labeld resources that are not part of the applied manifest. If this option is disabled and a resource is removed, it will become "orphaned" and will not be deleted from the cluster.
When this option is enabled (default), the construct will inject a label to all Kubernetes resources included in this manifest which will be used to prune resources when the manifest changes via kubectl apply --prune.
The label name will be aws.cdk.eks/prune-<ADDR> where <ADDR> is the 42-char unique address of this construct in the construct tree. Value is empty.
removalPolicyRemovalPolicyremoval_policyRemovalPolicyremovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicy= RemovalPolicy.DESTROY#notes
The removal policy controls what happens to the resource if it stops being managed by CloudFormation. This can happen in one of three situations:
- The resource is removed from the template, so CloudFormation stops managing it
- A change to the resource is made that requires it to be replaced, so CloudFormation stops managing it
- The stack is deleted, so CloudFormation stops managing all resources in it
skipValidationbooleanskip_validationboolskipValidationBooleanSkipValidationboolSkipValidation*bool= false#Properties
Methods
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.
1 parameter · returns
Parameters
mixinsmixinsmixinsmixinsMixins— The mixins to apply.
Returns: This construct for chaining