Skip to content
v2.277.0

SlackConfigurationProperty Struct ​

Configuration for Slack workspace integration.

Defines the workspace ID, workspace name, and transmission targets that specify which Slack channels receive notifications.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_devopsagent as devopsagent } from 'aws-cdk-lib';
const slackConfigurationProperty: devopsagent.CfnAssociation.SlackConfigurationProperty = {
  transmissionTarget: {
    incidentResponseTarget: {
      channelId: 'channelId',

      // the properties below are optional
      channelName: 'channelName',
    },
  },
  workspaceId: 'workspaceId',
  workspaceName: 'workspaceName',

  // the properties below are optional
  bidirectional: {
    roleArn: 'roleArn',

    // the properties below are optional
    enabled: false,
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_devopsagent as devopsagent

slack_configuration_property = devopsagent.CfnAssociation.SlackConfigurationProperty(
    transmission_target=devopsagent.CfnAssociation.SlackTransmissionTargetProperty(
        incident_response_target=devopsagent.CfnAssociation.SlackChannelProperty(
            channel_id="channelId",

            # the properties below are optional
            channel_name="channelName"
        )
    ),
    workspace_id="workspaceId",
    workspace_name="workspaceName",

    # the properties below are optional
    bidirectional=devopsagent.CfnAssociation.SlackBidirectionalConfigurationProperty(
        role_arn="roleArn",

        # the properties below are optional
        enabled=False
    )
)
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.devopsagent.*;

SlackConfigurationProperty slackConfigurationProperty = SlackConfigurationProperty.builder()
        .transmissionTarget(SlackTransmissionTargetProperty.builder()
                .incidentResponseTarget(SlackChannelProperty.builder()
                        .channelId("channelId")

                        // the properties below are optional
                        .channelName("channelName")
                        .build())
                .build())
        .workspaceId("workspaceId")
        .workspaceName("workspaceName")

        // the properties below are optional
        .bidirectional(SlackBidirectionalConfigurationProperty.builder()
                .roleArn("roleArn")

                // the properties below are optional
                .enabled(false)
                .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.DevOpsAgent;

var slackConfigurationProperty = new SlackConfigurationProperty {
    TransmissionTarget = new SlackTransmissionTargetProperty {
        IncidentResponseTarget = new SlackChannelProperty {
            ChannelId = "channelId",

            // the properties below are optional
            ChannelName = "channelName"
        }
    },
    WorkspaceId = "workspaceId",
    WorkspaceName = "workspaceName",

    // the properties below are optional
    Bidirectional = new SlackBidirectionalConfigurationProperty {
        RoleArn = "roleArn",

        // the properties below are optional
        Enabled = false
    }
};
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"

slackConfigurationProperty := &SlackConfigurationProperty{
	TransmissionTarget: &SlackTransmissionTargetProperty{
		IncidentResponseTarget: &SlackChannelProperty{
			ChannelId: jsii.String("channelId"),

			// the properties below are optional
			ChannelName: jsii.String("channelName"),
		},
	},
	WorkspaceId: jsii.String("workspaceId"),
	WorkspaceName: jsii.String("workspaceName"),

	// the properties below are optional
	Bidirectional: &SlackBidirectionalConfigurationProperty{
		RoleArn: jsii.String("roleArn"),

		// the properties below are optional
		Enabled: jsii.Boolean(false),
	},
}

Properties ​

bidirectionaloptionalIResolvable | CfnAssociation.SlackBidirectionalConfigurationPropertybidirectionaloptionaltyping.Union[IResolvable, SlackBidirectionalConfigurationProperty]bidirectionaloptionalIResolvableBidirectionaloptionalIResolvableBidirectionaloptionalinterface{} #
Optional bidirectional communication configuration.

Supply this configuration and set Enabled to true so you can interact with the agent directly from Slack

transmissionTargetIResolvable | CfnAssociation.SlackTransmissionTargetPropertytransmission_targettyping.Union[IResolvable, SlackTransmissionTargetProperty]transmissionTargetIResolvableTransmissionTargetIResolvableTransmissionTargetinterface{} required #
Transmission targets for agent notifications.
workspaceIdstringworkspace_idstrworkspaceIdStringWorkspaceIdstringWorkspaceId*string required #
Associated Slack workspace ID.
workspaceNamestringworkspace_namestrworkspaceNameStringWorkspaceNamestringWorkspaceName*string required #
Associated Slack workspace name.