CfnCapabilityProps Struct
Properties for defining a CfnCapability.
| Source | |
|---|---|
| Type last changed |
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_eks as eks } from 'aws-cdk-lib';
const cfnCapabilityProps: eks.CfnCapabilityProps = {
capabilityName: 'capabilityName',
clusterName: 'clusterName',
deletePropagationPolicy: 'deletePropagationPolicy',
roleArn: 'roleArn',
type: 'type',
// the properties below are optional
configuration: {
ack: {
disabledServices: ['disabledServices'],
enableCrossNamespace: false,
},
argoCd: {
awsIdc: {
idcInstanceArn: 'idcInstanceArn',
// the properties below are optional
idcManagedApplicationArn: 'idcManagedApplicationArn',
idcRegion: 'idcRegion',
},
// the properties below are optional
endpointPrefix: 'endpointPrefix',
namespace: 'namespace',
networkAccess: {
vpceIds: ['vpceIds'],
},
rbacRoleMappings: [{
identities: [{
id: 'id',
type: 'type',
}],
role: 'role',
}],
serverUrl: 'serverUrl',
},
},
tags: [{
key: 'key',
value: 'value',
}],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_eks as eks
cfn_capability_props = eks.CfnCapabilityProps(
capability_name="capabilityName",
cluster_name="clusterName",
delete_propagation_policy="deletePropagationPolicy",
role_arn="roleArn",
type="type",
# the properties below are optional
configuration=eks.CfnCapability.CapabilityConfigurationProperty(
ack=eks.CfnCapability.AckProperty(
disabled_services=["disabledServices"],
enable_cross_namespace=False
),
argo_cd=eks.CfnCapability.ArgoCdProperty(
aws_idc=eks.CfnCapability.AwsIdcProperty(
idc_instance_arn="idcInstanceArn",
# the properties below are optional
idc_managed_application_arn="idcManagedApplicationArn",
idc_region="idcRegion"
),
# the properties below are optional
endpoint_prefix="endpointPrefix",
namespace="namespace",
network_access=eks.CfnCapability.NetworkAccessProperty(
vpce_ids=["vpceIds"]
),
rbac_role_mappings=[eks.CfnCapability.ArgoCdRoleMappingProperty(
identities=[eks.CfnCapability.SsoIdentityProperty(
id="id",
type="type"
)],
role="role"
)],
server_url="serverUrl"
)
),
tags=[CfnTag(
key="key",
value="value"
)]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.eks.*;
CfnCapabilityProps cfnCapabilityProps = CfnCapabilityProps.builder()
.capabilityName("capabilityName")
.clusterName("clusterName")
.deletePropagationPolicy("deletePropagationPolicy")
.roleArn("roleArn")
.type("type")
// the properties below are optional
.configuration(CapabilityConfigurationProperty.builder()
.ack(AckProperty.builder()
.disabledServices(List.of("disabledServices"))
.enableCrossNamespace(false)
.build())
.argoCd(ArgoCdProperty.builder()
.awsIdc(AwsIdcProperty.builder()
.idcInstanceArn("idcInstanceArn")
// the properties below are optional
.idcManagedApplicationArn("idcManagedApplicationArn")
.idcRegion("idcRegion")
.build())
// the properties below are optional
.endpointPrefix("endpointPrefix")
.namespace("namespace")
.networkAccess(NetworkAccessProperty.builder()
.vpceIds(List.of("vpceIds"))
.build())
.rbacRoleMappings(List.of(ArgoCdRoleMappingProperty.builder()
.identities(List.of(SsoIdentityProperty.builder()
.id("id")
.type("type")
.build()))
.role("role")
.build()))
.serverUrl("serverUrl")
.build())
.build())
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EKS;
var cfnCapabilityProps = new CfnCapabilityProps {
CapabilityName = "capabilityName",
ClusterName = "clusterName",
DeletePropagationPolicy = "deletePropagationPolicy",
RoleArn = "roleArn",
Type = "type",
// the properties below are optional
Configuration = new CapabilityConfigurationProperty {
Ack = new AckProperty {
DisabledServices = new [] { "disabledServices" },
EnableCrossNamespace = false
},
ArgoCd = new ArgoCdProperty {
AwsIdc = new AwsIdcProperty {
IdcInstanceArn = "idcInstanceArn",
// the properties below are optional
IdcManagedApplicationArn = "idcManagedApplicationArn",
IdcRegion = "idcRegion"
},
// the properties below are optional
EndpointPrefix = "endpointPrefix",
Namespace = "namespace",
NetworkAccess = new NetworkAccessProperty {
VpceIds = new [] { "vpceIds" }
},
RbacRoleMappings = new [] { new ArgoCdRoleMappingProperty {
Identities = new [] { new SsoIdentityProperty {
Id = "id",
Type = "type"
} },
Role = "role"
} },
ServerUrl = "serverUrl"
}
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnCapabilityProps := &CfnCapabilityProps{
CapabilityName: jsii.String("capabilityName"),
ClusterName: jsii.String("clusterName"),
DeletePropagationPolicy: jsii.String("deletePropagationPolicy"),
RoleArn: jsii.String("roleArn"),
Type: jsii.String("type"),
// the properties below are optional
Configuration: &CapabilityConfigurationProperty{
Ack: &AckProperty{
DisabledServices: []*string{
jsii.String("disabledServices"),
},
EnableCrossNamespace: jsii.Boolean(false),
},
ArgoCd: &ArgoCdProperty{
AwsIdc: &AwsIdcProperty{
IdcInstanceArn: jsii.String("idcInstanceArn"),
// the properties below are optional
IdcManagedApplicationArn: jsii.String("idcManagedApplicationArn"),
IdcRegion: jsii.String("idcRegion"),
},
// the properties below are optional
EndpointPrefix: jsii.String("endpointPrefix"),
Namespace: jsii.String("namespace"),
NetworkAccess: &NetworkAccessProperty{
VpceIds: []*string{
jsii.String("vpceIds"),
},
},
RbacRoleMappings: []interface{}{
&ArgoCdRoleMappingProperty{
Identities: []interface{}{
&SsoIdentityProperty{
Id: jsii.String("id"),
Type: jsii.String("type"),
},
},
Role: jsii.String("role"),
},
},
ServerUrl: jsii.String("serverUrl"),
},
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
Properties
capabilityNamestringcapability_namestrcapabilityNameStringCapabilityNamestringCapabilityName*string required #The unique name of the capability within the cluster.
The name of the Amazon EKS cluster that contains this capability.
configurationoptionalIResolvable | CfnCapability.configurationoptionaltyping.Union[IResolvable, CapabilityConfigurationProperty]configurationoptionalIResolvableConfigurationoptionalIResolvableConfigurationoptionalinterface{} #The configuration settings for the capability.
The structure varies depending on the capability type.
deletePropagationPolicystringdelete_propagation_policystrdeletePropagationPolicyStringDeletePropagationPolicystringDeletePropagationPolicy*string required #The delete propagation policy for the capability.
Currently, the only supported value is RETAIN , which keeps all resources managed by the capability when the capability is deleted.
The Amazon Resource Name (ARN) of the IAM role that the capability uses to interact with AWS services.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #An array of key-value pairs to apply to this resource.
The type of capability.
Valid values are ACK , ARGOCD , or KRO .