Skip to content
v2.276.0

CfnDomainProps Struct Added in v2.276.0 ​

Properties for defining a CfnDomain.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudwatch as cloudwatch } from 'aws-cdk-lib';
const cfnDomainProps: cloudwatch.CfnDomainProps = {
  identityProviders: ['identityProviders'],
  name: 'name',

  // the properties below are optional
  identityProviderConfiguration: {
    identityCenterConfiguration: {
      identityCenterInstanceArn: 'identityCenterInstanceArn',
    },
  },
  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_cloudwatch as cloudwatch

cfn_domain_props = cloudwatch.CfnDomainProps(
    identity_providers=["identityProviders"],
    name="name",

    # the properties below are optional
    identity_provider_configuration=cloudwatch.CfnDomain.IdentityProviderConfigurationProperty(
        identity_center_configuration=cloudwatch.CfnDomain.IdentityCenterConfigurationProperty(
            identity_center_instance_arn="identityCenterInstanceArn"
        )
    ),
    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.cloudwatch.*;

CfnDomainProps cfnDomainProps = CfnDomainProps.builder()
        .identityProviders(List.of("identityProviders"))
        .name("name")

        // the properties below are optional
        .identityProviderConfiguration(IdentityProviderConfigurationProperty.builder()
                .identityCenterConfiguration(IdentityCenterConfigurationProperty.builder()
                        .identityCenterInstanceArn("identityCenterInstanceArn")
                        .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.CloudWatch;

var cfnDomainProps = new CfnDomainProps {
    IdentityProviders = new [] { "identityProviders" },
    Name = "name",

    // the properties below are optional
    IdentityProviderConfiguration = new IdentityProviderConfigurationProperty {
        IdentityCenterConfiguration = new IdentityCenterConfigurationProperty {
            IdentityCenterInstanceArn = "identityCenterInstanceArn"
        }
    },
    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"

cfnDomainProps := &CfnDomainProps{
	IdentityProviders: []*string{
		jsii.String("identityProviders"),
	},
	Name: jsii.String("name"),

	// the properties below are optional
	IdentityProviderConfiguration: &IdentityProviderConfigurationProperty{
		IdentityCenterConfiguration: &IdentityCenterConfigurationProperty{
			IdentityCenterInstanceArn: jsii.String("identityCenterInstanceArn"),
		},
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

identityProviderConfigurationoptionalIResolvable | CfnDomain.IdentityProviderConfigurationPropertyidentity_provider_configurationoptionaltyping.Union[IResolvable, IdentityProviderConfigurationProperty]identityProviderConfigurationoptionalIResolvableIdentityProviderConfigurationoptionalIResolvableIdentityProviderConfigurationoptionalinterface{}#
Identity provider configuration for the domain.
identityProvidersstring[]identity_providerstyping.List[str]identityProvidersList<String>IdentityProvidersstring[]IdentityProviders*[]*stringrequired#
The identity providers configured for the domain.
namestringnamestrnameStringNamestringName*stringrequired#
A name that identifies the domain.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
An array of key-value pairs to apply to this resource.